canned_soap 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23355d1c2e66be1f8577a68e8015eab0a1ea1169
-  data.tar.gz: 859ff7e1c8ff6b1cc0386e0173579e54d040c66e
+  metadata.gz: cd7e448086fd09cb538b48f828f002e0c0c415b5
+  data.tar.gz: 1ea6a961e2e01bfe607e451104a6d5817be2af50
 SHA512:
-  metadata.gz: 37fa359b99059c40aef433b40d7cf83aecc2a8ec5a6125296349a442b1087f10422a2ae860e6c672a943e49a6ed1c0b379d1cda672b271ec023faab59cca55b4
-  data.tar.gz: 638c52370ac7199be8143812d5fb1541d4ec604d06203743912b08f81486ed853c56062e0ebe23cff14fa4600599d220a05a66670a4effe9b0452e9f991a61a0
+  metadata.gz: b2b1571c901a2bc276c89d7310180ca36823e5c789b98f5bd1f32acc72fd3c1917b36da9fd0e9780301bda87dfa9ce6ed8067f98fdade457bf14bce3b97272f7
+  data.tar.gz: '090cb3f336f8e87f18c5268a2a603f8fa74837766b3f173ae1a58d3591cfad03d682eaea0e92c841718af727dab4d62f944b66d4e38ced6bae13cc4b15ef2501'

data/README.md

@@ -1,11 +1,58 @@
-#CannedSoap
+# CannedSoap
 
 A rewrite version of the [ruby2soap](https://github.com/ericman93/ruby2soap) gem.
 
-##Motivation
+## Motivation
 The original gem has a lot of bugs and don't work on Linux environments. I started to maintain an old gem that uses this gem, so I started to maintain this gem too.
 
-#Ruby2Soap Doc
+## Getting Started
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'canned_soap'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or if you don't use bundler:
+
+```sh
+gem install canned_soap
+```
+
+
+## Usage
+
+### Initialize the client
+
+```ruby
+client = CannedSoap::Client.new('http://www.webservicex.net/CurrencyConvertor.asmx')
+```
+
+### Simple objects
+```ruby
+client.ConversionRate(FromCurrency: 'ILS', ToCurrency: 'GBP')
+```
+
+### Statefull
+```ruby
+client.Init(userName: 'ericman93')
+client.IncreaseScore() #the cookies saved automaticly
+```
+
+### Complex type
+```ruby
+client = WcfHandler.new('http://localhost:1659/Service1.svc')
+res = client.GetDataUsingDataContract(composite: {BoolValue: true, StringValue: "canedo_soap"})
+```
+
+
+# Base Ruby2Soap Doc
 I started this project when I needed to call a WCF method which required cookies on init. Unfortunalty, I could not find any gem that will help me so, so I implemented it myself.
 
 While working I noticed that I need more features - authentication, for example.
@@ -16,47 +63,47 @@ Thank you,
 Eric
 
 
-##Examples
+## Examples
 
-###Initialize the handler
+### Initialize the handler
 
 ```ruby
 handler = WcfHandler.new('http://www.webservicex.net/CurrencyConvertor.asmx')
 ```
 
-###Simple objects
+### Simple objects
 ```ruby
 handler.ConversionRate(:FromCurrency => 'ILS', :ToCurrency => 'GBP')
 ```
 
-###Statefull
+### Statefull
 ```ruby
   handler.Init(:userName => 'ericman93')
   handler.IncreaseScore() #the cookies saved automaticly
 ```
 
-###Complex type
+### Complex type
 ```ruby
 handler = WcfHandler.new('http://localhost:1659/Service1.svc')
 res = handler.GetDataUsingDataContract(:composite => {:BoolValue => true,:StringValue => "ruby2soap"})
 ```
 
-##Result
+## Result
 The object that the soap service function returns is actually a HTTP response with 'result' function that returns the actual value.
 If the value is a complex object, then it would be represented as a hash
 
 
-##Authentication
+## Authentication
 Available authentications
 1. NTLM
 2. Basic
 3. Digest
 
-###NTLM Auth
+### NTLM Auth
 ```ruby
 handler.ConversionRate({:FromCurrency => 'ILS', :ToCurrency => 'GBP'},SecutryProtocol::NTLM,'user','password')
 ```
-###With domain
+### With domain
 ```ruby
 handler.ConversionRate({:FromCurrency => 'ILS', :ToCurrency => 'GBP'},SecutryProtocol::NTLM,'user','password','domain')
 ```

data/lib/canned_soap/client.rb

@@ -1,3 +1,4 @@
+include CannedSoap::Wsdl
 # Handle the requests to the service
 module CannedSoap
 	class Client
@@ -19,8 +20,6 @@ module CannedSoap
 			wsdl.actions.each do |action|
 				define_wcf_action(action)
 			end
-
-			# maybe create class for each service and the function will be there
 		end
 
 		# Return the the current cookie set
@@ -43,15 +42,8 @@ module CannedSoap
 				res.singleton_class.send(:define_method,:result) do
 					result
 				end
-
-				#if(res.code == '401') # not autorized
-				#	(raise "Please use ntlm") if res['WWW-Authenticate'].include?('NTLM')
-				#end
-
 				res
 			end
-
-			#create new method that takes the data and user and password and user ntlm
 		end
 
 		# Call to wcf method
@@ -60,24 +52,14 @@ module CannedSoap
 		# +body+:: the body of the HTTP request
 		# +args+:: metadata that indicate wich autountication to use
 		def send_wcf_action(soap_action,body,*args)
-			#req = Net::HTTP::Post.new(@uri.path)
-			#req = Net::HTTP::Post.new(@service_address)
-
-			#req["SOAPAction"] = soap_action
-			#req["Content-Type"] = "text/xml; charset=utf-8"
-			#req["Cookie"] = @cookies.join(',') unless @cookies.empty?
-			#req.body = body
-
 			yield(req) if block_given?
-
-			#get_web_response(req,@uri,*args)
-			# "Cookie" => (@cookies.join(',') unless @cookies.empty?)
 			cookies = @cookies.empty? ? "" : @cookies.join(',')
-			send_message_to_wcf(@service_address,
-							 {"SOAPAction" => soap_action,
-							  "Content-Type" => "text/xml; charset=utf-8",
-							  "Cookie" => cookies},
-							  body, *args)
+			header = {
+				"SOAPAction" => soap_action,
+				"Content-Type" => "text/xml; charset=utf-8",
+				"Cookie" => cookies
+			}
+			send_message_to_wcf(@service_address, header, body, *args)
 		end
 	end
 end

data/lib/canned_soap/version.rb

@@ -1,3 +1,3 @@
 module CannedSoap
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/canned_soap.rb

@@ -1,5 +1,4 @@
 require 'net/http'
 require 'xmlsimple'
 require 'canned_soap/wsdl/wsdl'
-include CannedSoap::Wsdl
 require 'canned_soap/client'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: canned_soap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gustavo Canedo
@@ -105,7 +105,6 @@ files:
 - lib/canned_soap/soap/soap_action.rb
 - lib/canned_soap/soap/soap_parameter.rb
 - lib/canned_soap/version.rb
-- lib/canned_soap/wcf_handler.rb
 - lib/canned_soap/web/security_protocol.rb
 - lib/canned_soap/web/web_request_handler.rb
 - lib/canned_soap/wsdl/wsdl.rb

data/lib/canned_soap/wcf_handler.rb

@@ -1,102 +0,0 @@
-require 'net/http'
-require 'xmlsimple'
-require 'canned_soap/wsdl/wsdl'
-include Wsdl
-#require 'soap/soap'
-#include Soap
-#include WebRequestHandler
-#require_relative 'wsdl.rb'
-#require_relative 'wsdl_parser.rb'
-#require_relative 'soap.rb'
-#include WsdlParser
-#include Soap
-
-#Dir["lib/*.rb"].each {|file|
-#	require file
-#	#require_relative file# if file != 'wcf_handler'
-#	#include file.gsub('.rb','')
-#}
-
-# Handle the requests to the service
-module CannedSoap
-	class WcfHandler
-		# C'tor.
-		# Parse the wsdl and create a method to each WCF/WebService method
-		# Params:
-		# +service_url+:: the url of your service
-		# +save_cookeis+:: should save cookies of the result
-		def initialize(service_url,save_cookeis = true)
-			HTTPI.log = false
-			@cookies = []
-			@save_cookeis = save_cookeis
-
-			@uri = URI("#{service_url}")
-
-			wsdl = Wsdl::WsdlParser.parse(service_url)
-			@service_address = wsdl.location_address
-
-			wsdl.actions.each do |action|
-				define_wcf_action(action)
-			end
-
-			# maybe create class for each service and the function will be there
-		end
-
-		# Return the the current cookie set
-		def cookies
-			@cookies
-		end
-
-		private
-		# Define a method to the +WcfHandler+ object base on the method from the WSDL
-		# Params:
-		# +action+:: +SoapAction+ that have all the info about the method from the WSDL
-		def define_wcf_action(action)
-		 	self.class.send(:define_method ,action.name) do |data=nil,*args|
-				body = build_body(action, data)
-
-				res = send_wcf_action(action.soap_action,body,*args)
-				(@cookies << res.headers["Set-Cookie"]) if @save_cookeis
-
-				result = get_wcf_response(res,action.name)
-				res.singleton_class.send(:define_method,:result) do
-					result
-				end
-
-				#if(res.code == '401') # not autorized
-				#	(raise "Please use ntlm") if res['WWW-Authenticate'].include?('NTLM')
-				#end
-
-				res
-			end
-
-			#create new method that takes the data and user and password and user ntlm
-		end
-
-		# Call to wcf method
-		# Params:
-		# +soap_action+:: the value of the SOAPAction header
-		# +body+:: the body of the HTTP request
-		# +args+:: metadata that indicate wich autountication to use
-		def send_wcf_action(soap_action,body,*args)
-			#req = Net::HTTP::Post.new(@uri.path)
-			#req = Net::HTTP::Post.new(@service_address)
-
-			#req["SOAPAction"] = soap_action
-			#req["Content-Type"] = "text/xml; charset=utf-8"
-			#req["Cookie"] = @cookies.join(',') unless @cookies.empty?
-			#req.body = body
-
-			yield(req) if block_given?
-
-			#get_web_response(req,@uri,*args)
-			# "Cookie" => (@cookies.join(',') unless @cookies.empty?)
-			cookies = @cookies.empty? ? "" : @cookies.join(',')
-			send_message_to_wcf(@service_address,
-							 {"SOAPAction" => soap_action,
-							  "Content-Type" => "text/xml; charset=utf-8",
-							  "Cookie" => cookies},
-							  body, *args)
-		end
-	end
-end