Как это работает
Итак, давайте разберемся как работает эта программа. Нам известно, что метод getCursOnDateXML получает на вход дату и возвращает информацию о курсе валют. Но каким образом передать методу аргумент и как интерпретировать полученный ответ? Для начала, откроем файл defaultDriver.rb и найдем в нем название интересующего нас метода: require 'default.rb' require 'defaultMappingRegistry.rb' require 'soap/rpc/driver'
class DailyInfoSoap < ::SOAP::RPC::Driver DefaultEndpointUrl = "http://www.cbr.ru/DailyInfoWebServ/DailyInfo.asmx"
Methods = [ ... [ "http://web.cbr.ru/GetCursOnDateXML", "getCursOnDateXML", [ ["in", "parameters", ["::SOAP::SOAPElement", "http://web.cbr.ru/", "GetCursOnDateXML"]], ["out", "parameters", ["::SOAP::SOAPElement", "http://web.cbr.ru/", "GetCursOnDateXMLResponse"]] ], { :request_style => :document, :request_use => :literal, :response_style => :document, :response_use => :literal, :faults => {} } ], ... end end
Видно, что на вход поступает объект класса GetCursOnDateXML, а на выходе мы получаем объект класса GetCursOnDateXMLResponse. Определение этих классов находится в файле default.rb: require 'xsd/qname'
...
# {http://web.cbr.ru/}GetCursOnDateXML # on_date - SOAP::SOAPDateTime class GetCursOnDateXML attr_accessor :on_date
def initialize(on_date = nil) @on_date = on_date end end
# {http://web.cbr.ru/}GetCursOnDateXMLResponse # getCursOnDateXMLResult - # GetCursOnDateXMLResponse::GetCursOnDateXMLResult class GetCursOnDateXMLResponse
# inner class for member: GetCursOnDateXMLResult # {http://web.cbr.ru/}GetCursOnDateXMLResult class GetCursOnDateXMLResult attr_reader :__xmlele_any
def set_any(elements) @__xmlele_any = elements end
def initialize @__xmlele_any = nil end end
attr_accessor :getCursOnDateXMLResult
def initialize(getCursOnDateXMLResult = nil) @getCursOnDateXMLResult = getCursOnDateXMLResult end end
...
С классом GetCursOnDateXML все достаточно очевидно. В его конструктор достаточно передать дату, что мы и делаем в строке 26 листинга get_curs.rb. Класс GetCursOnDateXMLResponse выглядит несколько сложнее. В нем определен метод getCursOnDateXMLResult который, судя по всему, и возвращает результат. Но в каком формате? Давайте заглянем в WSDL-файл и найдем там описание типа GetCursOnDateXMLResult: ... <s:element minOccurs="0" maxOccurs="1" name="GetCursOnDateXMLResult"> <s:complexType mixed="true"> <s:sequence> <s:any/> </s:sequence> </s:complexType> </s:element> ... Из этого фрагмента можно заключить, что GetCursOnDateXMLResult - это список "чего угодно" (s:any). В таких ситуациях на помощь приходит включение отладочного вывода (см. строку 23 листинга get_curs.rb) и irb - интерактивная консоль Ruby. При помощи irb можно наблюдать как исполняется код по мере его написания.
Итак, запускаем irb (из директории где находятся наши файлы), загружаем библиотеку SOAP4R и клиентские заглушки:
$ irb irb(main):001:0> require 'rubygems'
=> true
irb(main):002:0> require_gem 'soap4r'
=> true
irb(main):003:0> require 'defaultDriver.rb'
=> true
irb(main):004:0> Создаем объект-драйвер для работы с веб-сервисом и включаем отладочный вывод:
irb(main):004:0> serv = DailyInfoSoap.new
=> #<DailyInfoSoap:#<SOAP::RPC::Proxy:http://www.cbr.ru/DailyInfoWebServ/DailyInfo.asmx>>
irb(main):005:0> serv.wiredump_dev = STDERR
=> #<IO:0xb7c4ff60>
irb(main):006:0> Далее создаем запрос с текущей датой и отправляем его на сервер:
irb(main):006:0> request = GetCursOnDateXML.new(DateTime.now)
=> #<GetCursOnDateXML:0xb76797d0 @on_date=#<DateTime: 70695916331796971/28800000000,1/6,2299161>>
irb(main):007:0> response = serv.getCursOnDateXML(request)
Wire dump:
= Request
! CONNECT TO www.cbr.ru:80 ! CONNECTION ESTABLISHED POST /DailyInfoWebServ/DailyInfo.asmx HTTP/1.1 SOAPAction: "http://web.cbr.ru/GetCursOnDateXML" Content-Type: text/xml; charset=utf-8 User-Agent: SOAP4R/1.5.8 (/187, ruby 1.8.6 (2007-03-13) [i586-linux-gnu]) Date: Tue, 09 Sep 2008 19:36:45 GMT Content-Length: 405 Host: www.cbr.ru
<?xml version="1.0" encoding="utf-8" ?> <env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <env:Body> <n1:GetCursOnDateXML xmlns:n1="http://web.cbr.ru/"> <n1:On_date>2008-09-09T23:36:35.390913+04:00</n1:On_date> </n1:GetCursOnDateXML> </env:Body> </env:Envelope>
= Response
HTTP/1. 1 200 OK Date: Tue, 09 Sep 2008 19:40:34 GMT Server: Microsoft-IIS/6.0 X-Powered-By: ASP.NET X-AspNet-Version: 2.0.50727 Cache-Control: no-cache Pragma: no-cache Expires: -1 Content-Type: text/xml; charset=utf-8 Content-Length: 7601
<?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas. xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance " xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetCursOnDateXMLResponse xmlns="http://web.cbr.ru/"> <GetCursOnDateXMLResult> <ValuteData xmlns=""> <ValuteCursOnDate> <Vname>Австралийский доллар</Vname> <Vnom>1</Vnom> <Vcurs>21.0261</Vcurs> <Vcode>36</Vcode> <VchCode>AUD</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Фунт стерлингов Соединенного королевства</Vname> <Vnom>1</Vnom> <Vcurs>44.9826</Vcurs> <Vcode>826</Vcode> <VchCode>GBP</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Белорусский рубль</Vname> <Vnom>1000</Vnom> <Vcurs>11.9615</Vcurs> <Vcode>974</Vcode> <VchCode>BYR</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Датская крона</Vname> <Vnom>10</Vnom> <Vcurs>48.5829</Vcurs> <Vcode>208</Vcode> <VchCode>DKK</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Доллар США</Vname> <Vnom>1</Vnom> <Vcurs>25.2626</Vcurs> <Vcode>840</Vcode> <VchCode>USD</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Евро</Vname> <Vnom>1</Vnom> <Vcurs>36.2670</Vcurs> <Vcode>978</Vcode> <VchCode>EUR</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Исландская крона</Vname> <Vnom>100</Vnom> <Vcurs>28.8435</Vcurs> <Vcode>352</Vcode> <VchCode>ISK</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Казахский тенге</Vname> <Vnom>100</Vnom> <Vcurs>21.1120</Vcurs> <Vcode>398</Vcode> <VchCode>KZT</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Канадский доллар</Vname> <Vnom>1</Vnom> <Vcurs>23.8642</Vcurs> <Vcode>124</Vcode> <VchCode>CAD</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Китайский юань Жэньминьби</Vname> <Vnom>10</Vnom> <Vcurs>36.9304</Vcurs> <Vcode>156</Vcode> <VchCode>CNY</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Норвежская крона</Vname> <Vnom>10</Vnom> <Vcurs>45.2719</Vcurs> <Vcode>578</Vcode> <VchCode>NOK</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>СДР (специальные права заимствования)</Vname> <Vnom>1</Vnom> <Vcurs>39.0691</Vcurs> <Vcode>960</Vcode> <VchCode>XDR</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Сингапурский доллар</Vname> <Vnom>1</Vnom> <Vcurs>17.7668</Vcurs> <Vcode>702</Vcode> <VchCode>SGD</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Новая турецкая лира</Vname> <Vnom>1</Vnom> <Vcurs>20.7564</Vcurs> <Vcode>949</Vcode> <VchCode>TRY</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Украинская гривна</Vname> <Vnom>10</Vnom> <Vcurs>53.5225</Vcurs> <Vcode>980</Vcode> <VchCode>UAH</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Шведская крона</Vname> <Vnom>10</Vnom> <Vcurs>38.3377</Vcurs> <Vcode>752</Vcode> <VchCode>SEK</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Швейцарский франк</Vname> <Vnom>1</Vnom> <Vcurs>22.5962</Vcurs> <Vcode>756</Vcode> <VchCode>CHF</VchCode> </ValuteCursOnDate> <ValuteCursOnDate> <Vname>Японская иена</Vname> <Vnom>100</Vnom> <Vcurs>23.2653</Vcurs> <Vcode>392</Vcode> <VchCode>JPY</VchCode> </ValuteCursOnDate> </ValuteData> </GetCursOnDateXMLResult> </GetCursOnDateXMLResponse> </soap:Body> </soap:Envelope> => #<GetCursOnDateXMLResponse:0xb7658c74 @getCursOnDateXMLResult=#<GetCursOnDate ...
В отладочном выводе хорошо видно как вызов метода трансформируется в SOAP-сообщение. Ответ также очень наглядный: мы видим последовательность вложенных тегов: GetCursOnDateXMLResponse, GetCursOnDateXMLResult и ValuteData. Внутри ValuteData находится список тегов ValuteCursOnDate по одному на каждую валюту. Названия атрибутов также вполне ожидаемые - Vname, Vnom, Vcurs, Vcode и VchCode. Но как нам получить доступ к этим данным из кода Ruby? Для ответа на этот вопрос давайте выведем имена всех доступных методов объекта response в алфавитном порядке:
irb(main):008:0> response.methods.sort
=> ["==", "===", "=~", "__id__", "__send__", "class", "clone", "dclone", "display", "dup", "eql?", "equal?", "extend", "freeze", "frozen?", "gem", "getCursOnDateXMLResult", "getCursOnDateXMLResult=", "hash", "id", "inspect", "instance_eval", "instance_of?", "instance_variable_defined?", "instance_variable_get", "instance_variable_set", "instance_variables", "is_a?", "kind_of?", "method", "methods", "nil?", "object_id", "private_methods", "protected_methods", "public_methods", "require", "require_gem", "respond_to?", "send", "singleton_methods", "taint", "tainted?", "to_a", "to_s", "type", "untaint"]
irb(main):009:0> Обратите внимание на метод getCursOnDateXMLResult. Посмотрим, что он возвращает:
irb(main):009:0> response.getCursOnDateXMLResult.methods.sort
=> ["==", "===", "=~", "__id__", "__send__", "__xmlele_any", "class", "clone", "dclone", "display", "dup", "eql?", "equal?", "extend", "freeze", "frozen?", "gem", "hash", "id", "inspect", "instance_eval", "instance_of?", "instance_variable_defined?", "instance_variable_get", "instance_variable_set", "instance_variables", "is_a?", "kind_of?", "method", "methods", "nil?", "object_id", "private_methods", "protected_methods", "public_methods", "require", "require_gem", "respond_to?", "send", "set_any", "singleton_methods", "taint", "tainted?", "to_a", "to_s", "type", "untaint", "valuteData","valuteData="]
irb(main):010:0> В списке имеется метод valuteData. Посмотрим что внутри:
irb(main):010:0> response.getCursOnDateXMLResult.valuteData.methods.sort
=> ["==", "===", "=~", "[]", "[]=", "__add_xmlele_value", "__id__", "__send__", "__xmlattr", "__xmlele", "class", "clone", "dclone", "display", "dup", "eql?", "equal?", "extend", "freeze", "frozen?", "gem", "hash", "id", "inspect", "instance_eval", "instance_of?", "instance_variable_defined?", "instance_variable_get", "instance_variable_set", "instance_variables", "is_a?", "kind_of?", "marshal_dump", "marshal_load", "method", "methods", "nil?", "object_id", "private_methods", "protected_methods", "public_methods", "require", "require_gem", "respond_to?", "send", "singleton_methods", "taint", "tainted?", "to_a", "to_s", "type", "untaint", "valuteCursOnDate","valuteCursOnDate="] irb(main):011:0> Мы почти у цели. Посмотрим, какой объект возвращает метод valuteCursOnDate:
irb(main):011:0> response.getCursOnDateXMLResult.valuteData.valuteCursOnDate.class
=> Array
irb(main):012:0> response.getCursOnDateXMLResult.valuteData.valuteCursOnDate.length
=> 18 irb(main):013:0> Ага! Этот метод возвращает массив из 18 элементов. По всей видимости это и есть список валют. Для проверки нашей догадки, возьмем какой-нибудь элемент массива и посмотрим как он выглядит:
irb(main):013:0> response.getCursOnDateXMLResult.valuteData.valuteCursOnDate[4].methods.sort
=> ["==", "===", "=~", "[]", "[]=", "__add_xmlele_value", "__id__", "__send__", "__xmlattr", "__xmlele", "class", "clone", "dclone", "display", "dup", "eql?", "equal?", "extend", "freeze", "frozen?", "gem", "hash", "id", "inspect", "instance_eval", "instance_of?", "instance_variable_defined?", "instance_variable_get", "instance_variable_set", "instance_variables", "is_a?", "kind_of?", "marshal_dump", "marshal_load", "method", "methods", "nil?", "object_id", "private_methods", "protected_methods", "public_methods", "require", "require_gem", "respond_to?", "send", "singleton_methods", "taint", "tainted?", "to_a", "to_s", "type", "untaint", "vchCode", "vchCode=", "vcode", "vcode=", "vcurs", "vcurs=", "vname", "vname=", "vnom", "vnom="]
irb(main):014:0> response.getCursOnDateXMLResult.valuteData.valuteCursOnDate[4].vchCode
=> "USD"
irb(main):015:0> response.getCursOnDateXMLResult.valuteData.valuteCursOnDate[4]['VchCode']
=> "USD" irb(main):016:0> Действительно, каждый элемент массива соответствует определенной валюте. К атрибутам можно обратиться либо при помощи методов vname, vnom, vcurs, vcode, vchCode либо как к элементам хеша. Названия ключей при этом совпадают с названиями тегов в ответном XML-файле: Vname, Vnom, Vcurs, Vcode и VchCode. Теперь код тестовой программы становится очевидным: мы формируем запрос, отправляем его на сервер, получаем ссылку на массив валют, а затем бежим по этому массиву и выводим значения атрибутов. Вот и все!
Отмечу, что в более сложных ситуациях неоценимую помощь оказывают инструменты для отладки веб-сервисов, например, . При помощи этой программы можно вручную формировать SOAP-запросы и анализировать ответ от сервера.
