versapay 0.1.4 → 0.1.5

data/README.md

@@ -0,0 +1,51 @@
+# A gem to help with using VersaPay's API
+
+## Usage
+
+Include it in your app's 'Gemfile':
+
+```Ruby
+gem 'versapay'
+```
+
+In the controller you can make sure that all the actions are called with a valid Web Hook signature:
+
+```Ruby
+class VersapayController < ApplicationController
+  check_versapay_signatures "MyKey"
+```
+
+There are some Rails view helpers to set up a debit agreement:
+
+```Ruby
+# The first you hear of a new debit agreement is when VersaPay sends a callback. So the reference should be
+# something you can use to identify your user. For example,
+# key = MyApp::Application.config.secret_token
+# verifier = ActiveSupport::MessageVerifier.new(key)
+# @reference = verifier.generate(@user.id)
+= link_to "Setup VersaPay", debit_agreement_link("Set up an agreement", { :reference => @reference, :pref => "ba" })
+```
+
+And of course, you can sent transactions:
+
+```Ruby
+ Versapay::Transactions.new do |v|
+    begin
+      result = v.create(:amount_in_cents => 12345,
+                        :debit_agreement_token => "RWOCDPSM",
+                        :transaction_type => "pre_authorized_debit",
+                        :email => "foo@example.com",
+                        :message => "A crate of widgets",
+                        :transaction_reference => "my reference",
+                        :fund_token => "VersaPayBalanceFundingSource"
+                       )
+    rescue Versapay::VersapayError => e
+      logger.error "Transaction failed"
+      return false
+    end
+  end
+```
+
+Pretty much all the parameters to the functions match the way the VersaPay developers API works.
+
+See the VersaPay developers API: http://developers.versapay.com

data/lib/versapay.rb

@@ -11,6 +11,8 @@ module Versapay
   class VersapayError < RuntimeError; end
 
   class InvalidInput < VersapayError; end
+  class DuplicateTransaction < InvalidInput; end
+
   class InvalidWebhookSignature < VersapayError; end
   class Unprocessable < VersapayError; end
   class NotFound < VersapayError; end
@@ -47,7 +49,12 @@ module Versapay
         when 200,201
           return JSON.parse(response)
         when 412
-          raise Versapay::InvalidInput, response
+          result = JSON.parse(response)
+          if result.key? "unique_reference"
+            raise Versapay::DuplicateTransaction, response
+          else
+            raise Versapay::InvalidInput, response
+          end
         when 422
           raise Versapay::Unprocessable, response
         when 500

data/lib/versapay/transactions.rb

@@ -13,7 +13,7 @@ module Versapay
 
     def list(page = nil)
       args = page.nil? ? {} : { :page => page }
-      Versapay::make_request(:get, "/api/transactions/sent.json", args)
+      Versapay::make_request(:get, "/api/transactions.json", args)
     end
 
     def view(token)

data/lib/versapay/version.rb

@@ -1,3 +1,3 @@
 module Versapay
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/transactions_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+class TransactionsTest < ActionView::TestCase
+
+  def setup
+    Versapay.key = "mykey"
+    Versapay.token = "mytoken"
+    @v = Versapay::Transactions.new
+    FakeWeb.allow_net_connect = false
+  end
+
+  test "submitting a duplicate transaction" do
+    body = '{"unique_reference":"Already created transaction for supplied unique reference"}'
+    FakeWeb.register_uri(:post, "https://mytoken:mykey@demo.versapay.com/api/transactions.json", :body => body, :status => ["412", "Invalid input"])
+    assert_raises Versapay::DuplicateTransaction do
+      @v.create(:amount_in_cents => 12345,
+                :transaction_type => "direct_credit",
+                :message => "Have some cash!",
+                :transaction_reference => "Hello",
+                :unique_reference => 42,
+                :first_name => "Joe",
+                :last_name => "Blow",
+                :institution_number => "004",
+                :branch_number => "96610",
+                :account_number => "12345",
+                :fund_token => "123"
+                )
+    end
+
+  end
+
+  test "viewing a transaction's details" do
+    body = '{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"Mitch G.","unique_reference":null,"transaction_reference":"myreference","state":"completed","token":"83F2W2K2FJFV","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"11111","amount_in_cents":128105}'
+    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/transactions/83F2W2K2FJFV.json", :body => body)
+    results = @v.view("83F2W2K2FJFV")
+
+    assert_equal Hash, results.class
+    assert_equal "transaction", results["type"]
+    assert_equal "VersaPay Balance", results["from_fund"]
+  end
+  
+  test "viewing an invalid transaction's details" do
+    body = "Not found"
+    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/transactions/83F2W2K2FXXX.json", :body => body, :status => ["500", "Not found"])
+    assert_raises Versapay::NotFound do
+      @v.view("83F2W2K2FXXX")
+    end
+  end
+  
+  test "listing transactions when there are none" do
+    body = "[]"
+    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/transactions.json", :body => body)
+    results = @v.list
+    assert_equal Array, results.class
+    assert_equal 0, results.size
+
+  end
+
+  test "listing sent transactions when there are some" do
+    body = '[{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"Sean Walberg","unique_reference":"2","transaction_reference":"BAhpBw==--31ff18bce30e92ef2d9d4753a2c3c748e1fb8544","state":"completed","token":"8UB8QUMRJA8M","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":100},{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"Leia Organa","unique_reference":null,"transaction_reference":"BAhpAdA=--193ef4be953db212508b80802511ef21319c293b","state":"completed","token":"3FJRHSUKP4N2","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":15645},{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"J.T. Hutt","unique_reference":null,"transaction_reference":"BAhpAc8=--75cb17f2a52ab3518123ed091343d67104c0a929","state":"completed","token":"2RUPSUBFLH3G","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":131984},{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"Leia Organa","unique_reference":null,"transaction_reference":"BAhpAc0=--ab5d0a1b7976cd482f99dc708bee45ecc546d267","state":"completed","token":"5BV48XZ4CEHC","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":86087},{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"J.T. Hutt","unique_reference":null,"transaction_reference":"BAhpAcw=--0b2dabdaf965b6edbd4cf91ff2bb41724faa4822","state":"completed","token":"9TUHM13V1K4K","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":131895},{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"Leia Organa","unique_reference":null,"transaction_reference":"BAhpAco=--07bb3b7ae35affc7b6210daed6a0747318e4bfd3","state":"completed","token":"21WREVF394XH","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":45492},{"from_account":"wavepayrolltest","type":"transaction","transaction_type":"direct_credit","to_account":"J.T. Hutt","unique_reference":null,"transaction_reference":"BAhpAck=--bc8994974fc1ca3295c455800855e6df7cfb8504","state":"completed","token":"3AMV3SIL5UKF","link_url":null,"message":null,"from_fund":"VersaPay Balance","email":null,"created_by_user":"1kkOYn_uA6KWNjejFka1","amount_in_cents":131808}]'
+    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/transactions.json", :body => body)
+    results = @v.list
+    assert_equal Array, results.class
+    assert_equal 7, results.size
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: versapay
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: 
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Sean Walberg
@@ -15,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-13 00:00:00 -06:00
-default_executable: 
+date: 2012-03-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rails
@@ -119,6 +118,7 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
+- README.md
 - Rakefile
 - lib/versapay.rb
 - lib/versapay/debit_agreement.rb
@@ -131,10 +131,9 @@ files:
 - test/fund_sources_test.rb
 - test/helper_test.rb
 - test/test_helper.rb
-- test/transactions.test.rb
+- test/transactions_test.rb
 - test/webhook_test.rb
 - versapay.gemspec
-has_rdoc: true
 homepage: ""
 licenses: []
 
@@ -164,7 +163,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: versapay
-rubygems_version: 1.6.2
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A gem to use the Versapay API
@@ -173,5 +172,5 @@ test_files:
 - test/fund_sources_test.rb
 - test/helper_test.rb
 - test/test_helper.rb
-- test/transactions.test.rb
+- test/transactions_test.rb
 - test/webhook_test.rb

data/test/transactions.test.rb

@@ -1,49 +0,0 @@
-require 'test_helper'
-
-class TransactionsTest < ActionView::TestCase
-
-  def setup
-    Versapay.key = "mykey"
-    Versapay.token = "mytoken"
-    @v = Versapay::DebitAgreement.new
-    FakeWeb.register_uri(:any, "https://demo.versapay.com", :body => "response for any HTTP method", :status => ["500", "bad test"])
-  end
-
-  test "viewing a transaction's details" do
-    body = "{\"type\":\"debit_agreement\",\"state\":\"approved\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"83F2W2K2FJFV\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":\"BAhpBg==--7e0a441bda1b04f5b985fa654d357071bb9b32d1\",\"email\":\"jimbob@smallpayroll.ca\",\"name\":\"Jim Bob\"}" 
-    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/debit_agreements/83F2W2K2FJFV.json", :body => body)
-    results = @v.view("83F2W2K2FJFV")
-
-    assert_equal Hash, results.class
-    assert_equal "debit_agreement", results["type"]
-  end
-  
-  test "viewing an invalid transaction's details" do
-    body = "Not found"
-    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/debit_agreements/83F2W2K2FXXX.json", :body => body, :status => ["500", "Not found"])
-    assert_raises Versapay::NotFound do
-      @v.view("83F2W2K2FXXX")
-    end
-  end
-  
-  test "listing sent transactions when there are none" do
-    body = "[]"
-    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/debit_agreements/sent.json", :body => body)
-    results = @v.list_sent
-    assert_equal Array, results.class
-    assert_equal 0, results.size
-
-  end
-
-  test "listing sent transactions when there are some" do
-    body = "[{\"type\":\"debit_agreement\",\"state\":\"approved\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"83F2W2K2FJFV\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":\"BAhpBg==--7e0a441bda1b04f5b985fa654d357071bb9b32d1\",\"email\":\"jimbob@smallpayroll.ca\",\"name\":\"Jim Bob\"},{\"type\":\"debit_agreement\",\"state\":\"approved\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"6DCKWXXF1A51\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":\"BAhpBg==--7e0a441bda1b04f5b985fa654d357071bb9b32d1\",\"email\":\"jimbob@smallpayroll.ca\",\"name\":\"Jim Bob\"},{\"type\":\"debit_agreement\",\"state\":\"revoked\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"7VBJRS7TKLIL\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":\"BAhpBg==--7e0a441bda1b04f5b985fa654d357071bb9b32d1\",\"email\":\"fredsmith@smallpayroll.ca\",\"name\":\"Fred Smith\"},{\"type\":\"debit_agreement\",\"state\":\"revoked\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"6YI3MTVMY918\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":null,\"email\":\"fredsmith@smallpayroll.ca\",\"name\":\"Fred Smith\"},{\"type\":\"debit_agreement\",\"state\":\"revoked\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"1AYAG5T762TJ\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":null,\"email\":\"fredsmith@smallpayroll.ca\",\"name\":\"Fred Smith\"},{\"type\":\"debit_agreement\",\"state\":\"cancelled\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"7IN4ALWCXKJG\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":null,\"email\":\"fredsmith@smallpayroll.ca\",\"name\":\"Fred Smith\"},{\"type\":\"debit_agreement\",\"state\":\"revoked\",\"created_by_account\":\"wavepayrolltest\",\"token\":\"4RQ58W5B4M1W\",\"message\":\"blah\",\"created_by_user\":\"1kkOYn_uA6KWNjejFka1\",\"reference\":null,\"email\":\"fredsmith@smallpayroll.ca\",\"name\":\"Fred Smith\"}]"
-    FakeWeb.register_uri(:get, "https://mytoken:mykey@demo.versapay.com/api/debit_agreements/sent.json", :body => body)
-    results = @v.list_sent
-    assert_equal Array, results.class
-    assert_equal 7, results.size
-  end
-
-end
-
-########
-# When testing a transaction involving a post, ensure the data is in json and the content-type is application/json