pin_up 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c67d8075501e91bd3b435d0e505340c02205a535
-  data.tar.gz: 36267918b46bcc3bbeb595f3e8af798daba499f4
+  metadata.gz: f700bc2aa83973dd14ec89c9bff2bdb7b2fdfd78
+  data.tar.gz: bcc17c7fc2dc62c11cb92b3292d047bee18bc98d
 SHA512:
-  metadata.gz: b5cc15ec66e259f6e3ef21c22b7fb4e936195ba84c22a2f8521b0ff130ba9e42bfa1a399b0986beafcfaab0c299d20b89c466c8e71d6b5dcd4129452da6f3500
-  data.tar.gz: 1e25012796615fa553563200ca24888d915b06d6c55348f3ac7fdbd6d8696226424593d722add3dda0fcba055f8a36f6a04cff6c3d7f851724b44a880f364ebd
+  metadata.gz: 8b89a1203f95056d99e4734061a1bc6f2995b170e3ca24975d46087764692f6a61fe8b699a59a750db01bf328da315e21999ef099b9b31dc1d0f490eb4259ef8
+  data.tar.gz: 31b5c8ca1e3ab72d604020d9b1b1e55ec1b820f600ab7004f168eac96479dbc83cf5294004083dbc609f704be10c3e9b119371f488487b6bfd477fef6f81aa0e

data/README.md

@@ -233,6 +233,26 @@ A bank account token can only be used once to create a recipient. The token auto
 
 Receipts have been extracted out into their [own gem](https://github.com/dNitza/pin_up_receipts)
 
+## Exceptions
+
+A number of different error types are built in:
+
+### ResourceNotFound
+The requested resource could not be found in Pin.
+
+### InvalidResource
+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).
+
+### InsufficientPinBalance
+
+N.B. All of the above errors return an error object with a `message` and a `response` attribute. The response is the raw response from Pin (useful for logging).
+
+### ClientError
+An unsupported HTTP verb was used.
+
 ## Testing locally
 Create a YAML file under 'spec' called 'test_data.yml' and add in:
 

data/VERSION

@@ -1 +1 @@
-1.2.0
+1.3.0

data/lib/pin_up.rb

@@ -11,7 +11,6 @@ require 'pin_up/client'
 require 'pin_up/customer'
 require 'pin_up/recipient'
 require 'pin_up/refund'
-require 'pin_up/retrying_client'
 require 'pin_up/transfer'
 
 require 'pin_up/pin_errors'

data/lib/pin_up/base.rb

@@ -13,10 +13,11 @@ module Pin
     #  env: The environment you want to use.
     #    Leave blank for live and pass :test for test
     # An error is raised if an invalid env is passed in.
-    def initialize(key = '', env = :live)
+    def initialize(key = '', env = :live, timeout = 1800)
       @key = key
       env = env.to_sym
       @@auth = { username: @key, password: '' }
+      @@timeout = timeout
       @@base_url = if env == :live
                      'https://api.pin.net.au/1/'
                    elsif env == :test
@@ -37,9 +38,7 @@ module Pin
     # 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
+      Pin::Client.new(method, args, @@base_url, @@auth, @@timeout).make_request
     end
 
     ##

data/lib/pin_up/charge.rb

@@ -50,7 +50,7 @@ module Pin
     # returns: charge object
     # https://pin.net.au/docs/api/charges#put-charges
     def self.capture(token)
-      build_response(make_request(:put, { url: "/charges/#{token}/capture" } ))
+      build_response(make_request(:put, { url: "charges/#{token}/capture" } ))
     end
   end
 end

data/lib/pin_up/client.rb

@@ -1,19 +1,20 @@
 module Pin
   class Client
-    def initialize(method, args, base_url, auth)
+    def initialize(method, args, base_url, auth, timeout)
       @method = method
       @args = args
       @base_url = base_url
       @auth = auth
+      @timeout = timeout
     end
 
     ##
     # Sends an authenticated request to pin's server
     # args: method (Symbol), args (Hash)
     # eg. args => { url: 'cards', options: { ... } }
-    def make_request(times)
+    def make_request
       if %i(get post put patch delete).include? @method
-        HTTParty.send(@method, "#{@base_url}#{@args[:url]}", body: @args[:options], basic_auth: @auth)
+        HTTParty.send(@method, "#{@base_url}#{@args[:url]}", body: @args[:options], basic_auth: @auth, timeout: @timeout)
       else
         Pin::PinError.handle_bad_request
       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 1.2.0 ruby lib
+# stub: pin_up 1.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pin_up"
-  s.version = "1.2.0"
+  s.version = "1.3.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 = "2015-11-14"
+  s.date = "2016-03-31"
   s.description = "A Ruby gem wrapper for the pin-payments (pin.net.au) API"
   s.email = "dnitza@gmail.com"
   s.extra_rdoc_files = [
@@ -40,7 +40,6 @@ Gem::Specification.new do |s|
     "lib/pin_up/pin_errors.rb",
     "lib/pin_up/recipient.rb",
     "lib/pin_up/refund.rb",
-    "lib/pin_up/retrying_client.rb",
     "lib/pin_up/transfer.rb",
     "pin_up.gemspec",
     "spec/balance_spec.rb",

data/spec/base_spec.rb

@@ -23,10 +23,13 @@ RSpec.describe 'Base', :vcr, class: Pin::Base do
     expect { Pin::Base.new('KEY', :foo) }.to raise_error(RuntimeError, "'env' option must be :live or :test. Leave blank for live payments")
   end
 
-  it 'should list succesfully connect to Pin' do
+  it 'should succesfully connect to Pin' do
     stub_request(:get, "https://#{@test_pin.key}:''@test-api.pin.net.au/1/customers")
     expect(Pin::Base.make_request(:get, { url: 'customers' }).code).to eq 200
-    # expect(Pin::Base.auth_get('customers').code).to eq 200
   end
 
+  it "raises a timeout error if we don't get a response in time" do
+    @test_pin = Pin::Base.new(ENV['PIN_SECRET'], :test, 0)
+    expect { Pin::Base.make_request(:get, { url: 'customers' }) }.to raise_error(Net::ReadTimeout)
+  end
 end

data/spec/client_spec.rb

@@ -1,37 +1,8 @@
 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)
+    client = Pin::Client.new(:foo, {}, '', '', 30)
     expect {client.make_request}.to raise_error(Pin::ClientError, 'request :method must be one of get, post, put, patch or delete')
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pin_up
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Daniel Nitsikopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-14 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -179,7 +179,6 @@ files:
 - lib/pin_up/pin_errors.rb
 - lib/pin_up/recipient.rb
 - lib/pin_up/refund.rb
-- lib/pin_up/retrying_client.rb
 - lib/pin_up/transfer.rb
 - pin_up.gemspec
 - spec/balance_spec.rb

data/lib/pin_up/retrying_client.rb

@@ -1,12 +0,0 @@
-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