GaExampleGem
This Gem is just to demonstrate some patterns for creating, documenting and testing a Gem.
Installation
Add this line to your application's Gemfile:
gem 'ga_example_gem'
And then execute:
$ bundle
Or install it yourself as:
$ gem install ga_example_gem
Usage
Setup a new instance:
@client = GaExampleGem.new
@client.configure do |config|
config.api_key = "your_api_key"
config.oauth_key = "foo"
end
@client.api_key
Now make a request for an XKCD comic:
# Returns JSON of the first XKCD comic
client.get_xkcd(1)
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request