flexirest 1.10.0 → 1.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f713d7d9f8f37de42e54bd20623b4477b9893b6cd40f0d2d5e8c5a06079a821
-  data.tar.gz: b5fc1fe7bffbe57a6adf9443aab86d91313fddd90b2fcc2ef35f50f2b41ec942
+  metadata.gz: 89ef0bd6a927d830d9f98f1e4deeee8d26bf68a203a001f2299785386e1365b9
+  data.tar.gz: 3fa35c87cb16df1181207a6393682c6ec003346b4789d8bff30bbedbdba0e753
 SHA512:
-  metadata.gz: eedfb75a0ecacbb1114d62fad201cf5e478242dd74126b87b29f1081e9c56b4194b600c6d729ac8afa70a7dd4ee8d66a03057974a2e52ee76f575e848027bfca
-  data.tar.gz: 955f229836e2e6fbc6273b1505294619ab0a614af05e79d0e5113b956959dbf22bb76ed23b2a169a9dafe207b6ab48b3559f7adeb84f22e3fcff01fbc223b28f
+  metadata.gz: 520a9f3131d517c00180dd15a9fbd8c03372343bde13474457a37db78b321efa54a756878bd5161253ab6646a6e6ffc24171a3f69fca043c14cfb49630cf7ef8
+  data.tar.gz: 5580fe4c1079b03fb51465550afce7ca4a542051efbd127df0405d113d47955182d88cfc324ff184a36be7eee0d4eaab5fad85efe47f94d5163846aad952df6d

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.10.1
+
+Enhancement:
+
+- Nested objects now report their dirty/changed status up to the parent (thanks to Matthias Hähnel for the bug report)
+
 ## 1.10.0
 
 Enhancement:

data/docs/using-callbacks.md

@@ -66,6 +66,7 @@ After callbacks work in exactly the same way:
 ```ruby
 class Person < Flexirest::Base
   get :all, "/people"
+  get :all, "/people"
 
   after_request :fix_empty_content
   after_request :cache_all_people
@@ -88,6 +89,32 @@ end
 
 **Note:** since v1.3.21 the empty response trick above isn't necessary, empty responses for 204 are accepted normally (the method returns `true`), but this is here to show an example of an `after_request` callback adjusting the body. The `cache_all_people` example shows how to cache a response even if the server doesn't send the correct headers.
 
+If you manually set caching responses like the above, you may want to invalidate that cache when you make a create, update, delete etc request for the resource, for example:
+
+```ruby
+class Animal < Flexirest::Base
+  after_request :cache
+  before_request :cache_cleanup
+
+  get :get, '/animals/:id'
+  post :update, '/animals/:id'
+  delete :delete, '/animals/:id'
+
+  def cache_cleanup(name, request)
+    if name == :update || name == :delete
+      Flexirest::Logger.info("  \033[1;4;32m#{Flexirest.name}\033[0m Invalidating cache for #{self.class.name} #{request.url}")
+      Rails.cache.delete("#{self.class.name}:#{request.url}")
+    end
+  end
+
+  def cache(name, response)
+    if name == :get
+      response.response_headers["Expires"] = 1.hour.from_now.iso8601
+    end
+  end
+end
+```
+
 If you want to trap an error in an `after_request` callback and retry the request, this can be done - but retries will only happen once for each request (so we'd recommend checking all conditions in a single `after_request` and then retrying after fixing them all). You achieve this by raising a `Flexirest::CallbackRetryRequestException` from the callback.
 
 ```ruby
@@ -100,7 +127,7 @@ class Person < Flexirest::Base
 
   def fix_invalid_request(name, response)
     if response.status == 401
-      # Do something to fix the state of caches/variables used in the 
+      # Do something to fix the state of caches/variables used in the
       # before_request, etc
       raise Flexirest::CallbackRetryRequestException.new
     end

data/lib/flexirest/base_without_validation.rb

@@ -11,6 +11,8 @@ module Flexirest
     attr_accessor :_status
     attr_accessor :_etag
     attr_accessor :_headers
+    attr_accessor :_parent
+    attr_accessor :_parent_attribute_name
 
     instance_methods.each do |m|
       next unless %w{display presence load require untrust trust freeze method enable_warnings with_warnings suppress capture silence quietly debugger breakpoint}.map(&:to_sym).include? m
@@ -41,6 +43,13 @@ module Flexirest
     def _copy_from(result)
       @attributes = result._attributes
       @_status = result._status
+      self._parent = result._parent
+      self._parent_attribute_name = result._parent_attribute_name
+      @attributes.each do |k,v|
+        if v.respond_to?(:_parent) && v._parent.present?
+          @attributes[k]._parent = self
+        end
+      end
       _clean!
     end
 
@@ -184,6 +193,10 @@ module Flexirest
       output.to_json
     end
 
+    def _set_dirty(key)
+      @dirty_attributes[key.to_sym] = true
+    end
+
     private
 
     def _set_attribute(key, value)
@@ -191,6 +204,9 @@ module Flexirest
       old_value = @attributes[key.to_sym] unless old_value
       old_value = old_value[0] if old_value and old_value.is_a? Array
       @dirty_attributes[key.to_sym] = [old_value, value] if old_value != value
+      if _parent
+        _parent._set_dirty(_parent_attribute_name)
+      end
       @attributes[key.to_sym] = value
     end
 

data/lib/flexirest/lazy_association_loader.rb

@@ -94,6 +94,10 @@ module Flexirest
         request = Flexirest::Request.new(method, @request.object)
         request.url = request.forced_url = @url
         @object = request.call
+        if @object.respond_to?(:_parent=)
+          @object._parent = @options[:parent]
+          @object._parent_attribute_name = @options[:parent_attribute_name]
+        end
       end
     end
   end

data/lib/flexirest/request.rb

@@ -651,7 +651,7 @@ module Flexirest
       result
     end
 
-    def new_object(attributes, name = nil)
+    def new_object(attributes, name = nil, parent = nil, parent_attribute_name = nil)
       @method[:options][:has_many] ||= {}
       name = name.to_sym rescue nil
       if @method[:options][:has_many][name]
@@ -664,6 +664,9 @@ module Flexirest
         object = create_object_instance
       end
 
+      object._parent = parent
+      object._parent_attribute_name = parent_attribute_name
+
       if hal_response? && name.nil?
         attributes = handle_hal_links_embedded(object, attributes)
       end
@@ -691,9 +694,9 @@ module Flexirest
       v = value
       assignable_hash = value_from_object ? object._attributes : {}
       if value_from_object && @method[:options][:lazy].include?(k)
-        assignable_hash[k] = Flexirest::LazyAssociationLoader.new(overridden_name, v, self, overridden_name:(overridden_name))
+        assignable_hash[k] = Flexirest::LazyAssociationLoader.new(overridden_name, v, self, overridden_name:(overridden_name), parent: object, parent_attribute_name: k)
       elsif v.is_a? Hash
-        assignable_hash[k] = new_object(v, overridden_name )
+        assignable_hash[k] = new_object(v, overridden_name, object, k)
       elsif v.is_a? Array
         if @method[:options][:array].include?(k)
           assignable_hash[k] = Array.new

data/lib/flexirest/result_iterator.rb

@@ -4,6 +4,8 @@ module Flexirest
 
     attr_accessor :_status, :items
     attr_reader :_headers
+    attr_accessor :_parent
+    attr_accessor :_parent_attribute_name
 
     def initialize(response = nil)
       @_status  = response.try :status

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.0"
+  VERSION = "1.10.1"
 end

data/spec/lib/base_without_validation_spec.rb

@@ -12,6 +12,11 @@ class TranslatorExample
   end
 end
 
+class NestedExample < Flexirest::BaseWithoutValidation
+  get :all, "/all", fake:"{\"person\":{\"name\": \"Billy\"}}"
+end
+
+
 class AlteringClientExample < Flexirest::BaseWithoutValidation
   translator TranslatorExample
   base_url "http://www.example.com"
@@ -140,6 +145,31 @@ describe Flexirest::BaseWithoutValidation do
     expect(client).to be_dirty
   end
 
+  it "should store attribute changes on nested objects and mark them as dirty in the parent" do
+    client = NestedExample.all
+    client.person.name = "John"
+    expect(client.person.name.to_s).to eq("John")
+
+    expect(client).to be_dirty
+    expect(client.changes.keys).to include(:person)
+
+    expect(client.person).to be_dirty
+    expect(client.person.changes.keys).to include(:name)
+  end
+
+  it "should store attribute changes on nested objects loaded via instance methods and mark them as dirty in the parent" do
+    client = NestedExample.new()
+    client.all
+    client.person.name = "John"
+    expect(client.person.name.to_s).to eq("John")
+
+    expect(client).to be_dirty
+    expect(client.changes.keys).to include(:person)
+
+    expect(client.person).to be_dirty
+    expect(client.person.changes.keys).to include(:name)
+  end
+
   it "should track changed attributes and provide access to previous values (similar to ActiveRecord/Mongoid)" do
     client = EmptyExample.new()
     client["test"] = "Something"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.10.1
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler