https://github.com/peterberkenbosch/affirm-ruby-api
Affirm Ruby client for integrating with Affirm financing payments using the new Transaction API
https://github.com/peterberkenbosch/affirm-ruby-api
affirm affirm-financing financing payment-gateway payment-integration ruby-client
Last synced: 8 months ago
JSON representation
Affirm Ruby client for integrating with Affirm financing payments using the new Transaction API
- Host: GitHub
- URL: https://github.com/peterberkenbosch/affirm-ruby-api
- Owner: peterberkenbosch
- License: mit
- Created: 2020-03-27T09:19:52.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-08-14T13:33:25.000Z (over 4 years ago)
- Last Synced: 2024-05-01T14:03:13.250Z (over 1 year ago)
- Topics: affirm, affirm-financing, financing, payment-gateway, payment-integration, ruby-client
- Language: Ruby
- Homepage: https://peterberkenbosch.gitbook.io/affirm-ruby-api/
- Size: 76.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Affirm Ruby API
Clean, fast and pure Ruby implementation for the [Affirm API](https://docs.affirm.com/affirm-developers/reference)
This is using the new Transaction API and is not compatible with the Charge API. Also see the [Affirm Changelog](https://docs.affirm.com/affirm-developers/changelog/transactions-api)
[](https://badge.fury.io/rb/affirm-ruby-api)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'affirm-ruby-api'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install affirm-ruby-api
## Documentation
* [Official documentation](https://peterberkenbosch.gitbook.io/affirm-ruby-api)
## Development
After checking out the repo, run `bin/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.
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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### Testing support
When implementing this gem into your application or other gem, you can reuse the JSON and HTTP payloads and responses. For example with RSpec you can add the following to your `spec_helper.rb` file:
```ruby
require "affirm/testing_support/http_responses"
RSpec.configure do |config|
config.include Affirm::TestingSupport::HttpResponses
end
```
this will provide you with the `read_http_fixture` and `read_json_fixture` methods. These can be used to mock the responses and payload body's with `WebMock`.
For details on how to use this, take a look at the usage in the spec files here.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/peterberkenbosch/affirm-ruby-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/peterberkenbosch/affirm-ruby-api/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Affirm::Ruby::Api project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/peterberkenbosch/affirm-ruby-api/blob/master/CODE_OF_CONDUCT.md).