DEPRECATED
This is no longer supported or used since SynapsePay has incorporated these changes (mostly the detailed integration tests) into their own official Ruby SDK which has improved substantially. I'm not interested in doing more development for new or updated features so I've transitioned to using their SDK while also making various contributions.
The SynapsePayments Ruby Gem
A tested Ruby interface to the SynapsePay v3 API. Note: Requires Ruby 2.1 and up. Not all API actions are supported. Find out more in the TODO section.
Installation
Add this line to your application's Gemfile:
gem 'synapse_payments'
And then execute:
$ bundle
Or install it yourself as:
$ gem install synapse_payments
To try out the gem and experiment, you're better off following the development instructions.
Usage
Check out samples.md to review how to use this library.
Development
-
Clone the repo:
git clone https://github.com/javierjulio/synapse_payments.git
-
Use Ruby 2.1 and up. If you need to install use rbenv and ruby-build and then run:
gem update --system gem update gem install bundler --no-rdoc --no-ri
-
From project root run
./bin/setup
script -
Run
./bin/console
to experiment with an authenticatedclient
andfingerprint
:
fingerprint
# => acb123...
users = client.users.all
puts users
# => {...
TODO
- add pagination/querying to method
all
for users, nodes, transactions, and subscriptions - consider creating a
Response
object wrapper - clean up object/folder structure
- reorganize integration tests
Tests
Run bundle exec rake test
. To include integration tests run with USER_ID=YOUR_USER_ID
being a user you created in sandbox.
Releasing
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.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/javierjulio/synapse_payments. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.