govuk-pay-api-client 0.1.0

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/README.md

@@ -0,0 +1,138 @@
+[![CircleCI](https://circleci.com/gh/ministryofjustice/govuk-pay-api-client.svg?style=svg&circle-token=7fcc2b811dde84109b6615aa4e7b6ed89350ea53)](https://circleci.com/gh/ministryofjustice/govuk-pay-api-client)
+
+# GovukPayApiClient
+
+A simple client to integrate with the Govuk Pay payment gateway.
+
+## Usage
+
+### Create Payment
+
+```ruby
+GovukPayApiClient::CreatePayment.call(<fee object>, <url to return to>)
+```
+
+The first argument is a fee object that must repond to `#description`
+(text), `#reference` (string), and `#amount` (integer, in pence). The
+second object is a url string that tell the Govuk Pay gateway where to
+return the user after a successful payment.  Both are required.
+
+`GovukPayApiClient::RequiresFeeObject` will be raised if a fee object is
+not supplied.
+
+`GovukPayApiClient::RequiresReturnUrl` will be raised if a return url is
+not supplied.
+
+### Get Status
+
+```ruby
+GovukPayApiClient::GetStatus.call(<fee object>)
+```
+
+Requires a fee object that must respond to `#govpay_payment_id`, which
+should return an id that is valid on the Govuk Pay gateway.
+
+It returns an object with the method `#status` for a successful calls.
+Unsuccessful calls raise errors in the 400 to 599 status range and will
+therefore raise `GovukPayApiClient::Unavailable` errors.
+
+`GovukPayApiClient::RequiresFeeObject` will be raised if a fee object is
+not supplied.
+
+### Errors
+
+If any `GovukPayApiClient` post or get request returns a status in the
+400 to 599 range, the client will raise
+`GovukPayApiClient::Unavailable`.  It will also raise
+`GovukPayApiClient::Unavailable` if the connection times out or is
+otherwise unavailable.
+
+
+## Examples
+
+See the dummy Rails app in `/spec/dummy` for examples of how the gem might
+be used in a production environment.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'govuk-pay-api-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install govuk-pay-api-client
+
+## Testing
+
+Run `bundle rake` in the gem source directory for a full set of specs,
+mutation tests and rubocop checks.
+
+### Shared examples
+
+The gem can install a set of shared examples in your app that will stub
+a sensible set of API calls using Excon’s stubbing functionality. To
+install these, install the gem, make sure you have the `spec/support`
+subdirectory then run:
+
+```ruby
+bundle exec rake govuk_pay_api_client:install_shared_examples
+```
+
+This will install `spec/support/shared_examples_for_govpay.rb`.
+
+Lastly, add these lines to `spec/rails_helper`:
+
+```ruby
+  config.before(:all) do
+    Excon.defaults[:mock] = true
+  end
+
+  config.after(:each) do
+    Excon.stubs.clear
+  end
+```
+
+## Contributing
+
+Fork, then clone the repo:
+
+```bash
+git clone git@github.com:your-username/govuk-pay-api-client.git
+```
+
+Make sure the tests pass:
+
+```bash
+bundle
+bundle db:setup
+bundle exec rake
+```
+
+Make your change. Add specs for your change. Make the specs pass:
+
+```bash
+bundle exec rake
+```
+
+Push to your fork and [submit a pull request][pr].
+
+[pr]: https://github.com/ministryofjustice/govuk-pay-api-client/compare
+
+Some things that will increase the chance that your pull request is
+accepted:
+
+* Write specs.
+* Make sure you don’t have any mutants (part of total test suite).
+* Write a [good commit message][commit].
+
+[commit]: https://github.com/alphagov/styleguides/blob/master/git.md
+
+## License
+Released under the [MIT License](http://opensource.org/licenses/MIT).
+Copyright (c) 2015-2016 Ministry of Justice.

data/Rakefile

@@ -0,0 +1,16 @@
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+# Get rid of rspec background noise.
+task(:spec).clear
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+task default: :spec
+
+load 'tasks/mutant.rake'
+load 'tasks/rubocop.rake'

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "govuk/pay/api/client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

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

data/govuk-pay-api-client.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'govuk_pay_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'govuk-pay-api-client'
+  spec.version = GovukPayApiClient::VERSION
+  spec.authors = ['Todd Tyree']
+  spec.email = ['tatyree@gmail.com']
+
+  spec.summary = %q{An API client to handle Govuk Pay interactions}
+  spec.homepage = 'https://github.com/ministryofjustice/govuk-pay-api-client/'
+  spec.licenses = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'capybara', '~> 2.7'
+  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/govuk_pay_api_client/api.rb

@@ -0,0 +1,61 @@
+module GovukPayApiClient
+  module Api
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def call(*args)
+        new(*args).call
+      end
+    end
+
+    def post
+      @post ||=
+        client.post(path: endpoint, body: request_body.to_json).tap { |resp|
+          # Only timeouts and network issues raise errors.
+          handle_response_errors(resp)
+          @body = resp.body
+        }
+    rescue Excon::Error => e
+      raise Unavailable, e
+    end
+
+    def get
+      @get ||=
+        client.get(path: endpoint).tap { |resp|
+          # Only timeouts and network issues raise errors.
+          handle_response_errors(resp)
+          @body = resp.body
+        }
+    rescue Excon::Error => e
+      raise Unavailable, e
+    end
+
+    def response_body
+      @response_body ||= JSON.parse(@body, symbolize_names: true)
+    rescue JSON::ParserError
+      ''
+    end
+
+    private
+
+    def handle_response_errors(resp)
+      if (400..599).cover?(resp.status)
+        raise Unavailable, resp.status
+      end
+    end
+
+    def client
+      @client ||= Excon.new(
+        ENV.fetch('GOVUK_PAY_API_URL'),
+        headers: {
+          'Authorization' => "Bearer #{ENV.fetch('GOVUK_PAY_API_KEY')}",
+          'Content-Type' => 'application/json',
+          'Accept' => 'application/json'
+        },
+        persistent: true
+      )
+    end
+  end
+end

data/lib/govuk_pay_api_client/create_payment.rb

@@ -0,0 +1,39 @@
+module GovukPayApiClient
+  class CreatePayment
+    include GovukPayApiClient::Api
+    attr_accessor :fee, :return_url
+
+    def initialize(fee, return_url)
+      raise RequiresFeeObject if fee.blank?
+      raise RequiresReturnUrl if return_url.blank?
+      @fee = fee
+      @return_url = return_url
+    end
+
+    def call
+      post
+      parsed_response
+    end
+
+    private
+
+    def endpoint
+      '/payments'
+    end
+
+    def parsed_response
+      OpenStruct.new(
+        next_url: response_body.fetch(:_links).fetch(:next_url).fetch(:href)
+      )
+    end
+
+    def request_body
+      {
+        return_url: return_url,
+        description: fee.description,
+        reference: fee.govpay_reference,
+        amount: fee.amount
+      }
+    end
+  end
+end

data/lib/govuk_pay_api_client/get_status.rb

@@ -0,0 +1,28 @@
+module GovukPayApiClient
+  class GetStatus
+    include GovukPayApiClient::Api
+    attr_accessor :fee
+
+    def initialize(fee = nil)
+      raise RequiresFeeObject if fee.blank?
+      @fee = fee
+    end
+
+    def call
+      get
+      parsed_response
+    end
+
+    private
+
+    def parsed_response
+      OpenStruct.new(
+        status: response_body.fetch(:state).fetch(:status)
+      )
+    end
+
+    def endpoint
+      "/payments/#{fee.govpay_payment_id}"
+    end
+  end
+end

data/lib/govuk_pay_api_client/version.rb

@@ -0,0 +1,3 @@
+module GovukPayApiClient
+  VERSION = '0.1.0'
+end

data/lib/govuk_pay_api_client.rb

@@ -0,0 +1,10 @@
+require 'govuk_pay_api_client/version'
+require 'govuk_pay_api_client/api'
+require 'govuk_pay_api_client/create_payment'
+require 'govuk_pay_api_client/get_status'
+
+module GovukPayApiClient
+  class Unavailable < StandardError; end
+  class RequiresFeeObject < StandardError; end
+  class RequiresReturnUrl < StandardError; end
+end

data/lib/tasks/mutant.rake

@@ -0,0 +1,10 @@
+task :mutant do
+  vars = 'NOCOVERAGE=true'
+  flags = '--include lib --use rspec --fail-fast'
+  unless system("#{vars} mutant #{flags} GovukPayApiClient*")
+    raise 'Mutation testing failed'
+  end
+end
+
+task(:default).prerequisites << task(:mutant)
+

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 :govuk_pay_api_client do
+  desc 'Copy the shared examples for govuk pay api rspec testing'
+  task :install_shared_examples
+    source = File.join(
+      Gem.loaded_specs['govuk-pay-api-client'].full_gem_path,
+      'shared_examples',
+      'shared_examples_for_govpay.rb'
+    )
+    target = File.join(Rails.root, 'spec', 'support', 'shared_examples_for_govpay.rb')
+    FileUtils.cp_r source, target
+end

data/shared_examples/shared_examples_for_govpay.rb

@@ -0,0 +1,188 @@
+module GovpayExample
+  module Mocks
+    def glimr_api_call
+      class_double(
+        Excon,
+        'glimr availability check',
+        post: instance_double(
+          Excon::Response,
+          status: 200,
+          body: { glimrAvailable: 'yes' }.to_json
+        )
+      )
+    end
+
+    def a_create_payment_success(initial_payment_response)
+      class_double(
+        Excon,
+        'glimr availability check',
+        post: instance_double(
+          Excon::Response,
+          status: 200,
+          body: initial_payment_response
+        )
+      )
+    end
+
+    def a_create_payment_timeout
+      class_double(Excon, 'create payment timeout').tap { |ex|
+        expect(ex).to receive(:post).and_raise(Excon::Errors::Timeout)
+      }
+    end
+
+    def a_payment_status_timeout
+      class_double(Excon, 'create payment timeout').tap { |ex|
+        expect(ex).to receive(:get).and_raise(Excon::Errors::Timeout)
+      }
+    end
+  end
+
+  module Responses
+    def initial_payment_response(payment_id = 'rmpaurrjuehgpvtqg997bt50f')
+      {
+        'payment_id' => payment_id,
+        'payment_provider' => 'sandbox',
+        'amount' => 2000,
+        'state' => {
+          'status' => 'created',
+          'finished' => false
+        },
+        'description' => 'TC/2016/00001 - Lodgement Fee',
+        'return_url' => 'https://www-integration-2.pymnt.uk/liabilities/960eb61a-a592-4e79-a5f8-c35cde24352a/post_pay',
+        'reference' => '7G20160718180649',
+        'created_date' => '2016-07-18T17:06:53.172Z',
+        '_links' => {
+          'self' => {
+            'href' => 'https://publicapi.pymnt.uk/v1/payments/rmpaurrjuehgpvtqg997bt50fm',
+            'method' => 'GET'
+          },
+          'next_url' => {
+            'href' => 'https://www-integration-2.pymnt.uk/secure/94b35000-37f2-44e6-a2f5-c0193ca1e98a',
+            'method' => 'GET'
+          }
+        }
+      }.to_json
+    end
+
+    def post_pay_response
+      {
+        'payment_id' => 'oio28jhr7mj6rqc9g12pff2i44',
+        'payment_provider' => 'sandbox', 'amount' => 2000,
+        'state' => {
+          'status' => 'success',
+          'finished' => true
+        },
+        'description' => 'TC/2016/00001 - Lodgement Fee',
+        'return_url' => 'https://www-integration-2.pymnt.uk/liabilities/7f475fde-b509-4612-bffb-e2dac0066f4c/post_pay',
+        'reference' => '7G20160725115358',
+        'created_date' => '2016-07-25T10:54:00.294Z',
+        '_links' => {
+          'self' => {
+            'href' => 'https://publicapi.pymnt.uk/v1/payments/oio28jhr7mj6rqc9g12pff2i44',
+            'method' => 'GET'
+          },
+          'next_url' => nil,
+          'next_url_post' => nil,
+          'events' => {
+            'href' => 'https://publicapi.pymnt.uk/v1/payments/oio28jhr7mj6rqc9g12pff2i44/events',
+            'method' => 'GET'
+          },
+          'cancel' => nil
+        }
+      }.to_json
+    end
+  end
+end
+
+RSpec.shared_examples 'govpay payment response' do |fee, govpay_payment_id|
+  include GovpayExample::Responses
+
+  let(:request_body) {
+    {
+      return_url: 'the_return_url',
+      description: fee.description,
+      reference: fee.govpay_reference,
+      amount: fee.amount
+    }.to_json
+  }
+
+  before do
+    Excon.stub(
+      {
+        method: :post,
+        host: 'govpay-test.dsd.io',
+        body: request_body,
+        path: '/payments'
+      },
+      status: 201, body: initial_payment_response(govpay_payment_id)
+    )
+
+    Excon.stub(
+      {
+        method: :get,
+        host: 'govpay-test.dsd.io',
+        path: "/payments/#{govpay_payment_id}"
+      },
+      status: 200, body: post_pay_response
+    )
+  end
+end
+
+RSpec.shared_examples 'govpay returns a 404' do |fee|
+
+  let(:request_body) {
+    {
+      return_url: 'the_return_url',
+      description: fee.description,
+      reference: fee.govpay_reference,
+      amount: fee.amount
+    }.to_json
+  }
+
+  before do
+    Excon.stub(
+      {
+        method: :post,
+        host: 'govpay-test.dsd.io',
+        body: request_body,
+        path: '/payments'
+      },
+      status: 404
+    )
+  end
+end
+
+RSpec.shared_examples 'govpay post_pay returns a 500' do |govpay_payment_id|
+  before do
+    Excon.stub(
+      {
+        method: :get,
+        host: 'govpay-test.dsd.io',
+        path: "/payments/#{govpay_payment_id}"
+      },
+      status: 500, body: '{"message":"Govpay is not working"}'
+    )
+  end
+end
+
+RSpec.shared_examples 'govpay payment status times out' do
+  include GovpayExample::Responses
+  include GovpayExample::Mocks
+
+  before do
+    expect(Excon).to receive(:new).
+      and_return(
+        a_payment_status_timeout
+      )
+  end
+end
+
+RSpec.shared_examples 'govpay create payment times out' do
+  include GovpayExample::Responses
+  include GovpayExample::Mocks
+
+  before do
+    expect(Excon).to receive(:new).
+      and_return(a_create_payment_timeout)
+  end
+end