bandiera-client 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0231e248ad75e4dd5762406ce09fbb937853babf
-  data.tar.gz: cfacb3426cc40e772fc2e357f4ff870c99412f60
+  metadata.gz: af9fac1412763441ed0e77c4373acda416c2eb11
+  data.tar.gz: 4afd81a7571125fecff204ab9e7f35689e05f325
 SHA512:
-  metadata.gz: 9e4dfec63215c440d81ebe4f1cbdbe5f7465cd36340b1fa27cfa72f3577f51fb04fc55ee6048a5b660637b8dcbc146f561df640fa177cf0bba3bbf9e94bb6f49
-  data.tar.gz: ec1efc0dd1c3cf895515c1481ed8bdcf6311db2b3034e093524043e9041e3776ef42e6e1c766ddafb2732a9341092eb414de4dd0ced9c8fdc75ec97890ed0165
+  metadata.gz: 58d25b937aeebbd0a6dcf6eb6eb72cf8a1dbf1c1a7f7e252a82d9e2fce7a1c9daa8f5b07f073aa93ebfc88fefc1933290583958af7f7a00cd783ec40fbd5e539
+  data.tar.gz: 8603383f510a8ee339b8773d6919509d3083c988f02ed41a0b588021cdada2dbfccff5584199d75133b3834380b9ebdcce4606cf8d94d2772e3397310c59ff57

data/.hound.yml

@@ -0,0 +1 @@
+./.rubocop.yml

data/.rubocop.yml

@@ -1,28 +1,61 @@
+AllCops:
+  StyleGuideCopsOnly: true
+
 Metrics/LineLength:
   Description: 'Limit lines to 120 characters.'
   Max: 120
+  Enabled: true
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - describe
+    - context
+  Enabled: true
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 20
+  Enabled: true
+
+Metrics/AbcSize:
+  Max: 40
+  Enabled: true
 
 Style/Documentation:
   Enabled: false
 
-Style/SpaceBeforeFirstArg:
+Layout/SpaceBeforeFirstArg:
   Enabled: false
 
 Style/BracesAroundHashParameters:
   Enabled: false
 
-Style/IndentHash:
+Style/CaseEquality:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Layout/IndentHash:
   EnforcedStyle: consistent
+  Enabled: true
 
-Style/AlignHash:
+Layout/AlignHash:
+  Severity: fatal
+  Enabled: true
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 
-Style/AlignParameters:
+Layout/AlignParameters:
   EnforcedStyle: with_fixed_indentation
+  Enabled: true
 
 Style/StringLiterals:
   EnforcedStyle: single_quotes
+  Enabled: true
 
 Style/CollectionMethods:
   PreferredMethods:
@@ -31,9 +64,41 @@ Style/CollectionMethods:
     inject: 'reduce'
     detect: 'find'
     find_all: 'select'
+  Enabled: true
 
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: leading
+  Enabled: true
 
 Style/DoubleNegation:
   Enabled: false
+
+Style/Alias:
+  # I like alias_method with symbol parameters
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  # When true, allows most uses of extra spacing if the intent is to align
+  # with an operator on the previous or next line, not counting empty lines
+  # or comment lines.
+  AllowForAlignment: true
+  Enabled: true
+
+Style/SymbolArray:
+  # Turned off because the associated auto-correct makes a real mess
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  # An 'every file in the repo' recommendation.
+  Enabled: false
+  Severity: warning
+
+Layout/EmptyLineAfterMagicComment:
+  # Nooo not another 'every file in the repo' recommendation.
+  Enabled: false
+  Severity: warning
+
+Style/GlobalVars:
+  # Doesn't justify a critical
+  Enabled: true
+  Severity: warning

data/.travis.yml

@@ -7,7 +7,9 @@ rvm:
   - 2.0
   - 2.1
   - 2.2
-  - 2.3.0
+  - 2.3
+  - 2.4
+  - 2.5
   - jruby-9.0.0.0
 
 # Ensure we don't build for *every* commit (doesn't apply to PR builds)

data/HISTORY

@@ -1,3 +1,7 @@
+= 3.1.0 / 19-March-2017
+
+  * Use Typhoeus as the HTTP library of choice. Thanks @mattrayner!
+
 = 3.0.3 / 11-April-2016
 
   * Stop the client from logging warnings

data/bandiera-client.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'pry'
 
-  spec.add_dependency 'rest-client'
+  spec.add_dependency 'typhoeus'
   spec.add_dependency 'macmillan-utils'
 end

data/lib/bandiera/client.rb

@@ -1,6 +1,7 @@
-require 'rest_client'
+require 'typhoeus'
 require 'json'
 require 'logger'
+require 'bandiera/client/errors'
 
 module Bandiera
   ##
@@ -25,11 +26,11 @@ module Bandiera
     # @param [String] client_name A client name to pass through along with the HTTP requests
     #
     def initialize(base_uri = 'http://localhost', logger = Logger.new($stdout), client_name = nil)
-      @base_uri       = base_uri
-      @base_uri       << '/api' unless @base_uri.match(/\/api$/)
-      @logger         = logger
-      @timeout        = 0.2 # 0.4s (0.2 + 0.2) default timeout
-      @client_name    = client_name
+      @base_uri    = base_uri
+      @base_uri    << '/api' unless @base_uri.match(/\/api$/)
+      @logger      = logger
+      @timeout     = 0.2 # 0.4s (0.2 + 0.2) default timeout
+      @client_name = client_name
     end
 
     # @deprecated This functionality was deprecated/removed in 3.0.0
@@ -108,7 +109,7 @@ module Bandiera
     end
 
     EXCEPTIONS_TO_HANDLE = (
-      Errno.constants.map { |cla| Errno.const_get(cla) } + [RestClient::Exception, JSON::ParserError, SocketError]
+      Errno.constants.map { |cla| Errno.const_get(cla) } + [Bandiera::Client::Error, JSON::ParserError, SocketError]
     ).flatten
 
     def get_and_handle_exceptions(path, params, http_opts, return_upon_error, error_msg_prefix, &block)
@@ -127,11 +128,19 @@ module Bandiera
     end
 
     def get(path, params, passed_http_opts)
-      default_http_opts = { method: :get, timeout: timeout, open_timeout: timeout, headers: headers }
-      resource          = RestClient::Resource.new(@base_uri, default_http_opts.merge(passed_http_opts))
-      response          = resource[path].get(params: clean_params(params))
-
-      JSON.parse(response.body)
+      default_http_opts = { method: :get, timeout: timeout, headers: headers, params: clean_params(params) }
+      resource = Typhoeus::Request.new("#{@base_uri}#{path}", default_http_opts.merge(passed_http_opts))
+      response = resource.run
+
+      if response.success?
+        JSON.parse(response.body)
+      elsif response.timed_out?
+        raise Bandiera::Client::TimeoutError, 'Connection timed out'
+      elsif response.code == 0
+        raise Bandiera::Client::Error, response.return_message
+      else
+        raise Bandiera::Client::ResponseError, "HTTP request failed: " + response.code.to_s
+      end
     end
 
     def clean_params(passed_params)

data/lib/bandiera/client/errors.rb

@@ -0,0 +1,12 @@
+module Bandiera
+  class Client
+    class Error < StandardError
+    end
+
+    class TimeoutError < Bandiera::Client::Error
+    end
+
+    class ResponseError < Bandiera::Client::Error
+    end
+  end
+end

data/lib/bandiera/client/version.rb

@@ -1,5 +1,5 @@
 module Bandiera
   class Client
-    VERSION = '3.0.4'.freeze
+    VERSION = '3.1.0'.freeze
   end
 end

data/spec/lib/bandiera/client_spec.rb

@@ -53,16 +53,16 @@ describe Bandiera::Client do
     end
   end
 
-  context 'when some RestClient::Resource options are passed' do
-    it 'passes them onto the RestClient::Resource' do
+  context 'when some Typhoeus::Request options are passed' do
+    it 'passes them onto the Typhoeus::Resource' do
       params   = {}
       options  = { timeout: 24, open_timeout: 24 }
-      response = double(:response, body: JSON.generate({ response: {} }))
-      resource = double(:resource, '[]' => double(get: response))
+      response = double(:response, body: JSON.generate({ response: {} }), success?: true)
+      resource = double(:resource, run: response)
 
-      expect(RestClient::Resource)
+      expect(Typhoeus::Request)
         .to receive(:new)
-        .with(api_uri, method: :get, timeout: 24, open_timeout: 24, headers: anything)
+        .with("#{api_uri}/v2/groups/foo/features/bar", method: :get, timeout: 24, open_timeout: 24, headers: {"User-Agent"=>"Bandiera Ruby Client / #{Bandiera::Client::VERSION}"}, params: {})
         .once
         .and_return(resource)
 
@@ -70,6 +70,47 @@ describe Bandiera::Client do
     end
   end
 
+  context 'raises a Bandiera::Client::Error, Bandiera::Client::TimeoutError or Bandiera::Client::ResponseError if there is a problem' do
+    context 'Bandiera::Client::Error' do
+      it 'is raised if the response code is 0' do
+        params   = {}
+        response = double(:response, body: JSON.generate({ response: {} }), success?: false, timed_out?: false, code: 0, return_message: 'test')
+        resource = double(:resource, run: response)
+
+        allow(Typhoeus::Request).to receive(:new).and_return(resource)
+        expect(logger).to receive(:warn).with('Bandiera::Client - HANDLED EXCEPTION #<Bandiera::Client::Error: test> - CLASS Bandiera::Client::Error')
+
+        subject.enabled?('foo', 'bar', params)
+      end
+    end
+
+    context 'Bandiera::Client::TimeoutError' do
+      it 'is raised if the response is flagged as timed out' do
+        params   = {}
+        response = double(:response, body: JSON.generate({ response: {} }), success?: false, timed_out?: true)
+        resource = double(:resource, run: response)
+
+        allow(Typhoeus::Request).to receive(:new).and_return(resource)
+        expect(logger).to receive(:warn).with('Bandiera::Client - HANDLED EXCEPTION #<Bandiera::Client::TimeoutError: Connection timed out> - CLASS Bandiera::Client::TimeoutError')
+
+        subject.enabled?('foo', 'bar', params)
+      end
+    end
+
+    context 'Bandiera::Client::ResponseError' do
+      it 'is raised if the response is flagged as timed out' do
+        params   = {}
+        response = double(:response, body: JSON.generate({ response: {} }), success?: false, timed_out?: false, code: 404)
+        resource = double(:resource, run: response)
+
+        allow(Typhoeus::Request).to receive(:new).and_return(resource)
+        expect(logger).to receive(:warn).with('Bandiera::Client - HANDLED EXCEPTION #<Bandiera::Client::ResponseError: HTTP request failed: 404> - CLASS Bandiera::Client::ResponseError')
+
+        subject.enabled?('foo', 'bar', params)
+      end
+    end
+  end
+
   describe '#get_feature' do
     let(:group)   { 'pubserv' }
     let(:feature) { 'log-stats' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandiera-client
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.0
 platform: ruby
 authors:
 - Springer Nature
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2018-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -157,6 +157,7 @@ files:
 - Rakefile
 - bandiera-client.gemspec
 - lib/bandiera/client.rb
+- lib/bandiera/client/errors.rb
 - lib/bandiera/client/version.rb
 - lib/bandiera/middleware.rb
 - spec/lib/bandiera/client_spec.rb
@@ -182,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple feature flagging API client.

data/.hound.yml

@@ -1,39 +0,0 @@
-Metrics/LineLength:
-  Description: 'Limit lines to 120 characters.'
-  Max: 120
-
-Style/Documentation:
-  Enabled: false
-
-Style/SpaceBeforeFirstArg:
-  Enabled: false
-
-Style/BracesAroundHashParameters:
-  Enabled: false
-
-Style/IndentHash:
-  EnforcedStyle: consistent
-
-Style/AlignHash:
-  EnforcedHashRocketStyle: table
-  EnforcedColonStyle: table
-
-Style/AlignParameters:
-  EnforcedStyle: with_fixed_indentation
-
-Style/StringLiterals:
-  EnforcedStyle: single_quotes
-
-Style/CollectionMethods:
-  PreferredMethods:
-    collect: 'map'
-    collect!: 'map!'
-    inject: 'reduce'
-    detect: 'find'
-    find_all: 'select'
-
-Style/DotPosition:
-  EnforcedStyle: leading
-
-Style/DoubleNegation:
-  Enabled: false