/dwolla-iav

A quickstart Rails 4+ demo of the Dwolla IAV flow.

Primary LanguageRuby

dwolla-iav

A quickstart tutorial application written in Rails 4+ illustrating an example dwolla.js implementation.

Syntax highlighting done via redcarpet and rouge.

Ooh! Pretty!

Requirements

  • Rails 4+
  • Bundler

This application does not require any database access as all the data is processed via the Dwolla API. ActiveRecord has been removed from this project.

Getting Started

Fetch & Run

The default application key and secret bundled with the application are for you to use with the UAT environment, so you can just run it!

git clone https://github.com/mach-kernel/dwolla-iav.git
cd dwolla-iav
bundle install && rails s

Afterwards, just visit your default Rails URL, which is probably localhost:3000.

Configure

Just kidding. The only thing that you would really need to configure are the dwolla-swagger variables. You can find everything that you need in config/initializers/dwolla.rb

require 'dwolla_swagger'

module Dwolla
  DwollaSwagger::Swagger.configure do |config|
    config.access_token = 'some token'
    config.host = 'api-uat.dwolla.com'
    config.base_path = '/'
    config.verify_ssl = false if Rails.env.development?
  end
end

Note: These values cannot be edited on-the-fly (except from within a rails c session) and require a restart of the rails server.

Deploy to Heroku

Requirements

  • A Heroku account with an available instance.
  • The Heroku Toolbelt installed to your local machine (and added to your %PATH% variable if you are a Windows user).
  • I recommend forking this repository so that you can have write privileges.

How-to deploy: the easy-peasy way

Please fork this repository before doing this.

  1. Connect your GitHub account in your Heroku admin panel

  2. Search for your repository

    Search

  3. Deploy a branch

    Deploy

How-to deploy: the devops special

  1. Log in

    heroku login
    
    Enter your Heroku credentials.
    Email: you@example.com
    Password:
    Could not find an existing public key.
    Would you like to generate one? [Yn]
    Generating new SSH public key.
    Uploading ssh public key /Users/david/.ssh/id_rsa.pub
  2. Install Rails

    gem install rails
  3. Drop back to your local machine's shell and change to the application directory

    This will add a heroku branch to the git repository

    heroku create
    Creating dwolla-rails-heroku... done, stack is cedar-14
    https://dwolla-rails-heroku.herokuapp.com/ | https://git.heroku.com/dwolla-rails-heroku.git
    Git remote heroku added

And finally, deploy and run.

git push heroku master
heroku ps:scale web=1

That wasn't so bad, was it?

Credits

License

Copyright (C) 2015 David Stancu, Dwolla Inc.

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.