dwolla-ruby 1.0.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.swp
+*.gem
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/*
+coverage/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dwolla.gemspec
+gemspec

data/README.md

@@ -0,0 +1,130 @@
+# dwolla-ruby: Ruby Wrapper for Dwolla's API
+=================================================================================
+
+## Version
+1.0.0
+
+## Requirements
+- [Ruby](http://www.ruby-lang.org/)
+
+## Installation
+
+The recommended way to install dwolla-php is through RubyGems:
+
+    gem install dwolla-ruby
+
+## Usage
+```ruby
+
+```
+
+## Examples / Quickstart
+
+This repo includes various usage examples, including:
+
+* Authenticating with OAuth [oauth.rb]
+* Sending money [send.rb]
+* Fetching account information [accountInfo.rb]
+* Grabbing a user's contacts [contacts.rb]
+* Listing a user's funding sources [fundingSources.rb]
+* Creating offsite gateway sessions [offsiteGateway.rb]
+
+## Methods
+
+Authentication Methods:
+
+    getAuthUrl()        ==> (string) OAuth permissions page URL
+    requestToken($code) ==> (string) a never-expiring OAuth access token
+    setToken($token)    ==> (bool) was token saved?
+    getToken()          ==> (string) current OAuth token
+
+Users Methods:
+
+    me()                ==> (array) the user entity associated with the token
+    getUser($user_id)   ==> (array) the user entity for {$user_id}
+    
+Register Methods:
+
+    register($email, $password, $pin, $firstName, $lastName, $address, $address2, $city, $state, $zip, $phone, $dateOfBirth, $acceptTerms[, $type, $organization, $ein])    ==> (array) the newly created user record
+    
+Contacts Methods:
+
+    contacts([$search, $types, $limit])         ==> (array) list of contacts matching the search criteria
+    nearbyContacts([$search, $types, $limit])   ==> (array) list of nearby spots matching the search criteria
+    
+Funding Sources Methods:
+
+    fundingSources()    ==> (array) a list of funding sources associated with the token
+    fundingSource($id)  ==> (array) information about the {$id} funding source
+    
+Balance Methods:
+
+    balance()           ==> (string) the Dwolla balance of the account associated with the token
+    
+Transactions Methods:
+
+    send($pin, $destinationId, $amount[, $destinationType, $notes, $facilitatorAmount, $assumeCosts])   ==> (string) transaction ID
+    request($pin, $sourceId, $amount[, $sourceType, $notes, $facilitatorAmount])                        ==> (string) request ID
+    transaction($transactionId)                     ==> (array) transaction details
+    listings([$sinceDate, $types, $limit, $skip])   ==> (array) a list of recent transactions matching the search criteria
+    stats([$types, $sinceDate, $endDate])           ==> (array) statistics about the account associated with the token
+    
+Offsite Gateway Methods:
+
+    startGatewaySession()                                           ==> (bool) did session start?
+    addGatewayProduct($name, $amount[, $quantity, $description])    ==> (bool) was product added?
+    verifyGatewaySignature($signature, $checkoutId, $amount)        ==> (bool) is signature valid?
+    getGatewayURL($destinationId[, $orderId, $discount, $shipping, $tax, $notes, $callback])    ==> (string) checkout URL
+    
+Helper Methods:
+
+    getError()          ==> (string) error message
+    parseDwollaID($id)  ==> (bool) is valid Dwolla ID?
+    setMode($mode)      ==> (bool) did mode change?
+
+## Changelog
+
+1.0.0
+
+* Reworked Gem.
+
+## Credits
+
+This wrapper is a forked extension of Jefferson Girao's <@jeffersongirao> 'dwolla' module.
+
+- Jefferson Gir�o <contato@jefferson.eti.br>
+- Michael Schonfeld <michael@dwolla.com>
+
+## Support
+
+- Dwolla API <api@dwolla.com>
+- Michael Schonfeld <michael@dwolla.com>
+
+## References / Documentation
+
+http://developers.dwolla.com/dev
+
+## License 
+
+(The MIT License)
+
+Copyright (c) 2012 Dwolla <michael@dwolla.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc "Run specs"
+RSpec::Core::RakeTask.new

data/dwolla.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dwolla/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dwolla-ruby"
+  s.version     = Dwolla::VERSION
+  s.authors     = ["Jefferson Girao", "Michael Schonfeld"]
+  s.email       = ["contato@jefferson.eti.br", "michael@dwolla.com"]
+  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}
+
+  s.rubyforge_project = "dwolla"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'faraday', '= 0.7.6'
+  s.add_dependency 'multi_json', '= 1.3.6'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
+end

data/examples/_keys.rb

@@ -0,0 +1,5 @@
+# Dwolla Secret Stuff
+$apiKey = 'g3s04aw4SU1MSKuIF1CirwY5cP7P5ARfrerUYusaBwZ6nFzlMq'
+$apiSecret = 'wveOY0+3KtRG0LCrSfLh23GgggslSpmRQd2JATcLq4cP5Ee4+F'
+$token = 'rbMHVkBw7Q84of88bZVRkR/k+0cMNUNXFed4TH2DD5MqAY+q3R'
+$pin = '2208'

data/examples/accountInfo.rb

@@ -0,0 +1,31 @@
+# Include the Dwolla gem
+require 'rubygems'
+require 'pp'
+require 'dwolla'
+
+# Include any required keys
+require '_keys.rb'
+
+# Instantiate a new Dwolla User client
+# And, Sseed a previously generated access token
+DwollaClient = Dwolla::Client.new($apiKey, $apiSecret)
+DwollaUser = Dwolla::User.me($token)
+
+
+# EXAMPLE 1:
+#   Fetch account information for the
+#   account associated with the provided
+#   OAuth token
+pp DwollaUser.fetch
+
+
+# EXAMPLE 2: 
+#   Fetch basic account information
+#   for a given Dwolla ID
+pp DwollaClient.user('812-626-8794')
+
+
+# EXAMPLE 3: 
+#   Fetch basic account information
+#   for a given Email address
+pp DwollaClient.user('michael@dwolla.com')

data/examples/contacts.rb

@@ -0,0 +1,27 @@
+# Include the Dwolla gem
+require 'rubygems'
+require 'pp'
+require 'dwolla'
+
+# Include any required keys
+require '_keys.rb'
+
+# Instantiate a new Dwolla User client
+# And, Sseed a previously generated access token
+DwollaUser = Dwolla::User.me($token)
+
+
+# EXAMPLE 1: 
+#   Fetch last 10 contacts from the 
+#   account associated with the provided
+#   OAuth token
+contacts = DwollaUser.contacts()
+pp contacts
+
+
+# EXAMPLE 2: 
+#   Search through the contacts of the
+#   account associated with the provided
+#   OAuth token
+contacts = DwollaUser.contacts(:search => 'Ben')
+pp contacts

data/examples/fundingSources.rb

@@ -0,0 +1,26 @@
+# Include the Dwolla gem
+require 'rubygems'
+require 'pp'
+require 'dwolla'
+
+# Include any required keys
+require '_keys.rb'
+
+# Instantiate a new Dwolla User client
+# And, Sseed a previously generated access token
+DwollaUser = Dwolla::User.me($token)
+
+
+# EXAMPLE 1: 
+#   Fetch all funding sources for the
+#   account associated with the provided
+#   OAuth token
+sources = DwollaUser.funding_sources()
+pp sources
+
+
+# EXAMPLE 2: 
+#   Fetch detailed information for the
+#   funding source with a specific ID
+source = DwollaUser.funding_source('pJRq4tK38fiAeQ8xo2iH9Q==')
+pp source

data/examples/oauth.rb

@@ -0,0 +1,35 @@
+# Include the Dwolla gem
+require 'rubygems'
+require 'pp'
+require 'sinatra'
+require '../lib/dwolla'
+
+# Include any required keys
+require './_keys.rb'
+
+# Instantiate a new Dwolla User client
+# And, Sseed a previously generated access token
+DwollaClient = Dwolla::Client.new($apiKey, $apiSecret)
+
+# Constants...
+redirect_uri = 'http://localhost:4567/oauth_return'
+
+
+# STEP 1: 
+#   Create an authentication URL
+#   that the user will be redirected to
+get '/' do
+    authUrl = DwollaClient.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
+get '/oauth_return' do
+    code = params['code']
+    token = DwollaClient.request_token(code, redirect_uri)
+    "Your never-expiring OAuth access token is: <b>#{token}</b>"
+end

data/examples/offsiteGateway.rb

@@ -0,0 +1 @@
+# Coming soon...

data/examples/send.rb

@@ -0,0 +1,23 @@
+# Include the Dwolla gem
+require 'rubygems'
+require 'pp'
+require '../lib/dwolla'
+
+# Include any required keys
+require '_keys.rb'
+
+# Instantiate a new Dwolla User client
+# And, Sseed a previously generated access token
+DwollaUser = Dwolla::User.me($token)
+
+
+# EXAMPLE 1: 
+#   Send money ($1.00) to a Dwolla ID 
+transactionId = DwollaUser.send_money_to('812-626-8794', 1.00, $pin)
+pp transactionId
+
+
+# EXAMPLE 2: 
+#   Send money ($1.00) to an email address, with a note
+transactionId = DwollaUser.send_money_to('michael@dwolla.com', 1.00, $pin, 'Email', 'Everyone loves getting money')
+pp transactionId

data/lib/dwolla.rb

@@ -0,0 +1,43 @@
+module Dwolla
+  def self.endpoint=(endpoint)
+    @@endpoint = endpoint
+  end
+
+  def self.endpoint
+    @@endpoint
+  end
+
+  def self.user_agent=(user_agent)
+    @@user_agent = user_agent
+  end
+
+  def self.user_agent
+    @@user_agent
+  end
+
+  def self.debugging?
+    !!@@debug
+  end
+
+  def self.debug=(debug)
+    @@debug = debug
+  end
+
+  self.debug = false
+  self.user_agent = "Dwolla Ruby Wrapper"
+  self.endpoint = "https://www.dwolla.com/oauth/rest"
+end
+
+require 'faraday'
+require 'multi_json'
+
+require "#{File.dirname(__FILE__)}/dwolla/exceptions"
+require "#{File.dirname(__FILE__)}/dwolla/response/parse_json"
+require "#{File.dirname(__FILE__)}/dwolla/response/follow_redirects"
+require "#{File.dirname(__FILE__)}/dwolla/response/guard_server_error"
+require "#{File.dirname(__FILE__)}/dwolla/connection"
+require "#{File.dirname(__FILE__)}/dwolla/client"
+require "#{File.dirname(__FILE__)}/dwolla/transaction"
+require "#{File.dirname(__FILE__)}/dwolla/funding_source"
+require "#{File.dirname(__FILE__)}/dwolla/user"
+require "#{File.dirname(__FILE__)}/dwolla/version"

data/lib/dwolla/client.rb

@@ -0,0 +1,50 @@
+module Dwolla
+  class Client
+    include Dwolla::Connection
+
+    def initialize(client, secret)
+      @client, @secret = client, secret
+    end
+
+    def user(id)
+      user_attributes_hash = get("users/#{id}")
+      User.new(user_attributes_hash)
+    end
+
+    def auth_url(redirect_uri=nil, scope='send|transactions|balance|request|contacts|accountinfofull|funding')
+        params = {
+            'scope' => scope,
+            'response_type' => 'code',
+            'client_id' => @client
+        }
+        unless redirect_uri.nil?
+            params['redirect_uri'] = redirect_uri
+        end
+        querystring = params.map{|k,v| "#{CGI.escape(k)}=#{CGI.escape(v)}"}.join("&")
+
+        return 'https://www.dwolla.com/oauth/v2/authenticate?' + querystring
+    end
+    
+    def request_token(code, redirect_uri=nil)
+        params = {
+            'client_id' => @client,
+            'client_secret' => @secret,
+            'grant_type'    => 'authorization_code',
+            'code'          => code
+        }
+        unless redirect_uri.nil?
+            params['redirect_uri'] = redirect_uri
+        end
+
+        resp = get('https://www.dwolla.com/oauth/v2/token', params)
+
+        return resp['access_token']
+    end
+
+    private
+
+      def auth_params
+        { :client_id => @client, :client_secret => @secret }
+      end
+   end
+end

data/lib/dwolla/connection.rb

@@ -0,0 +1,47 @@
+module Dwolla
+  module Connection
+    private
+      def connection
+        default_options = {
+          :headers => {
+            :accept => 'application/json',
+            :content_type => 'application/json',
+            :user_agent => Dwolla.user_agent,
+          }
+        }
+
+        @connection ||= Faraday.new(Dwolla.endpoint, default_options) do |builder|
+          builder.use Dwolla::Response::FollowRedirects
+          builder.use Dwolla::Response::ParseJson
+          builder.use Dwolla::Response::GuardServerError
+
+          builder.use Faraday::Request::UrlEncoded
+
+          builder.response :logger if Dwolla.debugging?
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def get(path, params={})
+        request(:get, path, params)
+      end
+
+      def post(path, params={})
+        request(:post, path, params)
+      end
+
+      def request(method, path, params)
+        response = connection.send(method) do |request|
+          case method.to_sym
+          when :delete, :get
+            request.url(path, params.merge(auth_params))
+          when :post
+            request.path = path
+            params.merge!(auth_params) if auth_params
+            request.body = MultiJson.dump(params) unless params.empty?
+          end
+        end
+        response.body
+      end
+  end
+end