pin_up 1.3.4 → 1.4.0

data/VERSION

@@ -1 +1 @@
-1.3.4
+1.4.0

data/lib/pin_up.rb

@@ -12,5 +12,8 @@ require 'pin_up/customer'
 require 'pin_up/recipient'
 require 'pin_up/refund'
 require 'pin_up/transfer'
+require 'pin_up/webhook_endpoints'
+require 'pin_up/plan'
+require 'pin_up/subscription'
 
 require 'pin_up/pin_errors'

data/lib/pin_up/pin_errors.rb

@@ -18,6 +18,12 @@ module Pin
         case response['error']
         when 'cannot_delete_primary_card'
           raise Pin::InvalidResource.new(response, response['error_description'])
+        when 'invalid_card'
+          raise Pin::InvalidResource.new(response, response['error_description'])
+        when 'invalid_state'
+          raise Pin::InvalidResource.new(response, response['error_description'])
+        when 'invalid_request'
+          raise Pin::InvalidResource.new(response, response['error_description'])
         else
           raise Pin::ChargeError.new(response)
         end

data/lib/pin_up/plan.rb

@@ -0,0 +1,79 @@
+module Pin
+  ##
+  # This class models Pins Plans API
+  class Plan < Base
+    ##
+    # Lists all plans for your account
+    # args: page (Fixnum), pagination (Boolean)
+    # returns: a collection of customer objects
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
+    # https://www.pinpayments.com/developers/api-reference/plans
+    def self.all(page = nil, pagination = false)
+      build_collection_response(make_request(:get, {url: "plans?page=#{page}" } ), pagination)
+    end
+
+    ##
+    # Create a plan given plan details
+    # args: options (Hash)
+    # returns: a plan object
+    # https://www.pinpayments.com/developers/api-reference/plans
+    def self.create(options = {})
+      build_response(make_request(:post, { url: 'plans', options: options }))
+    end
+
+    ##
+    # Find a plan for your account given a token
+    # args: token (String)
+    # returns: a plan object
+    # https://www.pinpayments.com/developers/api-reference/plans#get-plan
+    def self.find(token)
+      build_response(make_request(:get, {url: "plans/#{token}" } ))
+    end
+
+    ##
+    # Update a plan given a token
+    # args: token (String), options (Hash)
+    # returns: a plan object
+    # https://www.pinpayments.com/developers/api-reference/plans#put-plan
+    def self.update(token, options = {})
+      build_response(make_request(:put, { url: "plans/#{token}", options: options }))
+    end
+
+    ##
+    # Delete a plan given a token
+    # args: token (String)
+    # returns: nil
+    # https://www.pinpayments.com/developers/api-reference/plans#delete-plan
+    def self.delete(token)
+      build_response(make_request(:delete, { url: "plans/#{token}" } ))
+    end
+
+    ##
+    # List Subscriptions associated with a plan given a token
+    # args: token (String)
+    # returns: nil
+    # 
+    def self.subscriptions(token, page = nil, pagination = false)
+      build_collection_response(make_request(:get, { url: "plans/#{token}/subscriptions" } ), pagination)
+    end
+
+    ##
+    # Create a subscription for a plan given a customer_token OR a card_token
+    # args: customer_token (String), card (String) see docs.
+    # returns: a subscription object
+    #
+    def self.create_subscription(token, customer_token, card_token = nil)
+      options = if card_token
+                  { customer_token: customer_token,
+                    card_token: card_token}
+                else
+                  { customer_token: customer_token }
+                end
+
+      build_response(make_request(:post, {url: "plans/#{token}/subscriptions", options: options} ))
+    end
+  end
+end

data/lib/pin_up/subscription.rb

@@ -0,0 +1,80 @@
+module Pin
+  ##
+  # This class models Pins Subscription API
+  class Subscription < Base
+    ##
+    # Lists all subscriptions for your account
+    # args: page (Fixnum), pagination (Boolean)
+    # returns: a collection of subscription objects
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
+    # https://www.pinpayments.com/developers/api-reference/subscriptions#get-subscriptions
+    def self.all(page = nil, pagination = false)
+      build_collection_response(make_request(:get, { url: "subscriptions?page=#{page}" }), pagination)
+    end
+
+    ##
+    # Create a subscription given subscription details
+    # args: options (Hash)
+    # returns: a subscription object
+    # https://www.pinpayments.com/developers/api-reference/subscriptions#post-subscriptions
+    def self.create(options = {})
+      build_response(make_request(:post, { url: 'subscriptions', options: options }))
+    end
+
+    ##
+    # Find a subscription for your account given a token
+    # args: token (String)
+    # returns: a subscription object
+    # https://www.pinpayments.com/developers/api-reference/subscriptions#get-subscription
+    def self.find(token)
+      build_response(make_request(:get, { url: "subscriptions/#{token}" }))
+    end
+
+    ##
+    # Update a subscription for your account given a token
+    # and any of: email, card (hash),card_token
+    # args: token (String), options (Hash)
+    # returns: a subscription object
+    # https://pin.net.au/docs/api/subscriptions#put-subscription
+    # NB: When providing a card (hash), you need to specify
+    # the full list of details.
+    def self.update(token, card_token = nil)
+      options = unless card_token.empty?
+                  { card_token: card_token }
+                else
+                  card_token
+                end
+      build_response(make_request(:put, { url: "subscriptions/#{token}", options: options }))
+    end
+
+    ##
+    # Delete (cancel) a subscription given a token
+    # args: token (String)
+    # returns: nil
+    # https://www.pinpayments.com/developers/api-reference/subscriptions#delete-subscription
+    def self.delete(token)
+      build_response(make_request(:delete, { url: "subscriptions/#{token}" }))
+    end
+
+    ##
+    # Reactivate a subscription given a token
+    # args: token (String)
+    # returns: nil
+    # https://www.pinpayments.com/developers/api-reference/subscriptions#reactivate-subscription
+    def self.reactivate(token)
+      build_response(make_request(:put, { url: "subscriptions/#{token}/reactivate" }))
+    end
+
+    ##
+    # Fetch all History for a subscription given a token
+    # args: token (String)
+    # returns: nil
+    # https://www.pinpayments.com/developers/api-reference/subscriptions#history-subscription
+    def self.history(token, page = nil, pagination = false)
+      build_collection_response(make_request(:get, { url: "subscriptions/#{token}/history?page=#{page}" }), pagination)
+    end
+  end
+end

data/lib/pin_up/webhook_endpoints.rb

@@ -0,0 +1,45 @@
+module Pin
+  ##
+  # This class models Pin's WebhookEndpoints API
+  class WebhookEndpoints < Base
+    ##
+    # Lists all webhook endpoints for your account
+    # args: page (Fixnum), pagination (Boolean)
+    # returns: a collection of webhook endpoint objects
+    #
+    # if pagination is passed, access the response hash with [:response]
+    # and the pagination hash with [:pagination]
+    #
+    # https://pin.net.au/docs/api/webhook_endpoints#get-webhook_endpoints
+    def self.all(page = nil, pagination = false)
+      build_collection_response(make_request(:get, {url: "webhook_endpoints?page=#{page}" } ), pagination)
+    end
+
+    ##
+    # creates a webhook endpoint given a hash of options
+    # https://pin.net.au/docs/api/webhook_endpoints
+    # args: url (Hash)
+    # returns: webhook object
+    def self.create(options)
+      build_response(make_request(:post, { url: 'webhook_endpoints', options: options }))
+    end
+
+    ##
+    # Find a webhook endpoint for your account given a token
+    # args: token (String)
+    # returns: a webhook endpoint object
+    # https://pin.net.au/docs/api/webhook_endpoints#get-webhook_endpoints
+    def self.find(token)
+      build_response(make_request(:get, {url: "webhook_endpoints/#{token}" } ))
+    end
+
+    ##
+    # Delete a webhook endpoint for your account given a token
+    # args: token (String)
+    # returns: nil
+    # https://pin.net.au/docs/api/webhook_endpoints#delete-webhook_endpoints
+    def self.delete(token)
+      build_response(make_request(:delete, {url: "webhook_endpoints/#{token}" } ))
+    end
+  end
+end

data/pin_up.gemspec

@@ -2,18 +2,18 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: pin_up 1.3.4 ruby lib
+# stub: pin_up 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "pin_up"
-  s.version = "1.3.4"
+  s.name = "pin_up".freeze
+  s.version = "1.4.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Daniel Nitsikopoulos"]
-  s.date = "2016-08-06"
-  s.description = "A Ruby gem wrapper for the pin-payments (pin.net.au) API"
-  s.email = "dnitza@gmail.com"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Daniel Nitsikopoulos".freeze]
+  s.date = "2018-06-15"
+  s.description = "A Ruby gem wrapper for the pin-payments (pin.net.au) API".freeze
+  s.email = "dnitza@gmail.com".freeze
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".travis.yml",
+    "CHANGELOG.md",
     "Gemfile",
     "Gemfile.lock",
     "Guardfile",
@@ -38,9 +39,12 @@ Gem::Specification.new do |s|
     "lib/pin_up/client.rb",
     "lib/pin_up/customer.rb",
     "lib/pin_up/pin_errors.rb",
+    "lib/pin_up/plan.rb",
     "lib/pin_up/recipient.rb",
     "lib/pin_up/refund.rb",
+    "lib/pin_up/subscription.rb",
     "lib/pin_up/transfer.rb",
+    "lib/pin_up/webhook_endpoints.rb",
     "pin_up.gemspec",
     "spec/balance_spec.rb",
     "spec/bank_accounts_spec.rb",
@@ -50,53 +54,53 @@ Gem::Specification.new do |s|
     "spec/client_spec.rb",
     "spec/customers_spec.rb",
     "spec/errors_spec.rb",
+    "spec/plan_spec.rb",
     "spec/recipients_spec.rb",
     "spec/refund_spec.rb",
     "spec/spec_helper.rb",
-    "spec/transfers_spec.rb"
+    "spec/subscription_spec.rb",
+    "spec/transfers_spec.rb",
+    "spec/webhook_endpoints_spec.rb"
   ]
-  s.homepage = "http://github.com/dNitza/pin_up"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
-  s.summary = "A Ruby gem wrapper for the pin-payments API"
+  s.homepage = "http://github.com/dNitza/pin_up".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.7.3".freeze
+  s.summary = "A Ruby gem wrapper for the pin-payments API".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0.11.0"])
-      s.add_development_dependency(%q<shoulda>, ["~> 3.5"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 2.1.1"])
-      s.add_development_dependency(%q<simplecov>, ["~> 0.7.1"])
-      s.add_development_dependency(%q<webmock>, ["~> 1.12.3"])
-      s.add_development_dependency(%q<vcr>, ["~> 2.5.0"])
-      s.add_development_dependency(%q<guard-rspec>, [">= 0"])
-      s.add_development_dependency(%q<terminal-notifier-guard>, ["~> 1.5.3"])
+      s.add_runtime_dependency(%q<httparty>.freeze, [">= 0.11.0"])
+      s.add_development_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_development_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_development_dependency(%q<simplecov>.freeze, ["~> 0.7.1"])
+      s.add_development_dependency(%q<webmock>.freeze, [">= 0"])
+      s.add_development_dependency(%q<vcr>.freeze, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>.freeze, [">= 0"])
+      s.add_development_dependency(%q<terminal-notifier-guard>.freeze, ["~> 1.5.3"])
     else
-      s.add_dependency(%q<httparty>, [">= 0.11.0"])
-      s.add_dependency(%q<shoulda>, ["~> 3.5"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<jeweler>, ["~> 2.1.1"])
-      s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
-      s.add_dependency(%q<webmock>, ["~> 1.12.3"])
-      s.add_dependency(%q<vcr>, ["~> 2.5.0"])
-      s.add_dependency(%q<guard-rspec>, [">= 0"])
-      s.add_dependency(%q<terminal-notifier-guard>, ["~> 1.5.3"])
+      s.add_dependency(%q<httparty>.freeze, [">= 0.11.0"])
+      s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+      s.add_dependency(%q<rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+      s.add_dependency(%q<simplecov>.freeze, ["~> 0.7.1"])
+      s.add_dependency(%q<webmock>.freeze, [">= 0"])
+      s.add_dependency(%q<vcr>.freeze, [">= 0"])
+      s.add_dependency(%q<guard-rspec>.freeze, [">= 0"])
+      s.add_dependency(%q<terminal-notifier-guard>.freeze, ["~> 1.5.3"])
     end
   else
-    s.add_dependency(%q<httparty>, [">= 0.11.0"])
-    s.add_dependency(%q<shoulda>, ["~> 3.5"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<jeweler>, ["~> 2.1.1"])
-    s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
-    s.add_dependency(%q<webmock>, ["~> 1.12.3"])
-    s.add_dependency(%q<vcr>, ["~> 2.5.0"])
-    s.add_dependency(%q<guard-rspec>, [">= 0"])
-    s.add_dependency(%q<terminal-notifier-guard>, ["~> 1.5.3"])
+    s.add_dependency(%q<httparty>.freeze, [">= 0.11.0"])
+    s.add_dependency(%q<rdoc>.freeze, ["~> 3.12"])
+    s.add_dependency(%q<rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
+    s.add_dependency(%q<simplecov>.freeze, ["~> 0.7.1"])
+    s.add_dependency(%q<webmock>.freeze, [">= 0"])
+    s.add_dependency(%q<vcr>.freeze, [">= 0"])
+    s.add_dependency(%q<guard-rspec>.freeze, [">= 0"])
+    s.add_dependency(%q<terminal-notifier-guard>.freeze, ["~> 1.5.3"])
   end
 end
 

data/spec/cards_spec.rb

@@ -1,12 +1,24 @@
 require 'spec_helper'
 
 RSpec.describe 'Card', :vcr, class: Pin::Card do
+  let(:card_1) {
+    { number: '5520000000000000',
+      expiry_month: '12',
+      expiry_year: '2025',
+      cvc: '123',
+      name: 'Roland Robot',
+      address_line1: '123 Fake Street',
+      address_city: 'Melbourne',
+      address_postcode: '1234',
+      address_state: 'Vic',
+      address_country: 'Australia' }
+  }
+
   before(:each) do
     Pin::Base.new(ENV['PIN_SECRET'], :test)
   end
 
   it 'should create a card and respond with the card detail from pin' do
-    options = { number: '5520000000000000', expiry_month: '12', expiry_year: '2018', cvc: '123', name: 'Roland Robot', address_line1: '123 Fake Road', address_line2: '', address_city: 'Melbourne', address_postcode: '1223', address_state: 'Vic', address_country: 'AU' }
-    expect(Pin::Card.create(options)['token']).to match(/^[a-z]{4}[_]/)
+    expect(Pin::Card.create(card_1)['token']).to match(/^[a-z]{4}[_]/)
   end
 end

data/spec/charges_spec.rb

@@ -1,8 +1,58 @@
 require 'spec_helper'
 
 describe 'Charge', :vcr, class: Pin::Charges do
+  let(:card_1) {
+    { number: '5520000000000000',
+      expiry_month: '12',
+      expiry_year: '2025',
+      cvc: '123',
+      name: 'Roland Robot',
+      address_line1: '123 Fake Street',
+      address_city: 'Melbourne',
+      address_postcode: '1234',
+      address_state: 'Vic',
+      address_country: 'Australia' }
+  }
+
+  let(:customer_token) {
+    Pin::Customer.create('email@example.com', card_1)['token']
+  }
+
+  let(:charge) {
+    Pin::Charges.create(email: 'email@example.com',
+                        description: 'Charge description',
+                        amount: '500',
+                        currency: 'AUD',
+                        number: '5520000000000000',
+                        ip_address: '203.192.1.172',
+                        customer_token: customer_token)
+  }
+
+  let(:charge_hash) {
+    { email: 'email@example.com',
+      description: 'A new charge from testing Pin gem',
+      amount: '400',
+      currency: 'AUD',
+      ip_address: '127.0.0.1',
+      customer_token: customer_token }
+  }
+
+  let(:charge_capture_false) {
+    { email: 'email@example.com',
+      description: 'A new captured charge from testing Pin gem',
+      amount: '400',
+      currency: 'AUD',
+      ip_address: '127.0.0.1',
+      customer_token: customer_token,
+      capture: false }
+  }
+
   before(:each) do
     Pin::Base.new(ENV['PIN_SECRET'], :test)
+    # Create a customer
+    customer_token
+    # Create a charge
+    charge
   end
 
   it 'should list charges in Pin' do
@@ -14,17 +64,15 @@ describe 'Charge', :vcr, class: Pin::Charges do
   end
 
   it 'should create a charge given details' do
-    customer = Pin::Customer.create('email@example.com', number: '5520000000000000', expiry_month: '12', expiry_year: Time.now.year+1, cvc: '123', name: 'Roland Robot', address_line1: '123 fake street', address_city: 'Melbourne', address_postcode: '1234', address_state: 'Vic', address_country: 'Australia')
-    options = { email: 'email@example.com', description: 'A new charge from testing Pin gem', amount: '400', currency: 'AUD', ip_address: '127.0.0.1', customer_token: customer['token'] }
-    expect(Pin::Charges.create(options)['success']).to eq true
+    expect(Pin::Charges.create(charge_hash)['success']).to eq true
   end
 
   it 'should show a charge given a token' do
-    expect(Pin::Charges.find('ch_YFEgBSs5qTIWggGt72jn7Q')['token']).to match(/^[a-z]{2}[_]/)
+    expect(Pin::Charges.find(charge['token'])['token']).to match(/^[a-z]{2}[_]/)
   end
 
   it 'should show a charge given a search term' do
-    expect(Pin::Charges.search(query: 'A new charge from testing Pin gem', end_date: 'Aug 31, 2016')).to_not eq []
+    expect(Pin::Charges.search(query: 'Charge Desc', end_date: 'Aug 31, 2025')).to_not eq []
   end
 
   it 'should return pagination if "pagination" is true' do
@@ -36,23 +84,19 @@ describe 'Charge', :vcr, class: Pin::Charges do
   end
 
   it 'should return pagination for search if "pagination" is true' do
-    expect(Pin::Charges.search(3, true, query: 'A new charge from testing Pin gem', end_date: 'Aug 31, 2016')[:pagination]['current']).to eq 3
+    expect(Pin::Charges.search(3, true, query: 'Charge Desc', end_date: 'Aug 31, 2025')[:pagination]['current']).to eq 3
   end
 
   it 'should list charges for search on a page given a page' do
-    expect(Pin::Charges.search(1, query: 'A new charge from testing Pin gem', end_date: 'Aug 31, 2016')).to_not eq []
+    expect(Pin::Charges.search(1, query: 'Charge Desc', end_date: 'Aug 31, 2025')).to_not eq []
   end
 
   it 'should create a pre-auth (capture a charge)' do
-    customer = Pin::Customer.create('email@example.com', number: '5520000000000000', expiry_month: '12', expiry_year: Time.now.year+1, cvc: '123', name: 'Roland Robot', address_line1: '123 fake street', address_city: 'Melbourne', address_postcode: '1234', address_state: 'Vic', address_country: 'Australia')
-    options = { email: 'email@example.com', description: 'A new captured charge from testing Pin gem', amount: '400', currency: 'AUD', ip_address: '127.0.0.1', customer_token: customer['token'], capture: false }
-    expect(Pin::Charges.create(options)['captured']).to eq false
+    expect(Pin::Charges.create(charge_capture_false)['captured']).to eq false
   end
 
   it 'should capture a charge' do
-    customer = Pin::Customer.create('email@example.com', number: '5520000000000000', expiry_month: '12', expiry_year: Time.now.year+1, cvc: '123', name: 'Roland Robot', address_line1: '123 fake street', address_city: 'Melbourne', address_postcode: '1234', address_state: 'Vic', address_country: 'Australia')
-    options = { email: 'email@example.com', description: 'A new captured charge from testing Pin gem', amount: '400', currency: 'AUD', ip_address: '127.0.0.1', customer_token: customer['token'], capture: false }
-    token = Pin::Charges.create(options)['token']
+    token = Pin::Charges.create(charge_capture_false)['token']
     expect(Pin::Charges.capture(token)['success']).to eq true
   end
 end