flexirest 1.10.11 → 1.10.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60510339b01a0ade8d9cd94686ecec5f431bcb58570c66b48fdc76075faf4d4f
-  data.tar.gz: 203e88d288ba8fa7f46f757a9aa24177908df116a272b754dc9bd685b19302db
+  metadata.gz: 40ffddde69dc7fb5e5e16c7de3e881f4c913d573170c8ddefcdc799da6a2139e
+  data.tar.gz: 370540fa78e3d99f8a9ac798104e21a1f8d0f5bb8ff54e99d398b682f0a58be9
 SHA512:
-  metadata.gz: f2d51bcbce5d390baa8140cc222cbe69bfb873cb6db399a3e955358b36b39aea6241df15abd8458b79e03d87e3e4643551d2d809dabd0a4ae92c9131e9277da1
-  data.tar.gz: 73445e4f9be17c311354112a41e7a9290695da228d853e1a67ea063d8aae8a1370f7bf4991fa43bd70a264b608c94416ad005929aa055863686ca919c6fe19ce
+  metadata.gz: 253e46a23429c4f0ec77fe9bb223ec80ab758bf352232559e68ae63f1462710af268bee3d9662c5cf104b5f262ff3bea112f03991be8f08ec76777f5c45c021a
+  data.tar.gz: 65a2576d868804a56147227cddb604d3ade6c91960bcd5f59778e3aaad3489682bbc725942a4c1f6f93148333b9929d27238280eb9c8f76b1c9f98b770ea3bdd

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.10.12
+
+Enhancement:
+
+- Added a quiet! mode to silence logging (thanks to Mujtaba Saboor for the issue and PR)
+
 ## 1.10.11
 
 Bugfix:

data/README.md

@@ -100,7 +100,7 @@ I've written a TON of documentation on how to use Flexirest and a LITTLE bit on
 - [HTTP/parse error handling](docs/httpparse-error-handling.md)
 - [Validation](docs/validation.md)
 - [Filtering result lists](docs/filtering-result-lists.md)
-- [Debugging](docs/debugging.md)
+- [Logging](docs/logging.md)
 - [XML responses](docs/xml-responses.md)
 
 

data/docs/{debugging.md → logging.md}

@@ -1,14 +1,18 @@
-# *Flexirest:* Debugging
+# *Flexirest:* Logging
 
-You can turn on verbose debugging to see what is sent to the API server and what is returned in one of these two ways:
+## Verbose
+
+You can turn on verbose logging to see what is sent to the API server and what is returned in one of these two ways:
 
 ```ruby
 class Article < Flexirest::Base
-  verbose true
+  verbose!
 end
 
+# or if you prefer
+
 class Person < Flexirest::Base
-  verbose!
+  verbose true
 end
 ```
 
@@ -26,6 +30,21 @@ class Article < Flexirest::Base
 end
 ```
 
+## Quiet
+
+By the same token, if you want to silence all log output from Flexirest, you can use quiet:
+
+```ruby
+class Article < Flexirest::Base
+  quiet!
+end
+
+# or if you prefer
+
+class Person < Flexirest::Base
+  quiet true
+end
+```
 
 -----
 

data/lib/flexirest/caching.rb

@@ -48,10 +48,10 @@ module Flexirest
         @@cache_store = nil
       end
 
-      def read_cached_response(request)
+      def read_cached_response(request, quiet)
         if cache_store && perform_caching && request.method[:method] == :get
           key = "#{request.class_name}:#{request.original_url}"
-          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{key} - Trying to read from cache"
+          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{key} - Trying to read from cache" unless quiet
           value = cache_store.read(key)
           value = Marshal.load(value) rescue value
         end

data/lib/flexirest/configuration.rb

@@ -299,6 +299,20 @@ module Flexirest
         value ? @verbose = value : @verbose
       end
 
+      def quiet!(options = {})
+        @quiet = true
+        @verbose = false
+      end
+
+      def quiet(value = nil)
+        @quiet ||= false
+        if value == true || value == false
+          @quiet = value
+          @verbose = false if @quiet != false
+        end
+        @quiet
+      end
+
       def translator(value = nil)
         Flexirest::Logger.warn("DEPRECATION: The translator functionality of Flexirest has been replaced with proxy functionality, see https://github.com/andyjeffries/flexirest#proxying-apis for more information") unless value.nil?
         @translator ||= nil

data/lib/flexirest/instrumentation.rb

@@ -4,7 +4,7 @@ module Flexirest
       self.class.time_spent += event.duration
       self.class.calls_made += 1
       name = '%s (%.1fms)' % [Flexirest.name, event.duration]
-      Flexirest::Logger.debug "  \033[1;4;32m#{name}\033[0m #{event.payload[:name]}"
+      Flexirest::Logger.debug "  \033[1;4;32m#{name}\033[0m #{event.payload[:name]}" unless event.payload[:quiet]
     end
 
     def self.time_spent=(value)

data/lib/flexirest/request.rb

@@ -184,6 +184,14 @@ module Flexirest
       end
     end
 
+    def quiet?
+      if object_is_class?
+        @object.quiet
+      else
+        @object.class.quiet
+      end
+    end
+
     def translator
       if object_is_class?
         @object.translator
@@ -226,7 +234,7 @@ module Flexirest
       @instrumentation_name = "#{class_name}##{@method[:name]}"
       result = nil
       cached = nil
-      ActiveSupport::Notifications.instrument("request_call.flexirest", :name => @instrumentation_name) do
+      ActiveSupport::Notifications.instrument("request_call.flexirest", :name => @instrumentation_name, quiet: quiet?) do
         @explicit_parameters = explicit_parameters
         @body = nil
         prepare_params
@@ -244,7 +252,7 @@ module Flexirest
           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"
+          Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Faked response found" unless quiet?
           content_type = @method[:options][:fake_content_type] || "application/json"
           return handle_response(OpenStruct.new(status:200, body:fake, response_headers:{"X-ARC-Faked-Response" => "true", "Content-Type" => content_type}))
         end
@@ -260,13 +268,13 @@ module Flexirest
         append_get_parameters
         prepare_request_body
         self.original_url = self.url
-        cached = original_object_class.read_cached_response(self)
+        cached = original_object_class.read_cached_response(self, quiet?)
         if cached && !cached.is_a?(String)
           if cached.expires && cached.expires > Time.now
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Absolutely cached copy found"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Absolutely cached copy found" unless quiet?
             return handle_cached_response(cached)
           elsif cached.etag.to_s != "" #present? isn't working for some reason
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Etag cached copy found with etag #{cached.etag}" unless quiet?
             etag = cached.etag
           end
         end
@@ -564,9 +572,9 @@ module Flexirest
         connection = Flexirest::ConnectionManager.get_connection(base_url)
       end
       if @method[:options][:direct]
-        Flexirest::Logger.info "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{@url}"
+        Flexirest::Logger.info "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{@url}" unless quiet?
       else
-        Flexirest::Logger.info "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}"
+        Flexirest::Logger.info "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Requesting #{connection.base_url}#{@url}" unless quiet?
       end
 
       if verbose?
@@ -634,7 +642,7 @@ module Flexirest
 
       if cached && response.status == 304
         Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name}" +
-          ' - Etag copy is the same as the server'
+          ' - Etag copy is the same as the server' unless quiet?
         return handle_cached_response(cached)
       end
 
@@ -647,9 +655,9 @@ module Flexirest
           return @response = Flexirest::PlainResponse.from_response(@response)
         elsif is_json_response? || is_xml_response?
           if @response.respond_to?(:proxied) && @response.proxied
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response was proxied, unable to determine size" unless quiet?
           else
-            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes"
+            Flexirest::Logger.debug "  \033[1;4;32m#{Flexirest.name}\033[0m #{@instrumentation_name} - Response received #{@response.body.size} bytes" unless quiet?
           end
           result = generate_new_object(ignore_root: ignore_root, ignore_xml_root: @method[:options][:ignore_xml_root])
           # TODO: Cleanup when ignore_xml_root is removed

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.10.11"
+  VERSION = "1.10.12"
 end

data/spec/lib/configuration_spec.rb

@@ -229,6 +229,26 @@ describe Flexirest::Configuration do
     expect(VerboseConfigurationExample3.verbose).to be_truthy
   end
 
+  it "should default to non-quiet logging" do
+    class QuietConfigurationExample1
+      include Flexirest::Configuration
+    end
+    expect(QuietConfigurationExample1.quiet).to be_falsey
+  end
+
+  it "should be able to switch on quiet logging" do
+    class QuietConfigurationExample2
+      include Flexirest::Configuration
+      quiet!
+    end
+    class QuietConfigurationExample3
+      include Flexirest::Configuration
+      quiet true
+    end
+    expect(QuietConfigurationExample2.quiet).to be_truthy
+    expect(QuietConfigurationExample3.quiet).to be_truthy
+  end
+
   it "should store a translator given" do
     expect{ ConfigurationExample.send(:translator) }.to_not raise_error
     ConfigurationExample.send(:translator, String.new)

data/spec/lib/instrumentation_spec.rb

@@ -14,7 +14,7 @@ describe Flexirest::Instrumentation do
   end
 
   it "should call ActiveSupport::Notifications.instrument when making any request" do
-    expect(ActiveSupport::Notifications).to receive(:instrument).with("request_call.flexirest", {:name=>"InstrumentationExampleClient#fake"})
+    expect(ActiveSupport::Notifications).to receive(:instrument).with("request_call.flexirest", {:name=>"InstrumentationExampleClient#fake", :quiet=>false})
     InstrumentationExampleClient.fake
   end
 

data/spec/lib/json_api_spec.rb

@@ -332,7 +332,7 @@ describe 'JSON API' do
         end
 
         it 'should raise the relevant Flexirest error' do
-          expect(-> { make_request }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
+          expect { make_request }.to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
             expect(exception.result.first.detail).to eq("The record identified by 123456 could not be found")
           end
         end
@@ -349,7 +349,7 @@ describe 'JSON API' do
         end
 
         it 'should ignore the "data" key and raise the relevant Flexirest error' do
-          expect(-> { make_request }).to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
+          expect { make_request }.to raise_error(Flexirest::HTTPNotFoundClientException) do |exception|
             expect(exception.result.first.detail).to eq("The record identified by 123456 could not be found")
           end
         end
@@ -464,7 +464,7 @@ describe 'JSON API' do
     end
 
     it 'should raise exception when an association in the response is not defined in base class' do
-      expect(-> { subject.includes(:tags).not_recognized_assoc(1) }).to raise_error(Exception)
+      expect { subject.includes(:tags).not_recognized_assoc(1) }.to raise_error(Exception)
     end
   end
 
@@ -528,7 +528,7 @@ describe 'JSON API' do
       article = JsonAPIExample::Article.new
       article.item = 'item one'
       article.tags = [tag, author]
-      expect(-> { article.create }).to raise_error(Exception)
+      expect { article.create }.to raise_error(Exception)
     end
 
     it 'should perform a patch request in proper json api format' do

data/spec/lib/request_spec.rb

@@ -188,6 +188,13 @@ describe Flexirest::Request do
       post :create, "/create"
     end
 
+    class QuietExampleClient < ExampleClient
+      base_url "http://www.example.com"
+      quiet!
+      get :all, "/all"
+      post :create, "/create"
+    end
+
     class CallbackBodyExampleClient < ExampleClient
       base_url "http://www.example.com"
       before_request do |name, request|
@@ -385,11 +392,14 @@ describe Flexirest::Request do
 
   it "should use the URL method for Basic auth when basic_auth_method is set to :url (and not include Authorization header)" do
     mocked_response = ::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{}))
-    headers_not_including_auth = hash_excluding("Authorization")
 
     connection = double(Flexirest::Connection).as_null_object
     expect(Flexirest::ConnectionManager).to receive(:get_connection).with("http://john:smith@www.example.com").and_return(connection)
-    expect(connection).to receive(:get).with("/", headers: headers_not_including_auth).and_return(mocked_response)
+    expect(connection).to receive(:get) do |path, options|
+      expect(path).to eq("/")
+      expect(options[:headers]).to eq({"Accept"=>"application/hal+json, application/json;q=0.5", "Content-Type"=>"application/x-www-form-urlencoded; charset=utf-8"})
+    end.and_return(mocked_response)
+
     AuthenticatedBasicUrlExampleClient.all
   end
 
@@ -1120,6 +1130,16 @@ describe Flexirest::Request do
     VerboseExampleClient.all
   end
 
+  it "should not log if quiet" do
+    connection = double(Flexirest::Connection).as_null_object
+    expect(Flexirest::ConnectionManager).to receive(:get_connection).and_return(connection)
+    expect(connection).to receive(:get).with("/all", an_instance_of(Hash)).and_return(::FaradayResponseMock.new(OpenStruct.new(body:'{"result":true}', response_headers:{"Content-Type" => "application/json", "Connection" => "close"})))
+    expect(Flexirest::Logger).to_not receive(:debug)
+    expect(Flexirest::Logger).to_not receive(:info)
+    expect(Flexirest::Logger).to_not receive(:error)
+    QuietExampleClient.all
+  end
+
   it "should return the headers still for 202 responses" do
     fake_location = "https://foo.example.com/123"
     expect_any_instance_of(Flexirest::Connection).

data/spec/spec_helper.rb

@@ -12,6 +12,8 @@ elsif ENV["TRAVIS"]
   Coveralls.wear!
 end
 
+ActiveSupport::Deprecation.silenced = true
+
 RSpec.configure do |config|
   config.color = true
   # config.formatter     = 'documentation'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.10.11
+  version: 1.10.12
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -280,7 +280,6 @@ files:
 - docs/body-types.md
 - docs/caching.md
 - docs/combined-example.md
-- docs/debugging.md
 - docs/default-parameters.md
 - docs/empty-body-handling.md
 - docs/faking-calls.md
@@ -291,6 +290,7 @@ files:
 - docs/issue_template.md
 - docs/json-api.md
 - docs/lazy-loading.md
+- docs/logging.md
 - docs/migrating-from-activerestclient.md
 - docs/parallel-requests.md
 - docs/per-request-parameter-encoding.md