dwolla-ruby 2.5.5 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 104ede0277b152834734532009f5bfc89fc3bdaf
-  data.tar.gz: e06536872c2ca718fd2036c2e8fe6ec52d62103f
+  metadata.gz: 7fa2436e7ea681ce8fea9abe309bccee237536ea
+  data.tar.gz: c398209cf8011fc35adacf92c7cb69d1b5746217
 SHA512:
-  metadata.gz: efd22544a62e1282ce6ae2719e3d7035ef4e205d0bcd2d15a402cf26de900ddc8bffb97dfe573a7b1f7be1edc4a45c4b764e593a351a74fd6b910237bbf0ee33
-  data.tar.gz: 3d52611e834a41c82ccbe07a72e2feceaaaf445df2c7938c25dddd50c37789988e29eace0e423097f6c74de6641e8908cae1c43a5109e4da6127a17f171045b5
+  metadata.gz: bd72ed9f135dec234bc41e405bed7cf0ff47a09e1aa48612d0abdb3eb8ea77b678512865be123af6740a0bd51e16c7cfc1a1751c247d28d98ce483543c6dad94
+  data.tar.gz: 4513c77af15a22339576046eb1ea7d6346f0fba9f65a97d4e9ea488f879e55b39106be2322b931b447252a8008e43f2ee5b37fa20c694014474818ef70e6a08b

data/.travis.yml

@@ -1,8 +1,6 @@
 language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
 gemfile:
-  - gemfiles/json.gemfile
+  - gemfiles/json.gemfile

data/README.md

@@ -2,7 +2,9 @@
 Official Ruby wrapper for Dwolla's API
 
 ## Version
-2.5.5
+2.6.0
+
+[![Build Status](https://travis-ci.org/Dwolla/dwolla-ruby.svg?branch=master)](https://travis-ci.org/Dwolla/dwolla-ruby)
 
 ## Requirements
 - [Ruby](http://www.ruby-lang.org/)
@@ -10,11 +12,11 @@ Official Ruby wrapper for Dwolla's API
 ## Installation
 The easiest way to install the dwolla-ruby gem for now is to use bundler and add the following line to your Gemfile:
 
-  gem 'dwolla-ruby'
+   `gem 'dwolla-ruby'`
 
 The recommended way to install dwolla-ruby is through RubyGems:
 
-  gem install dwolla-ruby
+   `gem install dwolla-ruby`
 
 ## Examples / Quickstart
 
@@ -23,15 +25,21 @@ To use the examples in the /examples folder, first edit the _keys.rb file and ad
 This repo includes various usage examples, including:
 
 * Authenticating with OAuth [oauth.rb]
-* Sending money [send.rb]
 * Fetching user information [users.rb]
 * Grabbing a user's contacts [contacts.rb]
 * Listing a user's funding sources [fundingSources.rb]
-* Transacting money [transactions.rb]
+* Transacting money (includes sending) [transactions.rb]
 * Getting a user's balance [balance.rb]
 
 ## Changelog
 
+2.6.0
+
+* **BREAKING CHANGE**: OAuth access tokens now expire. Instead of a string, `Dwolla::OAuth::get_token` now returns a hash with an `access_token`, `refresh_token`, and expiration times in seconds for both. In order to refresh authorization, use `Dwolla::OAuth.refresh_auth`
+* **BREAKING CHANGE**: Guest send has been officially deprecated and removed from this gem. 
+* All MassPay endpoints have been included in this release for batch payment support.
+* Proper unit tests implemented for all endpoints.
+
 2.5.5
 
 * Pulled in a merge request for syntax error (thanks, @mstahl)
@@ -121,8 +129,11 @@ This wrapper is heavily based off Stripe's Ruby Gem
 
 ## Support
 
+We highly recommend seeking support on our forums, [located here!](https://discuss.dwolla.com/category/api-support)
+
 - Dwolla API <api@dwolla.com>
-- Michael Schonfeld <michael@dwolla.com>
+- David Stancu <david@dwolla.com>
+- Gordon Zheng <gordon@dwolla.com>
 
 ## References / Documentation
 

data/dwolla-ruby.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
     s.homepage    = "https://github.com/dwolla/dwolla-ruby"
     s.summary     = %q{Official Ruby Wrapper for Dwolla's API}
     s.description = %q{Official Ruby Wrapper for Dwolla's API. Completely re-written based on Stripe's Ruby Bindings.}
+    s.license     = 'MIT'
 
     s.rubyforge_project = "dwolla-ruby"
 
@@ -21,7 +22,6 @@ Gem::Specification.new do |s|
     s.add_dependency('addressable', '>= 2')
 
     s.add_development_dependency('mocha')
-    s.add_development_dependency('shoulda')
     s.add_development_dependency('test-unit')
     s.add_development_dependency('rake')
 end

data/examples/oauth.rb

@@ -18,17 +18,34 @@ redirect_uri = 'http://localhost:4567/oauth_return'
 #   Create an authentication URL
 #   that the user will be redirected to
 get '/' do
-    authUrl = Dwolla::OAuth.get_auth_url(redirect_uri)
-    "To begin the OAuth process, send the user off to <a href=\"#{authUrl}\">#{authUrl}</a>"
+  authUrl = Dwolla::OAuth.get_auth_url(redirect_uri)
+  "To begin the OAuth process, send the user off to <a href=\"#{authUrl}\">#{authUrl}</a>"
 end
 
 
 # STEP 2:
 #   Exchange the temporary code given
 #   to us in the querystring, for
-#   a never-expiring OAuth access token
+#   an expiring OAuth access token and refresh token pair.
 get '/oauth_return' do
-    code = params['code']
-    token = Dwolla::OAuth.get_token(code, redirect_uri)
-    "Your never-expiring OAuth access token is: <b>#{token}</b>"
+  code = params['code']
+  info = Dwolla::OAuth.get_token(code, redirect_uri)
+  token = info['access_token']
+  refresh_token = info['refresh_token']
+  "Your expiring OAuth access token is: <b>#{token}</b>, and your refresh token is <b>#{refresh_token}</b>"
 end
+
+# STEP 3:
+#
+#   The array returned in step 2 as 'info' also contains
+#   expiration times for when the OAuth token will become
+#   invalid. Use this method to refresh your token with
+#   the provided refresh token.
+#
+get '/oauth_refresh' do
+  refresh_token = params['refresh_token']
+  info = Dwolla::OAuth.refresh_auth(refresh_token)
+  token = info['access_token']
+  refresh_token = info['refresh_token']
+  "Your expiring OAuth access token is: <b>#{token}</b>, and your refresh token is <b>#{refresh_token}</b>"
+end

data/lib/dwolla.rb

@@ -7,28 +7,28 @@ require 'multi_json'
 require 'addressable/uri'
 
 # Version
-require 'dwolla/version'
+require_relative 'dwolla/version'
 
 # Resources
-require 'dwolla/json'
-require 'dwolla/transactions'
-require 'dwolla/requests'
-require 'dwolla/contacts'
-require 'dwolla/users'
-require 'dwolla/balance'
-require 'dwolla/funding_sources'
-require 'dwolla/oauth'
-require 'dwolla/offsite_gateway'
-require 'dwolla/accounts'
-# require 'dwolla/register' // Under Construction
+require_relative 'dwolla/json'
+require_relative 'dwolla/transactions'
+require_relative 'dwolla/requests'
+require_relative 'dwolla/contacts'
+require_relative 'dwolla/users'
+require_relative 'dwolla/balance'
+require_relative 'dwolla/funding_sources'
+require_relative 'dwolla/oauth'
+require_relative 'dwolla/offsite_gateway'
+require_relative 'dwolla/accounts'
+require_relative 'dwolla/masspay'
 
 # Errors
-require 'dwolla/errors/dwolla_error'
-require 'dwolla/errors/api_connection_error'
-require 'dwolla/errors/api_error'
-require 'dwolla/errors/missing_parameter_error'
-require 'dwolla/errors/authentication_error'
-require 'dwolla/errors/invalid_request_error'
+require_relative 'dwolla/errors/dwolla_error'
+require_relative 'dwolla/errors/api_connection_error'
+require_relative 'dwolla/errors/api_error'
+require_relative 'dwolla/errors/missing_parameter_error'
+require_relative 'dwolla/errors/authentication_error'
+require_relative 'dwolla/errors/invalid_request_error'
 
 module Dwolla
     @@api_key = nil

data/lib/dwolla/accounts.rb

@@ -1,6 +1,12 @@
 module Dwolla
     class Accounts
-        def self.auto_withdrawl(enabled=true, funding_id=nil, token=nil)
+        def self.get_auto_withdrawal_status(token=nil)
+          url = accounts_url + 'features/auto_withdrawl'
+
+          Dwolla.request(:get, url, {}, {}, token)
+        end
+
+        def self.toggle_auto_withdrawl(enabled=true, funding_id=nil, token=nil)
             raise MissingParameterError.new('No Funding ID Provided.') if funding_id.nil?
 
             url = accounts_url + 'features/auto_withdrawl'

data/lib/dwolla/contacts.rb

@@ -7,10 +7,18 @@ module Dwolla
         end
 
 
-        def self.nearby(filters={})
-            url = contacts_url + 'nearby'
+        def self.nearby(lat=nil, lon=nil, filters={})
+          raise MissingParameterError.new('No Latitude Provided') unless lat
+          raise MissingParameterError.new('No Longitude Provided.') unless lon
 
-            Dwolla.request(:get, url, filters, {}, false)
+          url = contacts_url + 'nearby'
+
+          params = {
+              :latitude => lat,
+              :longitude => lon
+          }.merge(filters)
+
+          Dwolla.request(:get, url, params, {}, false)
         end
 
         private

data/lib/dwolla/masspay.rb

@@ -0,0 +1,53 @@
+module Dwolla
+  class MassPay
+
+    def self.get(token=nil)
+      Dwolla.request(:get, masspay_url, {}, {}, token);
+    end
+
+    def self.create(params={}, token=nil)
+      raise MissingParameterError.new('No fundsSource ID Provided.') unless params[:fundsSource]
+      raise MissingParameterError.new('No PIN Provided.') unless params[:pin]
+      raise MissingParameterError.new('No Items Provided.') unless params[:items]
+
+      Dwolla.request(:post, masspay_url, params, {}, token)
+    end
+
+    def self.getItems(id=nil, params={}, token=nil)
+      raise MissingParameterError.new('No MassPay Job ID Provided.') if id.nil?
+      url = masspay_url
+      url += id.to_s unless id.nil?
+      url += '/items'
+
+      Dwolla.request(:get, url, params, {}, token)
+    end
+
+    def self.getItem(jobId=nil, itemId=nil, token=nil)
+      raise MissingParameterError.new('No MassPay Job ID Provided.') if jobId.nil?
+      raise MissingParameterError.new('No Item ID Provided.') if itemId.nil?
+
+      url = masspay_url
+      url += jobId.to_s unless jobId.nil?
+      url += '/items/'
+      url += itemId.to_s unless itemId.nil?
+
+      Dwolla.request(:get, url, {}, {}, token)
+    end
+
+    def self.getJob(id=nil, token=nil)
+      raise MissingParameterError.new('No MassPay Job ID Provided.') if id.nil?
+
+      url = masspay_url
+      url += id.to_s unless id.nil?
+
+      Dwolla.request(:get, url, {}, {}, token)
+    end
+
+    private
+
+    def self.masspay_url
+      return '/masspay/'
+    end
+
+  end
+end

data/lib/dwolla/oauth.rb

@@ -1,51 +1,76 @@
 module Dwolla
-    class OAuth
-        def self.get_auth_url(redirect_uri=nil, scope=Dwolla::scope)
-            raise AuthenticationError.new('No Api Key Provided.') unless Dwolla::api_key
+  class OAuth
+    def self.get_auth_url(redirect_uri=nil, scope=Dwolla::scope)
+      raise AuthenticationError.new('No Api Key Provided.') unless Dwolla::api_key
 
-            params = {
-                :scope => scope,
-                :response_type => 'code',
-                :client_id => Dwolla::api_key
-            }
+      params = {
+          :scope => scope,
+          :response_type => 'code',
+          :client_id => Dwolla::api_key
+      }
 
-            params['redirect_uri'] = redirect_uri unless redirect_uri.nil?
+      params['redirect_uri'] = redirect_uri unless redirect_uri.nil?
 
-            uri = Addressable::URI.new
-            uri.query_values = params
+      uri = Addressable::URI.new
+      uri.query_values = params
 
-            if Dwolla::debug and Dwolla::sandbox
-                puts "[DWOLLA SANDBOX MODE OPERATION]"
-            end
+      if Dwolla::debug and Dwolla::sandbox
+        puts "[DWOLLA SANDBOX MODE OPERATION]"
+      end
 
-            return auth_url + '?' + uri.query
-        end
+      return auth_url + '?' + uri.query
+    end
+
+    def self.get_token(code=nil, redirect_uri=nil)
+      raise MissingParameterError.new('No Code Provided.') if code.nil?
+
+      params = {
+          :grant_type => 'authorization_code',
+          :code => code
+      }
+
+      # I realize this is ugly, but the unit tests fail
+      # if the key is accessed["like_this"] because the
+      # hash is compared with "quotes" and not :like_this.
+
+      # It may very well be my Ruby version
+      # TODO: Revisit this
+      (params = params.merge({:redirect_uri => redirect_uri})) unless redirect_uri.nil?
 
-        def self.get_token(code=nil, redirect_uri=nil)
-            raise MissingParameterError.new('No Code Provided.') if code.nil?
+      resp = Dwolla.request(:get, token_url, params, {}, false, false, true)
 
-            params = {
-                :grant_type => 'authorization_code',
-                :code => code
-            }
+      # TODO: Revisit this to make it more unit test friendly, fails ['error_description'] due to
+      # key not existing, same on L58
+      return "No data received." unless resp.is_a?(Hash)
+      raise APIError.new(resp['error_description']) unless resp['access_token'] and resp['refresh_token']
 
-            params['redirect_uri'] = redirect_uri unless redirect_uri.nil?
+      return resp
+    end
+
+    def self.refresh_auth(refresh_token=nil)
+      raise MissingParameterError.new('No Refresh Token Provided') if refresh_token.nil?
 
-            resp = Dwolla.request(:get, token_url, params, {}, false, false, true)
+      params = {
+          :grant_type => 'refresh_token',
+          :refresh_token => refresh_token
+      }
 
-            raise APIError.new(resp['error_description']) unless resp['access_token']
+      resp = Dwolla.request(:get, token_url, params, {}, false, false, true)
 
-            return resp['access_token']
-        end
+      return "No data received." unless resp.is_a?(Hash)
+      raise APIError.new(resp['error_description']) unless resp.has_key['access_token'] and resp['refresh_token']
 
-        private
+      return resp
+    end
 
-        def self.auth_url
-            Dwolla.hostname + '/oauth/v2/authenticate'
-        end
+    private
+
+    def self.auth_url
+      Dwolla.hostname + '/oauth/v2/authenticate'
+    end
 
-        def self.token_url
-            Dwolla.hostname + '/oauth/v2/token'
-        end
+    def self.token_url
+      Dwolla.hostname + '/oauth/v2/token'
     end
-end
+  end
+end

data/lib/dwolla/offsite_gateway.rb

@@ -85,6 +85,8 @@ module Dwolla
             }
 
             resp = Dwolla.request(:post, request_url, params, {}, false, false, true)
+
+            return "No data received." unless resp.is_a?(Hash)
             raise APIError.new(resp['Message']) unless resp['Result'] == 'Success'
 
             return checkout_url + resp['CheckoutId']

data/lib/dwolla/transactions.rb

@@ -42,21 +42,6 @@ module Dwolla
             Dwolla.request(:post, url, params, {}, token)
         end
 
-        def self.guest_send(params={})
-            raise MissingParameterError.new('No Destination ID Provided.') unless params[:destinationId]
-            raise MissingParameterError.new('No Amount Provided.') unless params[:amount]
-            raise MissingParameterError.new('No First Name Provided.') unless params[:firstName]
-            raise MissingParameterError.new('No Last Name Provided.') unless params[:lastName]
-            raise MissingParameterError.new('No Email Address Provided.') unless params[:emailAddress]
-            raise MissingParameterError.new('No Routing Number (ABA) Provided.') unless params[:routingNumber]
-            raise MissingParameterError.new('No Account Number Provided.') unless params[:accountNumber]
-            raise MissingParameterError.new('No Account Type Provided.') unless params[:accountType]
-
-            url = transactions_url + 'guestsend'
-
-            Dwolla.request(:post, url, params, {}, false)
-        end
-
         class << self
             alias_method :listing, :get
             alias_method :send, :create

data/lib/dwolla/users.rb

@@ -21,10 +21,13 @@ module Dwolla
             self.get(nil, token)
         end
 
-        def self.nearby(filters={})
-            url = users_url + 'nearby'
+        def self.nearby(params={})
+          raise MissingParameterError.new('No Latitude Provided') unless params[:latitude]
+          raise MissingParameterError.new('No Longitude Provided') unless params[:longitude]
 
-            Dwolla.request(:get, url, filters, {}, false)
+          url = users_url + 'nearby'
+
+          Dwolla.request(:get, url, params, {}, false)
         end
 
         private

data/lib/dwolla/version.rb

@@ -1,3 +1,3 @@
 module Dwolla
-  VERSION = "2.5.5"
+  VERSION = "2.6.0"
 end