json_api_resource 0.4.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86a8a63b0785492a9f4964e23c9a74a06a5bb627
-  data.tar.gz: 2185bd954e63235cacc9e76d231cb77f5a4c0865
+  metadata.gz: 2e08b47087e75a6dcbf21993cca2a1cca415b13e
+  data.tar.gz: f8eb103c7b7259c308eb31cca0bfac82b26654e0
 SHA512:
-  metadata.gz: f1a7eb2e44dbf6b7ee3d0eb50996f4743b56559596a26794b5ddabbe831d39df684b05670486c3e14e37e5b7ca312382282500fc6dec299233932269770e2184
-  data.tar.gz: a45673f3cebca622d6a30c26f440f8cd981ad61a7e4a265003a3089d9ae45f9f1012ae9f335d1680a36aaf31b1ce51bcffa9e1074335c243de988b421b9b7e5d
+  metadata.gz: 157cab83d13c35c97dceab05d4008a608a029096506812ab20e46506dc52ab13e4b04813f2bc747473589eac70df8ecd6c9472ce5fff9211ecb2820b83f08c2e
+  data.tar.gz: 94127db2d17bfb3874cc3c15110e83007d691ae6323026714282f4de9a6598ebe76a22be1f23a78906a502f2ff1b94d014cb3e43fba00f1d5f190924c41b0792

data/lib/json_api_resource/cacheable.rb

@@ -2,7 +2,7 @@ module JsonApiResource
   module Cacheable
     extend ActiveSupport::Concern
     def cache_key
-      @cache_key ||= Digest::SHA256.hexdigest(self.attributes.to_s)
+      @cache_key ||= Digest::SHA256.hexdigest(self.to_json)
     end
   end
 end

data/lib/json_api_resource/clientable.rb

@@ -0,0 +1,16 @@
+module JsonApiResource
+  module Clientable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :client_class
+      self.client_class = nil
+
+      class << self
+        def wraps(client)
+          self.client_class = client
+        end
+      end
+    end
+  end
+end

data/lib/json_api_resource/conversions.rb

@@ -1,23 +1,12 @@
 module JsonApiResource
   module Conversions
-    def Address(*args)
-      case args.first
-        when Address then args.first
-        when Hash then Address.new(args.first)
-        when Address.client then Address.new(args.first.attributes)
-        when Array then args.first.map { |attr| Address(attr) }
-        when Integer then Address.new(* args)
-        when String then Address.new(* args.first.split(':'). map(&:to_i))
-        else raise TypeError, "Cannot convert #{ args.inspect} to Address"
-      end
-    end
-
     def ApiErrors(*args)
       case args.first
         when ActiveModel::Errors then args.first
         when Hash then args.first
         when Array then { base: args }
         when String then { base: [args] }
+        when NilClass then { base: [[]]}
         else raise TypeError, "Cannot convert #{ args.inspect} to Error"
       end
     end
@@ -55,19 +44,12 @@ module JsonApiResource
       end
     end
 
-    def Symbolize(*args)
-      case args.first
-        when String then args.first.underscore.parameterize('_').to_sym
-        else args.first
-      end
-    end
-
     def ApiResource(klass, *args)
       case args.first
         when klass then args.first
         when Hash then klass.new(args.first)
-        when klass.client then klass.new(args.first.attributes)
-        when Array then args.first.map { |attr| JsonApiResource(attr, klass) }
+        when klass.client_class then klass.new(args.first.attributes)
+        when Array then args.first.map { |attr| ApiResource(klass, attr) }
         else raise TypeError, "Cannot convert #{ args.inspect} to #{klass}"
       end
     end

data/lib/json_api_resource/handlers/find_handler.rb

@@ -0,0 +1,15 @@
+module JsonApiResource
+  module Handlers
+    class FindHandler
+      attr_accessor :result
+
+      def initialize(results)
+        self.result = results.first
+
+        self.result.meta = results.meta
+
+        self.result.linked_data = results.try(:linked_data)
+      end
+    end
+  end
+end

data/lib/json_api_resource/handlers.rb

@@ -0,0 +1,5 @@
+module JsonApiResource
+  module Handlers
+    autoload :FindHandler,  'json_api_resource/handlers/find_handler'
+  end
+end

data/lib/json_api_resource/json_api_resource_error.rb

@@ -0,0 +1,12 @@
+module JsonApiResource
+  class JsonApiResourceError < StandardError
+    def initialize(opts = {})
+      @klass    = opts.fetch :class, JsonApiResource::Resource
+      @message  = opts.fetch :message, ""
+    end
+
+    def message
+      "#{@klass}: #{@message}"
+    end
+  end
+end

data/lib/json_api_resource/queryable.rb

@@ -2,91 +2,48 @@ module JsonApiResource
   module Queryable
     extend ActiveSupport::Concern
 
-    attr_accessor :meta
-    attr_accessor :linked_data
-    attr_accessor :errors
+    included do
 
-    MAX_PAGES_FOR_ALL = 25
+      define_model_callbacks :save, :update_attributes
 
-    module ClassMethods
+      around_save   :catch_errors
+      around_update_attributes :catch_errors
 
-      include JsonApiResource::Conversions
+      class << self
 
-      def find(id)
-        return nil unless id.present?
-        results = self.client_klass.find(id).map! do |result|
-          self.new(:client => result)
-        end
-        results.size == 1 ? single_result(results) : results
-      rescue JsonApiClient::Errors::ServerError => e
-        pretty_error e
-      end
+        MAX_PAGES_FOR_ALL = 25
 
-      def create(attr = {})
-        new(:client => self.client_klass.create(attr)).save
-      end
+        def find(id)
+          return nil unless id.present?
 
-      def where(opts = {})
-        opts[:per_page] = opts.fetch(:per_page, self.per_page) if self.per_page
-        (self.client_klass.where(opts).all).map! do |result|
-          self.new(:client => result)
+          results = request(:find, id: id)
+          JsonApiResource::Handlers::FindHandler.new(results).result # <= <#JsonApiclient::ResultSet @errors => <...>, @data => <...>, @linked_data => <...>>
         end
-      rescue JsonApiClient::Errors::ServerError => e
-        pretty_error e
-      end
 
-      def all_without_pagination(opts = {})
-        page_total = 1
-        current_page = 1
-        all_results = []
-        until (current_page > page_total) || (current_page > MAX_PAGES_FOR_ALL)
-          page_of_results = where({:page => current_page}.merge(opts))
-          all_results << page_of_results
-          page_total = page_of_results.meta[:total_pages] || 1
-          current_page = current_page + 1
+        def where(opts = {})
+          opts[:per_page] = opts.fetch(:per_page, self.per_page)
+          request(:where, opts)
         end
-        JsonApiClient::ResultSet.new(all_results.flatten.compact)
       end
 
-      private
-
-      # When we return a collection, these extra attributes on top of the result array from JsonApiClient are present.
-      # When we find just one thing and return the first element like ActiveRecord would,
-      # we lose these things.  We want them, so we will assign them to this object.
-      def single_result(results)
-        result = results.first
-
-        result.meta = results.meta
-
-        result.linked_data = results.linked_data if results.respond_to? :linked_data
-
-        return result
+      
+      def save
+        request :save
       end
 
-      def pretty_error(e)
-        case e.class.to_s
-
-        when 'JsonApiClient::Errors::NotFound'
-          error_response 404, { name: "RecordNotFound", message: e.message }
-
-        when 'JsonApiClient::Errors::UnexpectedStatus'
-          error_response e.code, { name: "UnexpectedStatus", message: e.message }
-
-        else
-          error_response 500, { name: "ServerError", message: e.message }
-        end
+      def update_attributes(attrs = {})
+        request :update_attributes, attrs
       end
 
-      def error_response(status, error)
-        result = JsonApiClient::ResultSet.new
+      def catch_errors
+        yield
 
-        result.meta = {status: status}
-
-        result.errors = ActiveModel::Errors.new(result)
-        result.errors.add(error[:name], Array(error[:message]).join(', '))
-
-        result
+        self.errors ||= ActiveModel::Errors.new(self)
+        ApiErrors(self.client.errors).each do | k,messages|
+          self.errors.add(k.to_sym, Array(messages).join(', '))
+        end
+        self.errors
       end
     end
   end
-end
+end

data/lib/json_api_resource/requestable.rb

@@ -0,0 +1,72 @@
+module JsonApiResource
+  module Requestable
+    extend ActiveModel::Callbacks
+    extend ActiveSupport::Concern
+    extend ActiveSupport::Callbacks
+
+    included do
+      def request(action, *args)
+        run_callbacks action do
+          self.client.send(action, *args)
+        end
+        self
+
+      rescue JsonApiClient::Errors::ServerError => e
+        add_error e
+      end
+
+      class << self
+        def request(action, *args)
+          result = self.client_class.send(action, *args)
+          
+          result = result.all if result.is_a? JsonApiClient::Scope
+          
+          JsonApiClient::ResultSet.new(
+            result.map do |result|
+              new(client: result)
+            end
+          )
+        rescue JsonApiClient::Errors::ServerError => e
+          empty_set_with_errors e
+        end
+
+        def empty_set_with_errors(e)
+          append_errors e do |status, error|
+            error_response status, error
+          end
+        end
+
+        def append_errors(e, &block)
+          case e.class.to_s
+
+          when "JsonApiClient::Errors::NotFound"
+            yield 404, { name: "RecordNotFound", message: e.message }
+
+          when "JsonApiClient::Errors::UnexpectedStatus"
+            yield e.code, { name: "UnexpectedStatus", message: e.message }
+
+          else
+            yield 500, { name: "ServerError", message: e.message }
+          end
+        end
+
+        def error_response(status, error)
+          result = JsonApiClient::ResultSet.new
+
+          result.meta = {status: status}
+
+          result.errors = ActiveModel::Errors.new(result)
+          result.errors.add(error[:name], Array(error[:message]).join(', '))
+
+          result
+        end
+      end
+
+      def add_error(e, &block)
+        self.class.append_errors e do |status, error|
+          errors.add error[:name], error[:message]
+        end
+      end
+    end
+  end
+end

data/lib/json_api_resource/resource.rb

@@ -1,24 +1,37 @@
+require 'active_support'
+require 'active_support/callbacks'
+require 'active_support/concern'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/class/attribute'
+require 'active_model'
+require 'active_model/model'
+require 'active_model/validations'
+require 'active_model/callbacks'
+
 module JsonApiResource
   class Resource
     include ActiveModel::Model
     include ActiveModel::Validations
     extend  ActiveModel::Callbacks
 
+    extend ActiveSupport::Callbacks
+
+    include JsonApiResource::Clientable
     include JsonApiResource::Schemable
     include JsonApiResource::Queryable
+    include JsonApiResource::Requestable
     include JsonApiResource::Conversions
     include JsonApiResource::Cacheable
 
     attr_accessor :client, :cache_expires_in
-    class_attribute :client_klass, :per_page
-
-    define_model_callbacks :save, :update_attributes
+    class_attribute :per_page
 
-    around_save :update_meta
-    around_update_attributes :update_meta
+    delegate :to_json, to: :attributes
 
     def initialize(opts={})
-      self.client = self.client_klass.new(self.schema)
+      raise( JsonApiResourceError, class: self.class, message: "A resource must have a client class" ) unless client_class.present?
+
+      self.client = self.client_class.new(self.schema)
       self.errors = ActiveModel::Errors.new(self)
       self.attributes = opts
     end
@@ -31,25 +44,9 @@ module JsonApiResource
       !new_record?
     end
 
-    def save
-      run_callbacks :save do
-        self.client.save
-      end
-    rescue JsonApiClient::Errors::ServerError => e
-      pretty_error e
-    end
-
-    def update_attributes(attrs = {})
-      run_callbacks :update_attributes do
-        self.client.update_attributes(attrs)
-      end
-    rescue JsonApiClient::Errors::ServerError => e
-      pretty_error e
-    end
-
     def attributes=(attr = {})
       client_params = attr.delete(:client)
-      if attr.is_a? self.client_klass
+      if attr.is_a? self.client_class
         self.client = attr
       elsif client_params
         self.client = client_params
@@ -62,55 +59,41 @@ module JsonApiResource
 
     def method_missing(method, *args, &block)
       if match = method.to_s.match(/^(.*=)$/)
-        self.client.send(match[1], args.first)
+        self.client.send(match[0], args.first)
       elsif self.client.respond_to?(method.to_sym)
-        is_method = self.client.methods.include?(method.to_sym)
-        argument_count = (is_method ? self.client.method(method.to_sym).arity : 0)
-        argument_count = args.length if argument_count == -1
-        if (argument_count == 0) || args.blank?
-          self.client.send(method)
-        else
-          self.client.send(method, *args.take(argument_count))
-        end
+        self.client.send(method, *args)
       else
         super
       end
 
     rescue JsonApiClient::Errors::ServerError => e
-      pretty_error e
-    end
-
-    def update_meta
-      yield
-
-      self.errors ||= ActiveModel::Errors.new(self)
-      ApiErrors(self.client.errors).each do | k,messages|
-        self.errors.add(k.to_sym, Array(messages).join(', '))
-      end
-      self.errors
-
-      self.meta = self.client.last_request_meta
+      add_error e
+    rescue ArgumentError => e
+      raise JsonApiResourceError, class: self.class, message: "#{method}: #{e.message}"
     end
 
     def self.method_missing(method, *args, &block)
       if match = method.to_s.match(/^(.*)=$/)
-        self.client_klass.send(match[1], args.first)
-      
-      elsif self.client_klass.respond_to?(method.to_sym)
-        results = self.client_klass.send(method, *args)
+        self.client_class.send(match[0], args.first)
+       
+      elsif self.client_class.respond_to?(method.to_sym)
+        results = self.client_class.send(method, *args)
 
         if results.is_a? JsonApiClient::ResultSet
-          results.map! do |result|
+          results = results.map do |result|
             self.new(:client => result)
           end
         end
+
         results
+
       else
         super
       end
-
     rescue JsonApiClient::Errors::ServerError => e
-      pretty_error e
+      empty_set_with_errors e
+    rescue ArgumentError => e
+      raise JsonApiResourceError, class: self, message: "#{method}: #{e.message}"
     end
 
     def respond_to_missing?(method_name, include_private = false)
@@ -118,7 +101,7 @@ module JsonApiResource
     end
 
     def self.respond_to_missing?(method_name, include_private = false)
-      client_klass.respond_to?(method_name.to_sym) || super
+      client_class.respond_to?(method_name.to_sym) || super
     end
   end
 end

data/lib/json_api_resource/schemable.rb

@@ -6,21 +6,19 @@ module JsonApiResource
     included do
       class_attribute :schema
       self.schema = {}
-    end
+      
+      class << self
+        def properties(opts = {})
+          self.schema = schema.dup
+          opts.each_pair do |name, default|
+            property name, default
+          end
+        end
 
-    module ClassMethods
-      def property(opts = {})
-        opts.each do |attr_name,default|
-          self.schema[attr_name.to_sym] = default || nil
+        def property(name, default = nil)
+          self.schema = schema.merge name.to_sym => default
         end
       end
     end
-
-    protected
-
-    def load_schema
-      self.client = self.client_klass.new(self.schema)
-    end
-
   end
 end

data/lib/json_api_resource/version.rb

@@ -1,3 +1,3 @@
 module JsonApiResource
-  VERSION = "0.4.9"
+  VERSION = "1.0.0"
 end

data/lib/json_api_resource.rb

@@ -1,9 +1,13 @@
 require 'json_api_client'
 
 module JsonApiResource
-  autoload :Conversions,  'json_api_resource/conversions'
-  autoload :Queryable,    'json_api_resource/queryable'
-  autoload :Schemable,    'json_api_resource/schemable'
-  autoload :Resource,     'json_api_resource/resource'
-  autoload :Cacheable,    'json_api_resource/cacheable'
+  autoload :Cacheable,              'json_api_resource/cacheable'
+  autoload :Clientable,             'json_api_resource/clientable'
+  autoload :Conversions,            'json_api_resource/conversions'
+  autoload :Handlers,               'json_api_resource/handlers'
+  autoload :JsonApiResourceError,   'json_api_resource/json_api_resource_error'
+  autoload :Queryable,              'json_api_resource/queryable'
+  autoload :Resource,               'json_api_resource/resource'
+  autoload :Requestable,            'json_api_resource/requestable'
+  autoload :Schemable,              'json_api_resource/schemable'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_resource
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Brandon Sislow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-13 00:00:00.000000000 Z
+date: 2016-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -63,12 +91,17 @@ files:
 - Rakefile
 - lib/json_api_resource.rb
 - lib/json_api_resource/cacheable.rb
+- lib/json_api_resource/clientable.rb
 - lib/json_api_resource/conversions.rb
+- lib/json_api_resource/handlers.rb
+- lib/json_api_resource/handlers/find_handler.rb
+- lib/json_api_resource/json_api_resource_error.rb
 - lib/json_api_resource/queryable.rb
+- lib/json_api_resource/requestable.rb
 - lib/json_api_resource/resource.rb
 - lib/json_api_resource/schemable.rb
 - lib/json_api_resource/version.rb
-homepage: http://gitlab.corp.avvo.com/api/api_resource
+homepage: https://github.com/avvo/json_api_resource
 licenses:
 - MIT
 metadata: {}
@@ -88,8 +121,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Build wrapper/adapter objects around JsonApiClient instances
 test_files: []
+has_rdoc: