bookingsync-api 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 657a1fe08c85da356e964602580b31d892e9a0c9
-  data.tar.gz: 09bd00b34418d232944dcd0f790b19233cffb735
+  metadata.gz: 880e050165fd6662866b2727aa066a6df376a609
+  data.tar.gz: bb7c1426aab6968106fae175fca59d8a4faa95bb
 SHA512:
-  metadata.gz: eec8bc8666f9b3c79f1a2771f671df6a0c3fbfbcf1795ca85400128751c3e2c33dd3272c03d017c9300a156f19b89eff9a68e37200eed507b39e531c45ee2d6e
-  data.tar.gz: 71251e0ff150dfc367788e047a0038794634d14a0fe1065c61938fb4d3544df20a1cc1977a98c26534307c42a5b469fb119f68b88ed9f725c5d609aa5664d485
+  metadata.gz: afaf6373157977f8af580f7d360761b440d54e53a1a08426ea267971bc27ca378730f31a6eaacf2c2cdb5a98954f9a0ec24d7e95d4bc2548bc3c0917c09d7b4b
+  data.tar.gz: eddb23e23bb4c566592c60553287ed47329fbe054ab7c1e065f519a31dabc6a4d490dc19af973153465a354aef9e596f29831416c544fc7b425e61f0ccf9a0e1

data/lib/bookingsync/api/client.rb

@@ -170,7 +170,7 @@ module BookingSync::API
         response = call(:get, path, query: options)
         data = response.resources.dup
 
-        if (block_given? or auto_paginate) && response.rels[:next]
+        if (block_given? or auto_paginate) && response.relations[:next]
           first_request = true
           loop do
             if block_given?
@@ -179,8 +179,8 @@ module BookingSync::API
               data.concat(response.resources) unless first_request
               first_request = false
             end
-            break unless response.rels[:next]
-            response = response.rels[:next].get
+            break unless response.relations[:next]
+            response = response.relations[:next].get
           end
         end
 

data/lib/bookingsync/api/resource.rb

@@ -3,22 +3,21 @@ require "hashie"
 module BookingSync::API
   class Resource < Hash
     include Hashie::Extensions::MethodAccess
-    attr_reader :_client, :_rels, :_links, :_resources_key
+    attr_reader :_client, :_rels, :_resources_key
 
-    # Initialize a Resource with the given links and data.
+    # Initialize a Resource with the given relations and data.
     #
     # @param client [BookingSync::API::Client] The client that made the API request.
     # @param data [Hash] Hash of key/value properties.
-    # @param links [Hash] Hash of link templates for this resource.
+    # @param rels [Hash] Hash of built relations for this resource.
     # @param resources_key [Symbol|String] Key in response body under which
-    def initialize(client, data = {}, links = {}, resources_key = nil)
-      @_links = links
+    def initialize(client, data = {}, rels = {}, resources_key = nil)
       @_client = client
       @_resources_key = resources_key
       data.each do |key, value|
         self[key.to_sym] = process_value(value)
       end
-      @_rels = Relation.from_links(client, links)
+      @_rels = rels
     end
 
     # Process an individual value of this resource. Hashes get exploded
@@ -28,7 +27,7 @@ module BookingSync::API
     # @return [Object] An Object to set as the value of a Resource key.
     def process_value(value)
       case value
-      when Hash  then self.class.new(@_client, value, @_links)
+      when Hash  then self.class.new(@_client, value)
       when Array then value.map { |v| process_value(v) }
       else value
       end

data/lib/bookingsync/api/response.rb

@@ -3,7 +3,7 @@ require "addressable/template"
 module BookingSync::API
   class Response
     SPECIAL_JSONAPI_FIELDS = %w(links linked meta)
-    attr_reader :client, :status, :headers, :data, :rels, :body
+    attr_reader :client, :status, :headers, :data, :relations, :body
 
     # Build a Response after a completed request.
     #
@@ -23,9 +23,9 @@ module BookingSync::API
     #
     # @param hash [Hash] A Hash of resources parsed from JSON.
     # @return [Array] An Array of Resources.
-    def process_data(hash, links)
+    def process_data(hash)
       Array(hash).map do |hash|
-        Resource.new(client, hash, links, resources_key)
+        Resource.new(client, hash, resource_relations, resources_key)
       end
     end
 
@@ -43,23 +43,25 @@ module BookingSync::API
     #
     # @return [Array<BookingSync::API::Resource>]
     def resources
-      @resources ||= process_data(decoded_body[resources_key], links)
+      @resources ||= process_data(decoded_body[resources_key])
     end
 
-    # Return an array of links templates from the response body,
-    # it's the contents of links hash
-    # {'links': {'rentals.photos':'https://www.bookingsync.com/api/v3/photos/{rentals.photos}'}}
+    # Returns a Hash of relations built from given links templates.
+    # These relations are the same for each resource, so we calculate
+    # them once here and pass to every top level resource.
     #
-    # @return [Hash] Hash of links to associated resources
-    def links
-      @links ||= decoded_body[:links]
+    # @return [Hash] Hash of relations to associated resources
+    def resource_relations
+      @resource_relations ||= Relation.from_links(client,
+        decoded_body[:links])
     end
 
-    # Return link relations from 'Link' response header
+    # Return a Hash of relations to other pages built from 'Link'
+    # response header
     #
-    # @return [Array] An array of Relations
-    def rels
-      @rels ||= process_rels
+    # @return [Hash] Hash of relations to first,last,next and prev pages
+    def relations
+      @relations ||= process_rels
     end
 
     private

data/lib/bookingsync/api/version.rb

@@ -1,5 +1,5 @@
 module BookingSync
   module API
-    VERSION = "0.0.13"
+    VERSION = "0.0.14"
   end
 end

data/spec/bookingsync/api/resource_spec.rb

@@ -12,10 +12,10 @@ describe BookingSync::API::Resource do
         details: {count: 1},
         id: 10
       },
-      {
+      BookingSync::API::Relation.from_links(client, {
         :"foo.photos" => "http://foo.com/photos/{foo.photos}",
         :"foo.category" => "http://foo.com/categories/{foo.category}"
-      },
+      }),
       "foo"
     )
   }

data/spec/bookingsync/api/response_spec.rb

@@ -8,13 +8,14 @@ describe BookingSync::API::Response do
   let(:links) {
     {:'rentals.photos' => 'https://www.bookingsync.com/api/v3/photos/{rentals.photos}'}
   }
-  let(:rentals) { [
-    {id: 1, name: 'rental 1', photos: [1, 43]},
-    {id: 2, name: 'rental 2'}
-  ] }
-  let(:response) do
-    stubs = Faraday::Adapter::Test::Stubs.new
-    client = BookingSync::API::Client.new(test_access_token,
+  let(:resource_relations) { BookingSync::API::Relation.from_links(client,
+    links) }
+  let(:rentals) do
+    [{id: 1, name: 'rental 1', photos: [1, 43]},
+     {id: 2, name: 'rental 2'}]
+  end
+  let(:client) do
+    BookingSync::API::Client.new(test_access_token,
       base_url: "http://foo.com") do |conn|
       conn.builder.handlers.delete(Faraday::Adapter::NetHttp)
       conn.adapter :test, @stubs do |stub|
@@ -24,6 +25,9 @@ describe BookingSync::API::Response do
         end
       end
     end
+  end
+  let(:response) do
+    stubs = Faraday::Adapter::Test::Stubs.new
     client.call(:get, '/rentals')
   end
 
@@ -39,9 +43,11 @@ describe BookingSync::API::Response do
     end
   end
 
-  describe "#links" do
+  describe "#resource_relations" do
     it "returns links to associated resources" do
-      expect(response.links).to eql(links)
+      href = response.resource_relations[:'rentals.photos'].href
+      expect(href).not_to be_nil
+      expect(href).to eq(resource_relations[:'rentals.photos'].href)
     end
   end
 
@@ -57,10 +63,10 @@ describe BookingSync::API::Response do
     end
   end
 
-  describe "#rels" do
+  describe "#relations" do
     it "returns relations from Link header" do
-      expect(response.rels[:next].href).to eql('/rentals?page=2')
-      expect(response.rels[:last].href).to eql('/rentals?page=19')
+      expect(response.relations[:next].href).to eql('/rentals?page=2')
+      expect(response.relations[:last].href).to eql('/rentals?page=19')
     end
   end
 end

metadata

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