bookingsync-api 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08d6720058ec3d13d13447f1ceb97e39b44740d6
-  data.tar.gz: 1050fdba11d3ce21578028d35269484c31b9a288
+  metadata.gz: 297041c927ac94cf6fd56b2c8994adc58a5d2962
+  data.tar.gz: b9b106fc73c0ca792bb5c899916d636f2bd02b77
 SHA512:
-  metadata.gz: 08824e7c2896b4a51e38134c81758a212473b53ab481d4ce12cc17aca94ff7b04fea1d44ecee8085fc20caae3e487adb6a37fc102575fa77d9f8cc61c48c3b33
-  data.tar.gz: 5a8cfb28de21e09172eca667234c3ce08d4475c2f5b707380d2cd5894943b2bd720116f5f72a15fb04e2d819d8ca02d50e293b400f7bcf2941f96b52e1091d0a
+  metadata.gz: 90c91f15b4ee3f3a8aa0cf0d23510372c8ffb80b92598b0d1fe08a8bddc6f6c135c1d95ae3d3c85dd61bed572f6e284147c7b76772d90c61bd7e44255eb29441
+  data.tar.gz: 8287a9f009569a5dc5780817a9ef1c915f7f3106d1f3b9777466dfad6a1cc118321ba308f1b660ce658e0c0c5b1efd255785daeff758e4dbfbe3c8f95a03897c

data/README.md

@@ -45,6 +45,14 @@ Fetch all resources (with multiple requests under the hood) and return one big a
 
     api.bookings(auto_paginate: true) => [BookingSync::API::Resource, BookingSync::API::Resource, ...]
 
+### Meta information
+
+Some endpoints return additional info about resource in meta section. To fetch it you need to
+access last response.
+
+    api.rentals(updated_since: "2014-01-01 15:43:96 UTC") # => [BookingSync::API::Resource,    BookingSync::API::Resource, ...]
+    api.last_response.meta # => {"deleted_rentals_ids" => [1, 3, 4]}
+
 ### Logging
 
 Sometimes it's useful to see what data bookingsync-api gem sends and what it

data/lib/bookingsync/api/client.rb

@@ -53,7 +53,7 @@ module BookingSync::API
 
     MEDIA_TYPE = "application/vnd.api+json"
 
-    attr_reader :token, :logger
+    attr_reader :token, :logger, :last_response
 
     def_delegator :@instrumenter, :instrument
 
@@ -283,7 +283,7 @@ module BookingSync::API
     # @raise [BookingSync::API::UnprocessableEntity] - On validations error
     # @return [BookingSync::API::Response|NilClass]
     def handle_response(faraday_response)
-      response = Response.new(self, faraday_response)
+      @last_response = response = Response.new(self, faraday_response)
       case response.status
       when 204; nil # destroy/cancel
       when 200..299; response

data/lib/bookingsync/api/response.rb

@@ -2,7 +2,7 @@ require "addressable/template"
 
 module BookingSync::API
   class Response
-    SPECIAL_JSONAPI_FIELDS = %w(links linked meta)
+    SPECIAL_JSONAPI_FIELDS = [:links, :linked, :meta]
     attr_reader :client, :status, :headers, :data, :relations, :body
 
     # Build a Response after a completed request.
@@ -34,8 +34,8 @@ module BookingSync::API
     #
     # @return [Symbol] Key name in the body hash
     def resources_key
-      decoded_body.keys.delete_if { |k|
-        SPECIAL_JSONAPI_FIELDS.include?(k)
+      decoded_body.keys.delete_if { |key|
+        SPECIAL_JSONAPI_FIELDS.include?(key)
       }.pop
     end
 
@@ -59,11 +59,18 @@ module BookingSync::API
     # Return a Hash of relations to other pages built from 'Link'
     # response header
     #
-    # @return [Hash] Hash of relations to first,last,next and prev pages
+    # @return [Hash] Hash of relations to first, last, next and prev pages
     def relations
       @relations ||= process_rels
     end
 
+    # Returns a Hash of meta information taken from the response body
+    #
+    # @return [Hash] Meta hash
+    def meta
+      @meta ||= decoded_body[:meta]
+    end
+
     private
 
     def decoded_body

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.0.16"
+    VERSION = "0.0.17"
   end
 end

data/spec/bookingsync/api/client_spec.rb

@@ -227,4 +227,12 @@ describe BookingSync::API::Client do
       end
     end
   end
+
+  describe "#last_response" do
+    it "returns last response" do
+      stub_get("resources", body: {meta: {count: 10}, resources: []}.to_json)
+      client.get("resources")
+      expect(client.last_response.meta).to eql(count: 10)
+    end
+  end
 end

data/spec/bookingsync/api/response_spec.rb

@@ -20,7 +20,8 @@ describe BookingSync::API::Response do
       conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
       conn.adapter :test, @stubs do |stub|
         stub.get '/rentals' do
-          body = {links: links, rentals: rentals}.to_json
+          body = {links: links, rentals: rentals,
+            meta: {count: 10}}.to_json
           [200, headers, body]
         end
       end
@@ -69,4 +70,10 @@ describe BookingSync::API::Response do
       expect(response.relations[:last].href).to eql('/rentals?page=19')
     end
   end
+
+  describe "#meta" do
+    it "returns meta information from response body" do
+      expect(response.meta).to eql(count: 10)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookingsync-api
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Sébastien Grosjean
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-20 00:00:00.000000000 Z
+date: 2014-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday