json_api_client 1.14.1 → 1.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3cabb055324f7f141ea20203dfc7204239c9c7e293310d53ac3b484e7a33d28
-  data.tar.gz: 18a958aab13cfef3ed8f199109ce0650ee0d56a1018fc6312052468c7b4c72fd
+  metadata.gz: 0177efb037e8cf64cb3dae65d29ff7dcadb09de9ea502f722da0086db4b7faab
+  data.tar.gz: 71650f09239773eea01bafdc8bc2527ec2f6b6142f268dfe6cba3deccd4bb4a9
 SHA512:
-  metadata.gz: 8d43ff4ac90ceab7b7e60bc32a160e09193931f5a69c0bc238db77db2309c2bc8423a13a055c9134c92d9ce947869a52c943d751771259b39aa6d8c266094c23
-  data.tar.gz: 5e2df37ed5bb8181007d48304db2f514912a77d407b0b54e7f8ff0dce447fc1db4095134a04449d5c9e8962e300d945232e5c67263dc762512eb948c2ef2b7b5
+  metadata.gz: e8d4cde22354f51620a16bbc7b05f7e81a77aaf5a664731af6603d71be81139cafeede497e0f0be539f8d4ecc8b53b83bf01c71fa966ada1fc0904f499baa780
+  data.tar.gz: 0d640bae03a241523468eb1a4d11b2073a65b3fad000d066203ea1ce79c6765700d9a303fda8c1049c25c4fab9d750084bacac97300f6398172b11b0a064fa06

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/query/requestor.rb

@@ -10,17 +10,21 @@ module JsonApiClient
 
       # expects a record
       def create(record)
-        request(:post, klass.path(record.path_attributes), {
-            body: { data: record.as_json_api },
-            params: record.request_params.to_params
-        })
+        request(
+          :post,
+          klass.path(record.path_attributes),
+          body: { data: record.as_json_api },
+          params: record.request_params.to_params
+        )
       end
 
       def update(record)
-        request(:patch, resource_path(record.path_attributes), {
-            body: { data: record.as_json_api },
-            params: record.request_params.to_params
-        })
+        request(
+          :patch,
+          resource_path(record.path_attributes),
+          body: { data: record.as_json_api },
+          params: record.request_params.to_params
+        )
       end
 
       def get(params = {})

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/schema.rb

@@ -29,7 +29,7 @@ module JsonApiClient
 
       class Decimal
         def self.cast(value, _)
-          BigDecimal.new(value)
+          BigDecimal(value)
         end
       end
 

data/lib/json_api_client/version.rb

@@ -1,3 +1,3 @@
 module JsonApiClient
-  VERSION = "1.14.1"
+  VERSION = "1.17.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.17.1
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-23 00:00:00.000000000 Z
+date: 2020-09-09 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