json_api_client 1.0.0.beta → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cab5bf2208be347ffc15b03c0af11c4c21ace976
-  data.tar.gz: 98074a5fcacd34fb0a4dc946f8968957437b8f3a
+  metadata.gz: 738f41ec73db3cf6cdf208abb4ad48ea7fc50e39
+  data.tar.gz: a0b6dfce9e509e9d7ac206ba742ce3b52e41a04e
 SHA512:
-  metadata.gz: 5f091b91fbb8006898403e893f7c934c11b600a1d0ccdb7e22afd8cefae97edaa51a1d59c3e9a52e1cf9fb52ceb2708db23407138c2dff9837f7bfdfb165be34
-  data.tar.gz: 286263275aebe8fb7a777c817a3b368dda97bea2aaec6208061631774f98ec92f2b5ea6f5a9ddabd3764de34a941a23fedf90b1f9587a286acb2ba0e2194a75c
+  metadata.gz: d20ef7885deb0589bbb6d6d7fa89d40ef7dbf192e1461ba006f4124c0986a581ce0da11d1bf5d9ce308610ef142effcc11ceb7aa4a91f78752db9f511357837e
+  data.tar.gz: 2dd89bd5ea1b889f71a1b62826f087ebb30078a38f20218483fdf119928a3e0f724db2f10fb2dfcef58dba7ab3f48b108d7c9ade2133f469aed8dbf4c47dbaaf

data/lib/json_api_client/connection.rb

@@ -5,12 +5,13 @@ module JsonApiClient
 
     def initialize(options = {})
       site = options.fetch(:site)
+      adapter_options = Array(options.fetch(:adapter, Faraday.default_adapter))
       @faraday = Faraday.new(site) do |builder|
         builder.request :json
         builder.use Middleware::JsonRequest
         builder.use Middleware::Status
         builder.use Middleware::ParseJson
-        builder.adapter Faraday.default_adapter
+        builder.adapter *adapter_options
       end
       yield(self) if block_given?
     end

data/lib/json_api_client/error_collector.rb

@@ -1,28 +1,79 @@
 module JsonApiClient
-  class ErrorCollector
+  class ErrorCollector < Array
     class Error
-      include Helpers::DynamicAttributes
+      delegate :[], to: :attrs
 
       def initialize(attrs = {})
-        attrs = {
-          title: attrs
-        } if attrs.is_a?(String)
-        self.attributes = attrs
+        @attrs = (attrs || {}).with_indifferent_access
       end
-    end
 
-    attr_reader :errors
-    extend Forwardable
-    def_delegators :errors, :length, :present?
+      def id
+        attrs[:id]
+      end
 
-    def initialize(error_data)
-      @errors = Array(error_data).map do |datum|
-        Error.new(datum)
+      def about
+        attrs.fetch(:links, {})[:about]
+      end
+
+      def status
+        attrs[:status]
+      end
+
+      def code
+        attrs[:code]
       end
+
+      def title
+        attrs[:title]
+      end
+
+      def detail
+        attrs[:detail]
+      end
+
+      def source_parameter
+        source.fetch(:parameter) do
+          source[:pointer] ?
+            source[:pointer].split("/").last :
+            nil
+        end
+      end
+
+      def source_pointer
+        source.fetch(:pointer) do
+          source[:parameter] ?
+            "/data/attributes/#{source[:parameter]}" :
+            nil
+        end
+      end
+
+      def source
+        attrs.fetch(:source, {})
+      end
+
+      def meta
+        MetaData.new(attrs.fetch(:meta, {}))
+      end
+
+      protected
+
+      attr_reader :attrs
+    end
+
+    def initialize(error_data)
+      super(error_data.map do |data|
+        Error.new(data)
+      end)
     end
 
     def full_messages
-      errors.map(&:title)
+      map(&:title)
+    end
+
+    def [](source)
+      map do |error|
+        error.source_parameter == source
+      end
     end
 
   end

data/lib/json_api_client/helpers/associable.rb

@@ -58,4 +58,4 @@ module JsonApiClient
 
     end
   end
-end
+end

data/lib/json_api_client/helpers/initializable.rb

@@ -25,4 +25,4 @@ module JsonApiClient
       end
     end
   end
-end
+end

data/lib/json_api_client/helpers/linkable.rb

@@ -10,9 +10,6 @@ module JsonApiClient
         # the links for this resource
         attr_accessor :links
 
-        # reference to all of the preloaded data
-        attr_accessor :linked_data
-
         initializer do |obj, params|
           links = params && params.delete("links")
           links ||= {}
@@ -20,29 +17,6 @@ module JsonApiClient
         end
       end
 
-      def as_link
-        {
-          :type => self.class.table_name,
-          primary_key => self[primary_key]
-        }
-      end
-
-      def attributes
-        super.tap do |attrs|
-          attrs.merge!(links: links.attributes) if links.present?
-        end
-      end
-
-      def method_missing(method, *args)
-        return super unless links && links.has_attribute?(method)
-        linked_data.data_for(method, links[method])
-      end
-
-      def respond_to_missing?(symbol, include_all = false)
-        return true if links && links.has_attribute?(symbol)
-        super
-      end
-
     end
   end
-end
+end

data/lib/json_api_client/helpers/paginatable.rb

@@ -10,4 +10,5 @@ module JsonApiClient
 
     end
   end
-end
+end
+

data/lib/json_api_client/helpers/relatable.rb

@@ -0,0 +1,45 @@
+module JsonApiClient
+  module Helpers
+    module Relatable
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :relationship_linker
+        self.relationship_linker = Relationships::Relations
+
+        # the relationships for this resource
+        attr_accessor :relationships
+
+        initializer do |obj, params|
+          relationships = params && params.delete("relationships")
+          relationships ||= {}
+          obj.relationships = obj.relationship_linker.new(relationships)
+        end
+      end
+
+      def as_relation
+        {
+          :type => self.class.table_name,
+          primary_key => self[primary_key]
+        }
+      end
+
+      def attributes
+        super.tap do |attrs|
+          attrs.merge!(relationships: relationships.attributes) if relationships.present?
+        end
+      end
+
+      def method_missing(method, *args)
+        return super unless relationships and relationships.has_attribute?(method) and result_set.included
+        result_set.included.data_for(method, relationships[method])
+      end
+
+      def respond_to_missing?(symbol, include_all = false)
+        return true if relationships && relationships.has_attribute?(symbol)
+        super
+      end
+
+    end
+  end
+end

data/lib/json_api_client/helpers/requestable.rb

@@ -32,8 +32,8 @@ module JsonApiClient
           self.class.requestor.create(self)
         end
 
+        self.errors = last_result_set.errors
         if last_result_set.has_errors?
-          self.errors = last_result_set.errors
           false
         else
           self.errors.clear if self.errors
@@ -57,4 +57,4 @@ module JsonApiClient
 
     end
   end
-end
+end

data/lib/json_api_client/helpers/serializable.rb

@@ -1,13 +1,24 @@
 module JsonApiClient
   module Helpers
     module Serializable
-      def as_json(options=nil)
-        attributes
+      RESERVED = ['id', 'type', 'links', 'meta', 'relationships']
+
+      # def as_json(options=nil)
+      #   attributes.slice(*RESERVED).tap do |h|
+      #     h['attributes'] = serialized_attributes
+      #   end
+      # end
+
+      def data
+        attributes.slice(*RESERVED).tap do |h|
+          h['attributes'] = serialized_attributes
+        end
       end
 
-      def read_attribute_for_serialization(name)
-        read_attribute(name)
+      def serialized_attributes
+        attributes.except(*RESERVED)
       end
+
     end
   end
-end
+end

data/lib/json_api_client/helpers.rb

@@ -6,6 +6,7 @@ module JsonApiClient
     autoload :DynamicAttributes, 'json_api_client/helpers/dynamic_attributes'
     autoload :Initializable, 'json_api_client/helpers/initializable'
     autoload :Linkable, 'json_api_client/helpers/linkable'
+    autoload :Relatable, 'json_api_client/helpers/relatable'
     autoload :Paginatable, 'json_api_client/helpers/paginatable'
     autoload :Parsable, 'json_api_client/helpers/parsable'
     autoload :Queryable, 'json_api_client/helpers/queryable'

data/lib/json_api_client/implementation.rb

@@ -0,0 +1,12 @@
+module JsonApiClient
+  class Implementation
+    attr_reader :version, :meta
+
+    def initialize(data)
+      # If the version member is not present, clients should assume the server implements at least version 1.0 of the specification.
+      @version = data.fetch("version", "1.0")
+
+      @meta = MetaData.new(data.fetch("meta", {}))
+    end
+  end
+end

data/lib/json_api_client/included_data.rb

@@ -0,0 +1,49 @@
+module JsonApiClient
+  class IncludedData
+    attr_reader :data
+
+    def initialize(result_set, data)
+      record_class = result_set.record_class
+      grouped_data = data.group_by{|datum| datum["type"]}
+      @data = grouped_data.inject({}) do |h, (type, records)|
+        klass = Utils.compute_type(record_class, type.singularize.classify)
+        h[type] = records.map do |datum|
+          params = klass.parser.parameters_from_resource(datum)
+          resource = klass.new(params)
+          resource.result_set = result_set
+          resource
+        end.index_by(&:id)
+        h
+      end
+    end
+
+    def data_for(method_name, definition)
+      # If data is defined, pull the record from the included data
+      if data = definition["data"]
+        if data.is_a?(Array)
+          # has_many link
+          data.map do |link_def|
+            record_for(link_def)
+          end
+        else
+          # has_one link
+          record_for(data)
+        end
+      else
+        # TODO: if "related" URI is defined, fetch the delated object and stuff it in data
+        nil
+      end
+    end
+
+    def has_link?(name)
+      data.has_key?(name)
+    end
+
+    private
+
+    # should return a resource record of some type for this linked document
+    def record_for(link_def)
+      data[link_def["type"]][link_def["id"]]
+    end
+  end
+end

data/lib/json_api_client/linking/links.rb

@@ -14,14 +14,7 @@ module JsonApiClient
       protected
 
       def set_attribute(name, value)
-        attributes[name] = case value
-        when JsonApiClient::Resource
-          {linkage: value.as_link}
-        when Array
-          {linkage: value.map(&:as_link)}
-        else
-          value
-        end
+        attributes[name] = value
       end
 
     end

data/lib/json_api_client/linking/top_level_links.rb

@@ -27,4 +27,4 @@ module JsonApiClient
       end
     end
   end
-end
+end

data/lib/json_api_client/linking.rb

@@ -1,6 +1,5 @@
 module JsonApiClient
   module Linking
-    autoload :IncludedData, "json_api_client/linking/included_data"
     autoload :Links, "json_api_client/linking/links"
     autoload :TopLevelLinks, "json_api_client/linking/top_level_links"
   end

data/lib/json_api_client/paginating/paginator.rb

@@ -2,10 +2,10 @@ module JsonApiClient
   module Paginating
     class Paginator
       attr_reader :params, :result_set, :links
-      def initialize(result_set, links)
+      def initialize(result_set, data)
         @params = params_for_uri(result_set.uri)
         @result_set = result_set
-        @links = links
+        @links = data['links']
       end
 
       def next
@@ -39,6 +39,7 @@ module JsonApiClient
       def total_entries
         per_page * total_pages
       end
+      alias_method :total_count, :total_entries
 
       def offset
         per_page * (current_page - 1)
@@ -77,4 +78,4 @@ module JsonApiClient
       end
     end
   end
-end
+end

data/lib/json_api_client/parsers/parser.rb

@@ -7,24 +7,69 @@ module JsonApiClient
           ResultSet.new.tap do |result_set|
             result_set.record_class = klass
             result_set.uri = response.env[:url]
+            handle_json_api(result_set, data)
             handle_data(result_set, data)
             handle_errors(result_set, data)
             handle_meta(result_set, data)
             handle_links(result_set, data)
+            handle_relationships(result_set, data)
             handle_pagination(result_set, data)
             handle_included(result_set, data)
           end
         end
 
+        #
+        # Given a resource hash, returns a Resource.new friendly hash
+        # which flattens the attributes in w/ id and type.
+        #
+        # Example:
+        #
+        # Given:
+        #  {
+        #    id: 1.
+        #    type: 'person',
+        #    attributes: {
+        #      first_name: 'Jeff',
+        #      last_name: 'Ching'
+        #    },
+        #    links: {...},
+        #    relationships: {...}
+        #  }
+        #
+        # Returns:
+        #  {
+        #    id: 1,
+        #    type: 'person',
+        #    first_name: 'Jeff',
+        #    last_name: 'Ching'
+        #    links: {...},
+        #    relationships: {...}
+        #  }
+        #
+        #
+        def parameters_from_resource(params)
+          attrs = params.slice('id', 'links', 'meta', 'type', 'relationships')
+          attrs.merge(params.fetch('attributes', {}))
+        end
+
         private
 
+        def handle_json_api(result_set, data)
+          result_set.implementation = Implementation.new(data.fetch("jsonapi", {}))
+        end
+
         def handle_data(result_set, data)
           # all data lives under the "data" attribute
           results = data.fetch("data", [])
 
           # we will treat everything as an Array
           results = [results] unless results.is_a?(Array)
-          result_set.concat(results.map{|res| result_set.record_class.load(res)})
+          resources = results.map do |res|
+            resource = result_set.record_class.load(parameters_from_resource(res))
+            resource.result_set = result_set
+            resource
+          end
+          result_set.concat(resources)
         end
 
         def handle_errors(result_set, data)
@@ -39,17 +84,18 @@ module JsonApiClient
           result_set.links = Linking::TopLevelLinks.new(result_set.record_class, data.fetch("links", {}))
         end
 
+        def handle_relationships(result_set, data)
+          result_set.relationships = Relationships::TopLevelRelations.new(result_set.record_class, data.fetch("relationships", {}))
+        end
+
         def handle_pagination(result_set, data)
-          result_set.pages = result_set.record_class.paginator.new(result_set, data.fetch("links", {}))
+          result_set.pages = result_set.record_class.paginator.new(result_set, data)
         end
 
         def handle_included(result_set, data)
-          included = Linking::IncludedData.new(result_set.record_class, data.fetch("included", []))
-          result_set.each do |res|
-            res.linked_data = included
-          end
+          result_set.included = IncludedData.new(result_set, data.fetch("included", []))
         end
       end
     end
   end
-end
+end

data/lib/json_api_client/query/builder.rb

@@ -34,12 +34,19 @@ module JsonApiClient
       end
 
       def paginate(conditions = {})
-        @pagination_params.merge!(conditions.slice(:page, :per_page))
-        self
+        scope = self
+        scope = scope.page(conditions[:page]) if conditions[:page]
+        scope = scope.per(conditions[:per_page]) if conditions[:per_page]
+        scope
       end
 
       def page(number)
-        @pagination_params[:page] = number
+        @pagination_params[:number] = number
+        self
+      end
+
+      def per(size)
+        @pagination_params[:size] = size
         self
       end
 
@@ -70,7 +77,9 @@ module JsonApiClient
 
       private
 
-      attr_reader :pagination_params
+      def pagination_params
+        @pagination_params.empty? ? {} : {page: @pagination_params}
+      end
 
       def includes_params
         @includes.empty? ? {} : {include: @includes.join(",")}

data/lib/json_api_client/query/requestor.rb

@@ -10,13 +10,13 @@ module JsonApiClient
       # expects a record
       def create(record)
         request(:post, klass.path(record.attributes), {
-          data: record.attributes
+          data: record.data
         })
       end
 
       def update(record)
         request(:patch, resource_path(record.attributes), {
-          data: record.attributes
+          data: record.data
         })
       end
 
@@ -74,4 +74,4 @@ module JsonApiClient
 
     end
   end
-end
+end

data/lib/json_api_client/relationships/relations.rb

@@ -0,0 +1,29 @@
+module JsonApiClient
+  module Relationships
+    class Relations
+      include Helpers::DynamicAttributes
+
+      def initialize(relations)
+        self.attributes = relations
+      end
+
+      def present?
+        attributes.present?
+      end
+
+      protected
+
+      def set_attribute(name, value)
+        attributes[name] = case value
+        when JsonApiClient::Resource
+          {data: value.as_relation}
+        when Array
+          {data: value.map(&:as_relation)}
+        else
+          value
+        end
+      end
+
+    end
+  end
+end

data/lib/json_api_client/relationships/top_level_relations.rb

@@ -0,0 +1,30 @@
+module JsonApiClient
+  module Relationships
+    class TopLevelRelations
+
+      attr_reader :relations, :record_class
+
+      def initialize(record_class, relations)
+        @relations = relations
+        @record_class = record_class
+      end
+
+      def respond_to_missing?(method, include_private = false)
+        relations.has_key?(method.to_s) || super
+      end
+
+      def method_missing(method, *args)
+        if respond_to_missing?(method)
+          fetch_relation(method)
+        else
+          super
+        end
+      end
+
+      def fetch_relation(relation_name)
+        link_definition = relations.fetch(relation_name.to_s)
+        record_class.requestor.linked(link_definition)
+      end
+    end
+  end
+end

data/lib/json_api_client/relationships.rb

@@ -0,0 +1,6 @@
+module JsonApiClient
+  module Relationships
+    autoload :Relations, "json_api_client/relationships/relations"
+    autoload :TopLevelRelations, "json_api_client/relationships/top_level_relations"
+  end
+end

data/lib/json_api_client/resource.rb

@@ -1,13 +1,9 @@
 require 'forwardable'
-require 'active_support/concern'
-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'
+require 'active_support/all'
 
 module JsonApiClient
   class Resource
+    attr_accessor :result_set
     class_attribute :site, :primary_key
     self.primary_key = :id
 
@@ -33,6 +29,7 @@ module JsonApiClient
     include Helpers::Queryable
     include Helpers::Serializable
     include Helpers::Linkable
+    include Helpers::Relatable
     include Helpers::CustomEndpoints
     include Helpers::Schemable
     include Helpers::Paginatable

data/lib/json_api_client/result_set.rb

@@ -9,10 +9,13 @@ module JsonApiClient
                   :meta,
                   :pages,
                   :uri,
-                  :links
+                  :links,
+                  :implementation,
+                  :relationships,
+                  :included
 
     # pagination methods are handled by the paginator
-    def_delegators :pages, :total_pages, :total_entries, :offset, :per_page, :current_page, :limit_value, :next_page, :previous_page, :out_of_bounds?
+    def_delegators :pages, :total_pages, :total_entries, :total_count, :offset, :per_page, :current_page, :limit_value, :next_page, :previous_page, :out_of_bounds?
 
     def has_errors?
       errors.present?

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.0.0.beta"
+  VERSION = "1.0.0.beta2"
 end

data/lib/json_api_client.rb

@@ -10,8 +10,10 @@ module JsonApiClient
   autoload :Errors, 'json_api_client/errors'
   autoload :ErrorCollector, 'json_api_client/error_collector'
   autoload :Helpers, 'json_api_client/helpers'
+  autoload :Implementation, 'json_api_client/implementation'
   autoload :IncludedData, 'json_api_client/included_data'
   autoload :Linking, 'json_api_client/linking'
+  autoload :Relationships, 'json_api_client/relationships'
   autoload :LinkDefinition, 'json_api_client/link_definition'
   autoload :MetaData, 'json_api_client/meta_data'
   autoload :Middleware, 'json_api_client/middleware'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-05 00:00:00.000000000 Z
+date: 2015-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -122,11 +122,13 @@ files:
 - lib/json_api_client/helpers/paginatable.rb
 - lib/json_api_client/helpers/parsable.rb
 - lib/json_api_client/helpers/queryable.rb
+- lib/json_api_client/helpers/relatable.rb
 - lib/json_api_client/helpers/requestable.rb
 - lib/json_api_client/helpers/schemable.rb
 - lib/json_api_client/helpers/serializable.rb
+- lib/json_api_client/implementation.rb
+- lib/json_api_client/included_data.rb
 - lib/json_api_client/linking.rb
-- lib/json_api_client/linking/included_data.rb
 - lib/json_api_client/linking/links.rb
 - lib/json_api_client/linking/top_level_links.rb
 - lib/json_api_client/meta_data.rb
@@ -141,6 +143,9 @@ files:
 - lib/json_api_client/query.rb
 - lib/json_api_client/query/builder.rb
 - lib/json_api_client/query/requestor.rb
+- lib/json_api_client/relationships.rb
+- lib/json_api_client/relationships/relations.rb
+- lib/json_api_client/relationships/top_level_relations.rb
 - lib/json_api_client/resource.rb
 - lib/json_api_client/result_set.rb
 - lib/json_api_client/schema.rb

data/lib/json_api_client/linking/included_data.rb

@@ -1,40 +0,0 @@
-module JsonApiClient
-  module Linking
-    class IncludedData
-      attr_reader :data
-
-      def initialize(record_class, data)
-        grouped_data = data.group_by{|datum| datum["type"]}
-        @data = grouped_data.inject({}) do |h, (type, records)|
-          klass = Utils.compute_type(record_class, type.singularize.classify)
-          h[type] = records.map{|datum| klass.new(datum)}.index_by(&:id)
-          h
-        end
-      end
-
-      def data_for(method_name, definition)
-        linkage = definition["linkage"]
-        if linkage.is_a?(Array)
-          # has_many link
-          linkage.map do |link_def|
-            record_for(link_def)
-          end
-        else
-          # has_one link
-          record_for(linkage)
-        end
-      end
-
-      def has_link?(name)
-        data.has_key?(name)
-      end
-
-      private
-
-      # should return a resource record of some type for this linked document
-      def record_for(link_def)
-        data[link_def["type"]][link_def["id"]]
-      end
-    end
-  end
-end