resource_accessor 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32baacfc4e7a916204597ea8d1f6241e56c38807
-  data.tar.gz: a1994c6edd8045267b9ab688cf658edcd70bec12
+  metadata.gz: 9f6eb7b46ad736c090bf61416ff239b6f39254d3
+  data.tar.gz: 5415d79f310c60cdce46f42666878c834d335cbe
 SHA512:
-  metadata.gz: afb238c1736db16a20a52b995b789bff9a3fbdc0989ecd174607972584ee87903d3071f0e5fcf69bbd22b7f49be2f8c456be6593f64aa075ac0c61c5e634acbe
-  data.tar.gz: b9e1d3c2f7069b857d86e9d4d4dbe42000055c79dc7344f3871df29ce5f5ddfc05709ca8d449b7362e80e727800bbccf631e08eb7ec431e6ae1f1c7da5678026
+  metadata.gz: d979406e639d945bde47697aea567afefd11e3014bb581789552ef0d67fd4070e092b45b0454131c7ee4f288b35ce618c59c2210f5a44740b606b1b2e0436158
+  data.tar.gz: db397ac1b3f05c92f69674fbf4f81f4f2858d518fe148d6fb7021cece49138a00b26f4aa77f6f10ffae85973f06fb333d59b562c5d55a23e9d303b03fc5b7aef

data/CHANGES

@@ -10,4 +10,8 @@
 
 == Version 1.1.0
 
-* Write documentation;API change.
+* Write documentation;API change.
+
+== Version 1.1.1
+
+* Adding specs.

data/Gemfile

@@ -8,4 +8,5 @@ end
 group :test do
   gem "rspec"
   gem "mocha"
+  gem "log4r"
 end

data/Gemfile.lock

@@ -7,6 +7,7 @@ GEM
     gemspec_deps_gen (1.1.2)
       bundler
       file_utils
+    log4r (1.1.10)
     metaclass (0.0.1)
     mocha (0.14.0)
       metaclass (~> 0.0.1)
@@ -25,5 +26,6 @@ PLATFORMS
 DEPENDENCIES
   gemcutter
   gemspec_deps_gen
+  log4r
   mocha
   rspec

data/lib/resource_accessor/resource_accessor.rb

@@ -1,4 +1,5 @@
 require 'net/https'
+require 'cgi'
 
 class ResourceAccessor
   attr_accessor :timeout, :ca_file, :validate_ssl_cert
@@ -43,6 +44,12 @@ class ResourceAccessor
     response.response['set-cookie']
   end
 
+  def query_from_hash(params)
+    return "" if params.empty?
+
+    params.sort.map {|k, v| "#{k}=#{v.nil? ? '' : CGI.escape(v)}"}.join("&")
+  end
+
   private
 
   def locate_response url, method, headers, body, cookie=nil

data/lib/resource_accessor/version.rb

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

data/spec/gateway_spec.rb

@@ -0,0 +1,188 @@
+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
+
+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
+  end
+
+  it "uses certificate file and OpenSSL::SSL::VERIFY_FAIL_IF_NO_PEER_CERT as verify mode if validate_ssl_cert is on" do
+    subject.accessor.validate_ssl_cert = true
+    subject.accessor.ca_file = 'some_ca_file'
+
+    Net::HTTP.any_instance.expects(:use_ssl=).with(true)
+    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))
+
+    subject.get(:url => some_https_url)
+  end
+
+  it "uses VERIFY_NONE to enforce certificate validation" do
+    subject.accessor.validate_ssl_cert = false
+    subject.accessor.ca_file = 'some_ca_file'
+
+    Net::HTTP.any_instance.expects(:use_ssl=).with(true)
+    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))
+
+    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)
+
+    subject.stubs(:bad_response? => true)
+
+    subject.logger.expects(:error)
+
+    expect do
+      subject.soap_post(:url => some_https_url, :body => 'body')
+    end.to raise_error(GatewayError)
+  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
+
+    params = {:url => some_https_url}
+    headers = {}
+
+    subject.soap_post(params, headers)
+
+    headers["Content-Type"].should match "text/xml"
+  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 = {}
+
+    subject.post(params, headers)
+
+    headers["Content-Type"].should match "application/x-www-form-urlencoded"
+  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)
+  end
+
+  it "logs SocketError and raises GatewayError when service not found" do
+    subject.logger.expects(:error).with("#{subject.class.name} received error: SocketError")
+
+    Net::HTTP.any_instance.expects(:request).raises(SocketError)
+    Timeout.expects(:timeout).yields
+
+    expect do
+      subject.get(:url => some_https_url, :body => '')
+    end.to raise_error(GatewayError)
+  end
+
+  it "logs Errno::ECONNRESET and raises GatewayError when service connection reset" 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

@@ -1,6 +1,6 @@
 require_relative 'spec_helper'
 
-require 'resource_accessor/resource_accessor'
+require 'resource_accessor'
 
 describe ResourceAccessor do
 
@@ -10,5 +10,13 @@ describe ResourceAccessor do
     response.should_not be_nil
   end
 
+  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"
+  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"
+  end
+
 end
 

data/spec/spec_helper.rb

@@ -3,4 +3,13 @@ require 'rspec'
 # add lib directory
 $:.unshift File.dirname(__FILE__) + '/../lib'
 
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+
+  config.mock_with :mocha
+end
+
+
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resource_accessor
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Alexander Shvets
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-24 00:00:00.000000000 Z
+date: 2013-08-27 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_spec.rb
 - spec/resource_accessor_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/shvets/resource_accessor
@@ -83,11 +84,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: This library is used to simplify access to protected or unprotected http
   resource
 test_files:
+- spec/gateway_spec.rb
 - spec/resource_accessor_spec.rb
 - spec/spec_helper.rb