Contents

# WA Easy API Ruby Bindings

[![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org)

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:

```rb
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:

```rb
WAEasyAPI.setup('key_id', 'key_secret')
```

You can set customer headers for your requests using the following:
```rb
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

1. Fork it ( https://github.com/waeasyapi/waeasyapi-ruby/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Run `rake` and `rubocop` after making your changes to make sure you didn't break anything
4. Commit your changes (`git commit -am 'Add some feature'`)
5. Push to the branch (`git push origin my-new-feature`)
6. Create a new Pull Request

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
waeasyapi-1.0.0	README.md