resource_accessor 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f6eb7b46ad736c090bf61416ff239b6f39254d3
-  data.tar.gz: 5415d79f310c60cdce46f42666878c834d335cbe
+  metadata.gz: b4960ccbbb27df69a3854814ceabe214ac8df1db
+  data.tar.gz: 95a5e556ed7578ec209e64f8eb990f2f4dcd6686
 SHA512:
-  metadata.gz: d979406e639d945bde47697aea567afefd11e3014bb581789552ef0d67fd4070e092b45b0454131c7ee4f288b35ce618c59c2210f5a44740b606b1b2e0436158
-  data.tar.gz: db397ac1b3f05c92f69674fbf4f81f4f2858d518fe148d6fb7021cece49138a00b26f4aa77f6f10ffae85973f06fb333d59b562c5d55a23e9d303b03fc5b7aef
+  metadata.gz: c284b9bf41355ecc21da3f33074f24579bc046740ff201af4d85cf4101eae4562fa61447cdf88e570e0a471db63801bef186cdbf97ad4b2b6f6bb4691cf6a9da
+  data.tar.gz: 5e5d853984783360508491f8f3b72179736f14961264248310fea33a843059fb8939e07263fcd5e8402b4626255145615d40e195a2595908fc7a011b072d6fb2

data/CHANGES

@@ -14,4 +14,8 @@
 
 == Version 1.1.1
 
-* Adding specs.
+* Adding specs.
+
+== Version 1.1.1
+
+* Adding query parameter.

data/README.md

@@ -43,6 +43,7 @@ response = accessor.get_response :url => some_url, :method => :post, :cookie =>
 response = accessor.get_response :url => some_url, :method => :post, :cookie => cookie,
                                  :body => some_string
 ```
+
 You have to specify HTTP method explicitly here (post).
 
 If you want to get AJAX resource, add special header to the request or use special method:
@@ -69,6 +70,18 @@ response = accessor.get_response {:url => some_url}, {'Content-Type" => "applica
 response2 = accessor.get_json_response :url => some_url
 ```
 
+If you want to provide additional parameters in GET call, use **query** parameter:
+
+```ruby
+response = accessor.get_response :url => some_url, :query => {:param1 => 'p1', :param2 => 'p2'}
+```
+
+or
+
+```ruby
+response = accessor.get_response :url => "#{some_url?param1=p1&param2=p2}"
+```
+
 You can setup timeout for your accessor object in milliseconds:
 
 ```ruby
@@ -82,7 +95,6 @@ accessor.validate_ssl_cert = true
 accessor.ca_file = 'your cert file location'
 ```
 
-
 ## Contributing
 
 1. Fork it

data/lib/resource_accessor/resource_accessor.rb

@@ -4,6 +4,8 @@ require 'cgi'
 class ResourceAccessor
   attr_accessor :timeout, :ca_file, :validate_ssl_cert
 
+  alias validate_ssl_cert? validate_ssl_cert
+
   def initialize timeout = 10000, ca_file = nil, validate_ssl_cert = false
     @timeout = timeout
     @ca_file = ca_file
@@ -11,7 +13,7 @@ class ResourceAccessor
   end
 
   def get_response params, headers = {}
-    locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
+    locate_response(params[:url], params[:query], params[:method], headers, params[:body], params[:cookie])
   end
 
   def get_soap_response params, headers = {}
@@ -19,19 +21,19 @@ class ResourceAccessor
     headers["SOAPAction"] = "" unless headers["SOAPAction"]
     headers["Content-Type"] = "text/xml;charset=UTF-8" unless headers["Content-Type"]
 
-    locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
+    locate_response(params[:url], params[:query], params[:method], headers, params[:body], params[:cookie])
   end
 
   def get_ajax_response params, headers = {}
     headers['X-Requested-With'] = 'XMLHttpRequest'
 
-    locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
+    locate_response(params[:url], params[:query], params[:method], headers, params[:body], params[:cookie])
   end
 
   def get_json_response params, headers = {}
     headers["Content-Type"] = "application/json;charset=UTF-8"
 
-    locate_response(params[:url], params[:method], headers, params[:body], params[:cookie])
+    locate_response(params[:url], params[:query], params[:method], headers, params[:body], params[:cookie])
   end
 
   def get_cookie url, user_name, password
@@ -44,16 +46,16 @@ class ResourceAccessor
     response.response['set-cookie']
   end
 
-  def query_from_hash(params)
-    return "" if params.empty?
+  def self.query_from_hash(params)
+    return nil if params.nil? or params.empty?
 
-    params.sort.map {|k, v| "#{k}=#{v.nil? ? '' : CGI.escape(v)}"}.join("&")
+    params.sort.map {|key, value| "#{key}=#{value.nil? ? '' : CGI.escape(value)}"}.join("&")
   end
 
   private
 
-  def locate_response url, method, headers, body, cookie=nil
-    response = execute_request url, method, headers, body, cookie
+  def locate_response url, query, method, headers, body, cookie=nil
+    response = execute_request url, query, method, headers, body, cookie
 
     if response.class == Net::HTTPMovedPermanently
       response = execute_request response['location'], method, headers, body, cookie
@@ -62,15 +64,18 @@ class ResourceAccessor
     response
   end
 
-  def execute_request url, method, headers, body, cookie=nil
-    headers["User-Agent"] = "Ruby/#{RUBY_VERSION} (Macintosh; Intel Mac OS X 10.8)" unless headers["User-Agent"]
+  def execute_request url, query, method, headers, body, cookie=nil
+    headers["User-Agent"] = "Ruby/#{RUBY_VERSION}" unless headers["User-Agent"]
     headers["Content-Type"] = "application/x-www-form-urlencoded; charset=UTF-8" unless headers["Content-Type"]
 
     if cookie
       headers['Cookie'] = cookie
     end
 
-    uri = URI.parse(URI.escape(url))
+    query_string = ResourceAccessor.query_from_hash(query)
+    new_url = query_string.nil? ? url : "#{url}?#{query_string}"
+
+    uri = URI.parse(URI.escape(new_url))
 
     connection = Net::HTTP.new(uri.host, uri.port)
 
@@ -110,8 +115,4 @@ class ResourceAccessor
     end
   end
 
-  def validate_ssl_cert?
-    validate_ssl_cert
-  end
-
 end

data/lib/resource_accessor/version.rb

@@ -1,3 +1,3 @@
 class ResourceAccessor
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/spec/gateway.rb

@@ -0,0 +1,68 @@
+require 'log4r'
+require 'resource_accessor'
+
+GatewayError = Class.new(Exception)
+
+class Gateway
+  include Log4r
+
+  attr_accessor :accessor, :logger
+
+  def initialize
+    @accessor = ResourceAccessor.new
+    @accessor.timeout = 30
+
+    @logger = Logger.new 'my_logger'
+    #@logger.outputters = Outputter.stdout
+  end
+
+  def bad_response? response
+    response.class == Net::HTTPNotFound or (response.kind_of?(Net::HTTPOK) and !!(response.body =~/error/))
+  end
+
+  def get params = {}, headers = {}
+    with_exception_handler(params, headers) do |params, headers|
+      @accessor.get_response(params, headers)
+    end
+  end
+
+  def post params = {}, headers = {}
+    with_exception_handler(params, headers) do |params, headers|
+      @accessor.get_response(params.merge(:method => :post), headers)
+    end
+  end
+
+  def soap_post params = {}, headers = {}
+    with_exception_handler(params, headers) do |params, headers|
+      response = @accessor.get_soap_response(params.merge(:method => :post), headers)
+
+      logger.debug "#{params[:body]}" if params[:body]
+
+      response
+    end
+  end
+
+  def with_exception_handler params, headers, &code
+    params[:url] = @url unless params[:url]
+
+    begin
+      response = code.call(params, headers)
+
+      if bad_response?(response)
+        log.error(response, "#{self.class.name} failed with #{response.code}:#{response.message}\n#{response.body}")
+
+        raise GatewayError, "#{response.code} #{response.message}\n#{response.body}\n(URL: '#{params[:url]}')"
+      else
+        logger.info("Got #{response.code} response from #{self.class.name} Service")
+      end
+
+      response
+    rescue GatewayError
+      raise
+    rescue Exception => e
+      logger.error("#{self.class.name} received error: #{e}")
+
+      raise GatewayError, "Error: #{e} (URL: '#{params[:url]}')"
+    end
+  end
+end

data/spec/gateway_spec.rb

@@ -1,77 +1,14 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-GatewayError = Class.new(Exception)
-
-require 'resource_accessor'
-require 'log4r'
-
-class Gateway
-  include Log4r
-
-  attr_accessor :accessor, :logger
-
-  def initialize
-    @accessor = ResourceAccessor.new
-    @accessor.timeout = 30
-
-    @logger = Logger.new 'my_logger'
-    #@logger.outputters = Outputter.stdout
-  end
-
-  def bad_response? response
-    response.class == Net::HTTPNotFound or (response.kind_of?(Net::HTTPSuccess) and !!(response.body =~/error/))
-  end
-
-  def get params = {}, headers = {}
-    with_exception_handler(params, headers) do |params, headers|
-      @accessor.get_response(params, headers)
-    end
-  end
-
-  def post params = {}, headers = {}
-    with_exception_handler(params, headers) do |params, headers|
-      @accessor.get_response(params.merge(:method => :post), headers)
-    end
-  end
-
-  def soap_post params = {}, headers = {}
-    with_exception_handler(params, headers) do |params, headers|
-      response = @accessor.get_soap_response(params.merge(:method => :post), headers)
-
-      logger.debug "#{params[:body]}" if params[:body]
-
-      response
-    end
-  end
-
-  def with_exception_handler params, headers, &code
-    begin
-      response = code.call(params, headers)
-
-      if bad_response?(response)
-        log.error(response, "#{self.class.name} failed with #{response.code}:#{response.message}\n#{response.body}")
-
-        raise GatewayError, "#{response.code} #{response.message}\n#{response.body}\n(URL: '#{params[:url]}')"
-      else
-        logger.info("Got #{response.code} response from #{self.class.name} Service")
-      end
-    rescue GatewayError
-      raise
-    rescue Exception => e
-      logger.error("#{self.class.name} received error: #{e}")
-
-      raise GatewayError, "Error: #{e} (URL: '#{params[:url]}')"
-    end
-  end
-end
+require 'gateway'
 
 describe Gateway do
   let(:some_https_url) { "https://somehost.com" }
 
   let(:simple_response) do
-    good_response = Net::HTTPSuccess.new "1.1", "200", "success"
-    good_response.stubs(:stream_check => '')
-    good_response
+    response = Net::HTTPSuccess.new "1.1", "200", "success"
+    response.stubs(:stream_check => '')
+    response
   end
 
   it "uses certificate file and OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT as verify mode if validate_ssl_cert is on" do
@@ -82,8 +19,7 @@ describe Gateway do
     Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT)
     Net::HTTP.any_instance.expects(:ca_file=).with('some_ca_file')
 
-    Timeout.expects(:timeout).yields
-    Net::HTTP.any_instance.stubs(:request).returns(stub_everything(:kind_of? => true))
+    Net::HTTP.any_instance.stubs(:request => stub_everything)
 
     subject.get(:url => some_https_url)
   end
@@ -96,15 +32,13 @@ describe Gateway do
     Net::HTTP.any_instance.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
     Net::HTTP.any_instance.expects(:ca_file=).with('some_ca_file').never
 
-    Timeout.expects(:timeout).yields
-    Net::HTTP.any_instance.stubs(:request).returns(stub_everything(:kind_of? => true))
+    Net::HTTP.any_instance.stubs(:request => stub_everything)
 
     subject.get(:url => some_https_url)
   end
 
   it "logs error and raises exception if response is bad" do
-    Timeout.expects(:timeout).yields
-    Net::HTTP.any_instance.expects(:request).returns(simple_response)
+    Net::HTTP.any_instance.expects(:request => simple_response)
 
     subject.stubs(:bad_response? => true)
 
@@ -116,9 +50,7 @@ describe Gateway do
   end
 
   it "should set content type to text/xml for soap post request" do
-    Net::HTTP.any_instance.expects(:request).returns(simple_response)
-
-    Timeout.expects(:timeout).yields
+    Net::HTTP.any_instance.expects(:request => simple_response)
 
     params = {:url => some_https_url}
     headers = {}
@@ -129,13 +61,8 @@ describe Gateway do
   end
 
   it "should set content type to application/x-www-form-urlencoded for regular post request" do
-    post_request = Net::HTTP::Post.new 'someurl.com'
-    Net::HTTP::Post.expects(:new).returns(post_request)
-
     Net::HTTP.any_instance.expects(:request => simple_response)
 
-    Timeout.expects(:timeout).yields
-
     params = {:url => some_https_url}
     headers = {}
 
@@ -144,12 +71,18 @@ describe Gateway do
     headers["Content-Type"].should match "application/x-www-form-urlencoded"
   end
 
+  it "logs body of request" do
+    Net::HTTP.any_instance.expects(:request => simple_response)
+
+    subject.logger.expects(:debug).with('some_request')
+
+    subject.soap_post(:url => some_https_url, :body => 'some_request')
+  end
+
   it "should log timeout errors and raise GatewayError" do
     subject.logger.expects(:error).with("#{subject.class.name} received error: Timeout::Error")
     Net::HTTP.any_instance.expects(:request).raises(Timeout::Error.new(nil))
 
-    Timeout.expects(:timeout).yields
-
     expect do
       subject.soap_post(:url => some_https_url, :body => 'body')
     end.to raise_error(GatewayError)
@@ -170,19 +103,10 @@ describe Gateway do
     subject.logger.expects(:error).with("#{subject.class.name} received error: Connection reset by peer")
 
     Net::HTTP.any_instance.expects(:request).raises(Errno::ECONNRESET)
-    Timeout.expects(:timeout).yields
 
     expect do
       subject.get(:url => some_https_url, :body => '')
     end.to raise_error(GatewayError)
   end
 
-  it "logs body of request" do
-    Net::HTTP.any_instance.expects(:request).returns(simple_response)
-
-    subject.logger.expects(:debug).with('some_request')
-
-    subject.soap_post(:url => some_https_url, :body => 'some_request')
-  end
-
 end

data/spec/resource_accessor_spec.rb

@@ -3,19 +3,31 @@ require_relative 'spec_helper'
 require 'resource_accessor'
 
 describe ResourceAccessor do
+  context "#get_response" do
+    it "should use provided url" do
+      Net::HTTP.expects(:new).with("someurl.com", 80).returns(stub_everything(:request => stub_everything))
 
-  it "should get simple response" do
-    response = subject.get_response :url => "http://www.lenta.ru"
+      subject.get_response :url => "http://someurl.com"
+    end
 
-    response.should_not be_nil
-  end
+    it "should use provided query parameters" do
+      Net::HTTP.expects(:new).with("someurl.com", 80).returns(stub_everything(:request => stub_everything))
+
+      Net::HTTP::Get.expects(:new).with("/?param1=p1&param2=p2", {'User-Agent' => 'user_agent', 'Content-Type' => 'content_type'})
 
-  it "query_string_from_hash escapes ampersands and spaces in values" do
-    subject.query_from_hash({'name1' => "name 1", 'name2' => "name 2"}).should eql "name1=name+1&name2=name+2"
+      subject.get_response({:url => "http://someurl.com", :query => {:param1 => 'p1', :param2 => 'p2'}},
+                           {'User-Agent' => 'user_agent', 'Content-Type' => 'content_type'})
+    end
   end
 
-  it "query_string_from_hash maps properly nil values " do
-    subject.query_from_hash({'param1' => nil, 'param2' => "A&B", 'param3' => "C & D"}).should eql "param1=&param2=A%26B&param3=C+%26+D"
+  context "#query_from_hash" do
+    it "escapes ampersands and spaces in values" do
+      subject.class.query_from_hash({:name1 => "name 1", :name2 => "name 2"}).should eql "name1=name+1&name2=name+2"
+    end
+
+    it "maps properly nil values " do
+      subject.class.query_from_hash({:param1 => nil, :param2 => "A&B", :param3 => "C & D"}).should eql "param1=&param2=A%26B&param3=C+%26+D"
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resource_accessor
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-27 00:00:00.000000000 Z
+date: 2013-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gemspec_deps_gen
@@ -61,6 +61,7 @@ files:
 - lib/resource_accessor/version.rb
 - resource_accessor.gemspec
 - resource_accessor.gemspec.erb
+- spec/gateway.rb
 - spec/gateway_spec.rb
 - spec/resource_accessor_spec.rb
 - spec/spec_helper.rb
@@ -90,6 +91,7 @@ specification_version: 4
 summary: This library is used to simplify access to protected or unprotected http
   resource
 test_files:
+- spec/gateway.rb
 - spec/gateway_spec.rb
 - spec/resource_accessor_spec.rb
 - spec/spec_helper.rb