api-model 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b46c6c4b3e683a5e7c5a3577611b72fb7b398e8e
-  data.tar.gz: 89a47c86aecc1c2b66e1566511b2939335d2e385
+  metadata.gz: 11061671355750be204f15d713db7d0c7086dffb
+  data.tar.gz: adc621e2d2c3a14aa0fc0506f95be9b4ac56244c
 SHA512:
-  metadata.gz: dab983c5d688a24d9916f7a2a73073a3b63e59d8cae7296e3b4eb554081f031f03b375690768258507fb1d07c7ceacb7779cd3f3a50ca780b87866627eb2c804
-  data.tar.gz: fb188b0fed0aeb683e9c9c3e84fe979e79d0045c766e81b115c69bbf03c951ca396289955154e5de92ab17d8b4f31831a7a2ef2f280ae8b23b1226ed0309d6e8
+  metadata.gz: 6fe21b33dcb485f05b08c1da02c264a27e0e757e408aa72b39cbf178003a84b46d61d05585b6157e088c8fd614602bcf603f1fbe21d142aa340fde379101082b
+  data.tar.gz: 0a0e470c1ed7274175ea78e1cd00d3e5f529bedb9350e083a4df6403ddf32c6d25e095a9c062ddf96a7d74f5ce11d38ce5c27227dbb6145e2d4af0cb69ea1662

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-model (0.1.3)
+    api-model (1.0.0)
       activemodel
       activesupport
       hashie

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.3"
+  s.version     = "1.0.0"
   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,8 @@ require 'hashie'
 require 'typhoeus'
 require 'ostruct'
 
+require 'api_model/core_extensions/hash'
+
 require 'api_model/assignment'
 require 'api_model/initializer'
 require 'api_model/http_request'

data/lib/api_model/configuration.rb

@@ -3,7 +3,8 @@ 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_server_error
+                  :raise_on_not_found, :cache_strategy, :parser, :builder, :raise_on_server_error,
+                  :json_errors_root
 
     def self.from_inherited_config(config)
       new config.instance_values.reject {|k,v| v.blank? }
@@ -26,6 +27,10 @@ module ApiModel
       @cache_settings ||= {}
       @cache_settings.reverse_merge duration: 30.seconds, timeout: 2.seconds
     end
+
+    def json_errors_root
+      @json_errors_root ||= "errors"
+    end
   end
 
   module ConfigurationMethods

data/lib/api_model/core_extensions/hash.rb

@@ -0,0 +1,16 @@
+# When using ApiModel in a Rails application, Rails will try to ascertain what type of class
+# an instance of ApiModel::Base is when attempting to build a polymorphic route. Since ApiModel::Base
+# inherits from Hashie, which in turn inherits from Hash, Rails thinks that an instance of
+# ApiModel::Base is in fact a hash instead of acting like an ActiveModel, which then causes
+# it to fail to compute a route for the class.
+#
+# This is a hacky workaround, but should not interfere with any core functionality since it just
+# calls super if the class is not a subclass of ApiModel::Base.
+Hash.class_eval do
+
+  def self.===(klass)
+    return false if klass.class.ancestors.include? ApiModel::Base
+    super klass
+  end
+
+end

data/lib/api_model/http_request.rb

@@ -14,7 +14,7 @@ module ApiModel
 
     def run
       run_callbacks :run do
-        Log.debug "#{method.to_s.upcase} #{full_path} #{options}"
+        Log.debug "#{method.to_s.upcase} #{full_path} with headers: #{options[:headers]}"
         self.api_call = Typhoeus.send method, full_path, options
         Response.new self, config
       end

data/lib/api_model/instance_methods.rb

@@ -5,6 +5,9 @@ module ApiModel
     included do
       extend ActiveModel::Callbacks
       define_model_callbacks :save, :successful_save, :unsuccessful_save
+
+      property :persisted, default: false
+      alias_method :persisted?, :persisted
     end
 
     # Overrides Hashie::Trash to catch errors from trying to set properties which have not been defined
@@ -46,6 +49,7 @@ module ApiModel
     # but can be easily overriden by passing in ++:builder++ in the options hash.
     def save(path, body=nil, options={})
       request_method = options.delete(:request_method) || :put
+      errors_root = options.delete(:json_errors_root) || self.class.api_model_configuration.json_errors_root
 
       run_callbacks :save do
         response = self.class.call_api_with_json request_method, path, body, options.reverse_merge(builder: ApiModel::Builder::Hash.new)
@@ -57,7 +61,7 @@ module ApiModel
           end
         else
           run_callbacks :unsuccessful_save do
-            set_errors_from_hash response.response_body["errors"]
+            set_errors_from_hash response.fetch_from_body(errors_root)
           end
         end
 

data/lib/api_model/response.rb

@@ -22,7 +22,7 @@ module ApiModel
       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?
+      return self if response_body.nil?
 
       if response_build_hash.is_a? Array
         self.objects = response_build_hash.collect{ |hash| build http_response.builder, hash }
@@ -59,23 +59,32 @@ module ApiModel
       RUBY_EVAL
     end
 
+    # Pass though any method which is not defined to the built objects. This makes the response class
+    # quite transparent, and keeps the response acting like the built object, or array of objects.
     def method_missing(method_name, *args, &block)
       objects.send method_name, *args, &block
     end
 
+    # Uses a string notation split by colons to fetch nested keys from a hash. For example, if you have a hash
+    # which looks like:
+    #
+    #   { foo: { bar: { baz: "Hello world" } } }
+    #
+    # Then calling ++fetch_from_body("foo.bar.baz")++ would return "Hello world"
+    def fetch_from_body(key_reference)
+      key_reference.split(".").inject(response_body) do |hash,key|
+        hash.fetch(key)
+      end
+    end
+
     private
 
     # If the model config defines a json root, use it on the response_body
     # to dig down in to the hash.
-    #
-    # The root for a deeply nested hash will come in as a string with key names split
-    # with a colon.
     def response_build_hash
       if @_config.json_root.present?
         begin
-          @_config.json_root.split(".").inject(response_body) do |hash,key|
-            hash.fetch(key)
-          end
+          fetch_from_body @_config.json_root
         rescue
           raise ResponseBuilderError, "Could not find key #{@_config.json_root} in:\n#{response_body}"
         end

data/spec/api-model/api_model_spec.rb

@@ -183,6 +183,10 @@ describe ApiModel do
       BlogPost.api_config { |config| config.host = "http://api-model-specs.com" }
     end
 
+    after do
+      BlogPost.reset_api_configuration
+    end
+
     let(:blog_post) { BlogPost.new }
 
     # VCR will blow up if this was not a PUT, so no rspec expectations are needed here...
@@ -211,6 +215,22 @@ describe ApiModel do
       blog_post.errors[:name].should eq ["Cannot be blank"]
     end
 
+    it 'should be possible to change the error root when making the save call' do
+      expect {
+        VCR.use_cassette('posts') { blog_post.save "/post/with_nested_errors", {name: ""}, json_errors_root: "result.errors" }
+      }.to change{ blog_post.errors.size }.from(0).to(1)
+      blog_post.errors[:name].should eq ["Cannot be blank"]
+    end
+
+    it 'should respect the class default error root if one was not defined in the save call' do
+      BlogPost.api_config { |c| c.json_errors_root = "hello.errors" }
+
+      expect {
+        VCR.use_cassette('posts') { blog_post.save "/post/with_different_nested_errors", name: "" }
+      }.to change{ blog_post.errors.size }.from(0).to(1)
+      blog_post.errors[:name].should eq ["Cannot be blank"]
+    end
+
     describe "callbacks" do
       class BlogPost
         after_save :saved
@@ -239,6 +259,18 @@ describe ApiModel do
     end
   end
 
+  describe "persistance" do
+    it 'should not be persisted by default' do
+      BlogPost.new.persisted?.should be false
+    end
+
+    it 'should be posible to set an instance as persisted' do
+      blog_post = BlogPost.new
+      blog_post.persisted = true
+      blog_post.persisted?.should be_true
+    end
+  end
+
   describe "cache_id" do
     it 'should use options and the request path to create an identifier for the cache' do
       BlogPost.cache_id("/box", params: { foo: "bar" }).should eq "/boxfoobar"
@@ -259,4 +291,10 @@ describe ApiModel do
     end
   end
 
+  describe "class equality" do
+    it 'should not be equal to a Hash even though it is technically a Hash subclass' do
+      (Hash === BlogPost.new).should be_false
+    end
+  end
+
 end

data/spec/api-model/configuration_spec.rb

@@ -36,6 +36,17 @@ describe ApiModel, "Configuration" do
     end
   end
 
+  describe "json_errors_root" do
+    it 'should default to "errors"' do
+      Banana.api_model_configuration.json_errors_root.should eq "errors"
+    end
+
+    it 'should be possible to set on a class' do
+      Banana.api_config { |c| c.json_errors_root = "some.deep.errors" }
+      Banana.api_model_configuration.json_errors_root.should eq "some.deep.errors"
+    end
+  end
+
   describe "headers" do
     it 'should create default headers for content type and accepts' do
       headers = Banana.api_model_configuration.headers
@@ -56,10 +67,16 @@ describe ApiModel, "Configuration" do
       headers.should have_key "Content-Type"
     end
 
-    it 'should be possible to override default headers' do
+    it 'should be possible to override default headers through ApiModel::Base' do
       ApiModel::Base.api_config { |config| config.headers = { "Accept" => "image/gif" } }
       Banana.api_model_configuration.headers["Accept"].should eq "image/gif"
     end
+
+    it 'should be possible to override custom headers through subclasses of ApiModel::Base' do
+      ApiModel::Base.api_config { |config| config.headers = { "Accept" => "image/gif" } }
+      Banana.api_config { |config| config.headers = { "Accept" => "application/x-www-form-urlencoded" } }
+      Banana.api_model_configuration.headers["Accept"].should eq "application/x-www-form-urlencoded"
+    end
   end
 
   describe "cache_strategy" do

data/spec/support/fixtures/posts.yml

@@ -222,4 +222,62 @@ http_interactions:
     http_version:
   recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
 
+- request:
+    method: put
+    uri: http://api-model-specs.com/post/with_nested_errors
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+    body:
+      string: "{\"name\":\"\"}"
+  response:
+    status:
+      code: 400
+      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: "{\"result\":{\"errors\":{\"name\":\"Cannot be blank\"}}}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+- request:
+    method: put
+    uri: http://api-model-specs.com/post/with_different_nested_errors
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+    body:
+      string: "{\"name\":\"\"}"
+  response:
+    status:
+      code: 400
+      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: "{\"hello\":{\"errors\":{\"name\":\"Cannot be blank\"}}}"
+    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.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -144,6 +144,7 @@ files:
 - lib/api_model/cache_stategy/no_cache.rb
 - lib/api_model/class_methods.rb
 - lib/api_model/configuration.rb
+- lib/api_model/core_extensions/hash.rb
 - lib/api_model/http_request.rb
 - lib/api_model/initializer.rb
 - lib/api_model/instance_methods.rb