WA Easy API Ruby Bindings
This is the base ruby gem for interacting with the WA Easy API. This is primarily meant for users who wish to perform interactions with the WA Easy API programatically.
Installation
Add this line to your application's Gemfile:
gem 'waeasyapi'
And then execute:
$ bundle
Or install it yourself as:
$ gem install waeasyapi
Requirements
Ruby 2.6.8 or later
Usage
Remember to require 'waeasyapi' before anything else.
Next, you need to setup your key and secret using the following:
WAEasyAPI.setup('key_id', 'key_secret')
You can set customer headers for your requests using the following:
WAEasyAPI.headers = {"CUSTOM_APP_HEADER" => "CUSTOM_VALUE"}
You can find your API keys at https://app.waeasyapi.com/.
If you are using rails, the right place to do this might be config/initializers/waeasyapi.rb.
Contributing
- Fork it ( https://github.com/waeasyapi/waeasyapi-ruby/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Run
rakeandrubocopafter making your changes to make sure you didn't break anything - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request