glimr-api-client 0.1.1

data/bin/rails

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/glimr_api_client/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/circle.yml

@@ -0,0 +1,7 @@
+database:
+  override:
+    - bundle exec rake db:setup
+
+test:
+  override:
+    - bundle exec rake

data/glimr_api_client.gemspec

@@ -0,0 +1,30 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+require 'glimr_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'glimr-api-client'
+  spec.version = GlimrApiClient::VERSION
+  spec.authors = ['Todd Tyree']
+  spec.email = ['todd.tyree@digital.justice.gov.uk']
+
+  spec.summary = 'Easy integration with the glimr case management system'
+  spec.homepage = 'https://github.com/ministryofjustice/glimr-api-client'
+  spec.licenses = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'capybara', '~> 2.7'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.2'
+  spec.add_development_dependency 'fuubar', '~> 2.0'
+  spec.add_development_dependency 'mutant-rspec', '~> 0.8'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_development_dependency 'rails', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+
+  spec.add_dependency 'excon', '~> 0.51'
+end

data/lib/glimr_api_client.rb

@@ -0,0 +1,14 @@
+require 'glimr_api_client/railtie' if defined?(Rails)
+require 'glimr_api_client/version'
+require 'glimr_api_client/api'
+require 'glimr_api_client/available'
+require 'glimr_api_client/case'
+require 'glimr_api_client/update'
+
+
+module GlimrApiClient
+  class PaymentNotificationFailure < StandardError; end
+  class Unavailable < StandardError; end
+  class CaseNotFound < StandardError; end
+  class RequestError < StandardError; end;
+end

data/lib/glimr_api_client/api.rb

@@ -0,0 +1,47 @@
+module GlimrApiClient
+  module Api
+
+    def post
+      @post ||=
+        client.post(path: endpoint, body: request_body.to_query).tap { |resp|
+          # Only timeouts and network issues raise errors.
+          handle_response_errors(resp)
+          @body = resp.body
+          @status = resp.status
+        }
+    rescue Excon::Error => e
+      if endpoint == '/paymenttaken'
+        raise GlimrApiClient::PaymentNotificationFailure, e
+      else
+        raise GlimrApiClient::Unavailable, e
+      end
+    end
+
+    def response_body
+      @response_body ||= JSON.parse(@body, symbolize_names: true)
+    end
+
+    private
+
+    def handle_response_errors(resp)
+      if resp.status == 404
+        raise GlimrApiClient::CaseNotFound
+      elsif (400..599).cover?(resp.status) && endpoint == '/paymenttaken'
+        raise GlimrApiClient::PaymentNotificationFailure, resp.status
+      elsif (400..599).cover?(resp.status)
+        raise GlimrApiClient::Unavailable, resp.status
+      end
+    end
+
+    def client
+      @client ||= Excon.new(
+        ENV.fetch('GLIMR_API_URL', 'https://glimr-test.dsd.io'),
+        headers: {
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
+        },
+        persistent: true
+      )
+    end
+  end
+end

data/lib/glimr_api_client/available.rb

@@ -0,0 +1,32 @@
+module GlimrApiClient
+  class Available
+    include GlimrApiClient::Api
+
+    class << self
+      delegate :call, to: :new
+    end
+
+    def call
+      post
+      self
+    end
+
+    def available?
+      response_body.fetch(:glimrAvailable).eql?('yes').tap { |status|
+        if status.equal?(false)
+          raise Unavailable
+        end
+      }
+    end
+
+    private
+
+    def endpoint
+      '/glimravailable'
+    end
+
+    def request_body
+      {}
+    end
+  end
+end

data/lib/glimr_api_client/case.rb

@@ -0,0 +1,45 @@
+module GlimrApiClient
+  class Case
+    include GlimrApiClient::Api
+
+    def self.find(case_reference = nil)
+      new(case_reference).call
+    end
+
+    def initialize(case_reference = nil)
+      @case_reference = case_reference
+    end
+
+    def call
+      post
+      self
+    end
+
+    def title
+      @title ||= response_body.fetch(:caseTitle)
+    end
+
+    def fees
+      @fees ||= response_body.fetch(:feeLiabilities).map do |fee|
+        OpenStruct.new(
+          glimr_id: Integer(fee.fetch(:feeLiabilityId)),
+          description: fee.fetch(:onlineFeeTypeDescription),
+          amount: Integer(fee.fetch(:payableWithUnclearedInPence))
+        )
+      end
+    end
+
+    private
+
+    def endpoint
+      '/requestpayablecasefees'
+    end
+
+    def request_body
+      {
+        jurisdictionId: 8, # TODO: Remove when no longer required in API
+        caseNumber: @case_reference
+      }
+    end
+  end
+end

data/lib/glimr_api_client/railtie.rb

@@ -0,0 +1,11 @@
+require 'glimr_api_client'
+require 'rails'
+module GlimrApiClient
+  class Railtie < Rails::Railtie
+    railtie_name :glimr_api_client
+
+    rake_tasks do
+      load 'tasks/spec_setup.rake'
+    end
+  end
+end

data/lib/glimr_api_client/update.rb

@@ -0,0 +1,42 @@
+module GlimrApiClient
+  class Update
+    include GlimrApiClient::Api
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def initialize(fee)
+      @fee = fee
+    end
+
+    def call
+      check_request!
+      post
+      self
+    end
+
+    private
+
+    def check_request!
+      errors = []
+      [:feeLiabilityId, :paymentReference, :govpayReference, :paidAmountInPence].each do |required|
+        errors << required if request_body.fetch(required).blank?
+      end
+      raise RequestError, errors unless errors.blank?
+    end
+
+    def endpoint
+      '/paymenttaken'
+    end
+
+    def request_body
+      {
+        feeLiabilityId: @fee.glimr_id,
+        paymentReference: @fee.govpay_reference,
+        govpayReference: @fee.govpay_payment_id,
+        paidAmountInPence: @fee.amount
+      }
+    end
+  end
+end

data/lib/glimr_api_client/version.rb

@@ -0,0 +1,3 @@
+module GlimrApiClient
+  VERSION = '0.1.1'
+end

data/lib/tasks/mutant.rake

@@ -0,0 +1,49 @@
+task :mutant do
+  classes_to_mutate.each do |klass|
+    vars = 'NOCOVERAGE=true'
+    flags = '--include lib --use rspec'
+    unless system("#{vars} mutant #{flags} #{klass}")
+      raise 'Mutation testing failed'
+    end
+  end
+end
+
+task(:default).prerequisites << task(:mutant)
+
+private
+
+def classes_to_mutate
+  files = grep_files_for_classes
+  klasses = extract_classes_for_mutation(files)
+  klasses.map { |k|
+    setup_class_for_run(k)
+  }
+end
+
+# This is a nasty hack because we’re using POROs; otherwise, we could just use
+# ApplicationRecord.descendants...
+#
+# Grepping through the source code seemed to be the most pragmatic solution
+# so that developers don’t need to remember to add new classes to a list for
+# mutation testing, but it’s not ideal
+def grep_files_for_classes
+  Dir.glob('lib/**/*.rb').
+    map { |f|
+    # There are some examples of `class << self` in codebase.
+    File.readlines(f).grep(/\bclass(?!\s<<)/)
+  }.flatten
+end
+
+def extract_classes_for_mutation(files)
+  re = /class (?<klass>\w+)/
+
+  files.map { |s|
+    re.match(s)[:klass]
+  }.compact
+end
+
+def setup_class_for_run(klass)
+  Object.const_get(klass)
+rescue NameError
+  Object.const_get("GlimrApiClient::#{klass}")
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+if Gem.loaded_specs.key?('rubocop')
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  task(:default).prerequisites << task(:rubocop)
+end

data/lib/tasks/spec_setup.rake

@@ -0,0 +1,11 @@
+namespace :glimr_api_client do
+  desc 'Copy the shared examples for glimr rspec testing'
+  task :install_shared_examples
+    source = File.join(
+      Gem.loaded_specs['glimr-api-client'].full_gem_path,
+      'shared_examples',
+      'shared_examples_for_glimr.rb'
+    )
+    target = File.join(Rails.root, 'spec', 'support', 'shared_examples_for_glimr.rb')
+    FileUtils.cp_r source, target
+end

data/shared_examples/shared_examples_for_glimr.rb

@@ -0,0 +1,212 @@
+RSpec.shared_examples 'glimr availability request' do |glimr_response|
+  before do
+    Excon.stub(
+      { host: 'glimr-test.dsd.io', path: '/glimravailable' },
+      status: 200, body: glimr_response.to_json
+    )
+  end
+end
+
+RSpec.shared_examples 'glimr availability request returns a 500' do
+  before do
+    Excon.stub(
+      { host: 'glimr-test.dsd.io', path: '/glimravailable' },
+      status: 500
+    )
+  end
+end
+
+RSpec.shared_examples 'service is not available' do
+  scenario do
+    visit '/'
+    expect(page).not_to have_text('Start now')
+    expect(page).to have_text('The service is currently unavailable')
+  end
+end
+
+RSpec.shared_examples 'generic glimr response' do |case_number, _confirmation_code, status, glimr_response|
+  before do
+    Excon.stub(
+      {
+        host: 'glimr-test.dsd.io',
+        body: /caseNumber=#{CGI.escape(case_number)}/,
+        path: '/requestpayablecasefees'
+      },
+      status: status, body: glimr_response.to_json
+    )
+  end
+end
+
+RSpec.shared_examples 'case not found' do
+  before do
+    Excon.stub(
+      {
+        host: 'glimr-test.dsd.io',
+        path: '/requestpayablecasefees'
+      },
+      status: 404
+    )
+  end
+end
+
+RSpec.shared_examples 'no new fees are due' do |case_number, _confirmation_code|
+  let(:response_body) {
+    {
+      'jurisdictionId' => 8,
+      'tribunalCaseId' => 60_029,
+      'caseTitle' => 'You vs HM Revenue & Customs',
+      'feeLiabilities' => []
+    }
+  }
+
+  before do
+    Excon.stub(
+      {
+        host: 'glimr-test.dsd.io',
+        body: /caseNumber=#{CGI.escape(case_number)}/,
+        path: '/requestpayablecasefees'
+      },
+      status: 200, body: response_body.to_json
+    )
+  end
+end
+
+RSpec.shared_examples 'a case fee of £20 is due' do |case_number, _confirmation_code|
+  let(:response_body) {
+    {
+      'jurisdictionId' => 8,
+      'tribunalCaseId' => 60_029,
+      'caseTitle' => 'You vs HM Revenue & Customs',
+      'feeLiabilities' =>
+      [{ 'feeLiabilityId' => '7',
+         'onlineFeeTypeDescription' => 'Lodgement Fee',
+         'payableWithUnclearedInPence' => '2000' }]
+    }.to_json
+  }
+
+  before do
+    Excon.stub(
+      {
+        method: :post,
+        host: 'glimr-test.dsd.io',
+        body: /caseNumber=#{CGI.escape(case_number)}&jurisdictionId=8/,
+        path: '/requestpayablecasefees'
+      },
+      status: 200, body: response_body
+    )
+  end
+end
+
+RSpec.shared_examples 'no fees then a £20 fee' do |case_number, _confirmation_code|
+  let(:no_fees) {
+    {
+      'jurisdictionId' => 8,
+      'tribunalCaseId' => 60_029,
+      'caseTitle' => 'You vs HM Revenue & Customs',
+      'feeLiabilities' => []
+    }
+  }
+
+  let(:twenty_pound_fee) {
+    {
+      'jurisdictionId' => 8,
+      'tribunalCaseId' => 60_029,
+      'caseTitle' => 'You vs HM Revenue & Customs',
+      'feeLiabilities' =>
+      [{ 'feeLiabilityId' => 7,
+         'onlineFeeTypeDescription' => 'Lodgement Fee',
+         'payableWithUnclearedInPence' => 2000 }]
+    }
+  }
+
+  before do
+    Excon.stub(
+      {
+        method: :post,
+        host: 'glimr-test.dsd.io',
+        body: /caseNumber=#{CGI.escape(case_number)}/,
+        path: '/requestpayablecasefees'
+      },
+      status: 200, body: no_fees.to_json
+    )
+
+    Excon.stub(
+      {
+        method: :post,
+        host: 'glimr-test.dsd.io',
+        body: /caseNumber=#{CGI.escape(case_number)}/,
+        path: '/requestpayablecasefees'
+      },
+      status: 200, body: twenty_pound_fee.to_json
+    )
+  end
+end
+
+RSpec.shared_examples 'report payment taken to glimr' do |req_body|
+  let(:paymenttaken_response) {
+    {
+      feeLiabilityId: 1234,
+      feeTransactionId: 1234,
+      paidAmountInPence: 9999
+    }
+  }
+
+  before do
+    Excon.stub(
+      {
+        method: :post,
+        host: 'glimr-test.dsd.io',
+        body: req_body,
+        path: '/paymenttaken'
+      },
+      status: 200, body: paymenttaken_response.to_json
+    )
+  end
+end
+
+RSpec.shared_examples 'glimr fee_paid returns a 500' do
+  before do
+    Excon.stub(
+      {
+        method: :post,
+        host: 'glimr-test.dsd.io',
+        path: '/paymenttaken'
+      },
+      status: 500
+    )
+  end
+end
+
+RSpec.shared_examples 'glimr times out' do
+  let(:glimr_check) {
+    class_double(Excon, 'glimr availability')
+  }
+
+  before do
+    expect(glimr_check).
+      to receive(:post).
+      with(path: '/glimravailable', body: '').
+      and_raise(Excon::Errors::Timeout)
+
+    expect(Excon).to receive(:new).
+      with(Rails.configuration.glimr_api_url, anything).
+      and_return(glimr_check)
+  end
+end
+
+RSpec.shared_examples 'glimr has a socket error' do
+  let(:glimr_check) {
+    class_double(Excon, 'glimr availability')
+  }
+
+  before do
+    expect(glimr_check).
+      to receive(:post).
+      with(path: '/glimravailable', body: '').
+      and_raise(Excon::Errors::SocketError)
+
+    expect(Excon).to receive(:new).
+      with('https://glimr-test.dsd.io', anything).
+      and_return(glimr_check)
+  end
+end