pin_up 1.3.4 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7928b5a023836c0ea7d2aabd6460298a7217a618
-  data.tar.gz: 22c4f78ceab8310d3a591bcd8562362b89c126da
+SHA256:
+  metadata.gz: 1dadaa5a3ca76c61d6b86c888136f7df5ed353ff268c30174d94c63e7b3c3229
+  data.tar.gz: 4a9562a6650e9573751fe9111bdb1db9f5a20a42651e7129dae2a944fa45e296
 SHA512:
-  metadata.gz: d57915c372668e066c31614cf1f33e70dd11fac3f93288fd4496b8cafef834894386f0bfe90d394e811f20579735de28cd9f6b94eff575dedee36404bf8ae09e
-  data.tar.gz: 3712a8b4f5fd3dbe1f684daf3e533cb91e724234f2ec224586fa1d7e78577f2791fcc83e71353a326241fe7b8fd76b60d8f2631c802aead6afec163e64d64a2c
+  metadata.gz: 9dcc1e35755e241979202e1d693031fcd5f341059f3936e7951ffabc61e8596d2d6590ac59da4fdbcd6e2fe957ae361389688f2a7e07a32c83c3328900459ca5
+  data.tar.gz: 1d0a1855470803206375f525331c20c52b5ecf441e3251895498180d255c2af7d29b1d04ac025940f4cd56ca582a426f1107c0cb237123e2c2ffc8a75fa8c8d4

data/.travis.yml

@@ -4,6 +4,8 @@ language: ruby
 sudo: false
 rvm:
   - 2.3.0
+  - 2.4.0
+  - 2.5.0
 addons:
   code_climate:
     repo_token: 497b5dc4169e71803c100a6a07b16356787fa137560de2a3c783e41766b3de18

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.4.0 / 2018-06-15
+
+### Added
+
+- [Subscriptions API](https://github.com/dNitza/pin_up#subscriptions) (drej2k)
+- [Plans API](https://github.com/dNitza/pin_up#plans) (drej2k)

data/Gemfile

@@ -1,19 +1,14 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gem "httparty", ">= 0.11.0"
 
 group :development do
-  gem "shoulda", "~> 3.5"
   gem "rdoc", "~> 3.12"
   gem "rspec" #, "~> 2.13"
-  gem "jeweler", "~> 2.1.1"
+  gem "jeweler", "~> 2.3.9"
   gem "simplecov", "~> 0.7.1"
-  gem "webmock", "~> 1.12.3"
-  gem "vcr", "~> 2.5.0"
+  gem "webmock"#, "~> 1.12.3"
+  gem "vcr"#, "~> 2.5.0"
   gem "guard-rspec" #, "~> 3.0.2"
   gem "terminal-notifier-guard", "~> 1.5.3"
 end
-
-group :test do
-  gem "codeclimate-test-reporter", require: nil
-end

data/Gemfile.lock

@@ -1,160 +1,135 @@
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (4.2.1)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    addressable (2.3.8)
-    builder (3.2.2)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    codeclimate-test-reporter (0.4.7)
-      simplecov (>= 0.7.1, < 1.0.0)
-    coderay (1.1.0)
-    crack (0.4.2)
+    addressable (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     faraday (0.9.2)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.8)
+    ffi (1.9.25)
     formatador (0.2.5)
-    git (1.3.0)
-    github_api (0.13.0)
-      addressable (~> 2.3)
+    git (1.4.0)
+    github_api (0.16.0)
+      addressable (~> 2.4.0)
       descendants_tracker (~> 0.0.4)
       faraday (~> 0.8, < 0.10)
       hashie (>= 3.4)
-      multi_json (>= 1.7.5, < 2.0)
-      nokogiri (~> 1.6.6)
-      oauth2
-    guard (2.12.5)
+      mime-types (>= 1.16, < 3.0)
+      oauth2 (~> 1.0)
+    guard (2.14.2)
       formatador (>= 0.2.4)
-      listen (~> 2.7)
-      lumberjack (~> 1.0)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
       pry (>= 0.9.12)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
-    guard-rspec (4.5.2)
+    guard-rspec (4.7.3)
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashie (3.4.4)
-    highline (1.7.8)
-    hitimes (1.2.2)
-    httparty (0.13.5)
-      json (~> 1.8)
+    hashdiff (0.3.7)
+    hashie (3.5.7)
+    highline (2.0.0)
+    httparty (0.16.2)
       multi_xml (>= 0.5.2)
-    i18n (0.7.0)
-    jeweler (2.1.1)
+    jeweler (2.3.9)
       builder
-      bundler (>= 1.0)
+      bundler
       git (>= 1.2.5)
-      github_api
+      github_api (~> 0.16.0)
       highline (>= 1.6.15)
       nokogiri (>= 1.5.10)
+      psych
       rake
       rdoc
-      semver
-    json (1.8.3)
-    jwt (1.5.4)
-    listen (2.10.0)
-      celluloid (~> 0.16.0)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    mini_portile2 (2.1.0)
-    minitest (5.7.0)
-    multi_json (1.11.0)
-    multi_xml (0.5.5)
+      semver2
+    json (1.8.6)
+    jwt (1.5.6)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    mime-types (2.99.3)
+    mini_portile2 (2.3.0)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
     multipart-post (2.0.0)
-    nenv (0.2.0)
-    nokogiri (1.6.8)
-      mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    notiffany (0.0.6)
+    nenv (0.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    oauth2 (1.2.0)
-      faraday (>= 0.8, < 0.10)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
       jwt (~> 1.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (>= 1.2, < 3)
-    pkg-config (1.1.7)
-    pry (0.10.1)
+    pry (0.11.3)
       coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rack (2.0.1)
-    rake (11.2.2)
-    rb-fsevent (0.9.5)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
+      method_source (~> 0.9.0)
+    psych (3.0.2)
+    rack (2.0.5)
+    rake (12.3.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
     rdoc (3.12.2)
       json (~> 1.4)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.3)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.1)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.2)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby_dep (1.5.0)
     safe_yaml (1.0.4)
-    semver (1.0.1)
+    semver2 (3.4.2)
     shellany (0.0.1)
-    shoulda (3.5.0)
-      shoulda-context (~> 1.0, >= 1.0.1)
-      shoulda-matchers (>= 1.4.1, < 3.0)
-    shoulda-context (1.2.1)
-    shoulda-matchers (2.8.0)
-      activesupport (>= 3.0.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
-    slop (3.6.0)
     terminal-notifier-guard (1.5.3)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    timers (4.0.1)
-      hitimes
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    vcr (2.5.0)
-    webmock (1.12.3)
-      addressable (>= 2.2.7)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    vcr (4.0.0)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  codeclimate-test-reporter
   guard-rspec
   httparty (>= 0.11.0)
-  jeweler (~> 2.1.1)
+  jeweler (~> 2.3.9)
   rdoc (~> 3.12)
   rspec
-  shoulda (~> 3.5)
   simplecov (~> 0.7.1)
   terminal-notifier-guard (~> 1.5.3)
-  vcr (~> 2.5.0)
-  webmock (~> 1.12.3)
+  vcr
+  webmock
 
 BUNDLED WITH
-   1.12.5
+   1.16.1

data/README.md

@@ -27,7 +27,7 @@ An optional second parameter can be passed in to set the environment (:live or :
 
 An optional third parameter can be passed in to set the timeout of HTTParty in seconds. The default is `1800` (30 minutes).
 
-### Charges
+## Charges
 ##### List All Charges
     Pin::Charges.all
 
@@ -58,7 +58,7 @@ With Pagination:
     # request[:response] => response hash
     # request[:pagination] => "pagination":{"current":3,"previous":2,"next":4,"per_page":25,"pages":10,"count":239}
 
-See https://pin.net.au/docs/api/charges#search-charges for a full list of options.
+See [Pin Payments Charges API](https://pinpayments.com/developers/api-reference/charges#search-charges) for a full list of options.
 
 ##### Create A Charge
     charge = {email: "email@example.com", description: "Description", amount: "400", currency: "AUD", ip_address: "127.0.0.1", customer_token: "cus_token"   }
@@ -75,7 +75,7 @@ Also known as a pre-auth, this will hold a charge to be captured by for up to 5
 ##### Capture an authorised charge
     Pin::Charges.capture(charge)
 
-### Customers
+## Customers
 ##### List All Customers
     Pin::Customer.all
 
@@ -112,19 +112,17 @@ With Pagination:
 
 ##### Update A Customer
 ###### Update Card details
----
+
     Pin::Customer.update('cus_token', hash_of_details)
 
 If passing a hash of details, it must be the full list of details of the credit card to be stored. (https://pin.net.au/docs/api/customers#put-customer)
 
 ###### Update only an email
----
 
     hash_of_details = {email: 'new_email@example.com'}
     Pin::Customer.update('cus_token', hash_of_details)
 
 ###### Update card by token
----
 
     hash_of_details = {card_token: 'new_card_token'}
     Pin::Customer.update('cus_token', hash_of_details)
@@ -155,7 +153,7 @@ You can also use a card token rather than a card hash
 
 ##### Delete a card given a customer and a token
 This method will raise an exception if attempting to remove the user's primary card
-    
+
     customer_token = 'customer_token'
     card_token = 'card_token'
     Pin::Customer.delete_card(customer_token, card_token)
@@ -186,8 +184,115 @@ This will list all refunds for a particular charge (will return an empty hash if
 
 Will return a card_token that can be stored against a customer.
 
-Only use this method if you're comfortable sending card details to your server - otherwise you can use a form that Pin provides (https://pin.net.au/docs/guides/payment-forms) and get the card_token that way.
+Only use this method if you're comfortable sending card details to your server - otherwise you can use a form that Pin provides (https://pinpayments.com/developers/integration-guides/payment-forms) and get the card_token that way.
+
+## Plans
+##### Create A Plan
+    Pin::Plan.create(plan)
+
+    plan = { name: 'Coffee Plan', 
+             amount: '1000', 
+             currency: 'AUD', 
+             interval: 30, 
+             interval_unit: 'day', 
+             setup_amount: 0, 
+             trial_amount: 0, 
+             trial_interval: 7, 
+             trial_interval_unit: 'day' }
+             
+Note: setup_amount, trial_amount, trial_interval and trial_interval_unit are all optional fields. 
+
+    Pin::Plan.create(plan)
+    
+##### List All Plans
+    Pin::Plan.all
+
+Show Plans on a particular page:
+
+    Pin::Plan.all(3)
+
+With Pagination:
+
+    Pin::Plan.all(3,true)
+    
+##### Find a Plan
+
+    Pin::Plan.find(plan_token)
+
+    Return the details of a specified plan
+    
+##### Update a Plan
+Update the name of a specified plan. Only the plan name can be updated!
+    
+    Pin::Plan.update(plan_token, name_hash)
+    
+    name_hash = { name: 'new_plan_name' }
 
+##### Delete a Plan
+Deletes a plan and all of its subscriptions. You will not be able to recover this. 
+
+Note: Plans can only be deleted if they have no running subscriptions.
+    
+    Pin::Plan.delete(plan_token)
+
+## Subscriptions
+##### Create A Subscription
+Activate a new subscription and return its details. The customer's card will immeadiately be billed the initial plan amount, unless there's a trial period. 
+
+
+    subscription =     { plan_token: plan_token,
+                         customer_token: customer_token,
+                         card_token: card_token,
+                         include_setup_fee: true }
+
+Note: card_token and include_setup_fee are both optional.
+
+    Pin::Subscription.create(subscription)
+    
+##### List All Subscriptions
+
+    Pin::Subscription.all
+
+Show Subscriptions on a particular page:
+
+    Pin::Subscription.all(3)
+
+With Pagination:
+
+    Pin::Subscription.all(3,true)
+    
+##### Find a Subscription
+Return the details of a subscription.
+
+    Pin::Subscription.find(subscription_token)
+    
+##### Update a Subscription
+Updates the card associated with a subscription identified by the subscription token.
+    
+Note: The card token must already be associated to the customer of the subscription.
+    
+    Pin::Subscription.update(subscription_token, card_token)
+    
+##### Delete a Subscription
+Cancels the subscription identified by the subscription token. Subscriptions can only be cancelled if they are in a trial or active state. 
+
+Note: Subscriptions will only attain a cancelled state once the subscription period has elapsed. Until such time subscriptions will be in a state of 'Cancelling'.
+    
+    Pin::Subscription.delete(plan_token)
+    
+##### Reactivate a Subscription
+Reactivates the subscription identified by the subscription token returning the details of the subscription
+    
+    Pin::Subscription.reactivate(plan_token)
+
+##### List Subscription history
+Fetch the ledger entries relating to a subscription identified by a subscription token
+    
+    Pin::Subscription.history(subscription_token)
+
+###### With pagination
+
+    Pin::Subscription.history(subscription_token, 3, true)
 
 ## Recipients
 The recipients API allows you to post bank account details and retrieve a token that you can safely store in your app. You can send funds to recipients using the [transfers API].
@@ -237,7 +342,7 @@ With Pagination:
     # request[:response] => response hash
     # request[:pagination] => "pagination":{"current":3,"previous":2,"next":4,"per_page":25,"pages":10,"count":239}
 
-See https://pin.net.au/docs/api/transfers#search-transfers for a full list of options.
+See [Pin Payments Transfers API](https://pinpayments.com/developers/api-reference/transfers#search-transfers) for a full list of options.
 
 ##### Get the line items associated with transfer.
 `Pin::Transfer.line_items(transfer_token)`
@@ -258,6 +363,24 @@ A bank account token can only be used once to create a recipient. The token auto
 
 `Pin::BankAccounts.create(options) `
 
+## Webhook Endpoints
+The Webhook Endpoints API allows you to create and view your webhook endpoints to enable your website to receive push notifications of events that occur on your Pin Payments account.
+
+##### Create a new webhook endpoint and returns its details.
+`options = { url: "http://example.com/webhooks/" }`
+
+`Pin::WebhookEndpoints.create(options)`
+
+##### Get a paginated list of all webhook endpoints.
+`Pin::WebhookEndpoints.all`
+
+##### Get the details of a webhook endpoint.
+`Pin::WebhookEndpoints.find(token)`
+
+##### Delete a webhook endpoint and all of its webhook requests. You will not be able to recover them.
+`token = "whe_foobar"`
+`Pin::WebhookEndpoints.delete(token)`
+
 ## Receipts
 
 Receipts have been extracted out into their [own gem](https://github.com/dNitza/pin_up_receipts)
@@ -273,7 +396,7 @@ The requested resource could not be found in Pin.
 A number of parameters sent to Pin were invalid.
 
 ### ChargeError
-Something went wrong while creating a charge in Pin. This could be due to insufficient funds, a card being declined or expired. A full list of possible errors is available [here](https://pin.net.au/docs/api/charges).
+Something went wrong while creating a charge in Pin. This could be due to insufficient funds, a card being declined or expired. A full list of possible errors is available [here](https://pinpayments.com/developers/api-reference/charges).
 
 ### InsufficientPinBalance
 
@@ -290,12 +413,33 @@ Create a YAML file under 'spec' called 'test_data.yml' and add in:
 
     PIN_SECRET: "your pin test secret"
 
-uncomment line 13 in spec_helper.rb and
+uncomment line 16 in spec_helper.rb and
 
 run
 
     rspec spec/*.rb
 
+### Record New VCR cassettes
+After cloning the project one should create a new set of cassettes.
+
+In spec_helper change 
+
+    VCR.use_cassette(name, options) { example.call }
+to
+
+    VCR.use_cassette(name, record: :all) { example.call }
+
+Run all tests and then change the line back (replace record: :all with options)
+
+### Updating VCR test cassettes
+A contributor can update cassettes previously recorded by adding the following syntax:
+     
+     record: :all, :match_requests_on => [:method, :host, :path]
+
+E.g. in a particular spec file:
+
+    describe Pin::Balance, :vcr, record: :all, :match_requests_on => [:method, :host, :path] do
+
 ## Contributing to pin_up
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.