octocat_herder 0.0.2 → 0.1.0

data/lib/octocat_herder.rb

@@ -1,13 +1,34 @@
 require 'octocat_herder/connection'
 require 'octocat_herder/user'
 
+# This is just a convenience class to serve as a jumping-off point
+# into the rest of the GitHub API.  You don't have to use this, if you
+# don't want; you can use the other classes directly, constructing
+# your own OctocatHerder::Connection to pass to them.
+#
+# This provides convenience methods for the following:
+# * OctocatHerder::User
 class OctocatHerder
+  # The instance of OctocatHerder::Connection used for making API
+  # requests.
+  #
+  # @since 0.0.1
   attr_reader :connection
 
+  # Get a new OctocatHerder for use with the GitHub v3 API.
+  #
+  # @since 0.0.1
+  # @see OctocatHerder::Connection.new
+  # @param [Hash] options Passed to OctocatHerder::Connection.new
   def initialize(options={})
-    @connection = OctocatHerder::Connection.new options
+    @connection = OctocatHerder::Connection.new(options)
   end
 
+  # Fetch an OctocatHerder::User by using OctocatHerder::User.fetch
+  # and the OctocatHerder::Connection from #connection
+  #
+  # @since 0.0.1
+  # @param [String] user_name The login name of the GitHub user to retrieve.
   def user(user_name)
     OctocatHerder::User.fetch(user_name, connection)
   end

data/octocat_herder.gemspec

@@ -5,23 +5,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{octocat_herder}
-  s.version = "0.0.2"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jacob Helwig"]
-  s.date = %q{2011-07-20}
+  s.date = %q{2011-08-12}
   s.description = %q{This gem provides Ruby bindings to the v3 GitHub API}
   s.email = %q{jacob@technosorcery.net}
   s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
+    "LICENSE",
+    "README.markdown"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
+    "CONTRIBUTING.markdown",
     "Gemfile",
     "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
+    "LICENSE",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "lib/octocat_herder.rb",
@@ -54,7 +56,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.8.0"])
+      s.add_development_dependency(%q<bluecloth>, ["~> 2.1.0"])
     else
       s.add_dependency(%q<httparty>, ["~> 0.7.8"])
       s.add_dependency(%q<link_header>, ["~> 0.0.5"])
@@ -63,7 +67,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
       s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.8.0"])
+      s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
     end
   else
     s.add_dependency(%q<httparty>, ["~> 0.7.8"])
@@ -73,7 +79,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
     s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.8.0"])
+    s.add_dependency(%q<bluecloth>, ["~> 2.1.0"])
   end
 end
 

data/spec/octocat_herder/connection_spec.rb

@@ -52,24 +52,24 @@ describe OctocatHerder::Connection do
   it 'raises an ArgumentError if given an OAuth2 Token and a user name and password' do
     expect do
       OctocatHerder::Connection.new :user_name => 'bob', :password => 'pass', :oauth2_token => 'token'
-    end.to raise_error(ArgumentError, 'Cannot provide both an OAuth2 Token, and a user name and password')
+    end.to raise_error(ArgumentError, 'Cannot provide both an OAuth2 token, and a user name and password')
   end
 
   it 'sets the Authorization header when given an OAuth2 Token' do
     conn = OctocatHerder::Connection.new :oauth2_token => 'my_token'
 
-    conn.httparty_options.should == { :headers => { 'Authorization' => 'token my_token' } }
+    conn.send(:httparty_options).should == { :headers => { 'Authorization' => 'token my_token' } }
   end
 
   it 'uses basic auth when given a user name and password' do
     conn = OctocatHerder::Connection.new :user_name => 'user', :password => 'pass'
 
-    conn.httparty_options.should == { :basic_auth => { :username => 'user', :password => 'pass' } }
+    conn.send(:httparty_options).should == { :basic_auth => { :username => 'user', :password => 'pass' } }
   end
 
   it 'should not set any additional options when making unauthenticated requests' do
     conn = OctocatHerder::Connection.new
 
-    conn.httparty_options.should == {}
+    conn.send(:httparty_options).should == {}
   end
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 2
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jacob Helwig
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-20 00:00:00 -07:00
+date: 2011-08-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -130,20 +130,52 @@ dependencies:
   type: :development
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  name: rdoc
+  name: yard
   version_requirements: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 7
         segments: 
-        - 2
-        - 4
-        - 2
-        version: 2.4.2
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
   requirement: *id008
   type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rdoc
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 39
+        segments: 
+        - 3
+        - 8
+        - 0
+        version: 3.8.0
+  requirement: *id009
+  type: :development
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bluecloth
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  requirement: *id010
+  type: :development
 description: This gem provides Ruby bindings to the v3 GitHub API
 email: jacob@technosorcery.net
 executables: []
@@ -151,14 +183,16 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
+- LICENSE
+- README.markdown
 files: 
 - .document
+- .travis.yml
+- CONTRIBUTING.markdown
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
-- README.rdoc
+- LICENSE
+- README.markdown
 - Rakefile
 - VERSION
 - lib/octocat_herder.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= octocat_herder
-
-Description goes here.
-
-== Contributing to octocat-herder
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Jacob Helwig. See LICENSE.txt for
-further details.
-