flexirest 1.9.13 → 1.9.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d22b9c2c356eec70454c6919ec81ac6fc37a42e500c95c2f40337ba3e40561a6
-  data.tar.gz: eaf44cd2c1e6378fc140beec5b38793880ff34b18ea49b57146e038dfe54cc01
+  metadata.gz: 4a602c593b7748bb16605a196b249920ad733152fee9c7969fa56445b8c07003
+  data.tar.gz: 1e75b70398bcc73ee2fbd68a169c9f30ed1cbdd968e2f0d74272a1ed1b254737
 SHA512:
-  metadata.gz: 33fc03579ec1bdd3a2af9542209efced52ab03294f06e36c9b19e0dc526b9f3982befba154a2621c318ecd9d70dda3b31b099b0bd3a13a11748b4678c33d86b1
-  data.tar.gz: aa5c88116eebc320d09b03932660a2299425647457758bcd080d842a2c895ed2584c2c068e1d9de0fcbe474fe76da41371b5631ce36022b8e76cd4a2e6aa6e87
+  metadata.gz: 1d868df5a25277b88e0482e5cae4ba4398aa0ae4082766321988172365d7e1d955f6254f4a29eccd927f6d95d3734e81333f55760c1fbc0847f1ba6a249ae922
+  data.tar.gz: 2710c351b4f5770a4cc177d5ca7509aff9e988ff7b89a892bf4f57c35bb5834c5f41ca193ae22023b15de71118b19799c52491682dad86d041fd21dad9773a32

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
+  - 2.7.0
   - 2.6.0
   - 2.5.0
-  - 2.4.0

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 1.9.18
+
+Security:
+
+- Upgrade rest-client development dependency to a CVE-fixed version.
+
+## 1.9.17
+
+Feature:
+
+- Methods can be specified as a symbol for generating fake data (thanks to Niall Duggan for the feature request).
+
+## 1.9.16
+
+Bugfix:
+
+- Cached responses were always returning as `dirty?`/`changed?` (thanks to AKRathore for the bug report).
+
+## 1.9.15
+
+Bugfix:
+
+- Fix not marking unchanged attributes as dirty (thanks to Khairi Adnan for the bug report).
+
+## 1.9.14
+
+Bugfix:
+
+- Remove deprecation warning for `URI.escape` on Ruby 2.7.x.
+
 ## 1.9.13
 
 Change:

data/docs/faking-calls.md

@@ -16,6 +16,17 @@ class Person < Flexirest::Base
 end
 ```
 
+Alternatively, you can specify a symbol as the `fake` parameter, and Flexirest will call that method to get a string JSON as if it was the request body:
+
+```ruby
+class Person < Flexirest::Base
+  get :all, '/people', fake: :get_data
+
+  def get_data
+    {result: true}.to_json
+  end
+end
+```
 
 -----
 

data/flexirest.gemspec

@@ -36,9 +36,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "simplecov-rcov"
   spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency "api-auth", ">= 1.3.1"
+  spec.add_development_dependency "api-auth", ">= 1.3.1", "< 2.4"
   spec.add_development_dependency 'typhoeus'
   spec.add_development_dependency 'activemodel'
+  spec.add_development_dependency 'rest-client', ">= 1.8.0"
 
   spec.add_runtime_dependency "mime-types"
   spec.add_runtime_dependency "multi_json"

data/lib/flexirest/base_without_validation.rb

@@ -41,6 +41,7 @@ module Flexirest
     def _copy_from(result)
       @attributes = result._attributes
       @_status = result._status
+      _clean!
     end
 
     def dirty?
@@ -189,7 +190,7 @@ module Flexirest
       old_value = @dirty_attributes[key.to_sym]
       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]
+      @dirty_attributes[key.to_sym] = [old_value, value] if old_value != value
       @attributes[key.to_sym] = value
     end
 

data/lib/flexirest/caching.rb

@@ -110,9 +110,12 @@ module Flexirest
       if @result.is_a?(Array)
         ri = ResultIterator.new(self)
         ri.items = @result.map{|i| @class_name.constantize.new(i)}
+        ri._clean!
         ri
       else
-        @class_name.constantize.new(@result)
+        obj = @class_name.constantize.new(@result)
+        obj._clean!
+        obj
       end
     end
   end

data/lib/flexirest/request.rb

@@ -191,9 +191,18 @@ module Flexirest
         @body = nil
         prepare_params
         prepare_url
-        if fake = @method[:options][:fake]
+        fake = @method[:options][:fake]
+        if fake.present?
           if fake.respond_to?(:call)
             fake = fake.call(self)
+          elsif @object.respond_to?(fake)
+            fake = @object.send(fake)
+          elsif @object.class.respond_to?(fake)
+            fake = @object.class.send(fake)
+          elsif @object.new.respond_to?(fake)
+            fake = @object.new.send(fake)
+          elsif @object.class.new.respond_to?(fake)
+            fake = @object.class.new.send(fake)
           end
           Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Faked response found"
           content_type = @method[:options][:fake_content_type] || "application/json"
@@ -380,7 +389,7 @@ module Flexirest
           if target.to_s.blank?
             missing << token
           end
-          @url.gsub!(":#{token}", URI.escape(target.to_s).gsub("/", "%2F").gsub("+", "%2B"))
+          @url.gsub!(":#{token}", URI.encode_www_form_component(target.to_s))
         end
       end
 

data/lib/flexirest/result_iterator.rb

@@ -15,6 +15,10 @@ module Flexirest
       @items << item
     end
 
+    def _clean!
+      @items.map(&:_clean!)
+    end
+
     def size
       @items.size
     end
@@ -62,8 +66,8 @@ module Flexirest
       self
     end
 
-    def delete_if
-      @items = @items.delete_if &Proc.new
+    def delete_if(&block)
+      @items = @items.delete_if &block
       self
     end
 

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.9.13"
+  VERSION = "1.9.18"
 end

data/spec/lib/base_without_validation_spec.rb

@@ -126,6 +126,13 @@ describe Flexirest::BaseWithoutValidation do
     expect(client).to be_dirty
   end
 
+  it "should not mark attributes that don't change as dirty" do
+    client = EmptyExample.new(test: "Foo")
+    client._clean!
+    client.test = client.test
+    expect(client).to_not be_dirty
+  end
+
   it "should store attribute set using []= array notation and mark them as dirty" do
     client = EmptyExample.new()
     client["test"] = "Something"
@@ -171,6 +178,13 @@ describe Flexirest::BaseWithoutValidation do
     expect(client).to be_dirty
   end
 
+  it "should not mark a freshly retrieved object as changed" do
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with('/find/1', anything).and_return(::FaradayResponseMock.new(OpenStruct.new(status:200, response_headers:{}, body:"{\"first_name\":\"Billy\"}")))
+    client = AlteringClientExample.find(id: 1)
+    expect(client).to_not be_changed
+    expect(client.changes).to eq({})
+  end
+
   it 'should respond_to? attributes defined in the response' do
     client = EmptyExample.new(hello: "World")
     expect(client.respond_to?(:hello)).to be_truthy

data/spec/lib/caching_spec.rb

@@ -184,6 +184,18 @@ describe Flexirest::Caching do
       expect(ret.first_name).to eq("Johnny")
     end
 
+    it "cache read objects shouldn't be marked as changed" do
+      cached_response = Flexirest::CachedResponse.new(
+        status:200,
+        result:@cached_object,
+        expires:Time.now + 30)
+      expect_any_instance_of(CachingExampleCacheStore5).to receive(:read).once.with("Person:/").and_return(Marshal.dump(cached_response))
+      expect_any_instance_of(Flexirest::Connection).not_to receive(:get)
+      ret = Person.all
+      expect(ret).to_not be_changed
+      expect(ret.changes).to eq({})
+    end
+
     it "should read from the cache store and restore to the same object" do
       cached_response = Flexirest::CachedResponse.new(
         status:200,

data/spec/lib/request_spec.rb

@@ -55,6 +55,7 @@ describe Flexirest::Request do
       get :hal, "/hal", fake:"{\"_links\":{\"child\": {\"href\": \"/child/1\"}, \"other\": {\"href\": \"/other/1\"}, \"cars\":[{\"href\": \"/car/1\", \"name\":\"car1\"}, {\"href\": \"/car/2\", \"name\":\"car2\"}, {\"href\": \"/car/not-embed\", \"name\":\"car_not_embed\"} ], \"lazy\": {\"href\": \"/lazy/load\"}, \"invalid\": [{\"href\": \"/invalid/1\"}]}, \"_embedded\":{\"other\":{\"name\":\"Jane\"},\"child\":{\"name\":\"Billy\"}, \"cars\":[{\"_links\": {\"self\": {\"href\": \"/car/1\"} }, \"make\": \"Bugatti\", \"model\": \"Veyron\"}, {\"_links\": {\"self\": {\"href\": \"/car/2\"} }, \"make\": \"Ferrari\", \"model\": \"F458 Italia\"} ], \"invalid\": [{\"present\":true, \"_links\": {} } ] } }", has_many:{other:ExampleOtherClient}
       get :fake_object, "/fake", fake:"{\"result\":true, \"list\":[1,2,3,{\"test\":true}], \"child\":{\"grandchild\":{\"test\":true}}}"
       get :fake_proc_object, "/fake", fake:->(request) { "{\"result\":#{request.get_params[:id]}}" }
+      get :fake_method, "/fake", fake: :generate_fake_data
       get :fake_array, "/fake", fake:"[1,2,3,{\"test\":true},null]"
       get :fake_proc_array, "/fake", fake:->(request) { "[{\"result\":#{request.get_params[:id]}},null]" }
       get :defaults, "/defaults", defaults:{overwrite:"no", persist:"yes"}
@@ -62,6 +63,10 @@ describe Flexirest::Request do
       patch :only_changed_1, "/changed1", only_changed: true
       patch :only_changed_2, "/changed2", only_changed: [:debug1, :debug2]
       patch :only_changed_3, "/changed3", only_changed: { debug1: false, debug2: true }
+
+      def generate_fake_data
+        "{\"result\":true, \"list\":[1,2,3,{\"test\":true}], \"child\":{\"grandchild\":{\"test\":true}}}"
+      end
     end
 
     class ExampleLoadBalancedClient < Flexirest::Base
@@ -344,7 +349,7 @@ describe Flexirest::Request do
   end
 
   it "should pass URL-encode URL parameters" do
-    expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/foo%20bar", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
+    expect_any_instance_of(Flexirest::Connection).to receive(:get).with("/foo+bar", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{})))
     ExampleClient.find id:"foo bar"
   end
 
@@ -576,6 +581,11 @@ describe Flexirest::Request do
     expect(object.result).to eq(1234)
   end
 
+  it "should parse JSON object from a fake response generated by method defined as a symbol" do
+    object = ExampleClient.fake_method id:1234
+    expect(object.result).to eq(true)
+  end
+
   it "should parse JSON array and return a nice result iterator for faked responses" do
     object = ExampleClient.fake_array debug:true
     expect(object).to be_instance_of(Flexirest::ResultIterator)

data/spec/spec_helper.rb

@@ -66,12 +66,12 @@ class FaradayResponseMock < ::Flexirest::FaradayResponseProxy
     @finished = false
   end
 
-  def on_complete
+  def on_complete(&block)
     if @auto_resolve
       @finished = true
       yield(@response)
     else
-      @callback = Proc.new
+      @callback = block
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.9.13
+  version: 1.9.18
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,6 +129,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -136,6 +139,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +170,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -364,7 +384,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: This gem is for accessing REST services in a flexible way.  ActiveResource