json_api_client 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e63300dc507979f0b7591f11c0bae0b8f51fc8d9
-  data.tar.gz: 1c22f0baf42e3ab2f1a130c17e4b6e77c5e23728
+  metadata.gz: a6ba83068b0d92b968d8ab4edd3f4d4daca21f90
+  data.tar.gz: 53051631d82e0bddf15c2854d14382893a0448cd
 SHA512:
-  metadata.gz: 6b76b52b3b65ca59508ba529045f3a2730e85e7780de81762a7f4f2f1a4a618938564e71f5485e3f347534d4e5d63bb72577f5b00de5745b2645bd92f8fa228a
-  data.tar.gz: cdab71113c09bc1db9e2c734c0ab613f4452e7d7590b8c1f6d5387504a444b6ebdfef2296c76239299e4227632ed2aed8ef0b72cc40c38e4bf6b7d3e19068320
+  metadata.gz: 3fab60fb4108bd15e9c7164370623c616153d52d5ca6c77df8b70a94ca0340a8a25b3dd8c18fbd73eb487616abf7857438950980a86b80261bda88e9cec0f918
+  data.tar.gz: 8d1998191c06f27e45208832a934b408214673a1a54c9318c875af1ccb9a0e293c1b159d6c83b5ebafbdba4a44ee55a348ea377fe88952cba6b256475ca0671a

data/README.md

@@ -153,4 +153,10 @@ end
 
 In the above scenario, you can call the class method `MyApi::User.search`.  The results will be parsed like any other query.  If the response returns users, you will get back a `ResultSet` of `MyApi::User` instances.
 
-You can also call the instance method `verify` on a `MyApi::User` instance.
+You can also call the instance method `verify` on a `MyApi::User` instance.
+
+## Links
+
+We also respect the [links specification](http://jsonapi.org/format/#document-structure-resource-relationships). The client can fetch linked resources based on the defined endpoint from the link specification as well as load data from any `linked` data provided in the response. Additionally, it will still fetch missing data if not all linked resources are provided in the `linked` data response.
+
+See the [tests](https://github.com/chingor13/json_api_client/blob/master/test/unit/links_test.rb).

data/lib/json_api_client/helpers/attributable.rb

@@ -13,6 +13,8 @@ module JsonApiClient
 
       def attributes=(attrs = {})
         @attributes ||= {}.with_indifferent_access
+
+        return @attributes unless attrs.present?
         @attributes.merge!(attrs)
       end
 

data/lib/json_api_client/helpers/linkable.rb

@@ -4,13 +4,35 @@ module JsonApiClient
       extend ActiveSupport::Concern
 
       included do
-        attr_accessor :links
+        attr_accessor :links,
+                      :linked_data
 
         initializer do |obj, params|
-          links = params.delete(:links)
-          obj.links = links if links
+          if params && links = params.delete("links")
+            obj.links = links
+          end
         end
       end
+
+      def method_missing(method, *args)
+        return super unless has_link?(method)
+
+        linked_data.data_for(method, links[method.to_s])
+      end
+
+      def respond_to?(symbol, include_all = false)
+        return true if has_link?(symbol)
+        super
+      end
+
+      private
+
+      def has_link?(symbol)
+        links && 
+          links.has_key?(symbol.to_s) &&
+          linked_data && 
+          linked_data.has_link?(symbol.to_s)
+      end
     end
   end
 end

data/lib/json_api_client/link.rb

@@ -0,0 +1,11 @@
+module JsonApiClient
+  class Link
+    attr_accessor :type
+
+    def initialize(type, spec)
+      @type = type
+      @spec = spec
+    end
+
+  end
+end

data/lib/json_api_client/link_definition.rb

@@ -0,0 +1,27 @@
+module JsonApiClient
+  class LinkDefinition
+
+    def initialize(spec)
+      @spec = {}.with_indifferent_access
+      spec.each do |type, definition|
+        @spec[type.split(".").last] = definition.merge({slurp: type})
+      end
+    end
+
+    def has_link?(type)
+      @spec.has_key?(type)
+    end
+
+    def attribute_name_for(type)
+      @spec.fetch(type).fetch("type")
+    end
+
+    def url_for(type, ids)
+      definition = @spec.fetch(type)
+      href = definition.fetch("href")
+      slurp = definition.fetch("slurp")
+      href.gsub("{#{slurp}}", Array(ids).join(","))
+    end
+
+  end
+end

data/lib/json_api_client/linked_data.rb

@@ -0,0 +1,69 @@
+# This object holds the preloaded data from the json response - essentially
+#   the preloaded foreign keys
+module JsonApiClient
+  class LinkedData
+    attr_reader :link_definition,
+                :record_class
+
+    extend Forwardable
+    def_delegators :link_definition, :has_link?
+
+    def initialize(data, link_definition, record_class)
+      @link_definition = link_definition
+      @record_class = record_class
+      @results_by_type_by_id = {}
+
+      data.each do |type, results|
+        klass = klass_for(type)
+        add_data(type, results.map{|result| klass.new(result)})
+      end
+    end
+
+    def data_for(type, ids)
+      ids = Array(ids)
+
+      # the name of the linked data is provided by the link definition from the result
+      attr_name = link_definition.attribute_name_for(type)
+
+      # get any preloaded data from the result
+      type_data = @results_by_type_by_id.fetch(attr_name, {})
+
+      # find the associated class for the data
+      klass = klass_for(type)
+
+      # return all the found records
+      found, missing = ids.partition { |id| type_data[id].present? }
+
+      # make another api request if there are missing records
+      fetch_data(klass, type, missing) if missing.present?
+
+      # reload data
+      type_data = @results_by_type_by_id.fetch(attr_name, {})
+
+      ids.map do |id|
+        type_data[id]
+      end
+    end
+
+    # make an api request to fetch the missing data
+    def fetch_data(klass, type, missing_ids)
+      path = URI(link_definition.url_for(type, missing_ids)).path
+
+      query = Query::Linked.new(path)
+      results = klass.run_request(query)
+
+      key = link_definition.attribute_name_for(type).to_s
+      add_data(key, results)
+    end
+
+    def add_data(key, data)
+      @results_by_type_by_id[key] ||= {}
+      @results_by_type_by_id[key].merge!(data.index_by{|datum| datum["id"]})
+    end
+
+    def klass_for(type)
+      Utils.compute_type(record_class, type.to_s.pluralize.classify)
+    end
+
+  end
+end

data/lib/json_api_client/parser.rb

@@ -6,6 +6,7 @@ module JsonApiClient
         data = response.body
         ResultSet.build(klass, data) do |result_set|
           handle_pagination(result_set, data)
+          handle_links(result_set, data)
           handle_errors(result_set, data)
         end
       end
@@ -33,6 +34,20 @@ module JsonApiClient
         end
       end
 
+      def handle_links(result_set, data)
+        return if result_set.empty?
+
+        linked_data = LinkedData.new(
+                        data.fetch("linked", {}),
+                        LinkDefinition.new(data.fetch("links", {})),
+                        result_set.record_class
+                      )
+
+        result_set.each do |resource|
+          resource.linked_data = linked_data
+        end
+      end
+
       def handle_errors(result_set, data)
         result_set.errors = data.fetch("meta", {}).fetch("errors", [])
       end

data/lib/json_api_client/query/linked.rb

@@ -0,0 +1,24 @@
+module JsonApiClient
+  module Query
+    class Linked
+      attr_accessor :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def request_method
+        :get
+      end
+
+      def headers
+        {}
+      end
+
+      def params
+        {}
+      end
+
+    end
+  end
+end

data/lib/json_api_client/query.rb

@@ -6,5 +6,6 @@ module JsonApiClient
     autoload :Destroy, 'json_api_client/query/destroy'
     autoload :Find, 'json_api_client/query/find'
     autoload :Update, 'json_api_client/query/update'
+    autoload :Linked, 'json_api_client/query/linked'
   end
 end

data/lib/json_api_client/resource.rb

@@ -4,6 +4,7 @@ require 'active_support/inflector'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/module'
 require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/enumerable'
 
 module JsonApiClient
   class Resource

data/lib/json_api_client/result_set.rb

@@ -1,12 +1,19 @@
 module JsonApiClient
   class ResultSet < Array
 
-    attr_accessor :total_pages, :total_entries, :offset, :per_page, :current_page, :errors
+    attr_accessor :total_pages,
+                  :total_entries,
+                  :offset,
+                  :per_page,
+                  :current_page,
+                  :errors,
+                  :record_class
     alias_attribute :limit_value, :per_page
 
     def self.build(klass, data)
       result_data = data.fetch(klass.table_name, [])
       new(result_data.map {|attributes| klass.new(attributes) }).tap do |result_set|
+        result_set.record_class = klass
         yield(result_set) if block_given?
       end
     end

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/lib/json_api_client.rb

@@ -7,7 +7,8 @@ module JsonApiClient
   autoload :Connection, 'json_api_client/connection'
   autoload :Errors, 'json_api_client/errors'
   autoload :Helpers, 'json_api_client/helpers'
-  autoload :Links, 'json_api_client/links'
+  autoload :LinkDefinition, 'json_api_client/link_definition'
+  autoload :LinkedData, 'json_api_client/linked_data'
   autoload :Middleware, 'json_api_client/middleware'
   autoload :Parser, 'json_api_client/parser'
   autoload :Query, 'json_api_client/query'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -92,6 +92,9 @@ files:
 - lib/json_api_client/helpers/parsable.rb
 - lib/json_api_client/helpers/queryable.rb
 - lib/json_api_client/helpers/serializable.rb
+- lib/json_api_client/link.rb
+- lib/json_api_client/link_definition.rb
+- lib/json_api_client/linked_data.rb
 - lib/json_api_client/middleware.rb
 - lib/json_api_client/middleware/json_request.rb
 - lib/json_api_client/middleware/parse_json.rb
@@ -103,6 +106,7 @@ files:
 - lib/json_api_client/query/custom.rb
 - lib/json_api_client/query/destroy.rb
 - lib/json_api_client/query/find.rb
+- lib/json_api_client/query/linked.rb
 - lib/json_api_client/query/update.rb
 - lib/json_api_client/resource.rb
 - lib/json_api_client/result_set.rb