ga_example_gem 0.0.2 → 0.0.3

data/README.md

@@ -1,5 +1,7 @@
 # GaExampleGem
 
+[![Gem Version](https://badge.fury.io/rb/ga_example_gem.png)](http://badge.fury.io/rb/ga_example_gem)
+
 [![Coverage Status](https://coveralls.io/repos/tibbon/ga-example-gem/badge.png)](https://coveralls.io/r/tibbon/ga-example-gem)
 
 [![Build Status](https://travis-ci.org/tibbon/ga-example-gem.png?branch=master)](https://travis-ci.org/tibbon/ga-example-gem)
@@ -29,6 +31,7 @@ Setup a new instance:
 ```ruby
 client = GaExampleGem.configure do |config|
 	config.api_key = "your_api_key"
+	config.oauth_key = "foo"
 end
 ```
 

data/lib/ga_example_gem.rb

@@ -3,8 +3,12 @@ require 'ga_example_gem/client'
 
 # This is our GaExampleGem namespace
 # for our gem
+
 module GaExampleGem
-	class << self
+  # This is weird. 
+  # These are now class methods.
+  # So you no longer have to call def self.method_missing
+	class << self  
 		# Alias for GaExampleGem::Client.new
 		def new
       @client ||= GaExampleGem::Client.new
@@ -14,6 +18,7 @@ module GaExampleGem
     # This is a weird trick that allows for calling 
     # on methods without calling .new first
     def method_missing(method, *args, &block)
+      # Normally this raises an error
       return super unless new.respond_to?(method)
       new.send(method, *args, &block)
     end
@@ -24,5 +29,12 @@ module GaExampleGem
     def respond_to?(method, include_private=false)
       new.respond_to?(method, include_private) || super(method, include_private)
     end
+
+    # The logic for above
+    # 1) Call a method, GaExampleGem.configure
+    # 2) Run .method_missing, because we don't have that method
+    # 3) Name of method is 'configure'
+    # 4) Does a new instance of the client respond to configure?
+    # 5) If yes, create a new client and run the method 'configure'
   end
 end

data/lib/ga_example_gem/client.rb

@@ -18,7 +18,9 @@ module GaExampleGem
   	# 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}")
+  		# This works too
+  		# JSON.parse self.class.get("http://xkcd-unofficial-api.herokuapp.com/xkcd?num=#{number}")
+  		JSON.parse HTTParty.get("http://xkcd-unofficial-api.herokuapp.com/xkcd?num=#{number}")
   	end
 	end
 end

data/lib/ga_example_gem/configuration.rb

@@ -8,7 +8,8 @@ module GaExampleGem
     # 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 is tricky, this adds these attr_accessors to the CLASS
+		attr_accessor :api_key, :oauth_key
 
     # This yields a block that can be iterated on
     # Its useful for being able to set values to the

data/lib/ga_example_gem/version.rb

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

data/spec/ga_example_gem/client_spec.rb

@@ -10,13 +10,20 @@ describe GaExampleGem::Client do
 
   describe '#get_xkcd' do
   	before do
+      # Intercept an HTTP request that looks like this, 
+      # and return a specific JSON file instead for the body
       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
+      # Make the request
       comic = @client.get_xkcd(1)
+
+      # Expect that you made a request
       expect(a_request(:get, 'http://xkcd-unofficial-api.herokuapp.com/xkcd?num=1')).to have_been_made
+      
+      # Check the results of the JSON file/body of HTTP request that we intercepted
       expect(comic.first["title"]).to eq "Barrel - Part 1"
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,6 @@
+# Do these first
 require 'simplecov'
+# Coveralls only reports when Travis runs the tests
 require 'coveralls'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
@@ -7,11 +9,15 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 ]
 SimpleCov.start
 
+# Require my gem itself
 require 'ga_example_gem'
+
+# Require testing dependencies
 require 'rspec'
 require 'webmock/rspec'
 require 'json'
 
+# This is where you put additional rSpec configuration
 RSpec.configure do |config|
   config.order = 'random'
   config.expect_with :rspec do |c|
@@ -19,10 +25,12 @@ RSpec.configure do |config|
   end
 end
 
+# Helper methods for accessing fixture path
 def fixture_path
   File.expand_path('../fixtures', __FILE__)
 end
 
+# Helper method for accessing a real file in the fixture path
 def fixture(file)
   File.new(fixture_path + '/' + file)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ga_example_gem
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: