priority_payout_gateway 0.9.0 → 0.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +36 -5
  3. data/lib/priority_payout_gateway/version.rb +1 -1
  4. data/priority_payout_gateway.gemspec +1 -1
  5. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 7beb080f9e76ef0360439d1cc37125cf507cf6b1
4
- data.tar.gz: 76b2b24dd75c53468d0ad5279ba631f6b834e871
3
+ metadata.gz: 4f21b7c99c550fef447b2f0d3016c8f8984c84d5
4
+ data.tar.gz: cd265b48a531064d8435275f78676e06a4f43f70
5
5
  SHA512:
6
- metadata.gz: 162c5b8722faf734f93199fdf0c24c6eb7736ed18ee6b610ecf530c7013bfe5bef65f119923db95cd1bc97d37e2b80961e4581151b661b12563c56e3b697ba75
7
- data.tar.gz: 9f873e9a6a8ffbd193d9d7b464453165f240d14c10cd2a84fb3ef3099f4de426e08640ffac1dad7086686476d17b7ba8287527e578f7247c4ea16d1002ccb9a7
6
+ metadata.gz: 2bb68ec00fae4ba016f0ef44421aa9bbe52034a6c097783d52357fe41f2c33c1dc24ae112fb0ee3108e43b9c29fc24e76dd87bc6d6bea575fafae42a6e72ef57
7
+ data.tar.gz: 683304821bb2e11ca9c67591f947ee522c61bd1671f014f5c4cc0acd2113c40743faa6f43553024b29728825584208825a282db33d91d45de1b02d5ba9809a11
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # PriorityPayoutGateway
1
+ [![Gem Version](https://badge.fury.io/rb/priority_payout_gateway.svg)](https://badge.fury.io/rb/priority_payout_gateway)
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/priority_payout_gateway`. To experiment with that code, run `bin/console` for an interactive prompt.
3
+ # Priority Payout Gateway
4
4
 
5
- TODO: Delete this and the text above, and describe your gem
5
+ This gem implements the Priority Payout Gateway (NMI) Direct Post & Query API sets as documented here: https://secure.prioritypayoutgateway.com/merchants/resources/integration/integration_portal.php
6
6
 
7
7
  ## Installation
8
8
 
@@ -22,7 +22,38 @@ Or install it yourself as:
22
22
 
23
23
  ## Usage
24
24
 
25
- TODO: Write usage instructions here
25
+ Set your username & password in an environment variable in your application or in a `.env` file directly from the gem:
26
+ ```
27
+ PPG_USERNAME = my_user
28
+ PPG_PASSWORD = my_pass
29
+ ```
30
+
31
+ There are three API sets:
32
+
33
+ ### Transaction
34
+ `sale` - `PriorityPayoutGateway::Transaction.new.sale ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", amount: 22.30, email: "john@doe.com", country: "US"`
35
+ `authorize` - `PriorityPayoutGateway::Transaction.new.authorize ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", amount: 22.25, email: "john@doe.com", country: "US" `
36
+ `capture` - `PriorityPayoutGateway::Transaction.new.capture transactionid: 3261830498, amount: 22.30 `
37
+ `void` - `PriorityPayoutGateway::Transaction.new.void transactionid: 3261830498, amount: 22.30 `
38
+ `refund` - `PriorityPayoutGateway::Transaction.new.refund transactionid: 3261844010, amount: 5 `
39
+ `update` - `PriorityPayoutGateway::Transaction.new.update transactionid: 3261844010, first_name: "joe" `
40
+ `find` - Implements Query Api - `PriorityPayoutGateway::Transaction.new.find transactionid: 3261844010 `
41
+ `credit` - `PriorityPayoutGateway::Transaction.new.credit ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", amount: 22.30, email: "john@doe.com", country: "US" `
42
+ `validate` - `PriorityPayoutGateway::Transaction.new.validate ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe", email: "john@doe.com", country: "US" `
43
+
44
+ ### Customer Vault
45
+ `create` - `PriorityPayoutGateway::CustomerVault.new.create ccnumber: '4111111111111111', ccexp: "0219", first_name: "John", last_name: "Doe"`
46
+ `update` - `PriorityPayoutGateway::CustomerVault.new.update customer_vault_id: 481397475, ccnumber: '4111111111111111', ccexp: "0220", first_name: "Jane", last_name: "Doe"`
47
+ `destroy` - `PriorityPayoutGateway::CustomerVault.new.destroy customer_vault_id: 481397475`
48
+ `find` - Implements Query Api - `PriorityPayoutGateway::CustomerVault.new.find customer_vault_id: 481397475`
49
+
50
+ ### Recurring
51
+ `create_plan` - `PriorityPayoutGateway::Recurring.new.create_plan plan_amount: 1.99, plan_name: "Test 1.99", plan_id: "test-1", month_frequency: 1, day_of_month: 1`
52
+ `add_subscription_to_plan` - `PriorityPayoutGateway::Recurring.new.add_subscription_to_plan plan_id: "test-1", customer_vault_id: 664625840`
53
+ `add_custom_subscription` - `PriorityPayoutGateway::Recurring.new.add_custom_subscription plan_amount: 1.99, month_frequency: 1, day_of_month: 1, customer_vault_id: 664625840`
54
+ `update_subscription` - `PriorityPayoutGateway::Recurring.new.update_subscription subscription_id: "3261766445", first_name: "John", last_name: "Doe"`
55
+ `delete_subscription` - `PriorityPayoutGateway::Recurring.new.delete_subscription subscription_id: "3261766445"`
56
+
26
57
 
27
58
  ## Development
28
59
 
@@ -32,7 +63,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
32
63
 
33
64
  ## Contributing
34
65
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/priority_payout_gateway.
66
+ Bug reports and pull requests are welcome on GitHub at https://github.com/beneggett/priority_payout_gateway.
36
67
 
37
68
 
38
69
  ## License
data/lib/priority_payout_gateway/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module PriorityPayoutGateway
2
- VERSION = "0.9.0"
2
+ VERSION = "0.9.1"
3
3
  end
data/priority_payout_gateway.gemspec CHANGED
@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
13
13
 
14
14
  spec.summary = %q{ Priority Payout Gateway (NMI) Api }
15
15
  spec.description = %q{ Ruby wrapper for interacting with the Priority Payout Gateway. Priority Payout Gateway is a white label gateway for NMI. }
16
- spec.homepage = "https://github.com/beneggett/sportradar-api"
16
+ spec.homepage = "https://github.com/beneggett/priority_payout_gateway"
17
17
 
18
18
  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
19
19
  # to allow pushing to a single host or delete this section to allow pushing to any host.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: priority_payout_gateway
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.9.0
4
+ version: 0.9.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Ben Eggett
@@ -236,7 +236,7 @@ files:
236
236
  - lib/priority_payout_gateway/transaction.rb
237
237
  - lib/priority_payout_gateway/version.rb
238
238
  - priority_payout_gateway.gemspec
239
- homepage: https://github.com/beneggett/sportradar-api
239
+ homepage: https://github.com/beneggett/priority_payout_gateway
240
240
  licenses: []
241
241
  metadata:
242
242
  allowed_push_host: https://rubygems.org