defra_ruby_govpay 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 985dbbc4e62af28fb16d7af3ff829f171dd570f41014b2408eb07e686d3776a3
+  data.tar.gz: 6605967ad08002c8633f82cef44f3910dbf1c5e66546ad6a2565ec92dd2792f2
+SHA512:
+  metadata.gz: 24b85aa48412e7e55e33f3ed8a8c31536370f6fb8c8f34a0460c39c17b582812752f53f50328729ce09aea05c167a9e7d80b2b4f3825e844dd262530ab89b4df
+  data.tar.gz: 22092a2f738956cec84167e3dc3d834024e69e1c7d5812049f2a40a1bf7c0409e425fa42b0abae151140c98916a1f15c7112e7586b1ca3e1f54a87a9b254de9d

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-09-06
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in govpay_integration.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+gem "webmock", "~> 3.4"

data/Gemfile.lock

@@ -0,0 +1,90 @@
+PATH
+  remote: .
+  specs:
+    defra_ruby_govpay (0.1.0)
+      rest-client (~> 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.5)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    mime-types (3.5.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2023.0808)
+    netrc (0.11.0)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    public_suffix (5.0.3)
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.54.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.4.2)
+    webmock (3.19.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  defra_ruby_govpay!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  webmock (~> 3.4)
+
+BUNDLED WITH
+   2.4.8

data/README.md

@@ -0,0 +1,84 @@
+# Defra Ruby Govpay Ruby Gem
+
+The `defra-ruby-govpay` gem facilitates seamless integration with GovPay services, specifically tailored for DEFRA's WCR and WEX applications. It aims to abstract the integration code, offering a flexible and adaptable solution that requires minimal assumptions about the application's data models.
+
+## Table of Contents
+
+1. [Installation](#installation)
+2. [Configuration](#configuration)
+3. [Usage](#usage)
+4. [Error Handling](#error-handling)
+5. [Testing](#testing)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'defra-ruby-govpay'
+```
+And then execute
+```sh
+bundle install
+```
+
+Or install it yourself as:
+```sh
+gem install defra-ruby-govpay
+```
+
+## Configuration
+
+Before you start using the gem, you need to configure it according to your requirements. Create an initializer file (e.g., `config/initializers/govpay.rb`) and set the necessary parameters:
+
+```ruby
+DefraRubyGovpay.configure do |config|
+  config.govpay_url = 'https://your-govpay-url.com'
+  config.govpay_front_office_api_token = 'your-front-office-token'
+  config.govpay_back_office_api_token = 'your-back-office-token'
+  config.host_is_back_office = false
+  # ... any other configurations
+end
+```
+
+## Usage
+
+Here is a detailed guide on how to use the various components of the `defra-ruby-govpay` gem in your application:
+
+## Sending a Request
+
+You can send requests to the GovPay API using the `send_request` method. Here's an example:
+
+after having followed the configuration step:
+```ruby
+govpay_api = DefraRubyGovpay::API.new
+
+begin
+  response = govpay_api.send_request(
+    method: :get,
+    path: '/path/to/endpoint',
+    params: { param1: 'value1', param2: 'value2' },
+    is_moto: false
+  )
+  puts "Response received: #{response}"
+rescue DefraRubyGovpay::GovpayApiError => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+## Error Handling
+
+Errors are handled through the DefraRubyGovpay::GovpayApiError class. Here's an example of how you can handle errors:
+```ruby
+begin
+  # some code that might raise an error
+rescue DefraRubyGovpay::GovpayApiError => e
+  puts "An error occurred: #{e.message}"
+end
+```
+
+## Testing
+
+```
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "govpay_integration"
+
+# 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(__FILE__)

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/defra_ruby_govpay.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/defra_ruby_govpay/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "defra_ruby_govpay"
+  spec.version = DefraRubyGovpay::VERSION
+  spec.authors = ["Jerome Pratt"]
+  spec.email = ["jerome.pratt@defra.gov.uk"]
+
+  spec.summary = "A Ruby gem facilitating integration with Govpay services in ruby applications."
+  spec.description = "This gem abstracts the Govpay integration code, facilitating " \
+                     "integration within defra ruby applications."
+  spec.homepage = "https://github.com/DEFRA/defra-ruby-govpay"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/DEFRA/defra-ruby-govpay"
+
+  spec.add_dependency "rest-client", "~> 2.1"
+  spec.require_paths = ["lib"]
+
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+end

data/lib/defra_ruby_govpay/api.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "rest-client"
+
+module DefraRubyGovpay
+  # Custom error class to handle Govpay API errors
+  class GovpayApiError < StandardError
+    def initialize(msg = "Govpay API error")
+      super
+    end
+  end
+
+  # The API class is responsible for making requests to the Govpay API.
+  # It handles the construction of request URLs, headers, and payload,
+  # and also deals with any errors that occur during the API request.
+  class API
+    def initialize(config = DefraRubyGovpay.configuration)
+      @config = config
+      @is_back_office = config.host_is_back_office
+      @front_office_token = config.govpay_front_office_api_token
+      @back_office_token = config.govpay_back_office_api_token
+    end
+
+    def send_request(method:, path:, params: nil, is_moto: false)
+      puts build_log_message(method, path, params, is_moto)
+
+      begin
+        response = execute_request(method, path, params, is_moto)
+        puts "Received response from Govpay: #{response}"
+        response
+      rescue StandardError => error
+        handle_error(error, method, path, params)
+      end
+    end
+
+    private
+
+    def build_log_message(method, path, params, is_moto)
+      "#{self.class} sending #{method} request to govpay (#{path}), params: #{params}, moto: #{is_moto}"
+    end
+
+    def execute_request(method, path, params, is_moto)
+      RestClient::Request.execute(
+        method: method,
+        url: url(path),
+        payload: payload(params),
+        headers: {
+          "Authorization" => "Bearer #{bearer_token(is_moto)}",
+          "Content-Type" => "application/json"
+        }
+      )
+    end
+
+    def handle_error(error, method, path, params)
+      error_message = "Error sending request to govpay (#{method} #{path}, params: #{params}): #{error}"
+      puts error_message
+      raise GovpayApiError, error_message
+    end
+
+    def url(path)
+      "#{@config.govpay_url}#{path}"
+    end
+
+    def bearer_token(is_moto)
+      return @front_office_token unless @is_back_office
+
+      is_moto ? @back_office_token : @front_office_token
+    end
+
+    def payload(params)
+      return nil if params.nil? || params.empty?
+
+      params.compact.to_json
+    end
+  end
+end

data/lib/defra_ruby_govpay/configuration.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module DefraRubyGovpay
+  # The Configuration class is responsible for storing configurable settings
+  # for the DefraRubyGovpay module. You can set different options like
+  # API tokens, host preferences, and other necessary configurations here.
+  class Configuration
+    attr_accessor :govpay_url, :govpay_front_office_api_token, :govpay_back_office_api_token, :host_is_back_office
+  end
+end

data/lib/defra_ruby_govpay/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DefraRubyGovpay
+  VERSION = "0.1.2"
+end

data/lib/defra_ruby_govpay.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "defra_ruby_govpay/version"
+require_relative "defra_ruby_govpay/configuration"
+require_relative "defra_ruby_govpay/api"
+
+# The DefraRubyGovpay module facilitates integration with Govpay services.
+# It provides a convenient and configurable way to interact with Govpay APIs in Defra's ruby applications.
+module DefraRubyGovpay
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+end

data/sig/defra_ruby_govpay.rbs

@@ -0,0 +1,4 @@
+module DefraRubyGovpay
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: defra_ruby_govpay
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jerome Pratt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: This gem abstracts the Govpay integration code, facilitating integration
+  within defra ruby applications.
+email:
+- jerome.pratt@defra.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- defra_ruby_govpay.gemspec
+- lib/defra_ruby_govpay.rb
+- lib/defra_ruby_govpay/api.rb
+- lib/defra_ruby_govpay/configuration.rb
+- lib/defra_ruby_govpay/version.rb
+- sig/defra_ruby_govpay.rbs
+homepage: https://github.com/DEFRA/defra-ruby-govpay
+licenses: []
+metadata:
+  source_code_uri: https://github.com/DEFRA/defra-ruby-govpay
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: A Ruby gem facilitating integration with Govpay services in ruby applications.
+test_files: []