json_api_client 1.15.0 → 1.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17005bc88ac7813f9492d669c5eb8ffe2e8f80ca600455f4d563d6d06363f902
-  data.tar.gz: 150b21556d5a33bea2d9b5d2b12999c5298cf4157bea34869b57324cab94416d
+  metadata.gz: c2f418d635feea4fc9b991da8be35ea33b733df916ef538651ed55abd9a8b2f1
+  data.tar.gz: 235060b6cb7f46e32b75dc2a9886dc7036e55793d13beb029a33546c01d6149e
 SHA512:
-  metadata.gz: dffeb3fe0e26ea1984a119b19d5d6cd8b97c5c4179e9b02507e21882157f5f595ef71b16d39b977ece158a79fe9ea92b58f386cc71caa61104b6e5832740385a
-  data.tar.gz: 2a794b74f9ffe077070b3485fe4eea40066a139eed7e2ce07ae97504df7a7ddb01154a02efdbe0509db6dc67f775b11aa72b477f8a7817bc8cb3cb5d1242d623
+  metadata.gz: d48e62663797fd41a0f00ff6e8261507db876a5cbbe0ba5f8bfff612114efc1557d1d77be32cb0f72af22769f9a7ed0880b8ba8dd5abb4d2ab258c349c1bd76d
+  data.tar.gz: 8291a372f23cc056a1745eec724c540b666c3e1b87b2f7777d787063c406caffe9e7efceab5dcdbda25c39e4817289fcd110cba1925ba81ad0401a36dff63098

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/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,18 @@ 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
+      end
+
       # Specifies the relative path that should be used for this resource;
       # by default, this is inferred from the resource class name.
       #
@@ -215,6 +232,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 +462,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 +493,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.15.0"
+  VERSION = "1.16.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_client
 version: !ruby/object:Gem::Version
-  version: 1.15.0
+  version: 1.16.0
 platform: ruby
 authors:
 - Jeff Ching
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-29 00:00:00.000000000 Z
+date: 2019-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport