api-model 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 820bf511fd4b03fc1a8d9523717d6f5a880f4ed5
-  data.tar.gz: c412f230bde85508e50b9ccb4615b79522b8d70e
+  metadata.gz: b46c6c4b3e683a5e7c5a3577611b72fb7b398e8e
+  data.tar.gz: 89a47c86aecc1c2b66e1566511b2939335d2e385
 SHA512:
-  metadata.gz: 4300025629a98a9c70f6c8f81cb9b0311f5a439256bdf0a5a68d3ba0595fc67049af6e7fb17add9452b5cbb875feb221b755aa690764186ce28f00c8c79d46a9
-  data.tar.gz: fbf370237c20cbc647435cf72feb51d5732cc9bf4f78aaa67dfebf247d7798bba4cd72c56e527ab994e1c73e5862d9ea9e99f6fbb570220bee1753935f915cf0
+  metadata.gz: dab983c5d688a24d9916f7a2a73073a3b63e59d8cae7296e3b4eb554081f031f03b375690768258507fb1d07c7ceacb7779cd3f3a50ca780b87866627eb2c804
+  data.tar.gz: fb188b0fed0aeb683e9c9c3e84fe979e79d0045c766e81b115c69bbf03c951ca396289955154e5de92ab17d8b4f31831a7a2ef2f280ae8b23b1226ed0309d6e8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-model (0.1.2)
+    api-model (0.1.3)
       activemodel
       activesupport
       hashie
@@ -35,7 +35,7 @@ GEM
     method_source (0.8.2)
     mime-types (1.25.1)
     minitest (4.7.5)
-    multi_json (1.8.2)
+    multi_json (1.8.4)
     pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)

data/README.md

@@ -143,7 +143,7 @@ configuration options may not be available on the per-api call technique).
 
 ```ruby
   ApiModel::Base.api_config do |config|
-    config.api_host = "http:://someserver.com"
+    config.host = "http:://someserver.com"
   end
 ```
 
@@ -189,17 +189,19 @@ an API which returns something other than JSON, you can set custom parsers to de
 before they are sent to builder classes. The parser should work in the same way as a custom builder, except it needs
 to respond to `#parse`, with the raw response body as an argument.
 
-### Raise on not found or unauthenticated
+### Raising exceptions
 
 ```ruby
   ApiModel::Base.api_config do |config|
     config.raise_on_not_found = true
     config.raise_on_unauthenticated = true
+    config.raise_on_server_error = true
   end
 ```
 
-This will cause any API requests which return a 404 status to raise an ApiModel::NotFoundError exception, and requests
-which return a 401 to raise an ApiModel::UnauthenticatedError exception. Both default to `false`.
+This will cause any API requests which return a 404 status to raise an ApiModel::NotFoundError exception,
+requests which return 500 to raise an ApiModel::ServerError exception, and requests which return a 401
+to raise an ApiModel::UnauthenticatedError exception. All default to `false`.
 
 ### Cache strategy & settings
 

data/api-model.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "api-model"
-  s.version     = "0.1.2"
+  s.version     = "0.1.3"
   s.authors     = ["Damien Timewell"]
   s.email       = ["mail@damientimewell.com"]
   s.homepage    = "https://github.com/iZettle/api-model"

data/lib/api-model.rb

@@ -6,6 +6,7 @@ require 'hashie'
 require 'typhoeus'
 require 'ostruct'
 
+require 'api_model/assignment'
 require 'api_model/initializer'
 require 'api_model/http_request'
 require 'api_model/response'
@@ -22,6 +23,7 @@ module ApiModel
   class ResponseBuilderError < StandardError; end
   class UnauthenticatedError < StandardError; end
   class NotFoundError < StandardError; end
+  class ServerError < StandardError; end
 
   if defined?(Rails)
     class Railtie < Rails::Railtie
@@ -40,6 +42,7 @@ module ApiModel
     extend ActiveModel::Callbacks
 
     extend ClassMethods
+    include Assignment
     include ConfigurationMethods
     include InstanceMethods
   end

data/lib/api_model/assignment.rb

@@ -0,0 +1,20 @@
+module ApiModel
+  module Assignment
+
+    # Convenience method to change attributes on an instance en-masse using a hash. This is
+    # useful for when an api response includes changed attributes and you want to update the current
+    # instance with the changes.
+    def update_attributes(values={})
+      return unless values.present?
+
+      values.each do |key,value|
+        begin
+          public_send "#{key}=", value
+        rescue
+          Log.debug "Could not set #{key} on #{self.class.name}"
+        end
+      end
+    end
+
+  end
+end

data/lib/api_model/configuration.rb

@@ -3,7 +3,7 @@ module ApiModel
     include Initializer
 
     attr_accessor :host, :json_root, :headers, :raise_on_unauthenticated, :cache_settings,
-                  :raise_on_not_found, :cache_strategy, :parser, :builder
+                  :raise_on_not_found, :cache_strategy, :parser, :builder, :raise_on_server_error
 
     def self.from_inherited_config(config)
       new config.instance_values.reject {|k,v| v.blank? }

data/lib/api_model/http_request.rb

@@ -1,6 +1,6 @@
 module ApiModel
   class HttpRequest
-    include ApiModel::Initializer
+    include Initializer
 
     attr_accessor :path, :method, :options, :api_call, :builder, :config, :cache_id
 
@@ -14,6 +14,7 @@ module ApiModel
 
     def run
       run_callbacks :run do
+        Log.debug "#{method.to_s.upcase} #{full_path} #{options}"
         self.api_call = Typhoeus.send method, full_path, options
         Response.new self, config
       end

data/lib/api_model/initializer.rb

@@ -1,5 +1,6 @@
 module ApiModel
   module Initializer
+    include ApiModel::Assignment
     extend ActiveSupport::Concern
 
     included do
@@ -13,17 +14,5 @@ module ApiModel
       end
     end
 
-    def update_attributes(values={})
-      return unless values.present?
-
-      values.each do |key,value|
-        begin
-          public_send "#{key}=", value
-        rescue
-          Log.debug "Could not set #{key} on #{self.class.name}"
-        end
-      end
-    end
-
   end
 end

data/lib/api_model/instance_methods.rb

@@ -30,21 +30,6 @@ module ApiModel
       end
     end
 
-    # Convenience method to change attributes on an instance en-masse using a hash. This is
-    # useful for when an api response includes changed attributes and you want to update the current
-    # instance with the changes.
-    def update_attributes_from_hash(values={})
-      return unless values.present?
-
-      values.each do |key,value|
-        begin
-          public_send "#{key}=", value
-        rescue
-          Log.debug "Could not set #{key} on #{self.class.name}"
-        end
-      end
-    end
-
     # Sends a request to the api to update a resource. If the response was successful, then it will
     # update the instance with any changes which the API has returned. If not, it will set ActiveModel
     # errors.
@@ -68,7 +53,7 @@ module ApiModel
 
         if response_success
           run_callbacks :successful_save do
-            update_attributes_from_hash response.response_body
+            update_attributes response.response_body
           end
         else
           run_callbacks :unsuccessful_save do

data/lib/api_model/response.rb

@@ -21,6 +21,7 @@ module ApiModel
     def build_objects
       raise UnauthenticatedError if @_config.raise_on_unauthenticated && http_response.api_call.response_code == 401
       raise NotFoundError if @_config.raise_on_not_found && http_response.api_call.response_code == 404
+      raise ServerError if @_config.raise_on_server_error && http_response.api_call.response_code == 500
       return if response_body.nil?
 
       if response_build_hash.is_a? Array
@@ -44,6 +45,10 @@ module ApiModel
       @response_body ||= @_config.parser.parse http_response.api_call.body
     end
 
+    def successful?
+      http_response.api_call.success?
+    end
+
     # Define common methods which should never be called on this abstract class, and should always be
     # passed down to the #objects
     FALL_THROUGH_METHODS.each do |transparent_method|

data/spec/api-model/api_model_spec.rb

@@ -121,9 +121,7 @@ describe ApiModel do
     end
 
     describe "with a single object which has properties which are undefined" do
-      let :new_car do
-        VCR.use_cassette('cars') { Car.get_json "http://cars.com/new_model" }
-      end
+      let(:new_car) { VCR.use_cassette('cars') { Car.get_json "http://cars.com/new_model" } }
 
       it "should not raise an exception" do
         expect {
@@ -164,19 +162,19 @@ describe ApiModel do
     it 'should change an existing attribute' do
       car.name = "Chevvy"
       expect {
-        car.update_attributes_from_hash name: "Ford"
+        car.update_attributes name: "Ford"
       }.to change{ car.name }.from("Chevvy").to("Ford")
     end
 
     it 'should set an attribute if unset' do
       expect {
-        car.update_attributes_from_hash number_of_doors: 2
+        car.update_attributes number_of_doors: 2
       }.to change{ car.number_of_doors }.from(nil).to(2)
     end
 
     it 'should log if the attribute is not defined' do
       ApiModel::Log.should_receive(:debug).with "Could not set age on Car"
-      car.update_attributes_from_hash age: 2
+      car.update_attributes age: 2
     end
   end
 
@@ -201,8 +199,8 @@ describe ApiModel do
       VCR.use_cassette('posts') { blog_post.save "/post/2", name: "foobarbaz" }
     end
 
-    it 'should use #update_attributes_from_hash using the response body to update the instance' do
-      blog_post.should_receive(:update_attributes_from_hash).with "name" => "foobarbaz"
+    it 'should use #update_attributes using the response body to update the instance' do
+      blog_post.should_receive(:update_attributes).with "name" => "foobarbaz"
       VCR.use_cassette('posts') { blog_post.save "/post/2", name: "foobarbaz" }
     end
 
@@ -247,4 +245,18 @@ describe ApiModel do
     end
   end
 
+  describe "successful?" do
+    let(:new_car) { VCR.use_cassette('cars') { Car.get_json "http://cars.com/new_model" } }
+
+    it 'should be true if the api call was successful' do
+      new_car.stub_chain(:http_response, :api_call, :success?).and_return true
+      new_car.successful?.should be_true
+    end
+
+    it 'should be false if the api call was not successful' do
+      new_car.stub_chain(:http_response, :api_call, :success?).and_return false
+      new_car.successful?.should be_false
+    end
+  end
+
 end

data/spec/api-model/response_spec.rb

@@ -169,6 +169,28 @@ describe ApiModel::Response do
         }.to_not raise_error
       end
     end
+
+    describe "for requests which return a 500" do
+      let :api_request do
+        VCR.use_cassette('errors') do
+          BlogPost.get_json "http://api-model-specs.com/server_error"
+        end
+      end
+
+      it 'should raise an ApiModel::ServerError if raise_on_server_error is true' do
+        BlogPost.api_config { |c| c.raise_on_server_error = true }
+        expect {
+          api_request
+        }.to raise_error(ApiModel::ServerError)
+      end
+
+      it 'should not raise an ApiModel::ServerError if raise_on_server_error is false' do
+        BlogPost.api_config { |c| c.raise_on_server_error = false }
+        expect {
+          api_request
+        }.to_not raise_error
+      end
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -10,6 +10,10 @@ VCR.configure do |c|
   c.hook_into :webmock # or :fakeweb
 end
 
+# Disable STDOUT logging during tests
+ApiModel.send :remove_const, :Log
+ApiModel::Log = Logger.new('/dev/null')
+
 RSpec.configure do |config|
 
   # Reset any config changes after each spec

data/spec/support/fixtures/errors.yml

@@ -54,4 +54,31 @@ http_interactions:
     http_version:
   recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
 
+- request:
+    method: get
+    uri: http://api-model-specs.com/server_error
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 500
+      message: OK
+    headers:
+      Server:
+      - nginx/1.4.1
+      Date:
+      - Thu, 28 Nov 2013 16:02:56 GMT
+      Content-Type:
+      - text/plain; charset=utf-8
+      Content-Length:
+      - '248'
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: "Oh no, something went wrong"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
 recorded_with: VCR 2.8.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api-model
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,6 +139,7 @@ files:
 - README.md
 - api-model.gemspec
 - lib/api-model.rb
+- lib/api_model/assignment.rb
 - lib/api_model/builder/hash.rb
 - lib/api_model/cache_stategy/no_cache.rb
 - lib/api_model/class_methods.rb