json_api_client 1.14.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 773e22610a90abf268c451e50ada8927f36b4f2f
-  data.tar.gz: c4368d2ba6de322219b0bba049c8f0bfff6b1344
+SHA256:
+  metadata.gz: dcb3e63c09c75358b9d182615b3b895fbd045f9e86e1bf43c0890afbdc256dc2
+  data.tar.gz: 68cb03b8cf7f9e7e9041ee410578dc2b9a1e07ea9eb63ae9606ff4bf34c1ca20
 SHA512:
-  metadata.gz: ae9da8c252d702468da498869c2ef9e0fe0e43731d2fb9f334c519e316081963595f733ad9d2dd070d840a09f0f26afa0eaf68550c8d98b643b5c22a3b42a45c
-  data.tar.gz: f152f2d5d903527f3744e47268e826499f5395e6941bcd421760416f3d78c862a2e845b7cbab599b6ccf3ceb31dfdd6e419a8c1d2706d8c55b04fffe9b209448
+  metadata.gz: 440f012b8cb173af6a577a5d46aac0cfac4c6e6cb9f281e1760353db09e86d0f48900531b1ac9b58e785ea3627d79870f1b9862c40deeac229116e4413bb86e4
+  data.tar.gz: 19d2186f54fa0a91787d6e258d556622c9b57c2374fbb98c21956ffe5a9d32592fbf352ebd8a466657a3063c1ab29443bde2841669e15e9834a6ae921a433673

data/README.md

@@ -166,8 +166,8 @@ module MyApi
   end
 
   class Customer < JsonApiClient::Resource
-      belongs_to :user, shallow_path: true
-    end
+    belongs_to :user, shallow_path: true
+  end
 end
 
 # try to find without the nested parameter

data/lib/json_api_client.rb

@@ -2,6 +2,7 @@ require 'faraday'
 require 'faraday_middleware'
 require 'json'
 require 'addressable/uri'
+require 'json_api_client/formatter'
 
 module JsonApiClient
   autoload :Associations, 'json_api_client/associations'
@@ -9,7 +10,6 @@ module JsonApiClient
   autoload :Connection, 'json_api_client/connection'
   autoload :Errors, 'json_api_client/errors'
   autoload :ErrorCollector, 'json_api_client/error_collector'
-  autoload :Formatter, 'json_api_client/formatter'
   autoload :Helpers, 'json_api_client/helpers'
   autoload :Implementation, 'json_api_client/implementation'
   autoload :IncludedData, 'json_api_client/included_data'

data/lib/json_api_client/connection.rb

@@ -14,6 +14,7 @@ module JsonApiClient
         builder.use Middleware::JsonRequest
         builder.use Middleware::Status, status_middleware_options
         builder.use Middleware::ParseJson
+        builder.use ::FaradayMiddleware::Gzip
         builder.adapter(*adapter_options)
       end
       yield(self) if block_given?

data/lib/json_api_client/errors.rb

@@ -32,6 +32,12 @@ module JsonApiClient
     class ClientError < ApiError
     end
 
+    class ResourceImmutableError < StandardError
+      def initialize(msg = 'Resource immutable')
+        super msg
+      end
+    end
+
     class AccessDenied < ClientError
     end
 

data/lib/json_api_client/included_data.rb

@@ -36,9 +36,7 @@ module JsonApiClient
 
       if data.is_a?(Array)
         # has_many link
-        data.map do |link_def|
-          record_for(link_def)
-        end
+        data.map(&method(:record_for)).compact
       else
         # has_one link
         record_for(data)
@@ -53,7 +51,8 @@ module JsonApiClient
 
     # should return a resource record of some type for this linked document
     def record_for(link_def)
-      data[link_def["type"]][link_def["id"]]
+      record = data[link_def["type"]]
+      record[link_def["id"]] if record
     end
   end
 end

data/lib/json_api_client/resource.rb

@@ -40,6 +40,11 @@ module JsonApiClient
                     instance_accessor: false
     class_attribute :add_defaults_to_changes,
                     instance_writer: false
+
+    class_attribute :_immutable,
+                    instance_writer: false,
+                    default: false
+
     self.primary_key          = :id
     self.parser               = Parsers::Parser
     self.paginator            = Paginating::Paginator
@@ -94,6 +99,19 @@ module JsonApiClient
         table_name
       end
 
+      # Indicates whether this resource is mutable or immutable;
+      # by default, all resources are mutable.
+      #
+      # @return [Boolean]
+      def immutable(flag = true)
+        self._immutable = flag
+      end
+
+      def inherited(subclass)
+        subclass._immutable = false
+        super
+      end
+
       # Specifies the relative path that should be used for this resource;
       # by default, this is inferred from the resource class name.
       #
@@ -215,6 +233,11 @@ module JsonApiClient
       # @option [Symbol] :on One of [:collection or :member] to decide whether it's a collect or member method
       # @option [Symbol] :request_method The request method (:get, :post, etc)
       def custom_endpoint(name, options = {})
+        if _immutable
+          request_method = options.fetch(:request_method, :get).to_sym
+          raise JsonApiClient::Errors::ResourceImmutableError if request_method != :get
+        end
+
         if :collection == options.delete(:on)
           collection_endpoint(name, options)
         else
@@ -440,6 +463,7 @@ module JsonApiClient
     # @return [Boolean] Whether or not the save succeeded
     def save
       return false unless valid?
+      raise JsonApiClient::Errors::ResourceImmutableError if _immutable
 
       self.last_result_set = if persisted?
         self.class.requestor.update(self)
@@ -470,6 +494,8 @@ module JsonApiClient
     #
     # @return [Boolean] Whether or not the destroy succeeded
     def destroy
+      raise JsonApiClient::Errors::ResourceImmutableError if _immutable
+
       self.last_result_set = self.class.requestor.destroy(self)
       if last_result_set.has_errors?
         fill_errors

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.14.0"
+  VERSION = "1.17.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,36 +28,42 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.15'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.15.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -199,8 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Build client libraries compliant with specification defined by jsonapi.org