私のクライアントから、サードパーティのAPIをRailsアプリに統合するように依頼されました。唯一の問題は、APIがSOAPを使用することです。Rubyは基本的にRESTを支持してSOAPを廃止しました。これらは、明らかにJava-Rubyブリッジで動作するJavaアダプターを提供しますが、可能であれば、すべてをRubyで保持したいと考えています。soap4rを調べましたが、少し評判が悪いようです。
では、SOAP呼び出しをRailsアプリに統合するための最良の方法は何でしょうか?
私のクライアントから、サードパーティのAPIをRailsアプリに統合するように依頼されました。唯一の問題は、APIがSOAPを使用することです。Rubyは基本的にRESTを支持してSOAPを廃止しました。これらは、明らかにJava-Rubyブリッジで動作するJavaアダプターを提供しますが、可能であれば、すべてをRubyで保持したいと考えています。soap4rを調べましたが、少し評判が悪いようです。
では、SOAP呼び出しをRailsアプリに統合するための最良の方法は何でしょうか?
私はSavonを構築して、Rubyを介したSOAP Webサービスとのやり取りをできるだけ簡単にしました。
チェックすることをお勧めします。
soap/wsdlDriver
実際には SOAP4R である組み込みクラスを使用しました。それは非常に遅いですが、本当に簡単です。gems/etc から取得する SOAP4R は、同じものの更新版にすぎません。
コード例:
require 'soap/wsdlDriver'
client = SOAP::WSDLDriverFactory.new( 'http://example.com/service.wsdl' ).create_rpc_driver
result = client.doStuff();
それだけです
ハンドソープからサボンに変えました。
2 つのクライアント ライブラリを比較する一連のブログ記事を次に示します。
サボンもおすすめです。Soap4R に対処するのに何時間も費やしましたが、結果はありませんでした。機能が大幅に不足しており、ドキュメントがありません。
サボンは私にとっての答えです。
SOAP4Rをお試しください
そして、私はRails Envyポッドキャスト(ep 31)でこれについて聞いたばかりです:
Savon を使用して 3 時間以内に動作するようになりました。
Savon のホームページにある Getting Started ドキュメントは非常に分かりやすく、実際に私が見たものと一致していました (常にそうであるとは限りません)。
以下のようなHTTP呼び出しを使用してSOAPメソッドを呼び出しましたが、
require 'net/http'
class MyHelper
def initialize(server, port, username, password)
@server = server
@port = port
@username = username
@password = password
puts "Initialised My Helper using #{@server}:#{@port} username=#{@username}"
end
def post_job(job_name)
puts "Posting job #{job_name} to update order service"
job_xml ="<soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:ns=\"http://test.com/Test/CreateUpdateOrders/1.0\">
<soapenv:Header/>
<soapenv:Body>
<ns:CreateTestUpdateOrdersReq>
<ContractGroup>ITE2</ContractGroup>
<ProductID>topo</ProductID>
<PublicationReference>#{job_name}</PublicationReference>
</ns:CreateTestUpdateOrdersReq>
</soapenv:Body>
</soapenv:Envelope>"
@http = Net::HTTP.new(@server, @port)
puts "server: " + @server + "port : " + @port
request = Net::HTTP::Post.new(('/XISOAPAdapter/MessageServlet?/Test/CreateUpdateOrders/1.0'), initheader = {'Content-Type' => 'text/xml'})
request.basic_auth(@username, @password)
request.body = job_xml
response = @http.request(request)
puts "request was made to server " + @server
validate_response(response, "post_job_to_pega_updateorder job", '200')
end
private
def validate_response(response, operation, required_code)
if response.code != required_code
raise "#{operation} operation failed. Response was [#{response.inspect} #{response.to_hash.inspect} #{response.body}]"
end
end
end
/*
test = MyHelper.new("mysvr.test.test.com","8102","myusername","mypassword")
test.post_job("test_201601281419")
*/
それが役に立てば幸い。乾杯。
私は、受け入れテストのために偽の SOAP サーバーを作成しなければならなかったときに、Ruby で SOAP を使用しました。これが問題に取り組むための最良の方法であったかどうかはわかりませんが、私にとってはうまくいきました。
サーバーには Sinatra gem (ここで Sinatra を使用したモック エンドポイントの作成について書きました) を使用し、XML にはNokogiriを使用しました (SOAP は XML で動作します)。
そのため、最初に 2 つのファイル (config.rb と response.rb など) を作成し、そこに SOAP サーバーが返す定義済みの回答を入れました。config.rbに WSDL ファイルを入れましたが、文字列としてです。
@@wsdl = '<wsdl:definitions name="StockQuote"
targetNamespace="http://example.com/stockquote.wsdl"
xmlns:tns="http://example.com/stockquote.wsdl"
xmlns:xsd1="http://example.com/stockquote.xsd"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns="http://schemas.xmlsoap.org/wsdl/">
.......
</wsdl:definitions>'
response.rbには、SOAP サーバーがさまざまなシナリオで返す応答のサンプルを入れました。
@@login_failure = "<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body>
<LoginResponse xmlns="http://tempuri.org/">
<LoginResult xmlns:a="http://schemas.datacontract.org/2004/07/WEBMethodsObjects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<a:Error>Invalid username and password</a:Error>
<a:ObjectInformation i:nil="true"/>
<a:Response>false</a:Response>
</LoginResult>
</LoginResponse>
</s:Body>
</s:Envelope>"
それでは、実際にサーバーを作成した方法をお見せしましょう。
require 'sinatra'
require 'json'
require 'nokogiri'
require_relative 'config/config.rb'
require_relative 'config/responses.rb'
after do
# cors
headers({
"Access-Control-Allow-Origin" => "*",
"Access-Control-Allow-Methods" => "POST",
"Access-Control-Allow-Headers" => "content-type",
})
# json
content_type :json
end
#when accessing the /HaWebMethods route the server will return either the WSDL file, either and XSD (I don't know exactly how to explain this but it is a WSDL dependency)
get "/HAWebMethods/" do
case request.query_string
when 'xsd=xsd0'
status 200
body = @@xsd0
when 'wsdl'
status 200
body = @@wsdl
end
end
post '/HAWebMethods/soap' do
request_payload = request.body.read
request_payload = Nokogiri::XML request_payload
request_payload.remove_namespaces!
if request_payload.css('Body').text != ''
if request_payload.css('Login').text != ''
if request_payload.css('email').text == some username && request_payload.css('password').text == some password
status 200
body = @@login_success
else
status 200
body = @@login_failure
end
end
end
end
これがお役に立てば幸いです。
Datanoise の Kent Sibilevも、Rails ActionWebService ライブラリを Rails 2.1 (およびそれ以降) に移植しました。これにより、独自の Ruby ベースの SOAP サービスを公開できます。彼には、ブラウザを使用してサービスをテストできる scaffold/test モードもあります。
私は同じ問題を抱えていて、Savonに切り替えてから、オープンWSDL(http://www.webservicex.net/geoipservice.asmx?WSDLを使用しました)でテストしましたが、これまでのところとても良いです!