defra_ruby_govpay 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 985dbbc4e62af28fb16d7af3ff829f171dd570f41014b2408eb07e686d3776a3
-  data.tar.gz: 6605967ad08002c8633f82cef44f3910dbf1c5e66546ad6a2565ec92dd2792f2
+  metadata.gz: 43f6940a760136d9ec07fa6996afff0915b9e49833c06684b4385409ea07a3ae
+  data.tar.gz: 02d6a26ad6c1020683d185d6204d7d3711a06516bfbd80803ca685ff3d45f2e6
 SHA512:
-  metadata.gz: 24b85aa48412e7e55e33f3ed8a8c31536370f6fb8c8f34a0460c39c17b582812752f53f50328729ce09aea05c167a9e7d80b2b4f3825e844dd262530ab89b4df
-  data.tar.gz: 22092a2f738956cec84167e3dc3d834024e69e1c7d5812049f2a40a1bf7c0409e425fa42b0abae151140c98916a1f15c7112e7586b1ca3e1f54a87a9b254de9d
+  metadata.gz: ddbbe449a23f25decf13b4bcdf9d84d2cc86d936d543c4426594c30392f28e61c1f50da4d40e4fcef9008d7079e2413383601e2bad6031048a45e562b325d75e
+  data.tar.gz: 9a8a6eae7022ffa666801384f622f44fbc2a7924841171f1993ffe814c64fbe6444a49d83091637046521196c45465612048c986378e5f4dd684b74475697a53

data/.gitignore

@@ -6,6 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
-
+*.gem
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    defra_ruby_govpay (0.1.0)
+    defra_ruby_govpay (0.1.2)
       rest-client (~> 2.1)
 
 GEM

data/lib/defra_ruby_govpay/error.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class Error < DefraRubyGovpay::Object
+end

data/lib/defra_ruby_govpay/object.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "ostruct"
+
+module DefraRubyGovpay
+  # Generic Object. Takes the hash/Json returned from the Govpay API
+  # and gives us openstruct objects for easier reading/consuming
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      case obj
+      when Hash
+        OpenStruct.new(obj.transform_values { |v| to_ostruct(v) })
+      when Array
+        obj.map { |o| to_ostruct(o) }
+      when String
+        string_reader(obj)&.strip
+      else # Likely a primative value
+        obj
+      end
+    end
+
+    def string_reader(value)
+      return if nil_value?(value)
+
+      value = value.to_s
+      value = yield value if block_given?
+
+      value
+    end
+
+    def nil_value?(value)
+      value.nil? ||
+        %w[nil null].any?(
+          value
+        .to_s
+        .strip
+        .downcase
+        )
+    end
+  end
+end

data/lib/defra_ruby_govpay/payment.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module DefraRubyGovpay
+  # The Payment class represents a payment object in the Govpay Integration.
+  # It contains methods to check refund status and details about the payment.
+  class Payment < Object
+    def refundable?(amount_requested = 0)
+      refund.status == "available" &&
+        refund.amount_available > refund.amount_submitted &&
+        amount_requested <= refund.amount_available
+    end
+
+    def refund
+      refund_summary
+    end
+  end
+end

data/lib/defra_ruby_govpay/refund.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module DefraRubyGovpay
+  # The Refund class represents a refund object in the Govpay Integration.
+  # It provides methods to check the status of a refund.
+  class Refund < Object
+    def success?
+      status == "success"
+    end
+
+    def submitted?
+      status == "submitted"
+    end
+  end
+end

data/lib/defra_ruby_govpay/version.rb

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

data/lib/defra_ruby_govpay.rb

@@ -3,6 +3,10 @@
 require "json"
 require_relative "defra_ruby_govpay/version"
 require_relative "defra_ruby_govpay/configuration"
+require_relative "defra_ruby_govpay/object"
+require_relative "defra_ruby_govpay/payment"
+require_relative "defra_ruby_govpay/refund"
+require_relative "defra_ruby_govpay/error"
 require_relative "defra_ruby_govpay/api"
 
 # The DefraRubyGovpay module facilitates integration with Govpay services.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: defra_ruby_govpay
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jerome Pratt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2023-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -46,6 +46,10 @@ files:
 - lib/defra_ruby_govpay.rb
 - lib/defra_ruby_govpay/api.rb
 - lib/defra_ruby_govpay/configuration.rb
+- lib/defra_ruby_govpay/error.rb
+- lib/defra_ruby_govpay/object.rb
+- lib/defra_ruby_govpay/payment.rb
+- lib/defra_ruby_govpay/refund.rb
 - lib/defra_ruby_govpay/version.rb
 - sig/defra_ruby_govpay.rbs
 homepage: https://github.com/DEFRA/defra-ruby-govpay