FieldawareApi

A Ruby wrapper for the FieldawareApi REST API.

Installation

Add this line to your application's Gemfile:

gem 'fieldaware_api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fieldaware_api

Usage

Configuration

Before you can make calls to FieldawareApi you must configure the library with a valid API Token. You can request a token be generated by FieldawareApi. The API Token ties the API request to a particualr FieldawareApi company id.

There are two ways to configure the gem. You can pass a hash of configuration options when you create a client, or you can use a configure block.

client = FieldawareApi.client({api_token: "YOUR_TOKEN_HERE"})

FieldawareApi.configure do |config|
  config.api_token = "YOUR_TOKEN_HERE"
end

client = FieldawareApi.client

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request