pr-pin 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf49a91cbc72d1af5343df37fbd964f8bb43306f26f7352918658919afec0bbc
-  data.tar.gz: c75dd94684dc08a730a3635644b4a2a497f0073d0e00334898cc521ddf62ef2b
+  metadata.gz: 3f65867e3c6f97d7f757e23c199c1b167aafd1a1767587d3d3bbe08b7723b1c3
+  data.tar.gz: cf527404ec9820b32de96b39f9fb6c0393de564839182a7ee0806dd456c74594
 SHA512:
-  metadata.gz: 85489fea42558f6c607f6bd5fe558b24dd0b035303171692aba94e2b992ae63102c50291f10b0e97cce142ff0cb148a2bf299ce8e4c8ff00bff534c6073eeb19
-  data.tar.gz: 4a2cd43d7a7687153833d5e69f467fa6694257dc6c3c79e701c68df98a86bfae3c2714db99248f98215851cf1e6f16849209ffc0d5b9e976024ffabd30718eed
+  metadata.gz: 1b54eb6c97cb8a674d1c89ec09f11b52d0d20fbd7c85dd28f5b5ffeee6c72e6deb57fcb40840721c23e39a1103e6f9342efbd877a70f634555b175f9fb4a522c
+  data.tar.gz: e630995c83be98c087a628f29e41048baa1c63d86d21f0c2dd6fde2e6727994b0c8b8302c6b0b903fbe5762bb1b8d6689f1ed26e515b8bd3e9cebf4cc3fa15b7

data/README.md

@@ -66,6 +66,10 @@ charge = PR::Pin.charges.create(
 charge.success? # => true
 charge.error? # => false
 charge # => #<PR::Pin::Struct::Charge>
+
+# Find a charge by token
+PR::Pin.charges.find('ch_1ee2d1')
+# => #<PR::Pin::Struct::Charge>
 ```
 
 ### Recurring payments
@@ -88,6 +92,35 @@ subscription = PR::Pin.subscriptions.create(
 subscription.success? # => true
 subscription.error? # => false
 subscription # => #<PR::Pin::Struct::Subscription>
+
+ledger = PR::Pin.ledger.for_subscription('sub_293857')
+subscription.success? # => true
+subscription.error? # => false
+ledger
+# => [
+#   #<PR::Pin::Struct::Ledger type="credit" annotation="charge_credit" amount=1026 currency="AUD" created_at=#<DateTime: 2020-07-02T02:19:50+00:00 ((2459033j,8390s,0n),+0s,2299161j)>>,
+#   #<PR::Pin::Struct::Ledger type="debit" annotation="interval_fee" amount=1026 currency="AUD" created_at=#<DateTime: 2020-07-02T02:19:47+00:00 ((2459033j,8387s,0n),+0s,2299161j)>>,
+#   #<PR::Pin::Struct::Ledger type="debit" annotation="setup_fee" amount=0 currency="AUD" created_at=#<DateTime: 2020-07-02T02:19:47+00:00 ((2459033j,8387s,0n),+0s,2299161j)>>
+# ]
+```
+
+### Refunds
+```ruby
+# List refunds (paginated)
+refunds = PR::Pin.refunds.list
+# => [#<PR::Pin::Struct::Refund>, ...]
+
+# Find a specific refund
+refund = PR::Pin.refunds.find('rf_1e5429')
+# => #<PR::Pin::Struct::Refund>
+
+# Create a refund for a charge
+PR::Pin.refunds.create_for_charge('ch_1ee2d1')
+# => #<PR::Pin::Struct::Refund>
+
+# List all refunds by charge
+PR::Pin.refunds.for_charge('ch_1ee2d1')
+# => [#<PR::Pin::Struct::Refund>, ...]
 ```
 
 ### Errors - See [PR::Pin::API::Error](https://github.com/PetRescue/pr-pin/blob/master/lib/pr/pin/api/error.rb)
@@ -115,7 +148,7 @@ Coverage of https://pinpayments.com/developers/api-reference
 | Charges | PUT /charges/charge-token/capture | Captures a previously authorised charge | [:link:](https://pinpayments.com/developers/api-reference/charges#put-charges) | :x: |
 | Charges | GET /charges | Returns a paginated list of all charges | [:link:](https://pinpayments.com/developers/api-reference/charges#get-charges) | :heavy_check_mark: |
 | Charges | GET /charges/search | Returns a paginated list of charges matching the search criteria | [:link:](https://pinpayments.com/developers/api-reference/charges#search-charges) | :heavy_check_mark: |
-| Charges | GET /charges/charge-token | Returns the details of a charge | [:link:](https://pinpayments.com/developers/api-reference/charges#get-charge) | :x: |
+| Charges | GET /charges/charge-token | Returns the details of a charge | [:link:](https://pinpayments.com/developers/api-reference/charges#get-charge) | :heavy_check_mark: |
 | Customers | POST /customers | Creates a new customer | [:link:](https://pinpayments.com/developers/api-reference/customers#post-customers) | :heavy_check_mark: |
 | Customers | GET /customers | Returns a paginated list of all customers | [:link:](https://pinpayments.com/developers/api-reference/customers#get-customers) | :heavy_check_mark: |
 | Customers | GET /customers/customer-token | Returns the details of a customer | [:link:](https://pinpayments.com/developers/api-reference/customers#get-customer) | :x: |
@@ -141,16 +174,16 @@ Coverage of https://pinpayments.com/developers/api-reference
 | Subscriptions | PUT /subscriptions/sub-token | Updates the card associated with a subscription identified by subscription token | [:link:](https://pinpayments.com/developers/api-reference/subscriptions#update-subscription) | :x: |
 | Subscriptions | DELETE /subscriptions/sub-token | Cancels the subscription identified by subscription token | [:link:](https://pinpayments.com/developers/api-reference/subscriptions#delete-subscription) | :x: |
 | Subscriptions | PUT /subscriptions/sub-token/reactivate | Reactivates the subscription identified by subscription token | [:link:](https://pinpayments.com/developers/api-reference/subscriptions#reactivate-subscription) | :x: |
-| Subscriptions | GET /subscriptions/sub-token/ledger | Fetch the ledger entries relating to a subscription identified by subscription token | [:link:](https://pinpayments.com/developers/api-reference/subscriptions#ledger-subscription) | :x: |
+| Subscriptions | GET /subscriptions/sub-token/ledger | Fetch the ledger entries relating to a subscription identified by subscription token | [:link:](https://pinpayments.com/developers/api-reference/subscriptions#ledger-subscription) | :heavy_check_mark: |
 | Recipients | POST /recipients | Creates a new recipient | [:link:](https://pinpayments.com/developers/api-reference/recipients#post-recipients) | :x: |
 | Recipients | GET /recipients | Returns a paginated list of all recipients | [:link:](https://pinpayments.com/developers/api-reference/recipients#get-recipients) | :x: |
 | Recipients | GET /recipients/recipient-token | Returns the details of a recipient | [:link:](https://pinpayments.com/developers/api-reference/recipients#get-recipient) | :x: |
 | Recipients | PUT /recipients/recipient-token | Updates the details of a recipient | [:link:](https://pinpayments.com/developers/api-reference/recipients#put-recipient) | :x: |
 | Recipients | GET /recipients/recipient-token/transfers | Returns a paginated list of a recipient's transfers | [:link:](https://pinpayments.com/developers/api-reference/recipients#get-recipients-transfers) | :x: |
-| Refunds | GET /refunds | Returns a paginated list of all refunds | [:link:](https://pinpayments.com/developers/api-reference/refunds#get-refunds) | :x: |
-| Refunds | GET /refunds/refund-token | Returns the details of the specified refund | [:link:](https://pinpayments.com/developers/api-reference/refunds#get-refund) | :x: |
-| Refunds | POST  /charges/charge-token/refunds | Creates a new refund and returns its details | [:link:](https://pinpayments.com/developers/api-reference/refunds#post-refunds) | :x: |
-| Refunds | GET /charges/charge-token/refunds | Returns a list of all refunds for the specified charge | [:link:](https://pinpayments.com/developers/api-reference/refunds#get-token-refunds) | :x: |
+| Refunds | GET /refunds | Returns a paginated list of all refunds | [:link:](https://pinpayments.com/developers/api-reference/refunds#get-refunds) | :heavy_check_mark: |
+| Refunds | GET /refunds/refund-token | Returns the details of the specified refund | [:link:](https://pinpayments.com/developers/api-reference/refunds#get-refund) | :heavy_check_mark: |
+| Refunds | POST  /charges/charge-token/refunds | Creates a new refund and returns its details | [:link:](https://pinpayments.com/developers/api-reference/refunds#post-refunds) | :heavy_check_mark: |
+| Refunds | GET /charges/charge-token/refunds | Returns a list of all refunds for the specified charge | [:link:](https://pinpayments.com/developers/api-reference/refunds#get-token-refunds) | :heavy_check_mark: |
 | Transfers | POST /transfers | Creates a new transfer | [:link:](https://pinpayments.com/developers/api-reference/transfers#post-transfers) | :x: |
 | Transfers | GET /transfers | Returns a paginated list of all transfers | [:link:](https://pinpayments.com/developers/api-reference/transfers#get-transfers) | :x: |
 | Transfers | GET /transfers/search | Returns a paginated list of transfers matching the search criteria | [:link:](https://pinpayments.com/developers/api-reference/transfers#search-transfers) | :x: |

data/lib/pr/pin.rb

@@ -57,10 +57,18 @@ module PR
         Repositories::Customers.new(environments[identifier])
       end
 
+      def ledger(identifier = :default)
+        Repositories::Ledger.new(environments[identifier])
+      end
+
       def plans(identifier = :default)
         Repositories::Plans.new(environments[identifier])
       end
 
+      def refunds(identifier = :default)
+        Repositories::Refunds.new(environments[identifier])
+      end
+
       def subscriptions(identifier = :default)
         Repositories::Subscriptions.new(environments[identifier])
       end

data/lib/pr/pin/adapter/commands.rb

@@ -4,6 +4,7 @@ module PR
       module Commands
         class Create < ROM::HTTP::Commands::Create
           adapter :pr_pin
+          restrictable true
 
           def execute(*args, &block)
             relation.new(super.map(&:to_h)).to_a
@@ -12,6 +13,7 @@ module PR
 
         class Update < ROM::HTTP::Commands::Update
           adapter :pr_pin
+          restrictable true
 
           def execute(*args, &block)
             relation.new(super.map(&:to_h)).to_a
@@ -20,6 +22,7 @@ module PR
 
         class Delete < ROM::HTTP::Commands::Delete
           adapter :pr_pin
+          restrictable true
         end
       end
     end

data/lib/pr/pin/relations/ledger.rb

@@ -0,0 +1,19 @@
+module PR
+  module Pin
+    module Relations
+      class Ledger < ROM::Relation[:pr_pin]
+        schema(:ledger) do
+          attribute :type, Types::Strict::String
+          attribute :annotation, Types::Strict::String
+          attribute :amount, Types::Strict::Integer
+          attribute :currency, Types::Strict::String
+          attribute :created_at, Types::JSON::DateTime
+        end
+
+        def for_subscription(token)
+          with_base_path("/subscriptions/#{token}/ledger")
+        end
+      end
+    end
+  end
+end

data/lib/pr/pin/relations/refunds.rb

@@ -0,0 +1,22 @@
+module PR
+  module Pin
+    module Relations
+      class Refunds < ROM::Relation[:pr_pin]
+        schema(:refunds) do
+          attribute :token, Types::Strict::String
+          attribute :success, Types::Bool.optional
+          attribute :amount, Types::Strict::Integer
+          attribute :currency, Types::Strict::String
+          attribute :charge, Types::Strict::String
+          attribute :error_message, Types::Strict::String.optional
+          attribute :status_message, Types::Strict::String
+          attribute :created_at, Types::JSON::DateTime
+        end
+
+        def for_charge(token)
+          with_base_path("/charges/#{token}/refunds")
+        end
+      end
+    end
+  end
+end

data/lib/pr/pin/relations/subscriptions.rb

@@ -5,7 +5,7 @@ module PR
         schema(:subscriptions) do
           attribute :state, Types::Strict::String
           attribute :next_billing_date, Types::JSON::DateTime
-          attribute :active_interval_started_at, Types::JSON::DateTime
+          attribute :active_interval_started_at, Types::JSON::DateTime.optional
           attribute :active_interval_finishes_at, Types::JSON::DateTime.optional
           attribute :cancelled_at, Types::JSON::DateTime.optional
           attribute :created_at, Types::JSON::DateTime

data/lib/pr/pin/repositories.rb

@@ -6,5 +6,7 @@ require 'pr/pin/struct'
 require 'pr/pin/repositories/concerns/common'
 require 'pr/pin/repositories/charges'
 require 'pr/pin/repositories/customers'
+require 'pr/pin/repositories/ledger'
 require 'pr/pin/repositories/plans'
+require 'pr/pin/repositories/refunds'
 require 'pr/pin/repositories/subscriptions'

data/lib/pr/pin/repositories/charges.rb

@@ -4,6 +4,12 @@ module PR
       class Charges < ROM::Repository[:charges]
         include Concerns::Common
 
+        def find(token)
+          relation = root.with_path(token)
+
+          API::Result.wrap(relation) { relation.one }
+        end
+
         def search(**params)
           relation = root.append_path('search').with_params(params)
 

data/lib/pr/pin/repositories/ledger.rb

@@ -0,0 +1,18 @@
+module PR
+  module Pin
+    module Repositories
+      class Ledger < ROM::Repository[:ledger]
+        struct_namespace PR::Pin::Struct
+
+        def for_subscription(token, page: 1, per_page: nil)
+          relation = root.for_subscription(token).with_params(
+            page: page,
+            per_page: per_page
+          )
+
+          API::PaginatedResult.wrap(relation) { relation.paginate }
+        end
+      end
+    end
+  end
+end

data/lib/pr/pin/repositories/refunds.rb

@@ -0,0 +1,41 @@
+module PR
+  module Pin
+    module Repositories
+      class Refunds < ROM::Repository[:refunds]
+        struct_namespace PR::Pin::Struct
+
+        def list(page: 1, per_page: nil)
+          relation = root.with_params(
+            page: page,
+            per_page: per_page
+          )
+
+          API::PaginatedResult.wrap(relation) { relation.paginate }
+        end
+
+        def find(token)
+          relation = root.with_path(token)
+
+          API::Result.wrap(relation) { relation.one }
+        end
+
+        def create_for_charge(token, *args)
+          relation = root.for_charge(token)
+
+          API::Result.wrap(relation) do
+            relation.command(:create).call(*args)
+          end
+        end
+
+        def for_charge(token, page: 1, per_page: nil)
+          relation = root.for_charge(token).with_params(
+            page: page,
+            per_page: per_page
+          )
+
+          API::PaginatedResult.wrap(relation) { relation.paginate }
+        end
+      end
+    end
+  end
+end

data/lib/pr/pin/version.rb

@@ -1,5 +1,5 @@
 module PR
   module Pin
-    VERSION = '0.4.0'.freeze
+    VERSION = '0.6.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pr-pin
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - AMHOL
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,13 +192,17 @@ files:
 - lib/pr/pin/inflector.rb
 - lib/pr/pin/relations/charges.rb
 - lib/pr/pin/relations/customers.rb
+- lib/pr/pin/relations/ledger.rb
 - lib/pr/pin/relations/plans.rb
+- lib/pr/pin/relations/refunds.rb
 - lib/pr/pin/relations/subscriptions.rb
 - lib/pr/pin/repositories.rb
 - lib/pr/pin/repositories/charges.rb
 - lib/pr/pin/repositories/concerns/common.rb
 - lib/pr/pin/repositories/customers.rb
+- lib/pr/pin/repositories/ledger.rb
 - lib/pr/pin/repositories/plans.rb
+- lib/pr/pin/repositories/refunds.rb
 - lib/pr/pin/repositories/subscriptions.rb
 - lib/pr/pin/struct.rb
 - lib/pr/pin/types.rb