dwolla-ruby 1.1.0 → 2.0.0

data/dwolla-ruby.gemspec

@@ -1,29 +1,24 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
 require "dwolla/version"
 
 Gem::Specification.new do |s|
-  s.name        = "dwolla-ruby"
-  s.version     = Dwolla::VERSION
-  s.authors     = ["Michael Schonfeld"]
-  s.email       = ["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.name        = "dwolla-ruby"
+    s.version     = Dwolla::VERSION
+    s.authors     = ["Michael Schonfeld"]
+    s.email       = ["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. Completely re-written based on Stripe's Ruby Bindings.}
 
-  s.rubyforge_project = "dwolla-ruby"
+    s.rubyforge_project = "dwolla-ruby"
 
-  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.files         = `git ls-files`.split("\n")
+    s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+    s.require_paths = %w{lib}
 
-  s.add_dependency 'faraday', '= 0.7.6'
-  s.add_dependency 'multi_json', '~> 1.3'
+    s.add_dependency('rest-client', '~> 1.4')
+    s.add_dependency('multi_json', '>= 1.0.4', '< 2')
+    s.add_dependency('addressable', '>= 2')
 
-  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'
+    s.add_development_dependency('rake')
 end

data/examples/accountInfo.rb

@@ -7,25 +7,25 @@ require 'dwolla'
 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)
-
+# And, seed a previously generated access token
+Dwolla::token = @token
+Dwolla::api_key = @api_key
+Dwolla::api_secret = @api_secret
 
 # EXAMPLE 1:
 #   Fetch account information for the
 #   account associated with the provided
 #   OAuth token
-pp DwollaUser.fetch
+pp Dwolla::Users.get
 
 
 # EXAMPLE 2: 
 #   Fetch basic account information
 #   for a given Dwolla ID
-pp DwollaClient.user('812-626-8794')
+pp Dwolla::Users.get('812-626-8794')
 
 
 # EXAMPLE 3: 
 #   Fetch basic account information
 #   for a given Email address
-pp DwollaClient.user('michael@dwolla.com')
+pp Dwolla::Users.get('michael@dwolla.com')

data/examples/balance.rb

@@ -1,17 +1,17 @@
 # Include the Dwolla gem
 require 'rubygems'
 require 'pp'
-require '../lib/dwolla'
+require 'dwolla'
 
 # Include any required keys
-require_relative '_keys.rb'
+require '_keys.rb'
 
 # Instantiate a new Dwolla User client
 # And, seed a previously generated access token
-DwollaUser = Dwolla::User.me($token)
+Dwolla::token = @token
 
 
 # EXAMPLE 1: 
 #   Get the balance of the authenticated user
-balance = DwollaUser.balance
-pp balance
+balance = Dwolla::Balance.get
+pp balance

data/examples/contacts.rb

@@ -7,15 +7,15 @@ require 'dwolla'
 require '_keys.rb'
 
 # Instantiate a new Dwolla User client
-# And, Sseed a previously generated access token
-DwollaUser = Dwolla::User.me($token)
+# And, seed a previously generated access token
+Dwolla::token = $token
 
 
 # EXAMPLE 1: 
 #   Fetch last 10 contacts from the 
 #   account associated with the provided
 #   OAuth token
-contacts = DwollaUser.contacts()
+contacts = Dwolla::Contacts.get
 pp contacts
 
 
@@ -23,5 +23,5 @@ pp contacts
 #   Search through the contacts of the
 #   account associated with the provided
 #   OAuth token
-contacts = DwollaUser.contacts(:search => 'Ben')
+contacts = Dwolla::Contacts.get({:search => 'Ben'})
 pp contacts

data/examples/fundingSources.rb

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

data/examples/oauth.rb

@@ -2,24 +2,23 @@
 require 'rubygems'
 require 'pp'
 require 'sinatra'
-require '../lib/dwolla'
+require 'dwolla'
 
 # Include any required keys
-require './_keys.rb'
+require '_keys.rb'
 
 # Instantiate a new Dwolla User client
-# And, Sseed a previously generated access token
-DwollaClient = Dwolla::Client.new($apiKey, $apiSecret)
+Dwolla::api_key = @api_key
+Dwolla::api_secret = @api_secret
 
 # 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)
+    authUrl = Dwolla::OAuth.get_auth_url(redirect_uri)
     "To begin the OAuth process, send the user off to <a href=\"#{authUrl}\">#{authUrl}</a>"
 end
 
@@ -30,6 +29,6 @@ end
 #   a never-expiring OAuth access token
 get '/oauth_return' do
     code = params['code']
-    token = DwollaClient.request_token(code, redirect_uri)
+    token = Dwolla::OAuth.get_token(code, redirect_uri)
     "Your never-expiring OAuth access token is: <b>#{token}</b>"
 end

data/examples/transactions.rb

@@ -0,0 +1,32 @@
+# Include the Dwolla gem
+require 'rubygems'
+require 'pp'
+require 'dwolla'
+
+# Include any required keys
+require '_keys.rb'
+
+# Instantiate a new Dwolla User client
+# And, seed a previously generated access token
+Dwolla::token = $token
+
+
+# EXAMPLE 1: 
+#   Send money ($1.00) to a Dwolla ID 
+transactionId = Dwolla::Transactions.send({:destinationId => '812-626-8794', :amount => 1.00, :pin => $pin})
+pp transactionId
+
+# EXAMPLE 2: 
+#   Send money ($1.00) to an email address, with a note
+transactionId = Dwolla::Transactions.send({:destinationId => '812-626-8794', :destinationType => 'Email', :amount => 1.00, :pin => $pin, :notes => 'Everyone loves getting money'})
+pp transactionId
+
+# EXAMPLE 3: 
+#   Get details about all recent transactions
+transactions = Dwolla::Transactions.get
+pp transactions
+
+# EXAMPLE 4: 
+#   Get details about a certain Transaction
+transactionId = Dwolla::Transactions.get(transactionId)
+pp transactionId

data/lib/dwolla.rb

@@ -1,54 +1,275 @@
 # Dwolla Ruby API Wrapper
-# API spec at http://developers.dwolla.com
-require 'rubygems'
-require 'faraday'
+# Heavily based off Stripe's Ruby Gem
+# API spec at https://developers.dwolla.com
+require 'openssl'
+require 'rest_client'
 require 'multi_json'
+require 'addressable/uri'
 
 # Version
-require "dwolla/version"
-
-# API operations
-require "dwolla/client"
-require "dwolla/transaction"
-require "dwolla/funding_source"
-require "dwolla/user"
+require 'dwolla/version'
 
 # Resources
-require "dwolla/connection"
-require "dwolla/response/parse_json"
-require "dwolla/response/follow_redirects"
-require "dwolla/response/guard_server_error"
+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' // Needs more work
 
 # Errors
-require "dwolla/exceptions"
+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'
 
 module Dwolla
-  def self.endpoint=(endpoint)
-    @@endpoint = endpoint
-  end
+    @@api_key = nil
+    @@api_secret = nil
+    @@token = nil
+    @@api_base = 'https://www.dwolla.com/oauth/rest'
+    @@verify_ssl_certs = true
+    @@api_version = nil
+    @@debug = false
+
+    def self.api_key=(api_key)
+        @@api_key = api_key
+    end
+
+    def self.api_key
+        @@api_key
+    end
+
+    def self.api_secret=(api_secret)
+        @@api_secret = api_secret
+    end
+
+    def self.api_secret
+        @@api_secret
+    end
+
+    def self.debug
+        @@debug
+    end
+
+    def self.debug=(debug)
+        @@debug = debug
+    end
+
+    def self.api_version=(api_version)
+        @@api_version = api_version
+    end
+
+    def self.api_version
+        @@api_version
+    end
+
+    def self.verify_ssl_certs=(verify_ssl_certs)
+        @@verify_ssl_certs = verify_ssl_certs
+    end
+
+    def self.verify_ssl_certs
+        @@verify_ssl_certs
+    end
+
+    def self.token=(token)
+        @@token = token
+    end
+
+    def self.token
+        @@token
+    end
+
+    def self.endpoint_url(endpoint)
+        @@api_base + endpoint
+    end
+
+    def self.request(method, url, params={}, headers={}, oauth=true, parse_response=true, custom_url=false)
+        if oauth
+            raise AuthenticationError.new('No OAuth Token Provided.') unless token
+            params = {
+                :oauth_token => token
+            }.merge(params)
+        else
+            raise AuthenticationError.new('No App Key & Secret Provided.') unless (api_key && api_secret)
+            params = {
+                :client_id => api_key,
+                :client_secret => api_secret
+            }.merge(params)
+        end
+
+        if !verify_ssl_certs
+            $stderr.puts "WARNING: Running without SSL cert verification."
+        else
+            ssl_opts = {
+                :use_ssl => true
+            }
+        end
+
+        uname = (@@uname ||= RUBY_PLATFORM =~ /linux|darwin/i ? `uname -a 2>/dev/null`.strip : nil)
+        lang_version = "#{RUBY_VERSION} p#{RUBY_PATCHLEVEL} (#{RUBY_RELEASE_DATE})"
+        ua = {
+            :bindings_version => Dwolla::VERSION,
+            :lang => 'ruby',
+            :lang_version => lang_version,
+            :platform => RUBY_PLATFORM,
+            :publisher => 'dwolla',
+            :uname => uname
+        }
+
+        url = self.endpoint_url(url) unless custom_url
+
+        case method.to_s.downcase.to_sym
+            when :get
+                # Make params into GET parameters
+                if params && params.count > 0
+                    uri = Addressable::URI.new
+                    uri.query_values = params
+                    url += '?' + uri.query
+                end
+                payload = nil
+            else
+                payload = ''
+        end
+
+        begin
+            headers = { :x_dwolla_client_user_agent => Dwolla::JSON.dump(ua) }.merge(headers)
+        rescue => e
+            headers = {
+                :x_dwolla_client_raw_user_agent => ua.inspect,
+                :error => "#{e} (#{e.class})"
+            }.merge(headers)
+        end
+
+        headers = {
+            :user_agent => "Dwolla Ruby API Wrapper/#{Dwolla::VERSION}",
+            :content_type => 'application/json'
+        }.merge(headers)
+
+        if self.api_version
+            headers[:dwolla_version] = self.api_version
+        end
+
+        opts = {
+            :method => method,
+            :url => url,
+            :headers => headers,
+            :open_timeout => 30,
+            :payload => payload,
+            :timeout => 80
+        }.merge(ssl_opts)
+
+        if self.debug
+            puts "Firing request with options and headers:"
+            puts opts
+            puts headers
+        end
+
+        begin
+            response = execute_request(opts)
+        rescue SocketError => e
+            self.handle_restclient_error(e)
+        rescue NoMethodError => e
+            # Work around RestClient bug
+            if e.message =~ /\WRequestFailed\W/
+                e = APIConnectionError.new('Unexpected HTTP response code')
+                self.handle_restclient_error(e)
+            else
+                raise
+            end
+        rescue RestClient::ExceptionWithResponse => e
+            if rcode = e.http_code and rbody = e.http_body
+                self.handle_api_error(rcode, rbody)
+            else
+                self.handle_restclient_error(e)
+            end
+        rescue RestClient::Exception, Errno::ECONNREFUSED => e
+            self.handle_restclient_error(e)
+        end
+
+        rbody = response.body
+        rcode = response.code
+
+        resp = self.extract_json(rbody, rcode)
+
+        if parse_response
+            return self.parse_response(resp)
+        else
+            return resp
+        end
+    end
+
+    private
+ 
+    def self.execute_request(opts)
+        RestClient::Request.execute(opts)
+    end
+
+    def self.extract_json(rbody, rcode)
+        begin
+            resp = Dwolla::JSON.load(rbody)
+        rescue MultiJson::DecodeError
+            raise APIError.new("There was an error parsing Dwolla's API response: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+        end
+
+        return resp
+    end
+
+    def self.parse_response(resp)
+        raise APIError.new(resp['Message']) unless resp['Success']
+
+        return resp['Response']
+    end
+
+    def self.handle_api_error(rcode, rbody)
+        begin
+            error_obj = Dwolla::JSON.load(rbody)
+            error = error_obj[:error] or raise DwollaError.new # escape from parsing
+        rescue MultiJson::DecodeError, DwollaError
+            raise APIError.new("Invalid response object from API: #{rbody.inspect} (HTTP response code was #{rcode})", rcode, rbody)
+        end
 
-  def self.endpoint
-    @@endpoint
-  end
+        case rcode
+            when 400, 404 then
+                raise invalid_request_error(error, rcode, rbody, error_obj)
+            when 401
+                raise authentication_error(error, rcode, rbody, error_obj)
+            else
+                raise api_error(error, rcode, rbody, error_obj)
+        end
+    end
 
-  def self.user_agent=(user_agent)
-    @@user_agent = user_agent
-  end
+    def self.invalid_request_error(error, rcode, rbody, error_obj)
+        InvalidRequestError.new(error[:message], error[:param], rcode, rbody, error_obj)
+    end
 
-  def self.user_agent
-    @@user_agent
-  end
+    def self.authentication_error(error, rcode, rbody, error_obj)
+        AuthenticationError.new(error[:message], rcode, rbody, error_obj)
+    end
 
-  def self.debugging?
-    !!@@debug
-  end
+    def self.api_error(error, rcode, rbody, error_obj)
+        APIError.new(error[:message], rcode, rbody, error_obj)
+    end
 
-  def self.debug=(debug)
-    @@debug = debug
-  end
+    def self.handle_restclient_error(e)
+        case e
+            when RestClient::ServerBrokeConnection, RestClient::RequestTimeout
+                message = "Could not connect to Dwolla (#{@@api_base}).  Please check your internet connection and try again.  If this problem persists, you should check Dwolla's service status at https://twitter.com/Dwolla, or let us know at support@Dwolla.com."
+            when RestClient::SSLCertificateNotVerified
+                message = "Could not verify Dwolla's SSL certificate. If this problem persists, let us know at support@dwolla.com."
+            when SocketError
+                message = "Unexpected error communicating when trying to connect to Dwolla. If this problem persists, let us know at support@dwolla.com."
+            else
+                message = "Unexpected error communicating with Dwolla. If this problem persists, let us know at support@dwolla.com."
+        end
 
-  self.debug = false
-  self.user_agent = "Dwolla Ruby Wrapper"
-  self.endpoint = "https://www.dwolla.com/oauth/rest"
-end
+        message += "\n\n(Network error: #{e.message})"
 
+        raise APIConnectionError.new(message)
+    end
+end