Reggora

Welcome to Reggora gem!

Reggora gem works for Lender and Vendor APIs supported by Reggora.

Installation

gem 'reggora'

And then execute:

$ bundle

Or install it yourself as:

$ gem install reggora

Usage

• Initializing Library

  @lender_api_client = Reggora::LenderApiClient.new(user_name, password, int_token)

• Make request

  @_user = Reggora::User.new(@lender_api_client)

  @_user.find(user_id)

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.

Running Tests

You must add your credentials to the .env file inside the root folder. If there isn't one please make one and add the following ENV variables:

USER_NAME=example@email.com
USER_PASS=example_pass123
INT_TOKEN=integration-api-token-here

To run tests run:

rake spec

To run an individual test run:

rspec spec/<name_of_file>/rb

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Reggora/reggora-ruby. 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.

Contributors

Contributor
@dansteren @Simple Nexus

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Reggora project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.