defra_ruby_mocks 4.0.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c648dae3e678030c2d132615c0d148b673bedacde6d9d0e653dd2f20710fe4f9
-  data.tar.gz: '0948298e72ee7c2adb8e5cd98ff71eaf0f72de6fe9a9faf0aa0e6ae1e3699c3b'
+  metadata.gz: fbc211a8e66923ea6517dd55d0f327c43b8b67e74981e8e49600a46eeb5ddd80
+  data.tar.gz: e28bfc2b91cfac3f76e8cf19dcee4cb00a2eb6e598826663f60d7e1ece4d2902
 SHA512:
-  metadata.gz: 1cdb1d9e9b0f434ef1b7bcc58de8f5ec79c07bb10621772cd705ef33bad0a66a7767b764df299a8b506af750b296429b814a5b4575385b66d08cf8f985853778
-  data.tar.gz: 4ca9a9935239757a5af2874392c85de2df9e9a1c93ee504610a8430b6179004de218b2ef9fb06ef20ffdc4e9edcc1f0d812d9ee14ed06a024ed14c46279dd50c
+  metadata.gz: b80a0af3f9ddd3711de5cac260152d2d7f503b74aece65788f6d96a805638501cb662ecec5a5c3572555a7972ab376ebf866b986ec1b56d8737763e6b571991e
+  data.tar.gz: c2036eb0aa7586a4d41c61ae7575b626f328e7900b5bc1318ea8c1c8b8648c84aab82d2826b8d29e81b7e75dca3ff6f67b07a90411bd7eb3cfcbe3b3cc98abc9

data/README.md

@@ -178,7 +178,7 @@ In order to use the govpay mock you'll need to provide additional configuration
 require "defra_ruby_mocks"
 
 DefraRubyMocks.configure do |config|
-  config.govpay_domain = File.join(ENV["WCRS_GOVPAY_DOMAIN"] || "http://localhost:3002", "/fo/mocks/govpay/v1")
+  config.govpay_domain = File.join(ENV["WCRS_GOVPAY_MOCK_DOMAIN"] || "http://localhost:3002", "/fo/mocks/govpay/v1")
 end
 ```
 

data/app/controllers/defra_ruby_mocks/govpay_controller.rb

@@ -8,17 +8,30 @@ module DefraRubyMocks
     def create_payment
       valid_create_params
 
-      # Enqueue the payment callback to run after the controller responds
-      DefraRubyMocks::GovpayPaymentCallbackJob.perform_later(params[:return_url])
+      store_return_url(params[:return_url])
 
       render json: GovpayCreatePaymentService.new.run(
-        amount: params[:amount], description: params[:description], return_url: params[:return_url]
+        amount: params[:amount], description: params[:description]
       )
     rescue StandardError => e
       Rails.logger.error("MOCKS: Govpay payment creation error: #{e.message}")
       head 500
     end
 
+    # This mocks the Govpay route which presents the payment details page to the user.
+    # We don't mock the actual payment details and payment confirmation pages - we go
+    # straight to the application callback route.
+    def next_url
+      response_url = retrieve_return_url
+      Rails.logger.warn "Govpay mock calling response URL #{response_url}"
+      redirect_to response_url, allow_other_host: true
+    rescue RestClient::ExceptionWithResponse => e
+      Rails.logger.warn "Govpay mock: RestClient received response: #{e}"
+    rescue StandardError => e
+      Rails.logger.error("Govpay mock: Error sending request to govpay: #{e}")
+      Airbrake.notify(e, message: "Error on govpay request")
+    end
+
     def payment_details
       valid_payment_id
       render json: GovpayGetPaymentService.new.run(payment_id: params[:payment_id])
@@ -44,6 +57,27 @@ module DefraRubyMocks
       head 500
     end
 
+    private
+
+    def s3_bucket_name
+      @s3_bucket_name = ENV.fetch("GOVPAY_MOCKS_BUCKET", "defra-ruby-mocks-s3bkt001")
+    end
+
+    def return_url_file_name
+      @return_url_file_name = "return_url_file"
+    end
+
+    # We need to persist the return_url between the initial payment creation request and the execution of next_url.
+    # We can't use tmp for multi-server environments so we load the temp file to AWS S3.
+    def store_return_url(return_url)
+      Rails.logger.warn ":::::: storing return_url #{return_url}"
+      AwsBucketService.write(s3_bucket_name, return_url_file_name, return_url)
+    end
+
+    def retrieve_return_url
+      AwsBucketService.read(s3_bucket_name, return_url_file_name)
+    end
+
     def valid_create_params
       params.require(%i[amount description return_url])
     end

data/app/services/defra_ruby_mocks/aws_bucket_service.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module DefraRubyMocks
+  class AwsBucketService
+
+    attr_accessor :bucket_name, :file_name
+
+    def self.write(bucket_name, file_name, content)
+      new.write(bucket_name, file_name, content)
+    end
+
+    def self.read(bucket_name, file_name)
+      new.read(bucket_name, file_name)
+    end
+
+    def write(bucket_name, file_name, content)
+      @bucket_name = bucket_name
+      @file_name = file_name
+
+      write_temp_file(content)
+
+      load_temp_file_to_s3
+
+      true
+    end
+
+    def read(bucket_name, file_name)
+      Rails.logger.warn ":::::: reading from S3"
+
+      s3 = Aws::S3::Client.new
+      s3.get_object(bucket: bucket_name, key: file_name)
+    rescue Aws::S3::NoSuchBucket => e
+      raise StandardError, e
+    end
+
+    private
+
+    def temp_filepath
+      "#{Dir.tmpdir}/#{file_name}"
+    end
+
+    def write_temp_file(content)
+      Rails.logger.warn ":::::: creating temp file for #{content}"
+      File.write(temp_filepath, content)
+    end
+
+    def load_temp_file_to_s3
+      Rails.logger.warn ":::::: loading temp file to S3"
+
+      result = nil
+
+      3.times do
+        result = bucket.load(File.new(temp_filepath, "r"))
+
+        break if result.successful?
+      end
+
+      raise(result&.error) unless result&.successful?
+    end
+
+    def bucket
+      @bucket ||= DefraRuby::Aws.get_bucket(bucket_name)
+    end
+  end
+end

data/app/services/defra_ruby_mocks/govpay_create_payment_service.rb

@@ -5,12 +5,12 @@ require "securerandom"
 module DefraRubyMocks
   class GovpayCreatePaymentService < BaseService
 
-    def run(amount:, description:, return_url:)
+    def run(amount:, description:)
       success_response.merge(
         {
           _links: {
             self: { href: "#{base_url}/#{payment_id}", method: "GET" },
-            next_url: { href: return_url, method: "GET" }
+            next_url: { href: "#{base_url}/secure/next-url-uuid-abc123", method: "GET" }
           },
           amount: amount.to_i,
           description: description,

data/app/services/defra_ruby_mocks/govpay_refund_details_service.rb

@@ -3,6 +3,8 @@
 module DefraRubyMocks
   class GovpayRefundDetailsService < BaseService
 
+    DEFAULT_LAST_REFUND_REQUEST_TIME = 1.day.ago.freeze
+
     def run(payment_id:, refund_id:) # rubocop:disable Lint/UnusedMethodArgument
       {
         amount: 2000,
@@ -19,24 +21,37 @@ module DefraRubyMocks
 
     # "submitted" for up to GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG seconds after the last refund request, then "success"
     def status
-      timestamp = File.read("#{Dir.tmpdir}/govpay_request_refund_service_last_run_time")
-      last_refund_time = timestamp ? Time.parse(timestamp) : 1.day.ago
+      last_refund_time = refund_request_timestamp
       submitted_success_lag = ENV.fetch("GOVPAY_REFUND_SUBMITTED_SUCCESS_LAG", 0).to_i
       cutoff_time = (last_refund_time + submitted_success_lag.seconds).to_time
       return "success" if submitted_success_lag.zero?
 
       Time.zone.now < cutoff_time ? "submitted" : "success"
     rescue Errno::ENOENT
-      write_timestamp_file("govpay_request_refund_service_last_run_time")
+      write_timestamp_file
 
       "success"
     end
 
-    def write_timestamp_file(filename)
-      filepath = "#{Dir.tmpdir}/#{filename}"
+    def write_timestamp_file
+      timestamp = Time.zone.now
+      Rails.logger.warn ":::::: writing timestamp file: #{timestamp}"
+      AwsBucketService.write(s3_bucket_name, timestamp_file_name, timestamp)
+    end
+
+    def s3_bucket_name
+      @s3_bucket_name = ENV.fetch("GOVPAY_MOCKS_BUCKET", "defra-ruby-mocks-s3bkt001")
+    end
+
+    def timestamp_file_name
+      @govpay_request_refund_service_last_run_time = "govpay_request_refund_service_last_run_time"
+    end
 
-      # FileUtils.touch seems unreliable in VM so need to write/read the actual time
-      File.write(filepath, Time.zone.now)
+    def refund_request_timestamp
+      timestamp = AwsBucketService.read(s3_bucket_name, timestamp_file_name)
+      timestamp ? Time.parse(timestamp) : DEFAULT_LAST_REFUND_REQUEST_TIME
+    rescue StandardError
+      DEFAULT_LAST_REFUND_REQUEST_TIME
     end
 
   end

data/app/services/defra_ruby_mocks/govpay_request_refund_service.rb

@@ -19,9 +19,16 @@ module DefraRubyMocks
 
     # let the refund details service know how long since the refund was requested
     def write_timestamp
-      filepath = "#{Dir.tmpdir}/govpay_request_refund_service_last_run_time"
-      # FileUtils.touch seems unreliable in VM so need to write/read the actual time
-      File.write(filepath, Time.zone.now)
+      Rails.logger.warn ":::::: storing refund request timestamp"
+      AwsBucketService.write(s3_bucket_name, timestamp_file_name, Time.zone.now.to_s)
+    end
+
+    def s3_bucket_name
+      @s3_bucket_name = ENV.fetch("GOVPAY_MOCKS_BUCKET", "defra-ruby-mocks-s3bkt001")
+    end
+
+    def timestamp_file_name
+      @timestamp_file_name = "govpay_request_refund_service_last_run_time"
     end
   end
 end

data/config/routes.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-DefraRubyMocks::Engine.routes.draw do
+DefraRubyMocks::Engine.routes.draw do # rubocop:disable Metrics/BlockLength
   get "/company/:id",
       to: "company#show",
       as: "company",
@@ -16,6 +16,11 @@ DefraRubyMocks::Engine.routes.draw do
        as: "govpay_create_payment",
        constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
 
+  get "/govpay/v1/payments/secure/:uuid",
+      to: "govpay#next_url",
+      as: "govpay_next_url",
+      constraints: ->(_request) { DefraRubyMocks.configuration.enabled? }
+
   get "/govpay/v1/payments/:payment_id",
       to: "govpay#payment_details",
       as: "govpay_payment_details",

data/lib/defra_ruby_mocks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DefraRubyMocks
-  VERSION = "4.0.0"
+  VERSION = "4.2.0"
 end

data/lib/defra_ruby_mocks.rb

@@ -12,12 +12,6 @@ module DefraRubyMocks
     def configuration
       @configuration ||= Configuration.new
     end
-
-    # Added for testing. Without we cannot test both a config object with and
-    # with set values in the same rspec session
-    def reset_configuration
-      @configuration = nil
-    end
   end
 
   def self.configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_mocks
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Defra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-05 00:00:00.000000000 Z
+date: 2024-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,30 +28,44 @@ dependencies:
   name: sprockets
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: defra_ruby_aws
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 description: A Rails engine which can be used to mock external services when loaded
   into an application
 email:
@@ -66,8 +80,7 @@ files:
 - app/controllers/defra_ruby_mocks/application_controller.rb
 - app/controllers/defra_ruby_mocks/company_controller.rb
 - app/controllers/defra_ruby_mocks/govpay_controller.rb
-- app/jobs/defra_ruby_mocks/application_job.rb
-- app/jobs/defra_ruby_mocks/govpay_payment_callback_job.rb
+- app/services/defra_ruby_mocks/aws_bucket_service.rb
 - app/services/defra_ruby_mocks/base_service.rb
 - app/services/defra_ruby_mocks/companies_house_service.rb
 - app/services/defra_ruby_mocks/govpay_create_payment_service.rb

data/app/jobs/defra_ruby_mocks/application_job.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/jobs/defra_ruby_mocks/govpay_payment_callback_job.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module DefraRubyMocks
-  class GovpayPaymentCallbackJob < DefraRubyMocks::ApplicationJob
-    queue_as :default
-
-    def perform(*response_url)
-      Rails.logger.debug "GovpayPaymentCallbackJob calling response URL #{response_url}"
-      RestClient::Request.execute(method: :GET, url: response_url[0])
-    rescue RestClient::ExceptionWithResponse => e
-      Rails.logger.debug "GovpayPaymentCallbackJob: RestClient received response: #{e}"
-    rescue StandardError => e
-      Rails.logger.error("GovpayPaymentCallbackJob: Error sending request to govpay: #{e}")
-      Airbrake.notify(e, message: "Error on govpay request")
-    end
-  end
-end