No description, website, or topics provided.
Ruby
Switch branches/tags
Nothing to show
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.document
.gitignore
.rspec
.travis.yml
Gemfile
Gemfile.lock
LICENSE.txt
README.md
Rakefile
ga-example-gem.gemspec

README.md

GaExampleGem

Gem Version

Coverage Status

Build Status

Code Climate

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

  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