glimr-api-client 0.2.4 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f0fab32d65bceb85478c42d25d708be7a828877
-  data.tar.gz: 500efa86ddf1c3c125339577e38a9b2e6b8e228c
+  metadata.gz: ac6a21364fe651bf2530a4149c43d3f93e5d7a1a
+  data.tar.gz: 335d61a17a2c08b598040e60bf1764354ec56402
 SHA512:
-  metadata.gz: ff8a5075972da215af4d15837cea074989ec3054338b61a9017c5022acacc7c99ba5b5645a07376f9198139a0f75dd38e837a722717c1b391f49f54e95b6171d
-  data.tar.gz: 981204f7a2da494acff182198933c6e84a0dcdbd262e4d05d38be5413caabd39f5fc1057cdfe6d3b38af7302abcfc81a4a83d612d49b2562d17665b31d875287
+  metadata.gz: 42c3ff09a2d3f938833cee3cbd4364ef8d63c2ed0e8a92e7abfc84766fc9afb61434ae3e686b54e92f7fcd295fd479c20316e027c70d95fd61866fd1b6209566
+  data.tar.gz: 98167bccf7e1c4bc10b3b19da9d7072bd36b8c8d208b44971b045489a3dccd690984e024e798ac15d11d138c303ad25f669d7b01cefcc1ab6c19d0a7cf4f6951

data/.rubocop.yml

@@ -81,7 +81,7 @@ Lint/EnsureReturn:
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-return-ensure'
   Enabled: true
 
-Lint/Eval:
+Security/Eval:
   Description: 'The use of eval represents a serious security risk.'
   Enabled: true
 
@@ -711,7 +711,7 @@ Style/LineEndConcatenation:
                  line end.
   Enabled: false
 
-Style/MethodCallParentheses:
+Style/MethodCallWithoutArgsParentheses:
   Description: 'Do not use parentheses for method calls with no arguments.'
   StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#no-args-no-parens'
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+2.3.3

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    glimr-api-client (0.2.2)
-      excon (~> 0.51)
+    glimr-api-client (0.3.2)
+      typhoeus (~> 1.1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -11,14 +11,15 @@ GEM
     adamantium (0.2.0)
       ice_nine (~> 0.11.0)
       memoizable (~> 0.4.0)
-    addressable (2.4.0)
+    addressable (2.5.1)
+      public_suffix (~> 2.0, >= 2.0.2)
     anima (0.3.0)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2)
       equalizer (~> 0.0.11)
     ast (2.3.0)
     byebug (9.0.6)
-    capybara (2.10.1)
+    capybara (2.13.0)
       addressable
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -31,15 +32,20 @@ GEM
     concord (0.1.5)
       adamantium (~> 0.2.0)
       equalizer (~> 0.0.9)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
     equalizer (0.0.11)
-    excon (0.54.0)
+    ethon (0.10.1)
+      ffi (>= 1.3.0)
+    ffi (1.9.18)
     fuubar (2.2.0)
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
+    hashdiff (0.3.2)
     ice_nine (0.11.2)
-    json (2.0.2)
+    json (2.1.0)
     memoizable (0.4.2)
       thread_safe (~> 0.3, >= 0.3.1)
     method_source (0.8.2)
@@ -75,10 +81,10 @@ GEM
     mutant-rspec (0.8.11)
       mutant (~> 0.8.11)
       rspec-core (>= 3.4.0, < 3.6.0)
-    nokogiri (1.6.8.1)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
-    parallel (1.9.0)
-    parser (2.3.1.4)
+    parallel (1.11.1)
+    parser (2.3.3.1)
       ast (~> 2.2)
     powerpack (0.1.1)
     procto (0.0.3)
@@ -86,13 +92,14 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.4.0)
+    pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
+    public_suffix (2.0.5)
     rack (2.0.1)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rainbow (2.1.0)
+    rainbow (2.2.1)
     rake (10.5.0)
     regexp_parser (0.3.6)
     rspec (3.5.0)
@@ -108,21 +115,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.45.0)
-      parser (>= 2.3.1.1, < 3.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    simplecov (0.12.0)
+    safe_yaml (1.0.4)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
-    thread_safe (0.3.5)
-    unicode-display_width (1.1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.1.2)
+      ethon (>= 0.9.0)
+    unicode-display_width (1.2.1)
     unparser (0.2.5)
       abstract_type (~> 0.0.7)
       adamantium (~> 0.2.0)
@@ -131,6 +141,10 @@ GEM
       equalizer (~> 0.0.9)
       parser (~> 2.3.0)
       procto (~> 0.0.2)
+    webmock (3.0.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     xpath (2.0.0)
       nokogiri (~> 1.3)
 
@@ -148,6 +162,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rspec (~> 3.5)
   rubocop (~> 0.41)
+  webmock (~> 3.0.1)
 
 BUNDLED WITH
-   1.13.6
+   1.14.3

data/README.md

@@ -1,4 +1,5 @@
-[![CircleCI](https://circleci.com/gh/ministryofjustice/glimr-api-client.svg?style=svg&circle-token=1d291c45a14d48ef123ffd904169e10b7f47411f)](https://circleci.com/gh/ministryofjustice/glimr-api-client)
+[![Build
+Status](https://travis-ci.org/ministryofjustice/glimr-api-client.svg?branch=master)](https://travis-ci.org/ministryofjustice/glimr-api-client)
 
 # GlimrApiClient
 
@@ -15,9 +16,14 @@ endpoint at which the API can be found. This will be something like;
 
 This URL must be accessible from wherever your code is running.
 
-If you need to set the api time, use the `GLIMR_API_TIMEOUT_SECONDS`
+If you need to set the api timeout, use the `GLIMR_API_TIMEOUT_SECONDS`
 environment variable.  This defaults to 5 seconds.
 
+The call to register new cases can take a long time.  It has its own
+timeout as a result: 32 seconds. Use the
+`GLIMR_REGISTER_NEW_CASE_TIMEOUT_SECONDS` environment variable to
+override this.
+
 ### Check Availablity
 
 ```ruby
@@ -28,56 +34,6 @@ Check if the GLiMR API is available.  Raises
 `GlimrApiClient::Unavailable` if anything other than a positive response
 is received; this includes network errors and timeouts.
 
-### Find a case
-
-```ruby
-  GlimrApiClient::Case.find(<case reference>, <confirmation code>)
-```
-
-Find a case on GLiMR using the case reference (‘TT/2012/00001’ in Tax
-Tribunals, for example) and confirmation code. `#title` returns case
-title from GLiMR, and `#fees` returns an array of anonymous objects
-(OpenStructs) detailing any outstanding fees. Each fee object responds
-to `#glimr_id`, `#description`, and `#amount`.
-
-Please note that `#amount` returns the amount in pence.
-
-If a case is not found, the client will raise `GlimrApiClient::CaseNotFound`.
-
-### Pay by Account
-
-```ruby
-  GlimrApiClient::PayByAccount.call(<params>)
-```
-
-Pay tribunal fees with a Pay By Account reference.
-
-Params are as follows:
-
-```ruby
-  feeLiabilityId: 123456789
-  pbaAccountNumber: "PBA1234567"
-  pbaConfirmationCode: "AC-D3-46" or "ACD346" - Glimr accepts hyphens
-  pbaTransactionReference: User's own reference. Max of 240 characters
-  amountToPayInPence: 9999
-```
-
-### Help With Fees Request
-
-```ruby
-  GlimrApiClient::HwfRequested.call(<params>)
-```
-
-Pay tribunal fees with a Help With Fees reference.
-
-Params are as follows:
-
-```ruby
-  feeLiabilityId: 123456789
-  hwfRequestReference: ABCD12345
-  amountToPayInPence: 9999
-```
-
 ### Register a New Case
 
 ```ruby
@@ -118,20 +74,18 @@ Accepts the following parameters:
 
 Currently only `jurisdictionId` and `onlineMappingCode` are mandatory.
 
-### Update a case, mark as paid
+## Deprecated Calls
 
-```ruby
-  GlimrApiClient::Update.call(<Fee object>)
-```
+Pending a Ministerial review of fees in tribunals, the four method
+related to managing payment were deprecated in late April, 2017.
+
+In the event that these methods are required at a later date, the code
+can be re-vivfied in the repo. See the following commit for details of
+files removed:
 
-Update a GLiMR case to indicate that payment has been received for a
-fee. The fee object passed must respond to `#glimr_id`,
-`#govpay_reference`, `#govpay_payment_id`, and `#amount`.  `#amount`
-must be the amount in pence. The client will validate the request and raise
-`GlimrApiClient::RequestError` if any of these methods are missing.
+02fe1117956089a4b2e62f2e93540165443de06e
 
-Network errors or API failures will raise
-`GlimrApiClient::PaymentNotificationFailure`.
+The specs may require some adaption.
 
 ### Examples
 

data/glimr_api_client.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.5'
   spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'webmock', '~> 3.0.1'
 
-  spec.add_dependency 'excon', '~> 0.51'
+  spec.add_dependency 'typhoeus', '~> 1.1.2'
 end

data/lib/glimr_api_client.rb

@@ -1,17 +1,17 @@
 require 'json'
 require 'glimr_api_client/version'
+
 require 'glimr_api_client/api'
 require 'glimr_api_client/base'
+
 require 'glimr_api_client/available'
-require 'glimr_api_client/case'
-require 'glimr_api_client/update'
-require 'glimr_api_client/register_new_case'
-require 'glimr_api_client/pay_by_account'
+require 'glimr_api_client/find_case'
 require 'glimr_api_client/hwf_requested'
-
+require 'glimr_api_client/pay_by_account'
+require 'glimr_api_client/register_new_case'
+require 'glimr_api_client/update'
 
 module GlimrApiClient
-  class PaymentNotificationFailure < StandardError; end
   class RegisterNewCaseFailure < StandardError; end
   class Unavailable < StandardError; end
   class CaseNotFound < StandardError; end

data/lib/glimr_api_client/api.rb

@@ -1,7 +1,9 @@
-require 'excon'
+require 'typhoeus'
 
 module GlimrApiClient
   module Api
+    attr_reader :response_body
+
     # Showing the GLiMR post & response in the container logs is helpful
     # for troubleshooting in the staging environment (when we are using
     # the websocket link to communicate with a GLiMR instance to which
@@ -9,18 +11,8 @@ module GlimrApiClient
     # DO NOT SET THIS ENV VAR IN PRODUCTION - we should not be logging
     # this sensitive user data from the live service.
     def post
+      @response_body = make_request("#{api_url}#{endpoint}", request_body.to_json)
       puts "GLIMR POST: #{endpoint} - #{request_body.to_json}" if ENV.key?('GLIMR_API_DEBUG')
-      client("#{api_url}#{endpoint}").post(body: request_body.to_json).tap { |resp|
-        handle_response_errors(resp) if (400..599).cover?(resp.status)
-        puts "GLIMR RESPONSE: #{resp.body}" if ENV.key?('GLIMR_API_DEBUG')
-        @body = resp.body
-      }
-    rescue Excon::Error => e
-      re_raise_error(message: e)
-    end
-
-    def response_body
-      @response_body ||= JSON.parse(@body, symbolize_names: true)
     end
 
     def timeout
@@ -29,6 +21,26 @@ module GlimrApiClient
 
     private
 
+    # This uses the REST response body instead of a simple error string in
+    # order to provide a consistent interface for raising errors.  GLiMR errors
+    # are indicated by a successful response that has the `:glimrerrorcode` key
+    # set. See `::RegisterNewCase` for an example.
+    def re_raise_error(body)
+      raise Unavailable, body.fetch(:message)
+    end
+
+    def parse_response(response_body)
+      JSON.parse(response_body, symbolize_names: true).tap { |body|
+        # These are required because GLiMR can return errors in an otherwise
+        # successful response.
+        re_raise_error(body) if body.key?(:glimrerrorcode)
+        # `:message` is only returned if there is an error  This *shouldn't*
+        # happen as all errors should have both `:glimrerrorcode` and
+        # `:message`...
+        re_raise_error(body) if body.key?(:message)
+      }
+    end
+
     # If this is set using a constant, and the gem is included in a project
     # that uses the dotenv gem, then it will always fall through to the default
     # unless dotenv is included and required before this gem is loaded.
@@ -37,32 +49,36 @@ module GlimrApiClient
                 'https://glimr-api.taxtribunals.dsd.io/Live_API/api/tdsapi')
     end
 
-    # Only timeouts and network issues raise errors.
-    def handle_response_errors(resp)
-      # TODO: log error as well.
-      # Deal with cases where we get an otherwise unparseable response body.
-      body = begin
-               JSON.parse(resp.body, symbolize_names: true)
-             rescue JSON::ParserError
-               { message: resp.status }
-             end
-      re_raise_error(body)
-    end
+    def make_request(endpoint, body)
+      response_body = nil
+      request = client(endpoint, body)
 
-    def re_raise_error(body)
-      error = body.fetch(:message)
-      raise Unavailable, error
+      request.on_complete do |response|
+        if response.success?
+          body = response.body
+          puts "GLIMR RESPONSE: #{body}" if ENV.key?('GLIMR_API_DEBUG')
+          response_body = parse_response(body)
+        elsif response.timed_out?
+          re_raise_error(message: 'timed out')
+        elsif (400..599).cover?(response.code)
+          re_raise_error(message: response.code)
+        end
+      end
+
+      request.run
+      response_body
     end
 
-    def client(uri)
-      Excon.new(
+    def client(uri, body)
+      Typhoeus::Request.new(
         uri,
+        method: :post,
+        body: body,
         headers: {
-          'Content-Type' => 'application/json',
-          'Accept' => 'application/json'
-        },
-        persistent: true,
-        read_timeout: timeout
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      },
+      timeout: timeout
       )
     end
   end

data/lib/glimr_api_client/base.rb

@@ -1,17 +1,24 @@
 module GlimrApiClient
   class Base
     include GlimrApiClient::Api
+    attr_reader :args
 
     def self.call(*args)
       new(*args).call
     end
 
+    def initialize(*args)
+      @args = args
+    end
+
     def call
       check_request!
       post
       self
     end
 
+    def check_request!
+    end
   end
 end
 

data/lib/glimr_api_client/{case.rb → find_case.rb}

@@ -1,11 +1,9 @@
 module GlimrApiClient
   # TODO: rename so it follow api spec
-  class Case
+  class FindCase < Base
     class NotFound < StandardError; end
     class InvalidCaseNumber < StandardError; end
 
-    include GlimrApiClient::Api
-
     TRIBUNAL_JURISDICTION_ID = 8
 
     # TODO: Case should use `#call(params)` directly, like everything else.

data/lib/glimr_api_client/register_new_case.rb

@@ -3,12 +3,23 @@ module GlimrApiClient
     class JurisdictionNotFound < StandardError; end
     class OnlineMappingNotFoundOrInvalid < StandardError; end
     class CaseCreationFailed < StandardError; end
+
+    TRIBUNAL_JURISDICTION_ID = 8
+
     attr_reader :request_body
 
     def initialize(params)
       @request_body = params
     end
 
+    # This addresses the problem that RegisterNewCase calls can take a much
+    # longer time to respond than availability calls. At the time this was
+    # written, the connection was periodically timing out at just over 30
+    # seconds.
+    def timeout
+      Integer(ENV.fetch('GLIMR_REGISTER_NEW_CASE_TIMEOUT_SECONDS', 32))
+    end
+
     private
 
     def check_request!

data/lib/glimr_api_client/version.rb

@@ -1,3 +1,3 @@
 module GlimrApiClient
-  VERSION = '0.2.4'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glimr-api-client
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.2
 platform: ruby
 authors:
 - Todd Tyree
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,19 +137,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.41'
 - !ruby/object:Gem::Dependency
-  name: excon
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 3.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.1
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: 1.1.2
 description: 
 email:
 - todd.tyree@digital.justice.gov.uk
@@ -161,6 +175,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
@@ -173,7 +188,7 @@ files:
 - lib/glimr_api_client/api.rb
 - lib/glimr_api_client/available.rb
 - lib/glimr_api_client/base.rb
-- lib/glimr_api_client/case.rb
+- lib/glimr_api_client/find_case.rb
 - lib/glimr_api_client/hwf_requested.rb
 - lib/glimr_api_client/pay_by_account.rb
 - lib/glimr_api_client/register_new_case.rb
@@ -201,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Easy integration with the glimr case management system