defra_ruby_govpay 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43f6940a760136d9ec07fa6996afff0915b9e49833c06684b4385409ea07a3ae
-  data.tar.gz: 02d6a26ad6c1020683d185d6204d7d3711a06516bfbd80803ca685ff3d45f2e6
+  metadata.gz: ebc3e1002f53ab4c0e4a467375e730feac353cd05d9fb701e6a643a0b783645a
+  data.tar.gz: d6437d4b6f89f745737b903debb6b34819e17eba8ff7f59fbb641b45780e07b9
 SHA512:
-  metadata.gz: ddbbe449a23f25decf13b4bcdf9d84d2cc86d936d543c4426594c30392f28e61c1f50da4d40e4fcef9008d7079e2413383601e2bad6031048a45e562b325d75e
-  data.tar.gz: 9a8a6eae7022ffa666801384f622f44fbc2a7924841171f1993ffe814c64fbe6444a49d83091637046521196c45465612048c986378e5f4dd684b74475697a53
+  metadata.gz: ea2d5f0d93136560796f261b8ed2b7fb955196fa85708b40372ea61a3486cab12f4cf93de3463ea336ccf1ba3dfc672ffee00fa93f10a8305ce936ad2d1a74bd
+  data.tar.gz: 6badf44aaa4a8bc9bc0f0b6111f144d8b2fd8f455832be5c1489e2e3b523ea35d95863b939310dadcf68aa6fb7636cdf605d96423def9bb875adbd0117dc89ab

data/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  versioning-strategy: lockfile-only

data/.gitignore

@@ -9,3 +9,4 @@
 *.gem
 # rspec failure tracking
 .rspec_status
+.byebug_history

data/.rubocop.yml

@@ -1,17 +1,5 @@
-AllCops:
-  TargetRubyVersion: 2.6
+inherit_from: .rubocop_todo.yml
 
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
+inherit_gem:
+  defra_ruby_style:
+    - default.yml

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-11-03 17:41:17 UTC using RuboCop version 1.57.2.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+Style/OpenStructUse:
+  Exclude:
+    - 'lib/defra_ruby_govpay/object.rb'

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -5,10 +5,18 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in govpay_integration.gemspec
 gemspec
 
+gem "byebug"
+
+gem "github_changelog_generator"
+
+gem "defra_ruby_style", "~> 0.4"
+
 gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"
 
 gem "webmock", "~> 3.4"

data/Gemfile.lock

@@ -1,45 +1,124 @@
 PATH
   remote: .
   specs:
-    defra_ruby_govpay (0.1.2)
+    defra_ruby_govpay (0.2.2)
       rest-client (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.1.1)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
     addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
+    async (2.6.5)
+      console (~> 1.10)
+      fiber-annotation
+      io-event (~> 1.1)
+      timers (~> 4.1)
+    async-http (0.61.0)
+      async (>= 1.25)
+      async-io (>= 1.28)
+      async-pool (>= 0.2)
+      protocol-http (~> 0.25.0)
+      protocol-http1 (~> 0.16.0)
+      protocol-http2 (~> 0.15.0)
+      traces (>= 0.10.0)
+    async-http-faraday (0.12.0)
+      async-http (~> 0.42)
+      faraday
+    async-io (1.36.1)
+      async
+    async-pool (0.4.0)
+      async (>= 1.25)
+    base64 (0.1.1)
+    bigdecimal (3.1.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
+    console (1.23.2)
+      fiber-annotation
+      fiber-local
     crack (0.4.5)
       rexml
+    defra_ruby_style (0.4.0)
+      rubocop (>= 1.0, < 2.0)
+      rubocop-factory_bot
+      rubocop-rake
+      rubocop-rspec
     diff-lcs (1.5.0)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    drb (2.1.1)
+      ruby2_keywords
+    faraday (2.7.11)
+      base64
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-http-cache (2.5.0)
+      faraday (>= 0.8)
+    faraday-net_http (3.0.2)
+    fiber-annotation (0.2.0)
+    fiber-local (1.0.0)
+    github_changelog_generator (1.16.4)
+      activesupport
+      async (>= 1.25.0)
+      async-http-faraday
+      faraday-http-cache
+      multi_json
+      octokit (~> 4.6)
+      rainbow (>= 2.2.1)
+      rake (>= 10.0)
     hashdiff (1.0.1)
     http-accept (1.7.0)
     http-cookie (1.0.5)
       domain_name (~> 0.5)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    io-event (1.3.3)
     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)
+    minitest (5.20.0)
+    multi_json (1.15.0)
+    mutex_m (0.1.2)
     netrc (0.11.0)
+    octokit (4.25.1)
+      faraday (>= 1, < 3)
+      sawyer (~> 0.9)
     parallel (1.23.0)
-    parser (3.2.2.3)
+    parser (3.2.2.4)
       ast (~> 2.4.1)
       racc
+    protocol-hpack (1.4.2)
+    protocol-http (0.25.0)
+    protocol-http1 (0.16.0)
+      protocol-http (~> 0.22)
+    protocol-http2 (0.15.1)
+      protocol-hpack (~> 1.4)
+      protocol-http (~> 0.18)
     public_suffix (5.0.3)
-    racc (1.7.1)
+    racc (1.7.2)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.1)
+    regexp_parser (2.8.2)
     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)
+    rexml (3.2.6)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
@@ -53,38 +132,62 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.1)
-    rubocop (1.54.1)
+    rubocop (1.57.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.2.2.4)
       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)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
+    rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.19.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.24.0)
+      rubocop (~> 1.33)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.25.0)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sawyer (0.9.2)
+      addressable (>= 2.3.5)
+      faraday (>= 0.17.3, < 3)
+    timers (4.3.5)
+    traces (0.11.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.8.2)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
     webmock (3.19.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  x86_64-darwin-21
   x86_64-darwin-22
 
 DEPENDENCIES
+  byebug
   defra_ruby_govpay!
+  defra_ruby_style (~> 0.4)
+  github_changelog_generator
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
   webmock (~> 3.4)
 
 BUNDLED WITH
-   2.4.8
+   2.4.13

data/defra_ruby_govpay.gemspec

@@ -12,14 +12,15 @@ Gem::Specification.new do |spec|
   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.required_ruby_version = ">= 3.2.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
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/defra_ruby_govpay/api.rb

@@ -22,38 +22,41 @@ module DefraRubyGovpay
     end
 
     def send_request(method:, path:, params: nil, is_moto: false)
-      puts build_log_message(method, path, params, is_moto)
+      @is_moto = is_moto
+      DefraRubyGovpay.logger.debug build_log_message(method, path, params)
 
       begin
-        response = execute_request(method, path, params, is_moto)
-        puts "Received response from Govpay: #{response}"
+        response = execute_request(method, path, params)
+        DefraRubyGovpay.logger.debug "Received response from Govpay: #{response}"
         response
-      rescue StandardError => error
-        handle_error(error, method, path, params)
+      rescue StandardError => e
+        handle_error(e, 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}"
+    def build_log_message(method, path, params)
+      "#{self.class} sending #{method} request to govpay (#{path}), params: #{params}, moto: #{@is_moto}, " \
+        "govpay API token ending \"#{bearer_token[-5..]}\""
     end
 
-    def execute_request(method, path, params, is_moto)
+    def execute_request(method, path, params)
       RestClient::Request.execute(
         method: method,
         url: url(path),
         payload: payload(params),
         headers: {
-          "Authorization" => "Bearer #{bearer_token(is_moto)}",
+          "Authorization" => "Bearer #{bearer_token}",
           "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
+      error_message = "Error sending request to govpay (#{method} #{path}, params: #{params}), " \
+                      "response body #{JSON.parse(error.response.body)}: #{error}"
+      DefraRubyGovpay.logger.error error_message
       raise GovpayApiError, error_message
     end
 
@@ -61,10 +64,12 @@ module DefraRubyGovpay
       "#{@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
+    def bearer_token
+      @bearer_token ||= if @is_back_office
+                          @is_moto ? @back_office_token : @front_office_token
+                        else
+                          @front_office_token
+                        end
     end
 
     def payload(params)

data/lib/defra_ruby_govpay/version.rb

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

data/lib/defra_ruby_govpay.rb

@@ -20,4 +20,13 @@ module DefraRubyGovpay
     self.configuration ||= Configuration.new
     yield(configuration)
   end
+
+  # Use DefraRubyGovpay.logger if it exists, else use a simple console logger
+  def self.logger
+    @logger ||= defined?(Rails) ? Rails.logger : Logger.new($stdout)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_govpay
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Jerome Pratt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -32,9 +32,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -56,6 +59,7 @@ homepage: https://github.com/DEFRA/defra-ruby-govpay
 licenses: []
 metadata:
   source_code_uri: https://github.com/DEFRA/defra-ruby-govpay
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -64,14 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A Ruby gem facilitating integration with Govpay services in ruby applications.