defra_ruby_govpay 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba54aba1349d8a9f7f7e7091775e4687b69ba8b3437a980fd0f355d8648db453
-  data.tar.gz: ea4115db350c21ba48e867aebbeb4b96791aa89852ca41144b0065cb07bc19df
+  metadata.gz: 50914b4891648701b6e1d7e553820f3938c232af1e52666ddc99c60fc12e22e6
+  data.tar.gz: b893ef2af65fadf32e9dc5e437a4303f9f538e597751a976378046d87410ae38
 SHA512:
-  metadata.gz: 5d1da26faac8cd47483c60a8f66c32b405654978e4322b3258812009a336ef6409ddd68a763248070e7dd5b08f95e658d25710b283a2be0425bb877ea6ab0e70
-  data.tar.gz: 9d64fc44573910e2aedd3290065d5d0f3743b12218af85466f2b3bfc8ca7fc5c99636456b59e99b07de2250ddb9a82055a02e34b29121693f6a2b574165370d7
+  metadata.gz: 6518bb755f204d0e71c717b7c4e4ee1c1cc325596fb43dff3b8d034488d6489f4729d7e798e93ca3d2d186d57f19b02ab1159a38ba68a14a4090affc579cced3
+  data.tar.gz: 71e3faefb42675a382fe7eb872ab5f08e96843d1fe54a46770c2f75e986fa0950837d1d69e415670014bb0bd46e44245fbfcd27fa6a74d33843a29ea0ab3914b

data/CHANGELOG.md

@@ -1,5 +1,64 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2023-09-06
+## [Unreleased](https://github.com/DEFRA/defra-ruby-govpay/tree/HEAD)
 
-- Initial release
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.2.4...HEAD)
+
+**Fixed bugs:**
+
+- fix host\_is\_back\_office [\#11](https://github.com/DEFRA/defra-ruby-govpay/pull/11) ([PaulDoyle-DEFRA](https://github.com/PaulDoyle-DEFRA))
+
+## [v0.2.4](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.2.4) (2023-11-10)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.2.3...v0.2.4)
+
+**Fixed bugs:**
+
+- fix DefraRubyGovpay config [\#9](https://github.com/DEFRA/defra-ruby-govpay/pull/9) ([PaulDoyle-DEFRA](https://github.com/PaulDoyle-DEFRA))
+
+**Merged pull requests:**
+
+- Version 0.2.4 [\#10](https://github.com/DEFRA/defra-ruby-govpay/pull/10) ([PaulDoyle-DEFRA](https://github.com/PaulDoyle-DEFRA))
+- Bump rake from 13.0.6 to 13.1.0 [\#6](https://github.com/DEFRA/defra-ruby-govpay/pull/6) ([dependabot[bot]](https://github.com/apps/dependabot))
+
+## [v0.2.3](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.2.3) (2023-11-07)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.2.2...v0.2.3)
+
+**Implemented enhancements:**
+
+- Chore/ruby 2769 enhance govpay logging [\#8](https://github.com/DEFRA/defra-ruby-govpay/pull/8) ([PaulDoyle-DEFRA](https://github.com/PaulDoyle-DEFRA))
+
+## [v0.2.2](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.2.2) (2023-11-06)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.2.1...v0.2.2)
+
+**Implemented enhancements:**
+
+- gem version 0.2.2 [\#7](https://github.com/DEFRA/defra-ruby-govpay/pull/7) ([PaulDoyle-DEFRA](https://github.com/PaulDoyle-DEFRA))
+- Chore/ruby 2769 enhance govpay logging [\#5](https://github.com/DEFRA/defra-ruby-govpay/pull/5) ([PaulDoyle-DEFRA](https://github.com/PaulDoyle-DEFRA))
+
+## [v0.2.1](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.2.1) (2023-10-03)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.2.0...v0.2.1)
+
+## [v0.2.0](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.2.0) (2023-09-26)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.1.2...v0.2.0)
+
+## [v0.1.2](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.1.2) (2023-09-18)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/v0.1.1...v0.1.2)
+
+**Merged pull requests:**
+
+- release/v0.1.2 [\#4](https://github.com/DEFRA/defra-ruby-govpay/pull/4) ([jjromeo](https://github.com/jjromeo))
+- gem version 0.1.0 [\#1](https://github.com/DEFRA/defra-ruby-govpay/pull/1) ([jjromeo](https://github.com/jjromeo))
+
+## [v0.1.1](https://github.com/DEFRA/defra-ruby-govpay/tree/v0.1.1) (2023-09-18)
+
+[Full Changelog](https://github.com/DEFRA/defra-ruby-govpay/compare/1bd9ccaffdb51137f980d553336b5dddf2f4901d...v0.1.1)
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -7,6 +7,8 @@ gemspec
 
 gem "byebug"
 
+gem "github_changelog_generator"
+
 gem "defra_ruby_style", "~> 0.4"
 
 gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,16 +1,53 @@
 PATH
   remote: .
   specs:
-    defra_ruby_govpay (0.2.2)
+    defra_ruby_govpay (0.2.5)
       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)
@@ -21,24 +58,60 @@ GEM
     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.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.2)
     rainbow (3.1.1)
-    rake (13.0.6)
+    rake (13.1.0)
     regexp_parser (2.8.2)
     rest-client (2.1.0)
       http-accept (>= 1.7.0, < 2.0)
@@ -83,6 +156,14 @@ GEM
       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)
@@ -95,11 +176,13 @@ GEM
 PLATFORMS
   x86_64-darwin-21
   x86_64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   byebug
   defra_ruby_govpay!
   defra_ruby_style (~> 0.4)
+  github_changelog_generator
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -36,7 +36,6 @@ 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
 ```
@@ -49,9 +48,10 @@ Here is a detailed guide on how to use the various components of the `defra-ruby
 
 You can send requests to the GovPay API using the `send_request` method. Here's an example:
 
-after having followed the configuration step:
+After having followed the configuration step, create an API instance. This has a mandatory parameter to indicate
+whether the host is a back-office application, in which case any payments it creates will be flagged as MOTO.
 ```ruby
-govpay_api = DefraRubyGovpay::API.new
+govpay_api = DefraRubyGovpay::API.new(host_is_back_office: false)
 
 begin
   response = govpay_api.send_request(

data/lib/defra_ruby_govpay/api.rb

@@ -3,6 +3,7 @@
 require "rest-client"
 
 module DefraRubyGovpay
+
   # Custom error class to handle Govpay API errors
   class GovpayApiError < StandardError
     def initialize(msg = "Govpay API error")
@@ -13,12 +14,11 @@ module DefraRubyGovpay
   # 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
+
+    def initialize(host_is_back_office:)
+      @host_is_back_office = host_is_back_office
     end
 
     def send_request(method:, path:, params: nil, is_moto: false)
@@ -60,16 +60,28 @@ module DefraRubyGovpay
       raise GovpayApiError, error_message
     end
 
+    def govpay_url
+      @govpay_url ||= DefraRubyGovpay.configuration.govpay_url
+    end
+
     def url(path)
-      "#{@config.govpay_url}#{path}"
+      "#{govpay_url}#{path}"
+    end
+
+    def front_office_token
+      @front_office_token ||= DefraRubyGovpay.configuration.govpay_front_office_api_token
+    end
+
+    def back_office_token
+      @back_office_token ||= DefraRubyGovpay.configuration.govpay_back_office_api_token
     end
 
     def bearer_token
-      @bearer_token ||= if @is_back_office
-                          @is_moto ? @back_office_token : @front_office_token
-                        else
-                          @front_office_token
-                        end
+      if @host_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/configuration.rb

@@ -5,6 +5,6 @@ module DefraRubyGovpay
   # 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
+    attr_accessor :govpay_url, :govpay_front_office_api_token, :govpay_back_office_api_token
   end
 end

data/lib/defra_ruby_govpay/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_govpay
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Jerome Pratt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client