active_rest_client 0.9.75 → 1.0.0

data/lib/active_rest_client/caching.rb

@@ -46,7 +46,7 @@ module ActiveRestClient
       def read_cached_response(request)
         if cache_store && perform_caching
           key = "#{request.class_name}:#{request.original_url}"
-          ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{key} - Reading from cache"
+          ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{key} - Trying to read from cache"
           value = cache_store.read(key)
           value = Marshal.load(value) rescue value
         end

data/lib/active_rest_client/mapping.rb

@@ -17,6 +17,10 @@ module ActiveRestClient
         _map_call(name, url:url, method: :delete, options:options)
       end
 
+      def patch(name, url, options = {})
+        _map_call(name, url:url, method: :patch, options:options)
+      end
+
       def _map_call(name, details)
         _calls[name] = {name:name}.merge(details)
         _calls["lazy_#{name}".to_sym] = {name:name}.merge(details)

data/lib/active_rest_client/request.rb

@@ -114,6 +114,11 @@ module ActiveRestClient
           elsif cached.etag.to_s != "" #present? isn't working for some reason
             ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}"
             etag = cached.etag
+            response = do_request(etag)
+            if response.status == 304
+              ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response status 304. Copy is still fresh"
+              return handle_cached_response(cached)
+            end
           end
         end
         response = if proxy
@@ -224,11 +229,12 @@ module ActiveRestClient
 
       if verbose?
         ActiveRestClient::Logger.debug "ActiveRestClient Verbose Log:"
-        ActiveRestClient::Logger.debug "  > GET #{@url} HTTP/1.1"
+        ActiveRestClient::Logger.debug "  Request"
+        ActiveRestClient::Logger.debug "  >> GET #{@url} HTTP/1.1"
         http_headers.each do |k,v|
-          ActiveRestClient::Logger.debug "  > #{k} : #{v}"
+          ActiveRestClient::Logger.debug "  >> #{k} : #{v}"
         end
-        ActiveRestClient::Logger.debug "  > #{@body}"
+        ActiveRestClient::Logger.debug "  >> Body:\n#{@body}"
       end
 
       case http_method
@@ -245,10 +251,12 @@ module ActiveRestClient
       end
 
       if verbose?
+        ActiveRestClient::Logger.debug "  Response"
+        ActiveRestClient::Logger.debug "  << Status : #{response.status}"
         response.headers.each do |k,v|
-          ActiveRestClient::Logger.debug "  < #{k} : #{v}"
+          ActiveRestClient::Logger.debug "  << #{k} : #{v}"
         end
-        ActiveRestClient::Logger.debug "  < #{response.body}"
+        ActiveRestClient::Logger.debug "  << Body:\n#{response.body}"
       end
 
       response
@@ -268,62 +276,49 @@ module ActiveRestClient
     end
 
     def handle_response(response)
-      if response.status == 304
-        ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Etag copy is the same as the server"
-        return :not_modified
-      end
-      if response.respond_to?(:proxied) && response.proxied
-        ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"
-      else
-        ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response received #{response.body.size} bytes"
-      end
-
-      if @method[:options][:plain]
-        return @response = response.body
-      end
-
       @response = response
+      @response.status ||= 200
 
-      if response.body.is_a?(Array) || response.body.is_a?(Hash)
-        body = response.body
-      else
-        body = MultiJson.load(response.body) || {}
-      end
-      body = begin
-        @method[:name].nil? ? body : translator.send(@method[:name], body)
-      rescue NoMethodError
-        body
-      end
-      if body.is_a? Array
-        result = ActiveRestClient::ResultIterator.new(response.status)
-        body.each do |json_object|
-          result << new_object(json_object, @overriden_name)
+      if (200..399).include? @response.status
+        if response.status == 304
+          ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Etag copy is the same as the server"
+          return :not_modified
+        end
+        if @method[:options][:plain]
+          return @response = response.body
+        elsif is_json_response?
+          if @response.respond_to?(:proxied) && @response.proxied
+            ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"
+          else
+            ActiveRestClient::Logger.debug "  \033[1;4;32m#{ActiveRestClient::NAME}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
+          end
+          result = generate_new_object
+        else
+          raise ResponseParseException.new(status:@response.status, body:@response.body)
         end
       else
-        result = new_object(body, @overriden_name)
-        result._status = response.status
-        unless object_is_class?
-          @object._copy_from(result)
-          result = @object
+        if is_json_response?
+          error_response = generate_new_object(mutable: false)
+        else
+          error_response = @response.body
+        end
+        if @response.status == 400
+          raise HTTPBadRequestClientException.new(status:@response.status, result:error_response, url:@url)
+        elsif @response.status == 401
+          raise HTTPUnauthorisedClientException.new(status:@response.status, result:error_response, url:@url)
+        elsif @response.status == 403
+          raise HTTPForbiddenClientException.new(status:@response.status, result:error_response, url:@url)
+        elsif @response.status == 404
+          raise HTTPNotFoundClientException.new(status:@response.status, result:error_response, url:@url)
+        elsif (400..499).include? @response.status
+          raise HTTPClientException.new(status:@response.status, result:error_response, url:@url)
+        elsif (500..599).include? @response.status
+          raise HTTPServerException.new(status:@response.status, result:error_response, url:@url)
         end
       end
 
-      response.status ||= 200
-      if response.status == 401
-        raise HTTPUnauthorisedClientException.new(status:response.status, result:result, url:@url)
-      elsif response.status == 403
-        raise HTTPForbiddenClientException.new(status:response.status, result:result, url:@url)
-      elsif response.status == 404
-        raise HTTPNotFoundClientException.new(status:response.status, result:result, url:@url)
-      elsif (400..499).include? response.status
-        raise HTTPClientException.new(status:response.status, result:result, url:@url)
-      elsif (500..599).include? response.status
-        raise HTTPServerException.new(status:response.status, result:result, url:@url)
-      end
 
       result
-    rescue MultiJson::ParseError
-      raise ResponseParseException.new(status:response.status, body:response.body)
     end
 
     def new_object(attributes, name = nil)
@@ -418,6 +413,39 @@ module ActiveRestClient
 
       attributes
     end
+
+    private
+
+    def is_json_response?
+      @response.headers['Content-Type'].nil? || @response.headers['Content-Type'].include?('json')
+    end
+
+    def generate_new_object(options={})
+      if @response.body.is_a?(Array) || @response.body.is_a?(Hash)
+        body = @response.body
+      else
+        body = MultiJson.load(@response.body) || {}
+      end
+      body = begin
+        @method[:name].nil? ? body : translator.send(@method[:name], body)
+      rescue NoMethodError
+        body
+      end
+      if body.is_a? Array
+        result = ActiveRestClient::ResultIterator.new(@response.status)
+        body.each do |json_object|
+          result << new_object(json_object, @overriden_name)
+        end
+      else
+        result = new_object(body, @overriden_name)
+        result._status = @response.status
+        if !object_is_class? && options[:mutable] != false
+          @object._copy_from(result)
+          result = @object
+        end
+      end
+      result
+    end
   end
 
   class RequestException < StandardError ; end
@@ -441,6 +469,7 @@ module ActiveRestClient
   end
   class HTTPClientException < HTTPException ; end
   class HTTPUnauthorisedClientException < HTTPClientException ; end
+  class HTTPBadRequestClientException < HTTPClientException ; end
   class HTTPForbiddenClientException < HTTPClientException ; end
   class HTTPNotFoundClientException < HTTPClientException ; end
   class HTTPServerException < HTTPException ; end

data/lib/active_rest_client/version.rb

@@ -1,3 +1,3 @@
 module ActiveRestClient
-  VERSION = "0.9.75"
+  VERSION = "1.0.0"
 end

data/spec/lib/mapping_spec.rb

@@ -8,7 +8,8 @@ class MappingExample < MappingExampleBase
   get :test_get, "/get", tag:1, fake:"{result:true}", lazy:[:something]
   put :test_put, "/put", tag:2
   post :test_post, "/post", tag:3
-  delete :test_delete, "/delete", tag:4
+  patch :test_patch, "/patch", tag:4
+  delete :test_delete, "/delete", tag:5
 end
 
 describe ActiveRestClient::Mapping do
@@ -23,6 +24,7 @@ describe ActiveRestClient::Mapping do
     expect(MappingExample._calls[:test_get][:url]).to eq("/get")
     expect(MappingExample._calls[:test_put][:url]).to eq("/put")
     expect(MappingExample._calls[:test_post][:url]).to eq("/post")
+    expect(MappingExample._calls[:test_patch][:url]).to eq("/patch")
     expect(MappingExample._calls[:test_delete][:url]).to eq("/delete")
   end
 
@@ -30,6 +32,7 @@ describe ActiveRestClient::Mapping do
     expect(MappingExample._calls[:test_get][:method]).to eq(:get)
     expect(MappingExample._calls[:test_put][:method]).to eq(:put)
     expect(MappingExample._calls[:test_post][:method]).to eq(:post)
+    expect(MappingExample._calls[:test_patch][:method]).to eq(:patch)
     expect(MappingExample._calls[:test_delete][:method]).to eq(:delete)
   end
 
@@ -39,7 +42,8 @@ describe ActiveRestClient::Mapping do
     expect(MappingExample._calls[:test_get][:options][:tag]).to eq(1)
     expect(MappingExample._calls[:test_put][:options][:tag]).to eq(2)
     expect(MappingExample._calls[:test_post][:options][:tag]).to eq(3)
-    expect(MappingExample._calls[:test_delete][:options][:tag]).to eq(4)
+    expect(MappingExample._calls[:test_patch][:options][:tag]).to eq(4)
+    expect(MappingExample._calls[:test_delete][:options][:tag]).to eq(5)
   end
 
   it "should allow for mapped calls on the class" do

data/spec/lib/request_spec.rb

@@ -233,8 +233,8 @@ describe ActiveRestClient::Request do
     ActiveRestClient::ConnectionManager.should_receive(:get_connection).and_return(connection)
     connection.should_receive(:get).with("/all", an_instance_of(Hash)).and_return(OpenStruct.new(body:'{"result":true}', headers:{"Content-Type" => "application/json", "Connection" => "close"}))
     ActiveRestClient::Logger.should_receive(:debug).with("ActiveRestClient Verbose Log:")
-    ActiveRestClient::Logger.should_receive(:debug).with(/ > /).at_least(:twice)
-    ActiveRestClient::Logger.should_receive(:debug).with(/ < /).at_least(:twice)
+    ActiveRestClient::Logger.should_receive(:debug).with(/ >> /).at_least(:twice)
+    ActiveRestClient::Logger.should_receive(:debug).with(/ << /).at_least(:twice)
     ActiveRestClient::Logger.stub(:debug).with(any_args)
     VerboseExampleClient.all
   end
@@ -270,7 +270,7 @@ describe ActiveRestClient::Request do
     end
     expect(e).to be_instance_of(ActiveRestClient::HTTPForbiddenClientException)
     expect(e.status).to eq(403)
-  expect(e.result.first_name).to eq("John")
+    expect(e.result.first_name).to eq("John")
   end
 
   it "should raise a not found client exception for 404 errors" do
@@ -304,7 +304,7 @@ describe ActiveRestClient::Request do
     end
     expect(e).to be_instance_of(ActiveRestClient::HTTPClientException)
     expect(e.status).to eq(409)
-  expect(e.result.first_name).to eq("John")
+    expect(e.result.first_name).to eq("John")
   end
 
   it "should raise a server exception for 5xx errors" do
@@ -330,25 +330,79 @@ describe ActiveRestClient::Request do
       any_instance.
       should_receive(:post).
       with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
-      and_return(OpenStruct.new(body:error_content, headers:{}, status:500))
+      and_return(OpenStruct.new(body:error_content, headers:{'Content-Type' => 'text/html'}, status:500))
     object = ExampleClient.new(first_name:"John", should_disappear:true)
     begin
       object.create
-    rescue ActiveRestClient::ResponseParseException => e
+    rescue => e
       e
     end
-    expect(e).to be_instance_of(ActiveRestClient::ResponseParseException)
+    expect(e).to be_instance_of(ActiveRestClient::HTTPServerException)
     expect(e.status).to eq(500)
+    expect(e.result).to eq(error_content)
+  end
+
+  it "should raise a bad request exception for 400 response status" do
+    error_content = "<h1>400 Bad Request</h1>"
+    ActiveRestClient::Connection.
+      any_instance.
+      should_receive(:post).
+      with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
+      and_return(OpenStruct.new(body:error_content, headers:{'Content-Type' => 'text/html'}, status:400))
+    object = ExampleClient.new(first_name:"John", should_disappear:true)
+    begin
+      object.create
+    rescue => e
+      e
+    end
+    expect(e).to be_instance_of(ActiveRestClient::HTTPBadRequestClientException)
+    expect(e.status).to eq(400)
+    expect(e.result).to eq(error_content)
+  end
+
+  it "should raise response parse exception for 200 response status and non json content type" do
+    error_content = "<h1>malformed json</h1>"
+    ActiveRestClient::Connection.
+      any_instance.
+      should_receive(:post).
+      with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
+      and_return(OpenStruct.new(body:error_content, headers:{'Content-Type' => 'text/html'}, status:200))
+    object = ExampleClient.new(first_name:"John", should_disappear:true)
+    begin
+      object.create
+    rescue => e
+      e
+    end
+    expect(e).to be_instance_of(ActiveRestClient::ResponseParseException)
+    expect(e.status).to eq(200)
     expect(e.body).to eq(error_content)
   end
 
+  it "should not override the attributes of the existing object on error response status" do
+    ActiveRestClient::Connection.
+      any_instance.
+      should_receive(:post).
+      with("/create", "first_name=John&should_disappear=true", an_instance_of(Hash)).
+      and_return(OpenStruct.new(body:'{"errors": ["validation": "error in validation"]}', headers:{'Content-Type' => 'text/html'}, status:400))
+    object = ExampleClient.new(first_name:"John", should_disappear:true)
+    begin
+      object.create
+    rescue => e
+      e
+    end
+    expect(e).to be_instance_of(ActiveRestClient::HTTPBadRequestClientException)
+    expect(e.status).to eq(400)
+    expect(object.first_name).to eq 'John'
+    expect(object.errors).to be_nil
+  end
+
   it "should raise an exception if you try to pass in an unsupport method" do
     method = {:method => :wiggle, url:"/"}
     class RequestFakeObject
       def request_body_type
         :form_encoded
       end
-      
+
       def base_url
         "http://www.example.com/"
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_rest_client
 version: !ruby/object:Gem::Version
-  version: 0.9.75
+  version: 1.0.0
 platform: ruby
 authors:
 - Which Ltd
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-21 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -219,12 +219,15 @@ files:
 - ".rspec"
 - ".simplecov"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - active_rest_client.gemspec
+- doc/ActiveRestClient Internals.graffle
+- doc/ActiveRestClient Internals.png
 - lib/active_rest_client.rb
 - lib/active_rest_client/base.rb
 - lib/active_rest_client/caching.rb
@@ -282,7 +285,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This gem is for accessing REST services in an ActiveRecord style.  ActiveResource