This repository contains the source code for Dwolla's Ruby-based SDK, which allows developers to interact with Dwolla's server-side API via a Ruby API, with automatic OAuth token management included. Any action that can be performed via an HTTP request can be made using this SDK when executed within a server-side environment.
To begin using this SDK, you will first need to download it to your machine. We use RubyGems to distribute this package.
Add this line to your application's Gemfile:
gem 'dwolla_v2', '~> 3.1'
And then execute:
$ bundle
Or install it yourself as:
$ gem install dwolla_v2
Before any API requests can be made, you must first determine which environment you will be using, as well as fetch the application key and secret. To fetch your application key and secret, please visit one of the following links:
Finally, you can create an instance of Client with key and secret replaced with the application key and secret that you fetched from one of the aforementioned links, respectively.
# config/initializers/dwolla.rb
$dwolla = DwollaV2::Client.new(
key: ENV["DWOLLA_APP_KEY"],
secret: ENV["DWOLLA_APP_SECRET"],
environment: :sandbox # defaults to :production
)
Dwolla for Ruby uses Faraday to make HTTP requests. You can configure your own Faraday middleware and adapter when configuring your client. Remember to always include an adapter last, even if you want to use the default adapter.
# config/initializers/dwolla.rb
$dwolla = DwollaV2::Client.new(
key: ENV["DWOLLA_APP_KEY"],
secret: ENV["DWOLLA_APP_SECRET"]
) do |config|
config.faraday do |faraday|
faraday.response :logger
faraday.adapter Faraday.default_adapter
end
end
Once you've created a Client, currently, you can make low-level HTTP requests.
To make low-level HTTP requests, you can use the get(), post(), and delete() methods.
GET# GET api.dwolla.com/resource?foo=bar
$dwolla.get "resource", foo: "bar"
POST# POST api.dwolla.com/resource {"foo":"bar"}
$dwolla.post "resource", foo: "bar"
# POST api.dwolla.com/resource multipart/form-data foo=...
$dwolla.post "resource", foo: Faraday::UploadIO.new("/path/to/bar.png", "image/png")
DELETE# DELETE api.dwolla.com/resource
$dwolla.delete "resource"
To set additional headers on a request, you can pass a Hash of headers as the 3rd argument.
For example:
$dwolla.post "customers", { firstName: "John", lastName: "Doe", email: "jd@doe.com" },
{ 'Idempotency-Key': 'a52fcf63-0730-41c3-96e8-7147b5d1fb01' }
The following snippets demonstrate successful and errored responses from the Dwolla API.
An errored response is returned when Dwolla's servers respond with a status code that is greater than or equal to 400, whereas a successful response is when Dwolla's servers respond with a 200-level status code.
Successful requests return a DwollaV2::Response.
res = $dwolla.get "/"
# => #<DwollaV2::Response response_status=200 response_headers={"server"=>"cloudflare-nginx", "date"=>"Mon, 28 Mar 2016 15:30:23 GMT", "content-type"=>"application/vnd.dwolla.v1.hal+json; charset=UTF-8", "content-length"=>"150", "connection"=>"close", "set-cookie"=>"__cfduid=d9dcd0f586c166d36cbd45b992bdaa11b1459179023; expires=Tue, 28-Mar-17 15:30:23 GMT; path=/; domain=.dwolla.com; HttpOnly", "x-request-id"=>"69a4e612-5dae-4c52-a6a0-2f921e34a88a", "cf-ray"=>"28ac1f81875941e3-MSP"} {"_links"=>{"events"=>{"href"=>"https://api-sandbox.dwolla.com/events"}, "webhook-subscriptions"=>{"href"=>"https://api-sandbox.dwolla.com/webhook-subscriptions"}}}>
res.response_status
# => 200
res.response_headers
# => {"server"=>"cloudflare-nginx", "date"=>"Mon, 28 Mar 2016 15:30:23 GMT", "content-type"=>"application/vnd.dwolla.v1.hal+json; charset=UTF-8", "content-length"=>"150", "connection"=>"close", "set-cookie"=>"__cfduid=d9dcd0f586c166d36cbd45b992bdaa11b1459179023; expires=Tue, 28-Mar-17 15:30:23 GMT; path=/; domain=.dwolla.com; HttpOnly", "x-request-id"=>"69a4e612-5dae-4c52-a6a0-2f921e34a88a", "cf-ray"=>"28ac1f81875941e3-MSP"}
res._links.events.href
# => "https://api-sandbox.dwolla.com/events"
If the server returns an error, a DwollaV2::Error (or one of its subclasses) will be raised.
DwollaV2::Errors are similar to DwollaV2::Responses.
begin
$dwolla.get "/not-found"
rescue DwollaV2::NotFoundError => e
e
# => #<DwollaV2::NotFoundError response_status=404 response_headers={"server"=>"cloudflare-nginx", "date"=>"Mon, 28 Mar 2016 15:35:32 GMT", "content-type"=>"application/vnd.dwolla.v1.hal+json; profile=\"http://nocarrier.co.uk/profiles/vnd.error/\"; charset=UTF-8", "content-length"=>"69", "connection"=>"close", "set-cookie"=>"__cfduid=da1478bfdf3e56275cd8a6a741866ccce1459179332; expires=Tue, 28-Mar-17 15:35:32 GMT; path=/; domain=.dwolla.com; HttpOnly", "access-control-allow-origin"=>"*", "x-request-id"=>"667fca74-b53d-43db-bddd-50426a011881", "cf-ray"=>"28ac270abca64207-MSP"} {"code"=>"NotFound", "message"=>"The requested resource was not found."}>
e.response_status
# => 404
e.response_headers
# => {"server"=>"cloudflare-nginx", "date"=>"Mon, 28 Mar 2016 15:35:32 GMT", "content-type"=>"application/vnd.dwolla.v1.hal+json; profile=\"http://nocarrier.co.uk/profiles/vnd.error/\"; charset=UTF-8", "content-length"=>"69", "connection"=>"close", "set-cookie"=>"__cfduid=da1478bfdf3e56275cd8a6a741866ccce1459179332; expires=Tue, 28-Mar-17 15:35:32 GMT; path=/; domain=.dwolla.com; HttpOnly", "access-control-allow-origin"=>"*", "x-request-id"=>"667fca74-b53d-43db-bddd-50426a011881", "cf-ray"=>"28ac270abca64207-MSP"}
e.code
# => "NotFound"
rescue DwollaV2::Error => e
# ...
end
DwollaV2::Error subclasses:See https://developers.dwolla.com/api-reference#errors for more info.
DwollaV2::AccessDeniedErrorDwollaV2::InvalidCredentialsErrorDwollaV2::NotFoundErrorDwollaV2::BadRequestErrorDwollaV2::InvalidGrantErrorDwollaV2::RequestTimeoutErrorDwollaV2::ExpiredAccessTokenErrorDwollaV2::InvalidRequestErrorDwollaV2::ServerErrorDwollaV2::ForbiddenErrorDwollaV2::InvalidResourceStateErrorDwollaV2::TemporarilyUnavailableErrorDwollaV2::InvalidAccessTokenErrorDwollaV2::InvalidScopeErrorDwollaV2::UnauthorizedClientErrorDwollaV2::InvalidAccountStatusErrorDwollaV2::InvalidScopesErrorDwollaV2::UnsupportedGrantTypeErrorDwollaV2::InvalidApplicationStatusErrorDwollaV2::InvalidVersionErrorDwollaV2::UnsupportedResponseTypeErrorDwollaV2::InvalidClientErrorDwollaV2::MethodNotAllowedErrorDwollaV2::ValidationErrorDwollaV2::TooManyRequestsErrorDwollaV2::ConflictErrorDwollaV2::MaxNumberOfResourcesError (Thanks @paulyeo21!). #54DwollaV2::Clientwww.dwolla.com/oauth/v2/token to accounts.dwolla.com/tokenTime.iso8601 is defined so timestamps get parsed. #38 (Thanks @javierjulio!)DuplicateResourceError #34 (Thanks @javierjulio!)DwollaV2::Response #status => #response_status, #headers => #response_headers to prevent
conflicts with response body properties.#empty? on DwollaV2::Token to allow it to be passed to ActiveRecord constructor.token.* methods.verified_account and dwolla_landing auth flags.TooManyRequestsError and ConflictError classes.Error class to be more like response, add ability to access keys using methods.DwollaV2::Response worksDwollaV2::Error error messagesTime objectsattr_encryptedbin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.If you prefer to use Docker to run dwolla-v2-python locally, a Dockerfile is included at the root directory. Follow these instructions from Docker's website to create a Docker image from the Dockerfile, and run it.
To learn more about Dwolla and how to integrate our product with your application, please consider visiting the following resources and becoming a member of our community!
FAQs
Unknown package
We found that tarric_dwolla_v2 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.