pin_up 0.9.5 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 569c2387bbe572f2e680d34ccc7319d663fd2941
-  data.tar.gz: 2e4ff4fc878584bf9938d2d7dd0bdd4b20b248e7
+  metadata.gz: 6462e443b565fb449f179d8dc607a6dd17026639
+  data.tar.gz: 65efb2532459059fb87f5842d3db3440ff93fd40
 SHA512:
-  metadata.gz: 429922018edf82e1cd70f9982961a43f2a335937655463af14640c821bfb6cdad01cb51ffcbe5ec34f0201ce0454e19bc12a48c8ba758f5edbeab86f8be9860a
-  data.tar.gz: 1a65fd45399e990c5730c166b91d5f88155323cd66aa9604c3f1ef1d3d75e95eb340c204d398e5cff4b7c96879ce51e73ad50a3b55c883282ae0bf0fcf9c742b
+  metadata.gz: 93a17f92904c15f4226d1f2d2b26fb535ef6d0fef66d44362e587bef735cc8273ec15c8b10dfbc69d2233cc152b5db9a176f59a858d0da99b9f815611092f161
+  data.tar.gz: e3a6b2d5644ac32fb3a470d272b8275286796c6b37e5e1dfacdef7b49ffda869bfc2768c24fd1279da19867763f5a9cf5b8075b6508efccb49c965c85cff0a71

data/VERSION

@@ -1 +1 @@
-0.9.5
+0.10.0

data/lib/pin_up.rb

@@ -1,11 +1,12 @@
 require 'httparty'
 require 'json'
-require 'erb'
 
 require 'pin_up/base'
 require 'pin_up/card'
 require 'pin_up/charge'
+require 'pin_up/client'
 require 'pin_up/customer'
 require 'pin_up/refund'
+require 'pin_up/retrying_client'
 
 require 'pin_up/pin_errors'

data/lib/pin_up/base.rb

@@ -18,12 +18,12 @@ module Pin
       env = env.to_sym
       @@auth = { username: @key, password: '' }
       @@base_url = if env == :live
-        'https://api.pin.net.au/1/'
-      elsif env == :test
-        'https://test-api.pin.net.au/1/'
-      else
-        fail "'env' option must be :live or :test. Leave blank for live payments"
-      end
+                     'https://api.pin.net.au/1/'
+                   elsif env == :test
+                     'https://test-api.pin.net.au/1/'
+                   else
+                     fail "'env' option must be :live or :test. Leave blank for live payments"
+                   end
     end
 
     ##
@@ -32,25 +32,14 @@ module Pin
       @@base_url
     end
 
-    # protected
-
-    ##
-    # Sends an authorised GET request to pins server
-    # args: url (eg: 'charges' or 'charges/token')
-    def self.auth_get(url, token = nil)
-      HTTParty.get("#{@@base_url}#{url}", basic_auth: @@auth)
-    end
-
-    ##
-    # Sends an authorised POST request to pins server
-    def self.auth_post(url, options = {})
-      HTTParty.post("#{@@base_url}#{url}", body: options, basic_auth: @@auth)
-    end
-
     ##
-    # Sends an authorised PUT request to pins server
-    def self.auth_put(url, options = {})
-      HTTParty.put("#{@@base_url}#{url}", body: options, basic_auth: @@auth)
+    # Sends an authenticated request to pin's server
+    # args: method (Symbol), args (Hash)
+    # eg. args => { url: 'cards', options: { ... } }
+    def self.make_request(method, args)
+      client = Pin::Client.new(method, args, @@base_url, @@auth)
+      retrying_client = Pin::RetryingClient.new(client)
+      retrying_client.make_request
     end
 
     ##

data/lib/pin_up/card.rb

@@ -11,7 +11,7 @@ module Pin
     # args: card_details (Hash)
     # returns: card object
     def self.create(options)
-      build_response(auth_post('cards', options))
+      build_response(make_request(:post, { url: 'cards', options: options }))
     end
   end
 end

data/lib/pin_up/charge.rb

@@ -12,7 +12,7 @@ module Pin
     #
     # https://pin.net.au/docs/api/charges#get-charges
     def self.all(page = nil, pagination = false)
-      build_collection_response(auth_get("charges?page=#{page}"), pagination)
+      build_collection_response(make_request(:get, { url: "charges?page=#{page}" }), pagination)
     end
 
     ##
@@ -21,7 +21,7 @@ module Pin
     # returns: a charge object
     # https://pin.net.au/docs/api/charges#get-charge
     def self.find(token)
-      build_response(auth_get("charges/#{token}"))
+      build_response(make_request(:get, {url: "charges/#{token}" } ))
     end
 
     # Find a charge(s) for your account given a search term or set of terms
@@ -33,7 +33,7 @@ module Pin
       options.each do |key, option|
         term += "#{key.to_s}=#{URI.encode(option)}&"
       end
-      build_response(auth_get("charges/search?#{term}"))
+      build_response(make_request(:get, {url: "charges/search?#{term}" } ))
     end
 
     # Create a charge given charge details and a card,
@@ -42,7 +42,7 @@ module Pin
     # returns: a charge object
     # https://pin.net.au/docs/api/charges#post-charges
     def self.create(options = {})
-      build_response(auth_post('charges', options))
+      build_response(make_request(:post, {url: 'charges', options: options} ))
     end
 
     # Captures a previously authorised charge and returns its details.
@@ -50,7 +50,7 @@ module Pin
     # returns: charge object
     # https://pin.net.au/docs/api/charges#put-charges
     def self.capture(token)
-      build_response(auth_put("/charges/#{token}/capture"))
+      build_response(make_request(:put, { url: "/charges/#{token}/capture" } ))
     end
   end
 end

data/lib/pin_up/client.rb

@@ -0,0 +1,22 @@
+module Pin
+  class Client
+    def initialize(method, args, base_url, auth)
+        @method = method
+        @args = args
+        @base_url = base_url
+        @auth = auth
+    end
+
+    ##
+    # Sends an authenticated request to pin's server
+    # args: method (Symbol), args (Hash)
+    # eg. args => { url: 'cards', options: { ... } }
+    def make_request(times)
+      if %i(get post put patch delete).include? @method
+        HTTParty.send(@method, "#{@base_url}#{@args[:url]}", body: @args[:options], basic_auth: @auth)
+      else
+        Pin::PinError.handle_bad_request
+      end
+    end
+  end
+end

data/lib/pin_up/customer.rb

@@ -12,7 +12,7 @@ module Pin
     #
     # https://pin.net.au/docs/api/customers#get-customers
     def self.all(page = nil, pagination = false)
-      build_collection_response(auth_get("customers?page=#{page}"), pagination)
+      build_collection_response(make_request(:get, {url: "customers?page=#{page}" } ), pagination)
     end
 
     ##
@@ -27,7 +27,7 @@ module Pin
         { card_token: card }
       end.merge(email: email)
 
-      build_response(auth_post('customers', options))
+      build_response(make_request(:post, { url: 'customers', options: options }))
     end
 
     ##
@@ -36,7 +36,7 @@ module Pin
     # returns: a customer object
     # https://pin.net.au/docs/api/customers#get-customers
     def self.find(token)
-      build_response(auth_get("customers/#{token}"))
+      build_response(make_request(:get, {url: "customers/#{token}" } ))
     end
 
     ##
@@ -48,7 +48,7 @@ module Pin
     # NB: When providing a card (hash), you need to specify
     # the full list of details.
     def self.update(token, options = {})
-      build_response(auth_put("customers/#{token}", options))
+      build_response(make_request(:put, { url: "customers/#{token}", options: options }))
     end
 
     ##
@@ -62,7 +62,7 @@ module Pin
     # https://pin.net.au/docs/api/customers#get-customers-charges
     def self.charges(token, page = nil, pagination = false)
       build_collection_response(
-        auth_get("customers/#{token}/charges?page=#{page}"), pagination
+        make_request(:get, {url: "customers/#{token}/charges?page=#{page}" }), pagination
       )
     end
   end

data/lib/pin_up/pin_errors.rb

@@ -30,17 +30,21 @@ module Pin
       message = ''
       begin
         response['messages'].each do |m|
-          message += "#{m['code']}: #{m['message']}"
+          message += "#{m['code']}: #{m['message']} "
         end
       rescue
         begin response['messages']['amount'][0]
-          message = "#{response['error']}: #{response['error_description']}. Amount: #{response['messages']['amount'][0]}"
+          message = "#{response['error']}: #{response['error_description']}. Amount: #{response['messages']['amount'][0]} "
         rescue
           message = "#{response['error']}: #{response['error_description']}"
         end
       end
       message
     end
+
+    def self.handle_bad_request
+      fail(Pin::ClientError, 'request :method must be one of get, post, put, patch or delete')
+    end
   end
 
   class ResourceNotFound < PinError
@@ -54,4 +58,7 @@ module Pin
 
   class InsufficientPinBalance < PinError
   end
+
+  class ClientError < PinError
+  end
 end

data/lib/pin_up/refund.rb

@@ -12,7 +12,7 @@ module Pin
     #
     # https://pin.net.au/docs/api/refunds#get-refunds
     def self.find(token, page = nil, pagination = false)
-      build_collection_response(auth_get("charges/#{token}/refunds?page=#{page}"), pagination)
+      build_collection_response(make_request(:get, { url: "charges/#{token}/refunds?page=#{page}" } ), pagination)
     end
 
     ##
@@ -23,7 +23,7 @@ module Pin
     # https://pin.net.au/docs/api/refunds#post-refunds
     def self.create(token, amount = nil)
       options = { amount: amount }
-      build_response(auth_post("charges/#{token}/refunds", options))
+      build_response(make_request(:post, { url: "charges/#{token}/refunds", options: options } ))
     end
   end
 end

data/lib/pin_up/retrying_client.rb

@@ -0,0 +1,12 @@
+module Pin
+  require 'delegate'
+
+  class RetryingClient < DelegateClass(Pin::Client)
+    def make_request(*, times: 3)
+      super
+    rescue
+      retry if (times -= 1) > 0
+      raise
+    end
+  end
+end

data/pin_up.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: pin_up 0.9.5 ruby lib
+# stub: pin_up 0.10.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pin_up"
-  s.version = "0.9.5"
+  s.version = "0.10.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 = "2014-03-10"
+  s.date = "2015-02-27"
   s.description = "A Ruby gem wrapper for the pin-payments (pin.net.au) API"
   s.email = "dnitza@gmail.com"
   s.extra_rdoc_files = [
@@ -19,18 +19,8 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".DS_Store",
     ".document",
-    ".idea/.name",
-    ".idea/.rakeTasks",
-    ".idea/encodings.xml",
-    ".idea/misc.xml",
-    ".idea/modules.xml",
-    ".idea/pin_up.iml",
-    ".idea/scopes/scope_settings.xml",
-    ".idea/vcs.xml",
-    ".idea/workspace.xml",
-    ".rubocop.yml",
-    ".ruby-version",
     ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
@@ -44,22 +34,24 @@ Gem::Specification.new do |s|
     "lib/pin_up/base.rb",
     "lib/pin_up/card.rb",
     "lib/pin_up/charge.rb",
+    "lib/pin_up/client.rb",
     "lib/pin_up/customer.rb",
     "lib/pin_up/pin_errors.rb",
     "lib/pin_up/refund.rb",
+    "lib/pin_up/retrying_client.rb",
     "pin_up.gemspec",
     "spec/base_spec.rb",
     "spec/cards_spec.rb",
     "spec/charges_spec.rb",
+    "spec/client_spec.rb",
     "spec/customers_spec.rb",
     "spec/errors_spec.rb",
     "spec/refund_spec.rb",
-    "spec/spec_helper.rb",
-    "views/receipt.html.erb"
+    "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/dNitza/pin_up"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.0"
+  s.rubygems_version = "2.2.2"
   s.summary = "A Ruby gem wrapper for the pin-payments API"
 
   if s.respond_to? :specification_version then

data/spec/base_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'Base', :vcr, class: Pin::Base do
+RSpec.describe 'Base', :vcr, class: Pin::Base do
   before(:each) do
     @test_pin = Pin::Base.new(ENV['PIN_SECRET'], :test)
   end
@@ -25,6 +25,8 @@ describe 'Base', :vcr, class: Pin::Base do
 
   it 'should list succesfully connect to Pin' do
     stub_request(:get, "https://#{@test_pin.key}:''@test-api.pin.net.au/1/customers")
-    expect(Pin::Base.auth_get('customers').code).to eq 200
+    expect(Pin::Base.make_request(:get, { url: 'customers' }).code).to eq 200
+    # expect(Pin::Base.auth_get('customers').code).to eq 200
   end
+
 end

data/spec/cards_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'Card', :vcr, class: Pin::Card do
+RSpec.describe 'Card', :vcr, class: Pin::Card do
   before(:each) do
     Pin::Base.new(ENV['PIN_SECRET'], :test)
   end

data/spec/client_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+RSpec.describe 'Client', class: Pin::Client do
+  it 'delegates http requests to an inner object' do
+    inner = double(make_request: 'RESULT')
+    client = Pin::RetryingClient.new(inner)
+    expect(client.make_request).to eq('RESULT')
+  end
+
+  it 'retries if a request fails' do
+    inner = double
+    client = Pin::RetryingClient.new(inner)
+    times = 2
+    allow(inner).to receive(:make_request) do
+      raise "Oops" if (times -= 1) > 0
+      'RESULT'
+    end
+    expect(client.make_request).to eq('RESULT')
+  end
+
+  it 'gives up after a few tries' do
+    inner = double
+    client = Pin::RetryingClient.new(inner)
+    times = 4
+    allow(inner).to receive(:make_request) do
+      raise "Ooops!" if (times -= 1) > 0
+    end
+    expect{client.make_request}.to raise_error('Ooops!')
+    expect(inner).to have_received(:make_request).exactly(3).times
+  end
+
+  it 'fails if invalid http verb is used' do
+    inner = Pin::Client.new(:foo, {}, '', '')
+    client = Pin::RetryingClient.new(inner)
+    expect {client.make_request}.to raise_error(Pin::ClientError, 'request :method must be one of get, post, put, patch or delete')
+  end
+end

data/spec/customers_spec.rb

@@ -46,11 +46,11 @@ describe 'Customer', :vcr, class: Pin::Customer do
   end
 
   it 'should create a customer given an email and card details' do
-    Pin::Customer.create('dNitza@gmail.com', number: '5520000000000000', expiry_month: '12', expiry_year: '2014', cvc: '123', name: 'Roland Robot', address_line1: '123 fake street', address_city: 'Melbourne', address_postcode: '1234', address_state: 'Vic', address_country: 'Australia')['token'].should match(/^[a-z]{3}[_]/)
+    Pin::Customer.create('dNitza@gmail.com', number: '5520000000000000', expiry_month: '12', expiry_year: '2016', cvc: '123', name: 'Roland Robot', address_line1: '123 fake street', address_city: 'Melbourne', address_postcode: '1234', address_state: 'Vic', address_country: 'Australia')['token'].should match(/^[a-z]{3}[_]/)
   end
 
   it 'should update a customer given a token and details to update' do
-    options = { email: 'dNitza@gmail.com', card: { number: '5520000000000000', address_line1: '12345 Fake Street', expiry_month: '05', expiry_year: '2014', cvc: '123', name: 'Daniel Nitsikopoulos', address_city: 'Melbourne', address_postcode: '1234', address_state: 'VIC', address_country: 'Australia' } }
+    options = { email: 'dNitza@gmail.com', card: { number: '5520000000000000', address_line1: '12345 Fake Street', expiry_month: '05', expiry_year: '2016', cvc: '123', name: 'Daniel Nitsikopoulos', address_city: 'Melbourne', address_postcode: '1234', address_state: 'VIC', address_country: 'Australia' } }
     Pin::Customer.update('cus_sRtAD2Am-goZoLg1K-HVpA', options)['card']['address_line1'].should == '12345 Fake Street'
   end
 

data/spec/errors_spec.rb

@@ -10,8 +10,8 @@ describe 'Errors', :vcr, class: Pin::PinError do
   end
 
   it 'should raise a 422 error when trying to update missing a param' do
-    options = { email: 'dNitza@gmail.com', card: { address_line1: '12345 Fake Street', expiry_month: '05', expiry_year: '2014', cvc: '123', address_city: 'Melbourne', address_postcode: '1234', address_state: 'VIC', address_country: 'Australia' } }
-    expect { Pin::Customer.update('cus_sRtAD2Am-goZoLg1K-HVpA', options) }.to raise_error(Pin::InvalidResource, 'invalid_resource: One or more parameters were missing or invalid')
+    options = { email: 'dNitza@gmail.com', card: { address_line1: '12345 Fake Street', expiry_month: '05', expiry_year: '2016', cvc: '123', address_city: 'Melbourne', address_postcode: '1234', address_state: 'VIC', address_country: 'Australia' } }
+    expect { Pin::Customer.update('cus_sRtAD2Am-goZoLg1K-HVpA', options) }.to raise_error(Pin::InvalidResource, "card_number_invalid: Card number can't be blank card_name_invalid: Card name can't be blank ")
   end
 
   it 'should raise a 422 error when trying to make a payment with an expired card' do
@@ -27,7 +27,7 @@ describe 'Errors', :vcr, class: Pin::PinError do
         address_state: 'WA',
         address_country: 'Australia'
       } }
-    expect { Pin::Charges.create(options) }.to raise_error(Pin::InvalidResource, 'card_expiry_month_invalid: Card expiry month is expiredcard_expiry_year_invalid: Card expiry year is expired')
+    expect { Pin::Charges.create(options) }.to raise_error(Pin::InvalidResource, 'card_expiry_month_invalid: Card expiry month is expired card_expiry_year_invalid: Card expiry year is expired ')
   end
 
   it 'should raise a 400 error when trying to make a payment and a valid card gets declined' do
@@ -50,7 +50,7 @@ describe 'Errors', :vcr, class: Pin::PinError do
     options = { email: 'dNitza@gmail.com', description: 'A new charge from testing Pin gem', amount: '400', currency: 'AUD', ip_address: '127.0.0.1', card: {
         number: '5520000000000099',
         expiry_month: '05',
-        expiry_year: '2014',
+        expiry_year: '2019',
         cvc: '123',
         name: 'Roland Robot',
         address_line1: '42 Sevenoaks St',
@@ -59,7 +59,7 @@ describe 'Errors', :vcr, class: Pin::PinError do
         address_state: 'WA',
         address_country: 'Australia'
       } }
-    expect { Pin::Charges.create(options) }.to raise_error(Pin::InvalidResource, 'card_number_invalid: Card number is not a valid Visa or Mastercard number')
+    expect { Pin::Charges.create(options) }.to raise_error(Pin::InvalidResource, 'card_number_invalid: Card number is not a valid Visa or Mastercard number ')
   end
 
   it 'Should raise a ResourceNotFound error when can\'t find customer' do
@@ -69,13 +69,13 @@ describe 'Errors', :vcr, class: Pin::PinError do
   it 'should raise a 422 error if no 2nd argument is given' do
     options = { email: 'dNitza@gmail.com', description: 'A new charge from testing Pin gem', amount: '400', currency: 'AUD', ip_address: '127.0.0.1', customer_token: 'cus_8ImkZdEZ6BXUA6NcJDZg_g' }
     @charge = Pin::Charges.create(options)
-    expect { Pin::Refund.create(@charge['token']) }.to raise_error(Pin::InvalidResource, 'invalid_resource: One or more parameters were missing or invalid. Amount: can\'t be blank')
+    expect { Pin::Refund.create(@charge['token']) }.to raise_error(Pin::InvalidResource, "amount_invalid: Amount can't be blank amount_invalid: Amount is not a number ")
   end
 
   xit 'should raise a 422 error if a value of < 100 is given' do
-    options = { email: 'dNitza@gmail.com', description: 'A new charge from testing Pin gem', amount: '400', currency: 'AUD', ip_address: '127.0.0.1', customer_token: 'cus_8ImkZdEZ6BXUA6NcJDZg_g' }
+    options = { email: 'dNitza@gmail.com', description: 'A new charge from testing Pin gem', amount: '10', currency: 'AUD', ip_address: '127.0.0.1', customer_token: 'cus_8ImkZdEZ6BXUA6NcJDZg_g' }
     @charge = Pin::Charges.create(options)
-    expect { Pin::Refund.create(@charge['token'], 90) }.to raise_error(Pin::InvalidResource, 'One or more parameters were missing or invalid')
+    expect { Pin::Refund.create(@charge['token'], 90) }.to raise_error(Pin::InvalidResource, 'amount_invalid: Amount must be more than 100 ($1.00 AUD) ')
   end
 
 end