Project

orghunter

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
This gem creates API calls and returns the results as objects
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.13
~> 2.1
~> 0.10
~> 10.0
~> 3.0
~> 3.0
~> 2.1

Runtime

= 2.0
 Project Readme

Orghunter Gem Version

Installation

Add this line to your application's Gemfile:

gem 'orghunter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install orghunter

Usage

API keys must be configured in the gem setup. You can do this anywhere in your application before you make API calls using the gem.

Orghunter.configure do |config|
  config.api_key = YOUR_KEY_HERE
end

Getting these keys requires a (free) Orghunter account and that you agree to the terms of use for the API.

The keys are available to you throughout your application as:

Orghunter.configuration.api_key

Contributing

  1. Fork the repo on GitHub.
  2. Clone the project to your own machine
  3. Add your API key to the cassettes
  4. Run `bundle && bundle exec rake', you will need an API key for tests to work.
  5. Commit changes to your own branch
  6. Push your work back up to your fork
  7. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

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