json_api_client 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ed66b4d235079e662896ac7076427c21c716706c
-  data.tar.gz: c70ff83b6e97b0671d584e68fc6958b41bd75246
+  metadata.gz: 26efa266b2d3eb7d2b504738b19392474c832b02
+  data.tar.gz: 5b60463dae1806e7318298cbd58ab5ce968453ae
 SHA512:
-  metadata.gz: 57f163489d42ceff20dc4ab15de433c5d30af28daa0332d9bef2a990dc398de3b92d9f8b2d1e6b947943d88f8b031b533bb55fcfb406f79fde020d1b1517e42d
-  data.tar.gz: 5b431c9c1e10f1197bff2558d776f92ff9ecec69cb484a6c603e07d47ef1ae03bc00a2511b9f7849a17d7ba5e9fb85617ed72fe82ace564a78ec9fdbb9a641f5
+  metadata.gz: 5830accd29e4821e85a32c0d39e650cc6603882a0022f9fe8cb633ec60c3efc030cc36d6d11d931ffd10cf38b4272ff3bac3184ca1547f81fe53b8071f92bbec
+  data.tar.gz: 487d5411c3f399a737b72c0ff007076f71e92ab84b93fca19a9d3e54f9b345082358e9b98340ed7a5bfdd543f994ee4bac5be37759ace8ded75d74824b177e21

data/README.md

@@ -474,6 +474,44 @@ module MyApi
 end
 ```
 
+##### Custom status handler
+
+You can change handling of response status using `connection_options`. For example you can override 400 status handling. 
+By default it raises `JsonApiClient::Errors::ClientError` but you can skip exception if you want to process errors from the server.
+You need to provide a `proc` which should call `throw(:handled)` default handler for this status should be skipped.
+```ruby
+class ApiBadRequestHandler
+  def self.call(_env)
+    # do not raise exception
+  end
+end
+
+class CustomUnauthorizedError < StandardError
+  attr_reader :env
+
+  def initialize(env)
+    @env = env
+    super('not authorized')
+  end
+end
+
+MyApi::Base.connection_options[:status_handlers] = {
+    400 => ApiBadRequestHandler,
+    401 => ->(env) { raise CustomUnauthorizedError, env }
+}
+
+module MyApi
+  class User < Base
+    # will use the customized status_handlers
+  end
+end
+
+user = MyApi::User.create(name: 'foo')
+# server responds with { errors: [ { detail: 'bad request' } ] }
+user.errors.messages # { base: ['bad request'] }
+# on 401 it will raise CustomUnauthorizedError instead of JsonApiClient::Errors::NotAuthorized
+```
+
 ##### Specifying an HTTP Proxy
 
 All resources have a class method ```connection_options``` used to pass options to the JsonApiClient::Connection initializer.
@@ -553,6 +591,22 @@ class MyApi::Base < JsonApiClient::Resource
 end
 ```
 
+### Custom type
+
+If your model must be named differently from classified type of resource you can easily customize it.
+It will work both for defined and not defined relationships
+
+```ruby
+class MyApi::Base < JsonApiClient::Resource
+  resolve_custom_type 'document--files', 'File'
+end
+
+class MyApi::File < MyApi::Base
+  def self.resource_name
+    'document--files'
+  end
+end
+```
 
 ### Type Casting
 

data/lib/json_api_client/connection.rb

@@ -7,10 +7,12 @@ module JsonApiClient
       site = options.fetch(:site)
       connection_options = options.slice(:proxy, :ssl, :request, :headers, :params)
       adapter_options = Array(options.fetch(:adapter, Faraday.default_adapter))
+      status_middleware_options = {}
+      status_middleware_options[:custom_handlers] = options[:status_handlers] if options[:status_handlers].present?
       @faraday = Faraday.new(site, connection_options) do |builder|
         builder.request :json
         builder.use Middleware::JsonRequest
-        builder.use Middleware::Status
+        builder.use Middleware::Status, status_middleware_options
         builder.use Middleware::ParseJson
         builder.adapter(*adapter_options)
       end

data/lib/json_api_client/helpers/dirty.rb

@@ -18,6 +18,10 @@ module JsonApiClient
         @changed_attributes = ActiveSupport::HashWithIndifferentAccess.new
       end
 
+      def forget_change!(attr)
+        @changed_attributes.delete(attr.to_s)
+      end
+
       def set_all_attributes_dirty
         attributes.each do |k, v|
           set_attribute_was(k, v)
@@ -68,4 +72,4 @@ module JsonApiClient
 
     end
   end
-end
+end

data/lib/json_api_client/middleware/status.rb

@@ -1,6 +1,11 @@
 module JsonApiClient
   module Middleware
     class Status < Faraday::Middleware
+      def initialize(app, options)
+        super(app)
+        @options = options
+      end
+
       def call(environment)
         @app.call(environment).on_complete do |env|
           handle_status(env[:status], env)
@@ -15,9 +20,16 @@ module JsonApiClient
         raise Errors::ConnectionError.new environment, e.to_s
       end
 
-      protected
+      private
+
+      def custom_handler_for(code)
+        @options.fetch(:custom_handlers, {})[code]
+      end
 
       def handle_status(code, env)
+        custom_handler = custom_handler_for(code)
+        return custom_handler.call(env) if custom_handler.present?
+
         case code
         when 200..399
         when 401

data/lib/json_api_client/resource.rb

@@ -35,6 +35,7 @@ module JsonApiClient
                     :request_params_class,
                     :keep_request_params,
                     :search_included_in_result_set,
+                    :custom_type_to_class,
                     instance_accessor: false
     class_attribute :add_defaults_to_changes,
                     instance_writer: false
@@ -52,6 +53,7 @@ module JsonApiClient
     self.keep_request_params = false
     self.add_defaults_to_changes = false
     self.search_included_in_result_set = false
+    self.custom_type_to_class = {}
 
     #:underscored_key, :camelized_key, :dasherized_key, or custom
     self.json_key_format = :underscored_key
@@ -63,6 +65,11 @@ module JsonApiClient
       extend Forwardable
       def_delegators :_new_scope, :where, :order, :includes, :select, :all, :paginate, :page, :with_params, :first, :find, :last
 
+      def resolve_custom_type(type_name, class_name)
+        classified_type = key_formatter.unformat(type_name.to_s).singularize.classify
+        self.custom_type_to_class = custom_type_to_class.merge(classified_type => class_name.to_s)
+      end
+
       # The table name for this resource. i.e. Article -> articles, Person -> people
       #
       # @return [String] The table name for this resource
@@ -322,6 +329,7 @@ module JsonApiClient
       self.links = self.class.linker.new(params.delete(:links) || {})
       self.relationships = self.class.relationship_linker.new(self.class, params.delete(:relationships) || {})
       self.attributes = self.class.default_attributes.merge params.except(*self.class.prefix_params)
+      self.forget_change!(:type)
       self.__belongs_to_params = params.slice(*self.class.prefix_params)
 
       setup_default_properties
@@ -394,7 +402,7 @@ module JsonApiClient
     #
     # @return [Hash] Representation of this object as JSONAPI object
     def as_json_api(*)
-      attributes.slice(:id, :type).tap do |h|
+      attributes.slice(self.class.primary_key, :type).tap do |h|
         relationships_for_serialization.tap do |r|
           h[:relationships] = self.class.key_formatter.format_keys(r) unless r.empty?
         end
@@ -403,11 +411,11 @@ module JsonApiClient
     end
 
     def as_json(*)
-      attributes.slice(:id, :type).tap do |h|
+      attributes.slice(self.class.primary_key, :type).tap do |h|
         relationships.as_json.tap do |r|
           h[:relationships] = r unless r.empty?
         end
-        h[:attributes] = attributes.except(:id, :type).as_json
+        h[:attributes] = attributes.except(self.class.primary_key, :type).as_json
       end
     end
 
@@ -504,7 +512,7 @@ module JsonApiClient
     end
 
     def path_attributes
-      _belongs_to_params.merge attributes.slice('id').symbolize_keys
+      _belongs_to_params.merge attributes.slice( self.class.primary_key ).symbolize_keys
     end
 
     protected

data/lib/json_api_client/utils.rb

@@ -2,6 +2,7 @@ module JsonApiClient
   module Utils
 
     def self.compute_type(klass, type_name)
+      return klass.custom_type_to_class.fetch(type_name).constantize if klass.custom_type_to_class.key?(type_name)
       # If the type is prefixed with a scope operator then we assume that
       # the type_name is an absolute reference.
       return type_name.constantize if type_name.match(/^::/)

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.8.0"
+  VERSION = "1.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-23 00:00:00.000000000 Z
+date: 2019-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport