flexirest 1.9.14 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e675234b5624a923906ecea0ed2f1cdf47230e2bef5f35fbde9731da4bdae062
-  data.tar.gz: '0237757812519f5b82eb311608b00414cdef1d935feecb462c330e998f960158'
+  metadata.gz: 9f713d7d9f8f37de42e54bd20623b4477b9893b6cd40f0d2d5e8c5a06079a821
+  data.tar.gz: b5fc1fe7bffbe57a6adf9443aab86d91313fddd90b2fcc2ef35f50f2b41ec942
 SHA512:
-  metadata.gz: 9ca1b058118cd12b4ba659332acb5b8cde5e476c0f786b46d803f385c8b59f8661bf65352acca1c1f741dfa1872a510244f704815bb87fb92492c8618d64c027
-  data.tar.gz: 7ae4402501167aa8a40c02bf446f5267106d9a6b5e50a9e89bfb68798e8ff5b4f20fe2acc9bd9f80cd2a5372a49f9db388fd94bfe90af516a1643c1f97d55749
+  metadata.gz: eedfb75a0ecacbb1114d62fad201cf5e478242dd74126b87b29f1081e9c56b4194b600c6d729ac8afa70a7dd4ee8d66a03057974a2e52ee76f575e848027bfca
+  data.tar.gz: 955f229836e2e6fbc6273b1505294619ab0a614af05e79d0e5113b956959dbf22bb76ed23b2a169a9dafe207b6ab48b3559f7adeb84f22e3fcff01fbc223b28f

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.10.0
+
+Enhancement:
+
+- Add specific exceptions for the most common 5xx server-side errors
+
+## 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:

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"
@@ -52,12 +53,4 @@ Gem::Specification.new do |spec|
   else
     spec.add_runtime_dependency "activesupport", "< 5.0.0"
   end
-  # JSON is an implicit dependency of something, but JSON v2+ requires Ruby 2+
-  # Same with "tins" which is a dependency of coveralls
-  if Gem::Version.new(RUBY_VERSION) < Gem::Version.new('2.0.0')
-    spec.add_runtime_dependency "json", "< 2.0.0"
-    spec.add_runtime_dependency "tins", "~> 1.6.0"
-    spec.add_runtime_dependency "term-ansicolor", "~> 1.3.2"
-    spec.add_runtime_dependency "public_suffix", "~> 1.4.6"
-  end
 end

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"
@@ -621,6 +630,16 @@ module Flexirest
           raise HTTPConflictClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
         elsif status == 429
           raise HTTPTooManyRequestsClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
+        elsif status == 500
+          raise HTTPInternalServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
+        elsif status == 501
+          raise HTTPNotImplementedServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
+        elsif status == 502
+          raise HTTPBadGatewayServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
+        elsif status == 503
+          raise HTTPServiceUnavailableServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
+        elsif status == 504
+          raise HTTPGatewayTimeoutServerException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
         elsif (400..499).include? status
           raise HTTPClientException.new(status:status, result:error_response, raw_response: @response.body, url:@url, method: http_method)
         elsif (500..599).include? status
@@ -892,5 +911,9 @@ module Flexirest
   class HTTPNotFoundClientException < HTTPClientException ; end
   class HTTPTooManyRequestsClientException < HTTPClientException ; end
   class HTTPServerException < HTTPException ; end
-
+  class HTTPInternalServerException < HTTPServerException ; end
+  class HTTPNotImplementedServerException < HTTPServerException ; end
+  class HTTPBadGatewayServerException < HTTPServerException ; end
+  class HTTPServiceUnavailableServerException < HTTPServerException ; end
+  class HTTPGatewayTimeoutServerException < HTTPServerException ; 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.14"
+  VERSION = "1.10.0"
 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
@@ -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)
@@ -995,7 +1005,7 @@ describe Flexirest::Request do
     rescue Flexirest::HTTPServerException => e
       e
     end
-    expect(e).to be_instance_of(Flexirest::HTTPServerException)
+    expect(e).to be_instance_of(Flexirest::HTTPInternalServerException)
     expect(e.status).to eq(500)
     expect(e.result.first_name).to eq("John")
   end
@@ -1011,7 +1021,7 @@ describe Flexirest::Request do
     rescue Flexirest::HTTPServerException => e
       e
     end
-    expect(e.message).to eq(%q{The POST to '/create' returned a 500 status, which raised a Flexirest::HTTPServerException with a body of: \{"first_name":"John", "id":1234\}})
+    expect(e.message).to eq(%q{The POST to '/create' returned a 500 status, which raised a Flexirest::HTTPInternalServerException with a body of: \{"first_name":"John", "id":1234\}})
   end
 
   it "should raise a parse exception for invalid JSON returns" do
@@ -1026,7 +1036,7 @@ describe Flexirest::Request do
     rescue => e
       e
     end
-    expect(e).to be_instance_of(Flexirest::HTTPServerException)
+    expect(e).to be_instance_of(Flexirest::HTTPInternalServerException)
     expect(e.status).to eq(500)
     expect(e.result).to eq(error_content)
   end

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.14
+  version: 1.10.0
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-02 00:00:00.000000000 Z
+date: 2020-08-26 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