crowdhaven / fund_america

This is a ruby gem to use the FundAmerica (http://www.fundamerica.com) API easily in your ruby, rails and sinatra apps built by RubyEffect (http://www.rubyeffect.com)

FundAmerica

This is a ruby gem to provide easy implementation of FundAmerica API

Installation

Add this line to your application's Gemfile:

gem 'fund_america'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fund_america

Usage

The details on usage of FundAmerica gem are present at: http://www.rubyeffect.com/blog/category/fundamerica/. If you wish to see FundAmerica's API documentation, please visit the url: https://apps.fundamerica.com/support/documentation

1. FundAmerica Gem Introductory Post
2. Entity Endpoints Part One
3. Entity Endpoints Part Two
4. API Info
5. ACH Authorizations
6. Background Checks
7. Bank Info
8. Error Handling
9. Offerings
10. Cancel Offering Request
11. Close Offering Request

TODO

1. Addition of new end points as per the latest FundAmerica latest changelog
2. Addition of paginated results fetch, sorting and hide options for resource_list responses
3. Support for ruby versions < 2.2.2
4. More test cases

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

1. Fork it ( https://github.com/rubyeffect/fund_america/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

1. Dan M (https://github.com/dan987)
2. Charles S (https://github.com/Designbookcom)

About RubyEffect

RubyEffect builds intuitive, live and elegant software that solves real world problems. We love open source and it's community.

Liked this gem? You may also like the articles we post on our blog. Please do check

We would love to work on your ideas and see them grow. Say hello @ http://rubyeffect.com/contact