api-model 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af939e7e3edf3d3f1e9236a531ec288140df7e84
-  data.tar.gz: e01192448c015b9a0a02c8e9b801741db322e078
+  metadata.gz: 820bf511fd4b03fc1a8d9523717d6f5a880f4ed5
+  data.tar.gz: c412f230bde85508e50b9ccb4615b79522b8d70e
 SHA512:
-  metadata.gz: 53e12bde27910eb5115106868b1cfc6b9897c47d7c8e0a53c42b493cb6c3eca3c5be403fe30b051aa2b3cf5ac190c0c207fe7ec6509d689f978e547cd6ada548
-  data.tar.gz: 8ed44b655edc400dfc2f263ba5bae51f3ab874b61725b18b92709863fccfb698d2b0695a3f169f1ea17a73d65ecfdd632406666e97efc4603c39e0447b0e5b57
+  metadata.gz: 4300025629a98a9c70f6c8f81cb9b0311f5a439256bdf0a5a68d3ba0595fc67049af6e7fb17add9452b5cbb875feb221b755aa690764186ce28f00c8c79d46a9
+  data.tar.gz: fbf370237c20cbc647435cf72feb51d5732cc9bf4f78aaa67dfebf247d7798bba4cd72c56e527ab994e1c73e5862d9ea9e99f6fbb570220bee1753935f915cf0

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format documentation
+--format progress

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api-model (0.1.1)
+    api-model (0.1.2)
       activemodel
       activesupport
       hashie
@@ -52,8 +52,8 @@ GEM
     slop (3.4.6)
     thread_safe (0.1.3)
       atomic
-    typhoeus (0.6.5)
-      ethon (~> 0.6.1)
+    typhoeus (0.6.7)
+      ethon (~> 0.6.2)
     tzinfo (0.3.38)
     vcr (2.8.0)
     webmock (1.15.0)

data/README.md

@@ -253,3 +253,24 @@ These can of course be overridden by just re-defining them in the headers config
     config.headers = { "Content-Type" => "application/soap+xml" }
   end
 ```
+
+### Logging requests
+
+You can hook onto a callback on the `ApiModel::HttpRequest` class in order to perform tasks before, after or around an
+API request. This is useful for logging requests. For example, if you wanted to add a custom NewRelic tracer, you could
+add the following callback to make external API calls show up nicely in NewRelic:
+
+```ruby
+require 'new_relic/agent/method_tracer'
+
+ApiModel::HttpRequest.class_eval do
+  include NewRelic::Agent::MethodTracer
+  around_run :trace_with_newrelic
+
+  def trace_with_newrelic
+    trace_execution_scoped(["API/#{self.method}/#{self.path}"]) do
+      yield
+    end
+  end
+end
+```

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.1"
+  s.version     = "0.1.2"
   s.authors     = ["Damien Timewell"]
   s.email       = ["mail@damientimewell.com"]
   s.homepage    = "https://github.com/iZettle/api-model"

data/lib/api-model.rb

@@ -12,8 +12,9 @@ require 'api_model/response'
 require 'api_model/class_methods'
 require 'api_model/instance_methods'
 require 'api_model/configuration'
-require 'api_model/cache_stategies/no_cache'
+require 'api_model/cache_stategy/no_cache'
 require 'api_model/response_parser/json'
+require 'api_model/builder/hash'
 
 module ApiModel
   Log = Logger.new STDOUT

data/lib/api_model/builder/hash.rb

@@ -0,0 +1,11 @@
+module ApiModel
+  module Builder
+    class Hash
+
+      def build(response)
+        response if response.is_a?(Hash)
+      end
+
+    end
+  end
+end

data/lib/api_model/{cache_stategies → cache_stategy}/no_cache.rb

@@ -1,5 +1,5 @@
 module ApiModel
-  module CacheStrategies
+  module CacheStrategy
     class NoCache
 
       def initialize(*args)

data/lib/api_model/class_methods.rb

@@ -6,8 +6,16 @@ module ApiModel
     end
 
     def post_json(path, body=nil, options={})
+      call_api_with_json :post, path, body, options
+    end
+
+    def put_json(path, body=nil, options={})
+      call_api_with_json :put, path, body, options
+    end
+
+    def call_api_with_json(method, path, body=nil, options={})
       body = body.to_json if body.is_a?(Hash)
-      call_api :post, path, options.merge(body: body)
+      call_api method, path, options.merge(body: body)
     end
 
     def call_api(method, path, options={})

data/lib/api_model/configuration.rb

@@ -15,7 +15,7 @@ module ApiModel
     end
 
     def cache_strategy
-      @cache_strategy ||= ApiModel::CacheStrategies::NoCache
+      @cache_strategy ||= ApiModel::CacheStrategy::NoCache
     end
 
     def parser

data/lib/api_model/instance_methods.rb

@@ -1,5 +1,11 @@
 module ApiModel
   module InstanceMethods
+    extend ActiveSupport::Concern
+
+    included do
+      extend ActiveModel::Callbacks
+      define_model_callbacks :save, :successful_save, :unsuccessful_save
+    end
 
     # Overrides Hashie::Trash to catch errors from trying to set properties which have not been defined
     # and defines it automatically
@@ -24,5 +30,55 @@ 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.
+    #
+    # The default request type is PUT, but you can override this by setting ++:request_method++ in the
+    # options hash.
+    #
+    # It also includes 3 callbacks which you can hook onto; ++save++, which is the entire method, whether
+    # the API request was successful or not, and ++successful_save++ and ++unsuccessful_save++ which are
+    # triggered on successful or unsuccessful responses.
+    #
+    # By default it uses the ++ApiModel::Builder::Hash++ builder rather than using the normal method of
+    # using the class, or api config builders. This is to avoid building new objects from the response,
+    # 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
+
+      run_callbacks :save do
+        response = self.class.call_api_with_json request_method, path, body, options.reverse_merge(builder: ApiModel::Builder::Hash.new)
+        response_success = response.http_response.api_call.success?
+
+        if response_success
+          run_callbacks :successful_save do
+            update_attributes_from_hash response.response_body
+          end
+        else
+          run_callbacks :unsuccessful_save do
+            set_errors_from_hash response.response_body["errors"]
+          end
+        end
+
+        response_success
+      end
+    end
+
   end
 end

data/spec/api-model/api_model_spec.rb

@@ -21,10 +21,20 @@ describe ApiModel do
       post_request.http_response.request_method.should eq :post
     end
 
+    it 'should be possible to send a PUT request' do
+      put_request = VCR.use_cassette('posts') { BlogPost.put_json "/post/1" }
+      put_request.http_response.request_method.should eq :put
+    end
+
     it 'should be possible to send a POST request with a hash as body' do
       post_request = VCR.use_cassette('posts') { BlogPost.post_json "/create_with_json", name: "foobarbaz" }
       post_request.http_response.api_call.request.options[:body].should eq "{\"name\":\"foobarbaz\"}"
     end
+
+    it 'should be possible to send a PUT request with a hash as body' do
+      post_request = VCR.use_cassette('posts') { BlogPost.put_json "/post/1", name: "foobarbaz" }
+      post_request.http_response.api_call.request.options[:body].should eq "{\"name\":\"foobarbaz\"}"
+    end
   end
 
   describe "retrieving a single object" do
@@ -148,6 +158,89 @@ describe ApiModel do
     end
   end
 
+  describe "updating attributes from a hash" do
+    let(:car) { Car.new }
+
+    it 'should change an existing attribute' do
+      car.name = "Chevvy"
+      expect {
+        car.update_attributes_from_hash 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
+      }.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
+    end
+  end
+
+  describe "saving changes on an instance" do
+    before do
+      BlogPost.api_config { |config| config.host = "http://api-model-specs.com" }
+    end
+
+    let(:blog_post) { BlogPost.new }
+
+    # VCR will blow up if this was not a PUT, so no rspec expectations are needed here...
+    it 'should send a PUT request' do
+      VCR.use_cassette('posts') { blog_post.save "/post/1" }
+    end
+
+    # Same again here with VCR...
+    it 'should be possible to change the request type' do
+      VCR.use_cassette('posts') { blog_post.save "/post/update_with_post", nil, request_method: :post }
+    end
+
+    it 'should be possible to send a JSON body in the same way a normal POST or PUT request would' 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"
+      VCR.use_cassette('posts') { blog_post.save "/post/2", name: "foobarbaz" }
+    end
+
+    it 'should set errors on the instance if the response contains an errors hash' do
+      expect {
+        VCR.use_cassette('posts') { blog_post.save "/post/with_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
+        after_successful_save :yay_it_saved
+        after_unsuccessful_save :oh_no_it_didnt_save
+
+        def saved; end
+        def yay_it_saved; end
+        def oh_no_it_didnt_save; end
+      end
+
+      it 'should run a callback around the whole save method' do
+        blog_post.should_receive(:saved).once
+        VCR.use_cassette('posts') { blog_post.save "/post/1" }
+      end
+
+      it 'should run a callback around the handling of a successful response' do
+        blog_post.should_receive(:yay_it_saved).once
+        VCR.use_cassette('posts') { blog_post.save "/post/1" }
+      end
+
+      it 'should run a callback around the handling of a unsuccessful response' do
+        blog_post.should_receive(:oh_no_it_didnt_save).once
+        VCR.use_cassette('posts') { blog_post.save "/post/with_errors", name: "" }
+      end
+    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"

data/spec/api-model/configuration_spec.rb

@@ -64,7 +64,7 @@ describe ApiModel, "Configuration" do
 
   describe "cache_strategy" do
     it 'should default to NoCache' do
-      ApiModel::Base.api_model_configuration.cache_strategy.should eq ApiModel::CacheStrategies::NoCache
+      ApiModel::Base.api_model_configuration.cache_strategy.should eq ApiModel::CacheStrategy::NoCache
     end
   end
 

data/spec/support/fixtures/posts.yml

@@ -54,6 +54,60 @@ http_interactions:
     http_version:
   recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
 
+- request:
+    method: put
+    uri: http://api-model-specs.com/post/1
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      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: "{\"name\":\"something_else\"}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+- request:
+    method: post
+    uri: http://api-model-specs.com/post/update_with_post
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+  response:
+    status:
+      code: 200
+      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: "{\"name\":\"something_else\"}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
 - request:
     method: get
     uri: http://api-model-specs.com/single_post
@@ -110,4 +164,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/2
+    headers:
+      User-Agent:
+      - Typhoeus - https://github.com/typhoeus/typhoeus
+    body:
+      string: "{\"name\":\"foobarbaz\"}"
+  response:
+    status:
+      code: 200
+      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: "{\"name\":\"foobarbaz\"}"
+    http_version:
+  recorded_at: Thu, 28 Nov 2013 16:02:20 GMT
+
+- request:
+    method: put
+    uri: http://api-model-specs.com/post/with_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: "{\"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.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Damien Timewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-07 00:00:00.000000000 Z
+date: 2014-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,7 +139,8 @@ files:
 - README.md
 - api-model.gemspec
 - lib/api-model.rb
-- lib/api_model/cache_stategies/no_cache.rb
+- lib/api_model/builder/hash.rb
+- lib/api_model/cache_stategy/no_cache.rb
 - lib/api_model/class_methods.rb
 - lib/api_model/configuration.rb
 - lib/api_model/http_request.rb
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: A simple way of interacting with rest APIs