ga_example_gem 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,9 @@
+coverage
+coverage.data
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+.DS_Store
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,27 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem 'httparty'
+
+group :development do
+  gem "shoulda", ">= 0"
+  gem "pry"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 1.8.7"
+  gem "simplecov"
+end
+
+
+group :test do
+  gem 'webmock'
+	gem 'simplecov'
+	gem 'coveralls'
+	gem 'rspec'
+	gem 'shoulda-matchers'
+end

data/Gemfile.lock

@@ -0,0 +1,123 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.0.1)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    atomic (1.1.14)
+    builder (3.2.2)
+    coderay (1.1.0)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
+    diff-lcs (1.2.5)
+    docile (1.1.0)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    httpauth (0.2.0)
+    i18n (0.6.5)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    pry (0.9.12.3)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    safe_yaml (0.9.7)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.6)
+    shoulda-matchers (2.4.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.4.7)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    thread_safe (0.1.3)
+      atomic
+    tins (0.12.0)
+    tzinfo (0.3.38)
+    webmock (1.15.0)
+      addressable (>= 2.2.7)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  coveralls
+  httparty
+  jeweler (~> 1.8.7)
+  pry
+  rdoc (~> 3.12)
+  rspec
+  shoulda
+  shoulda-matchers
+  simplecov
+  webmock

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 David Fisher
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# GaExampleGem
+
+[![Coverage Status](https://coveralls.io/repos/tibbon/ga-example-gem/badge.png)](https://coveralls.io/r/tibbon/ga-example-gem)
+
+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: 
+
+```ruby
+client = GaExampleGem.configure do |config|
+	config.api_key = "your_api_key"
+end
+```
+
+
+Now make a request for an XKCD comic:
+
+```ruby
+	# 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ga-example-gem.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ga_example_gem/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ga_example_gem"
+  spec.version       = GaExampleGem::VERSION
+  spec.authors       = ["David Fisher"]
+  spec.email         = ["tibbon@gmail.com"]
+  spec.description   = %q{An example gem}
+  spec.summary       = %q{Makes requests to APIs and has tests.}
+  spec.homepage      = "https://github.com/tibbon/ga-example-gem"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "httparty"
+end

data/lib/ga_example_gem.rb

@@ -0,0 +1,28 @@
+# Require files in your internal folder
+require 'ga_example_gem/client'
+
+# This is our GaExampleGem namespace
+# for our gem
+module GaExampleGem
+	class << self
+		# Alias for GaExampleGem::Client.new
+		def new
+      @client ||= GaExampleGem::Client.new
+    end
+
+    # Delegate to GaExampleGem::Client
+    # This is a weird trick that allows for calling 
+    # on methods without calling .new first
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+
+    # This is used for the method_missing to see
+    # if a new client would respond to a method
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/ga_example_gem/client.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'httparty'
+require 'ga_example_gem/configuration'
+
+module GaExampleGem
+	
+	# This is our client that we can initialize with
+	# GaExampleGem.new
+	class Client
+		include GaExampleGem::Configuration
+		include HTTParty
+
+		# This resets our API keys when it is initialized
+		def initialize
+      reset
+  	end
+
+  	# This method gets the JSON for a single XKCD comic
+  	# by number
+  	def get_xkcd(number)
+  		JSON.parse self.class.get("http://xkcd-unofficial-api.herokuapp.com/xkcd?num=#{number}")
+  	end
+	end
+end

data/lib/ga_example_gem/configuration.rb

@@ -0,0 +1,27 @@
+module GaExampleGem
+
+  # This is the configuration module that 
+  # allows us to setup an api_key
+  # using a pattern close to the Twitter or MtGox gem
+	module Configuration
+
+    # This is our API key. We aren't really using it
+    # anywhere, but you could imagine using it
+    # with HTTP requests
+		attr_accessor :api_key
+
+    # This yields a block that can be iterated on
+    # Its useful for being able to set values to the
+    # attr_accessor
+    def configure
+      yield self
+    end
+
+    # This reset our API key and is called when the 
+    # client is initialized
+    def reset
+      self.api_key = nil
+      self
+    end
+	end
+end

data/lib/ga_example_gem/version.rb

@@ -0,0 +1,7 @@
+module GaExampleGem
+
+	# This sets the version of our gem
+	# Its a bit complex, but check out Semantic Versionining
+	# http://semver.org/
+  VERSION = "0.0.1"
+end

data/spec/fixtures/single_xkcd.json

@@ -0,0 +1 @@
+[{"id":1,"month":1,"num":1,"link":"","year":2006,"news":"","safe_title":"Barrel - Part 1","transcript":"[[A boy sits in a barrel which is floating in an ocean.]]\nBoy: I wonder where I'll float next?\n[[The barrel drifts into the distance. Nothing else can be seen.]]\n{{Alt: Don't we all.}}","title_text":null,"alt":"Don't we all.","img":"http://imgs.xkcd.com/comics/barrel_cropped_(1).jpg","title":"Barrel - Part 1","day":1,"created_at":"2013-11-25T16:57:20.568Z","updated_at":"2013-11-25T16:57:20.568Z"}]

data/spec/ga_example_gem/client_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe GaExampleGem::Client do
+	before do
+    @client = GaExampleGem::Client.new
+    @client.configure do |config|
+      config.api_key = "its a secret to everybody"
+    end
+  end
+
+  describe '#get_xkcd' do
+  	before do
+      stub_request(:get, 'http://xkcd-unofficial-api.herokuapp.com/xkcd?num=1').
+        to_return(body: fixture('single_xkcd.json'))
+    end
+
+    it "fetchs a single xkcd webcomic" do
+      comic = @client.get_xkcd(1)
+      expect(a_request(:get, 'http://xkcd-unofficial-api.herokuapp.com/xkcd?num=1')).to have_been_made
+      expect(comic.first["title"]).to eq "Barrel - Part 1"
+    end
+  end
+end

data/spec/ga_example_gem/configuration_spec.rb

@@ -0,0 +1 @@
+# Nothing needed in here. Already has full test coverage

data/spec/ga_example_gem_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe GaExampleGem do
+	describe '.new' do
+		it "returns a GaExampleGem::Client" do
+			expect(GaExampleGem.new).to be_a GaExampleGem::Client
+		end
+	end
+
+	describe ".configure" do
+    it "sets api_key" do
+      GaExampleGem.configure do |config|
+        config.api_key = "its a secret to everybody"
+      end
+
+      expect(GaExampleGem.api_key).to eq "its a secret to everybody"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
+require 'ga_example_gem'
+require 'rspec'
+require 'webmock/rspec'
+require 'json'
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ga_example_gem
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- David Fisher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An example gem
+email:
+- tibbon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ga-example-gem.gemspec
+- lib/ga_example_gem.rb
+- lib/ga_example_gem/client.rb
+- lib/ga_example_gem/configuration.rb
+- lib/ga_example_gem/version.rb
+- spec/fixtures/single_xkcd.json
+- spec/ga_example_gem/client_spec.rb
+- spec/ga_example_gem/configuration_spec.rb
+- spec/ga_example_gem_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tibbon/ga-example-gem
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Makes requests to APIs and has tests.
+test_files:
+- spec/fixtures/single_xkcd.json
+- spec/ga_example_gem/client_spec.rb
+- spec/ga_example_gem/configuration_spec.rb
+- spec/ga_example_gem_spec.rb
+- spec/spec_helper.rb
+has_rdoc: