json_api_client 0.9.6 → 1.0.0.beta

data/lib/json_api_client/query/requestor.rb

@@ -0,0 +1,77 @@
+module JsonApiClient
+  module Query
+    class Requestor
+      extend Forwardable
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      # expects a record
+      def create(record)
+        request(:post, klass.path(record.attributes), {
+          data: record.attributes
+        })
+      end
+
+      def update(record)
+        request(:patch, resource_path(record.attributes), {
+          data: record.attributes
+        })
+      end
+
+      def find(args)
+        params = case args
+        when Hash
+          args
+        when Array
+          {klass.primary_key.to_s.pluralize.to_sym => args.join(",")}
+        else
+          {klass.primary_key => args}
+        end
+
+        path = resource_path(params)
+        params.delete(klass.primary_key)
+        request(:get, path, params)
+      end
+
+      def destroy(record)
+        request(:delete, resource_path(record.attributes), {})
+      end
+
+      def linked(path)
+        request(:get, path, {})
+      end
+
+      def custom(method_name, options, params)
+        path = resource_path(params)
+        params.delete(klass.primary_key)
+        path = File.join(path, method_name.to_s)
+
+        request(options.fetch(:request_method, :get), path, params)
+      end
+
+      protected
+
+      attr_reader :klass
+      def_delegators :klass, :connection
+
+      def resource_path(parameters)
+        if resource_id = parameters[klass.primary_key]
+          File.join(klass.path(parameters), encoded(resource_id))
+        else
+          klass.path(parameters)
+        end
+      end
+
+      def encoded(part)
+        Addressable::URI.encode_component(part, Addressable::URI::CharacterClasses::UNRESERVED)
+      end
+
+      def request(type, path, params)
+        klass.parse(connection.run(type, path, params))
+      end
+
+    end
+  end
+end

data/lib/json_api_client/resource.rb

@@ -8,11 +8,8 @@ require 'active_support/core_ext/enumerable'
 
 module JsonApiClient
   class Resource
-    class_attribute :site, :primary_key, :link_style, :default_headers
-
+    class_attribute :site, :primary_key
     self.primary_key = :id
-    self.link_style = :id # or :url
-    self.default_headers = {}
 
     class << self
       # base URL for this resource
@@ -27,23 +24,6 @@ module JsonApiClient
       def resource_name
         name.demodulize.underscore
       end
-
-      def find(conditions)
-        run_request(Query::Find.new(self, conditions))
-      end
-
-      def create(conditions = {})
-        result = run_request(Query::Create.new(self, conditions))
-        if result.has_errors?
-          yield(result) if block_given?
-          return nil
-        end
-        result.first
-      end
-
-      def run_request(query)
-        parse(connection.execute(query))
-      end
     end
 
     include Helpers::Initializable
@@ -55,44 +35,8 @@ module JsonApiClient
     include Helpers::Linkable
     include Helpers::CustomEndpoints
     include Helpers::Schemable
-
-    attr_reader :last_request_meta
-
-    def save
-      query = persisted? ? 
-        Query::Update.new(self.class, attributes) :
-        Query::Create.new(self.class, attributes)
-
-      run_request(query)
-    end
-
-    def destroy
-      if run_request(Query::Destroy.new(self.class, attributes))
-        self.attributes.clear
-        true
-      else
-        false
-      end
-    end
-
-    protected
-
-    def run_request(query)
-      # reset errors if a new request is being made
-      self.errors.clear if self.errors
-
-      result = self.class.run_request(query)
-      self.errors = result.errors
-      @last_request_meta = result.meta
-      if result.has_errors?
-        return false
-      else
-        if updated = result.first
-          self.attributes = updated.attributes
-        end
-        return true
-      end
-    end
+    include Helpers::Paginatable
+    include Helpers::Requestable
 
   end
 end

data/lib/json_api_client/result_set.rb

@@ -1,40 +1,22 @@
+require 'forwardable'
+
 module JsonApiClient
   class ResultSet < Array
+    extend Forwardable
 
-    attr_accessor :total_pages,
-                  :total_entries,
-                  :offset,
-                  :per_page,
-                  :current_page,
-                  :errors,
+    attr_accessor :errors,
                   :record_class,
-                  :meta
-    alias_attribute :limit_value, :per_page
+                  :meta,
+                  :pages,
+                  :uri,
+                  :links
 
-    def self.build(klass, data)
-      # Objects representing an individual resource are
-      # not necessarily wrapped in an Array; enforce wrapping
-      result_data = [data.fetch(klass.table_name, [])].flatten
-      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
+    # 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 has_errors?
-      errors && errors.length > 0
-    end
-
-    def out_of_bounds?
-      current_page > total_pages
+      errors.present?
     end
 
-    def previous_page
-      current_page > 1 ? (current_page - 1) : nil
-    end
-
-    def next_page
-      current_page < total_pages ? (current_page + 1) : nil
-    end
   end
 end

data/lib/json_api_client/schema.rb

@@ -1,40 +1,25 @@
-require 'date'
-
 module JsonApiClient
   class Schema
-    DEFAULT_PROPERTY_TYPES = {
-      int: lambda {|value| value.to_i },
-      integer: lambda {|value| value.to_i },
-      string: lambda {|value| value.to_s },
-      float: lambda {|value| value.to_f },
-      boolean: lambda {|value| value.is_a?(String) ? (value != "false") : !!value },
-      timestamp: lambda {|value| value.is_a?(DateTime) ? value : Time.at(value.to_f).to_datetime },
-      timestamp_ms: lambda {|value| value.is_a?(DateTime) ? value : Time.at(value.to_f/1000).to_datetime },
-      datetime: lambda {|value| value.is_a?(DateTime) ? value : DateTime.parse(value.to_s) },
-      date: lambda {|value| value.is_a?(Date) ? value : Date.parse(value.to_s) }
-    }
-
-    class << self
-      def property_types
-        @property_types ||= DEFAULT_PROPERTY_TYPES
-      end
-
-      def register_property_type(name, caster)
-        property_types[name.to_sym] = caster
-      end
-
-      def find_property_type(name)
-        property_types[name.to_sym]
-      end
-    end
-
     Property = Struct.new(:name, :type, :default) do
       def cast(value)
         return nil if value.nil?
         return value if type.nil?
 
-        if caster = Schema.find_property_type(type)
-          caster.call(value)
+        case type.to_sym
+        when :int, :integer
+          value.to_i
+        when :string
+          value.to_s
+        when :float
+          value.to_f
+        when :time
+          value.is_a?(Time) || nil ? value : Time.parse(value)
+        when :boolean
+          if value.is_a?(String)
+            value == "false" ? false : true
+          else
+            !!value
+          end
         else
           value
         end

data/lib/json_api_client/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 0.9.6
+  version: 1.0.0.beta
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2015-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -96,37 +110,40 @@ files:
 - lib/json_api_client/associations/has_many.rb
 - lib/json_api_client/associations/has_one.rb
 - lib/json_api_client/connection.rb
+- lib/json_api_client/error_collector.rb
 - lib/json_api_client/errors.rb
 - lib/json_api_client/helpers.rb
 - lib/json_api_client/helpers/associable.rb
 - lib/json_api_client/helpers/attributable.rb
 - lib/json_api_client/helpers/custom_endpoints.rb
+- lib/json_api_client/helpers/dynamic_attributes.rb
 - lib/json_api_client/helpers/initializable.rb
 - lib/json_api_client/helpers/linkable.rb
+- 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/requestable.rb
 - lib/json_api_client/helpers/schemable.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/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
 - lib/json_api_client/middleware.rb
 - lib/json_api_client/middleware/json_request.rb
 - lib/json_api_client/middleware/parse_json.rb
 - lib/json_api_client/middleware/status.rb
-- lib/json_api_client/parser.rb
+- lib/json_api_client/paginating.rb
+- lib/json_api_client/paginating/paginator.rb
+- lib/json_api_client/parsers.rb
+- lib/json_api_client/parsers/parser.rb
 - lib/json_api_client/query.rb
-- lib/json_api_client/query/base.rb
-- lib/json_api_client/query/create.rb
-- 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/query/builder.rb
+- lib/json_api_client/query/requestor.rb
 - lib/json_api_client/resource.rb
 - lib/json_api_client/result_set.rb
 - lib/json_api_client/schema.rb
-- lib/json_api_client/scope.rb
 - lib/json_api_client/utils.rb
 - lib/json_api_client/version.rb
 homepage: http://github.com/chingor13/json_api_client
@@ -144,12 +161,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Build client libraries compliant with specification defined by jsonapi.org

data/lib/json_api_client/link.rb

@@ -1,11 +0,0 @@
-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

@@ -1,27 +0,0 @@
-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

@@ -1,75 +0,0 @@
-# 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
-
-      @results_by_type_by_id.values.each do |results|
-        results.values.each do |result|
-          result.linked_data = self
-        end
-      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)
-      uri = URI(link_definition.url_for(type, missing_ids)).to_s
-
-      query = Query::Linked.new(uri)
-      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