restful_resource 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db211e69eaa5a728787f648586539ee4f2e7973f
-  data.tar.gz: 90b99d72f60ede0ab07d59e4ebbbd257d5c75b3b
+  metadata.gz: d294661eeac9255891b66e6dbebb6f1f5da44921
+  data.tar.gz: 5859ac65ef925dbd3c92b310ab377f8b3247258b
 SHA512:
-  metadata.gz: 16060fe0a969d7e693ab6bc1117b601c61be1692a05cf96a2f9895d606a08d6137a334f630367f5ca215c53deaa1bade441aab17a7a65d5fb7301af2beb23a9d
-  data.tar.gz: 6be2ba5e9eae8c91f38b1adaa97ce291196f0fc5b0d4375653896e2ac842ffd523401647aafdfca9e4cfee0016bd9d9230e542143415059e83c98c21cab8cbe4
+  metadata.gz: 49e2eb64d13010ced65c8a1d0b7b18d61047cfb7afd9d9afaced84453975a8b8317161cd5ea038413750e777ef7bc93acd916e82b6ed088507f0bb03695c23aa
+  data.tar.gz: 590deacd3e072ec8bb49cbe2e5e5d479d7442e7ad45cc9ba6e108af080434a7ec2dd716badf6d1dc0c3019fcd77540eea4298ac593e3db5d0c3b140d28e6eb09

data/Rakefile

@@ -9,12 +9,12 @@ desc "Upload to rubygems"
 task :upload => :build do
   # Check if tag with v#{ResearchSiteApiClient::VERSION} version exists, if so, return with error
 
-  if tag_exists?(current_tag_name)
-    puts "Tag exists, did you run rake increase_revision_number after merging with master?"
-    exit 1
-  end
+  # if tag_exists?(current_tag_name)
+  #   puts "Tag exists, did you run rake increase_revision_number after merging with master?"
+  #   exit 1
+  # end
 
-  create_tag(current_tag_name)
+  # create_tag(current_tag_name)
   Rake::Task[:release].invoke
 end
 

data/lib/restful_resource/http_client.rb

@@ -3,9 +3,16 @@ module RestfulResource
     class HttpError < StandardError
       attr_reader :request, :response
 
-      def initialize(request, response)
-        @response = Response.new(body: response[:body], headers: response[:headers], status: response[:status])
-        @request = request
+      def initialize(request, response = nil)
+        @request, @response = request, assign_response(response)
+      end
+
+      def assign_response(response = nil)
+        if response
+          @response = Response.new body: response[:body], headers: response[:headers], status: response[:status]
+        else
+          @response = Response.new
+        end
       end
     end
 
@@ -31,21 +38,40 @@ module RestfulResource
     end
 
     class ClientError < HttpError
-      def initalize(request)
-        super(request, {})
-      end
-
       def message
         "There was some client error"
       end
     end
 
-    def initialize(username: nil, password: nil, logger: nil, cache_store: nil)
-      @client = Faraday.new do |b|
-        if username.present? && password.present?
-          b.basic_auth username, password
-        end
+    def initialize(username: nil, password: nil, logger: nil, cache_store: nil, connection: nil)
+      # Use a provided faraday client or initalize a new one
+      @connection = connection || initialize_connection(logger: logger, cache_store: cache_store)
+
+      if username && password
+        @connection.basic_auth username, password
+      end
+    end
+
+    def get(url, accept: 'application/json')
+      http_request(Request.new(:get, url, accept: accept))
+    end
+
+    def delete(url, accept: 'application/json')
+      http_request(Request.new(:delete, url, accept: accept))
+    end
+
+    def put(url, data: {}, accept: 'application/json')
+      http_request(Request.new(:put, url, body: data, accept: accept))
+    end
+
+    def post(url, data: {}, accept: 'application/json')
+      http_request(Request.new(:post, url, body: data, accept: accept))
+    end
 
+    private
+
+    def initialize_connection(logger: nil, cache_store: nil)
+      @connection = Faraday.new do |b|
         b.request :url_encoded
         b.response :raise_error
 
@@ -69,25 +95,8 @@ module RestfulResource
       end
     end
 
-    def get(url, accept: 'application/json')
-      http_request(Request.new(:get, url, accept: accept))
-    end
-
-    def delete(url, accept: 'application/json')
-      http_request(Request.new(:delete, url, accept: accept))
-    end
-
-    def put(url, data: {}, accept: 'application/json')
-      http_request(Request.new(:put, url, body: data, accept: accept))
-    end
-
-    def post(url, data: {}, accept: 'application/json')
-      http_request(Request.new(:post, url, body: data, accept: accept))
-    end
-
-    private
     def http_request(request)
-      response = @client.send(request.method) do |req|
+      response = @connection.send(request.method) do |req|
         req.body = request.body unless request.body.nil?
         req.url request.url
 

data/lib/restful_resource/version.rb

@@ -1,3 +1,3 @@
 module RestfulResource
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

data/spec/restful_resource/http_client_configuration_spec.rb

@@ -0,0 +1,93 @@
+require_relative '../spec_helper'
+
+describe RestfulResource::HttpClient do
+  def find_middleware(adapter, name)
+    adapter.builder.handlers.find {|m| m.name == name }
+
+    rescue
+      raise "Could not find Faraday middleware: #{name}"
+  end
+
+  def find_middleware_args(adapter, name)
+    find_middleware(adapter, name).instance_variable_get("@args").first
+
+    rescue
+      raise "Could not find args for Faraday middleware: #{name}"
+  end
+
+  describe 'Configuration' do
+    let(:connection) { described_class.new.instance_variable_get("@connection") }
+    let(:middleware) { connection.builder.handlers }
+
+    describe 'Builder configuration' do
+      it 'uses the excon adapter' do
+        expect(middleware).to include Faraday::Adapter::Excon
+      end
+
+      it 'url_encodes requests' do
+        expect(middleware).to include Faraday::Request::UrlEncoded
+      end
+
+      it 'raises on any error responses' do
+        expect(middleware).to include Faraday::Response::RaiseError
+      end
+
+      it 'uses utf-8 encoding' do
+        expect(middleware).to include Faraday::Encoding
+      end
+
+      it 'compresses requests' do
+        expect(middleware).to include FaradayMiddleware::Gzip
+      end
+
+      describe 'when provided a logger' do
+        let(:connection) { described_class.new(logger: logger).instance_variable_get("@connection") }
+        let(:logger) { Logger.new('/dev/null') }
+
+        it 'uses the logger middleware' do
+          expect(middleware).to include Faraday::Response::Logger
+        end
+
+        it 'uses that logger' do
+          expect(find_middleware_args(connection, 'Faraday::Response::Logger')).to eq logger
+        end
+      end
+
+      describe 'when provided a cache store' do
+        let(:connection) { described_class.new(cache_store: 'redis').instance_variable_get("@connection") }
+
+        it 'uses the cache_store middleware' do
+          expect(middleware).to include Faraday::HttpCache
+        end
+
+        it 'uses that cache_store' do
+          expect(find_middleware_args(connection, 'Faraday::HttpCache')).to include(store: 'redis')
+        end
+      end
+    end
+
+    describe 'Excon Adapter configuration' do
+      let(:config) { find_middleware_args connection, 'Faraday::Adapter::Excon' }
+    
+      it 'uses nonblock' do
+        expect(config[:nonblock]).to eq true
+      end
+
+      it 'uses a persistent connection' do
+        expect(config[:persistent]).to eq true
+      end
+
+      it 'has a connect_timeout of 2' do
+        expect(config[:connect_timeout]).to eq 2
+      end
+
+      it 'has a read_timeout of 10' do
+        expect(config[:read_timeout]).to eq 10
+      end
+
+      it 'has a write_timeout of 2' do
+        expect(config[:write_timeout]).to eq 2
+      end
+    end
+  end
+end

data/spec/restful_resource/http_client_spec.rb

@@ -1,67 +1,145 @@
 require_relative '../spec_helper'
 
 describe RestfulResource::HttpClient do
-  describe 'Basic HTTP' do
-    before :each do
-      @http_client = RestfulResource::HttpClient.new
+  def faraday_connection
+    Faraday.new do |builder|
+      builder.request :url_encoded
+      builder.response :raise_error
+      builder.adapter :test do |stubs|
+        yield stubs if block_given?
+      end
     end
+  end
+
+  def http_client(connection)
+    described_class.new(connection: connection)
+  end
 
+  describe 'Basic HTTP' do
     it 'should execute get' do
-      response = @http_client.get('http://httpbin.org/get')
+      connection = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/get') { |env| [200, {}, nil] }
+      end
+
+      response = http_client(connection).get('http://httpbin.org/get')
       expect(response.status).to eq 200
     end
 
     it 'should execute put' do
-      response = @http_client.put('http://httpbin.org/put', data: { name: 'Alfred' })
+      connection = faraday_connection do |stubs|
+        # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
+        stubs.put('http://httpbin.org/put', 'name=Alfred') { |env| [200, {}, nil] }
+      end
+
+      response = http_client(connection).put('http://httpbin.org/put', data: { name: 'Alfred' })
       expect(response.status).to eq 200
     end
 
     it 'should execute post' do
-      response = @http_client.post('http://httpbin.org/post', data: { name: 'Alfred' })
+      connection = faraday_connection do |stubs|
+        # Note: request body is serialized as url-encoded so the stub body must be in the same format to match
+        stubs.post('http://httpbin.org/post', 'name=Alfred') { |env| [200, {}, %{"name": "Alfred"}] }
+      end
+
+      response = http_client(connection).post('http://httpbin.org/post', data: { name: 'Alfred' })
+
       expect(response.body).to include "name\": \"Alfred"
       expect(response.status).to eq 200
     end
 
     it 'should execute delete' do
-      response = @http_client.delete('http://httpbin.org/delete')
+      connection = faraday_connection do |stubs|
+        stubs.delete('http://httpbin.org/delete') { |env| [200, {}, nil] }
+      end
+
+      response = http_client(connection).delete('http://httpbin.org/delete')
+
       expect(response.status).to eq 200
     end
 
     it 'put should raise error 422' do
-      expect { @http_client.put('http://httpbin.org/status/422', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
+      connection = faraday_connection do |stubs|
+        stubs.put('http://httpbin.org/status/422') { |env| [422, {}, nil] }
+      end
+
+      expect { http_client(connection).put('http://httpbin.org/status/422') }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
     end
 
     it 'post should raise error 422' do
-      expect { @http_client.post('http://httpbin.org/status/422', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
+      connection = faraday_connection do |stubs|
+        stubs.post('http://httpbin.org/status/422') { |env| [422, {}, nil] }
+      end
+
+      expect { http_client(connection).post('http://httpbin.org/status/422') }.to raise_error(RestfulResource::HttpClient::UnprocessableEntity)
     end
 
     it 'put should raise error 503' do
-      expect { @http_client.put('http://httpbin.org/status/503', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
+      connection = faraday_connection do |stubs|
+        stubs.put('http://httpbin.org/status/503') { |env| [503, {}, nil] }
+      end
+
+      expect { http_client(connection).put('http://httpbin.org/status/503') }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
     end
 
     it 'post should raise error 503' do
-      expect { @http_client.post('http://httpbin.org/status/503', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
+      connection = faraday_connection do |stubs|
+        stubs.post('http://httpbin.org/status/503') { |env| [503, {}, nil] }
+      end
+
+      expect { http_client(connection).post('http://httpbin.org/status/503') }.to raise_error(RestfulResource::HttpClient::ServiceUnavailable)
     end
 
     it 'should raise error on 404' do
-      expect { @http_client.get('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { @http_client.delete('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { @http_client.put('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
-      expect { @http_client.post('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      connection = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/status/404') { |env| [404, {}, nil] }
+        stubs.post('http://httpbin.org/status/404') { |env| [404, {}, nil] }
+        stubs.put('http://httpbin.org/status/404') { |env| [404, {}, nil] }
+        stubs.delete('http://httpbin.org/status/404') { |env| [404, {}, nil] }
+      end
+
+      expect { http_client(connection).get('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      expect { http_client(connection).delete('http://httpbin.org/status/404') }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      expect { http_client(connection).put('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+      expect { http_client(connection).post('http://httpbin.org/status/404', data: { name: 'Mad cow' }) }.to raise_error(RestfulResource::HttpClient::ResourceNotFound)
+    end
+
+    it 'should raise Faraday::ConnectionFailed errors' do
+      connection = faraday_connection do |stubs|
+        stubs.get('https://localhost:3005') {|env| raise Faraday::ConnectionFailed.new(nil) }
+      end
+
+      expect { http_client(connection).get('https://localhost:3005') }.to raise_error(Faraday::ConnectionFailed)
     end
 
-    it 'should raise normal exception' do
-      expect { @http_client.get('https://localhost:3005') }.to raise_error(Faraday::ConnectionFailed)
+    it 'raises ClientError when a client errors with no response' do
+      connection = faraday_connection do |stubs|
+        stubs.get('https://localhost:3005') {|env| raise Faraday::ClientError.new(nil) }
+      end
+
+      expect { http_client(connection).get('https://localhost:3005') }.to raise_error(RestfulResource::HttpClient::ClientError)
+    end
+
+    it 'raises OtherHttpError for other status response codes' do
+      connection = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/status/418') { |env| [418, {}, nil] }
+      end
+
+      expect { http_client(connection).get('http://httpbin.org/status/418') }.to raise_error(RestfulResource::HttpClient::OtherHttpError)
     end
   end
 
   describe 'Authentication' do
-    before :each do
-      @http_client = RestfulResource::HttpClient.new(username: 'user', password: 'passwd')
+    def http_client(connection)
+      described_class.new(connection: connection, username: 'user', password: 'passwd')
     end
 
     it 'should execute authenticated get' do
-      response = @http_client.get('http://httpbin.org/basic-auth/user/passwd')
+      connection = faraday_connection do |stubs|
+        stubs.get('http://httpbin.org/basic-auth/user/passwd', { "Authorization"=>"Basic dXNlcjpwYXNzd2Q=" }) { |env| [200, {}, nil] }
+      end
+
+      response = http_client(connection).get('http://httpbin.org/basic-auth/user/passwd')
+
       expect(response.status).to eq 200
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_resource
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - David Santoro
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-18 00:00:00.000000000 Z
+date: 2016-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -199,6 +199,7 @@ files:
 - spec/restful_resource/associations_spec.rb
 - spec/restful_resource/base_authorization_spec.rb
 - spec/restful_resource/base_spec.rb
+- spec/restful_resource/http_client_configuration_spec.rb
 - spec/restful_resource/http_client_spec.rb
 - spec/restful_resource/open_object_spec.rb
 - spec/restful_resource/rails_validations_spec.rb
@@ -234,6 +235,7 @@ test_files:
 - spec/restful_resource/associations_spec.rb
 - spec/restful_resource/base_authorization_spec.rb
 - spec/restful_resource/base_spec.rb
+- spec/restful_resource/http_client_configuration_spec.rb
 - spec/restful_resource/http_client_spec.rb
 - spec/restful_resource/open_object_spec.rb
 - spec/restful_resource/rails_validations_spec.rb