devver-octopi 0.2.13 → 0.2.14

data/README.markdown

@@ -0,0 +1,144 @@
+# octopi
+
+Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com).
+
+To install it as a Gem, just run:
+
+    $ sudo gem install octopi
+
+Get notifications via Twitter, following @octopi_gem:
+http://twitter.com/octopi_gem
+  
+## Authenticated Usage
+
+### Seamless authentication using .gitconfig defaults
+
+If you have your <tt>~/.gitconfig</tt> file in place, and you have a [github] section (if you don't, take a look at this [GitHub Guides entry][http://github.com/guides/tell-git-your-user-name-and-email-address], you can use seamless authentication using this method:
+
+    authenticated do 
+      repo = Repository.find(:name => "api-labrat", :user => "fcoury")
+    end
+  
+### Explicit authentication
+
+Sometimes, you may not want to get authentication data from _~/.gitconfig_. You want to use GitHub API authenticated as a third party. For this use case, you have a couple of options too.
+
+**1. Providing login and token inline:**
+
+    authenticated_with :login => "mylogin", :token => "mytoken" do 
+      repo = Repository.find(:name => "api-labrat", :user => "fcoury")
+      issue = repo.open_issue :title => "Sample issue", 
+        :body => "This issue was opened using GitHub API and Octopi"
+      puts issue.number
+    end
+
+**2. Providing login and password inline:**
+
+    authenticated_with :login => "mylogin", :password => "password" do 
+      repo = Repository.find(:name => "api-labrat", :user => "fcoury")
+      issue = repo.open_issue :title => "Sample issue", 
+        :body => "This issue was opened using GitHub API and Octopi"
+      puts issue.number
+    end
+
+**3. Providing a YAML file with authentication information:**
+
+Use the following format:
+
+    #
+    # Octopi GitHub API configuration file
+    #
+
+    # GitHub user login and token
+    login: github-username
+    token: github-token
+
+    # Trace level
+    # Possible values:
+    #   false - no tracing, same as if the param is ommited
+    #   true  - will output each POST or GET operation to the stdout
+    #   curl  - same as true, but in addition will output the curl equivalent of each command (for debugging)
+    trace: curl
+  
+  And change the way you connect to:
+
+    authenticated_with :config => "github.yml" do
+      (...)
+    end
+  
+## Anonymous Usage
+
+This reflects the usage of the API to retrieve information on a read-only fashion, where the user doesn't have to be authenticated.
+
+### Users API
+
+Getting user information
+
+    user = User.find("fcoury")
+    puts "#{user.name} is being followed by #{user.followers.join(", ")} and following #{user.following.join(", ")}"
+
+The bang methods `followers!` and `following!` retrieves a full User object for each user login returned, so it has to be used carefully.
+
+    user.followers!.each do |u|
+      puts "  - #{u.name} (#{u.login}) has #{u.public_repo_count} repo(s)"
+    end
+  
+Searching for user
+
+    users = User.find_all("silva")
+    puts "#{users.size} users found for 'silva':"
+    users.each do |u|
+      puts "  - #{u.name}"
+    end
+
+### Repositories API
+
+    repo = user.repository("octopi") # same as: Repository.find("fcoury", "octopi")
+    puts "Repository: #{repo.name} - #{repo.description} (by #{repo.owner}) - #{repo.url}"
+    puts "      Tags: #{repo.tags and repo.tags.map {|t| t.name}.join(", ")}"
+  
+Search:
+
+    repos = Repository.find_all("ruby", "git")
+    puts "#{repos.size} repository(ies) with 'ruby' and 'git':"
+    repos.each do |r|
+      puts "  - #{r.name}"
+    end
+  
+Issues API integrated into the Repository object:
+
+    issue = repo.issues.first
+    puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"
+
+Single issue information:
+
+    issue = repo.issue(11)
+
+Commits API information from a Repository object:
+
+    first_commit = repo.commits.first
+    puts "First commit: #{first_commit.id} - #{first_commit.message} - by #{first_commit.author['name']}"
+  
+Single commit information:
+
+    puts "Diff:"
+    first_commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
+
+## Author
+
+* Felipe Coury - http://felipecoury.com
+* HasMany.info blog - http://hasmany.info
+
+## Contributors
+
+In alphabetical order:
+
+* Ryan Bigg - http://ryanbigg.net
+* Brandon Calloway - http://github.com/bcalloway
+* runpaint - http://github.com/runpaint
+
+Thanks guys!
+
+## Copyright
+
+Copyright (c) 2009 Felipe Coury. See LICENSE for details.

data/VERSION.yml

@@ -2,3 +2,5 @@
 :patch: 13
 :major: 0
 :minor: 2
+:patch: 8
+

data/lib/octopi.rb

@@ -71,7 +71,7 @@ module Octopi
   private
   
   def grab_token(username, password)
-    a = WWW::Mechanize.new { |agent|
+    a = Mechanize.new { |agent|
       # Fake out the agent
       agent.user_agent_alias = 'Mac Safari'
     }

data/lib/octopi/base.rb

@@ -26,8 +26,8 @@ module Octopi
       # puts caller.first.inspect
       # puts "#{self.class.inspect} #{attributes.keys.map { |s| s.to_sym }.inspect}"
       attributes.each do |key, value|
-        raise "no attr_accessor set for #{key} on #{self.class}" if !respond_to?("#{key}=")
-        self.send("#{key}=", value)
+        method = "#{key}="
+        self.send(method, value) if respond_to? method
       end
     end
     

data/lib/octopi/repository.rb

@@ -109,7 +109,7 @@ module Octopi
     end
 
     def collaborators
-      property('collaborators', [self.owner, self.name].join('/')).values.map { |v| User.find(v) }
+      property('collaborators', [self.owner, self.name].join('/')).values.map { |v| User.find(v.join) }
     end  
     
     def self.create(options={})

data/lib/octopi/user.rb

@@ -1,9 +1,17 @@
 module Octopi
   class User < Base
     include Resource
-    attr_accessor :company, :name, :following_count, :blog, :public_repo_count, :public_gist_count, :id, :login, :followers_count, :created_at, :email, :location, :disk_usage, :private_repo_count, :private_gist_count, :collaborators, :plan, :owned_private_repo_count, :total_private_repo_count, :gravatar_id,
-    # These come from search results, which doesn't contain the above information.
-    :actions, :score, :language, :followers, :following, :fullname, :type, :username, :repos, :pushed, :created
+    attr_accessor :company, :name, :following_count, :gravatar_id,
+                  :blog, :public_repo_count, :public_gist_count, 
+                  :id, :login, :followers_count, :created_at, 
+                  :email, :location, :disk_usage, :private_repo_count, 
+                  :private_gist_count, :collaborators, :plan, 
+                  :owned_private_repo_count, :total_private_repo_count, 
+                  
+                  # These come from search results, which doesn't 
+                  # contain the above information.
+                  :actions, :score, :language, :followers, :following,
+                  :fullname, :type, :username, :repos, :pushed, :created
     
     def plan=(attributes={})
       @plan = Plan.new(attributes)

data/test/base_test.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class BaseTest < Test::Unit::TestCase
+  class SparseUser < Octopi::Base
+    include Octopi::Resource
+    
+    attr_accessor :some_attribute
+    
+    find_path "/user/search/:query"
+    resource_path "/user/show/:id"
+  end
+  
+  def setup
+    fake_everything
+  end
+  
+  should "not raise an error if it doesn't know about the attributes that GitHub API provides" do
+    assert_nothing_raised { SparseUser.find("radar") }
+  end
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: devver-octopi
 version: !ruby/object:Gem::Version 
-  version: 0.2.13
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 14
+  version: 0.2.14
 platform: ruby
 authors: 
 - Felipe Coury
@@ -9,49 +14,63 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 -07:00
+date: 2010-04-05 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 1
         version: 1.3.1
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: httparty
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 5
         version: 0.4.5
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: mechanize
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 3
         version: 0.9.3
-    version: 
+  type: :runtime
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: api_cache
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
 description: |
   This is a gem of the Devver fork of Octopi (a Github API library), which can be
   found at http://github.com/fcoury/octopi.  This gem exists solely to enable us
@@ -65,17 +84,16 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.markdown
 files: 
 - .gitignore
 - .yardoc
 - CHANGELOG.md
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION.yml
 - contrib/backup.rb
-- lib/ext/hash_ext.rb
 - lib/ext/string_ext.rb
 - lib/octopi.rb
 - lib/octopi/api.rb
@@ -100,6 +118,7 @@ files:
 - lib/octopi/self.rb
 - lib/octopi/tag.rb
 - lib/octopi/user.rb
+- octopi.gemspec
 has_rdoc: true
 homepage: http://github.com/devver/octopi
 licenses: []
@@ -113,24 +132,27 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: octopi
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to GitHub API v2 (Devver Fork)
 test_files: 
 - test/api_test.rb
 - test/authenticated_test.rb
+- test/base_test.rb
 - test/blob_test.rb
 - test/branch_test.rb
 - test/commit_test.rb

data/README.rdoc

@@ -1,144 +0,0 @@
-= octopi
-
-Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com).
-
-To install it as a Gem, just run:
-
-  $ sudo gem install octopi
-
-Get notifications via Twitter, following @octopi_gem:
-http://twitter.com/octopi_gem
-  
-== Authenticated Usage
-
-=== Seamless authentication using .gitconfig defaults
-
-If you have your <tt>~/.gitconfig</tt> file in place, and you have a [github] section (if you don't, take a look at this GitHub Guides entry: http://github.com/guides/tell-git-your-user-name-and-email-address), you can use seamless authentication using this method:
-
-  authenticated do 
-    repo = Repository.find(:name => "api-labrat", :user => "fcoury")
-  end
-  
-=== Explicit authentication
-
-Sometimes, you may not want to get authentication data from <tt>~/.gitconfig</tt>. You want to use GitHub API authenticated as a third party. For this use case, you have a couple of options too.
-
-<b>1. Providing login and token inline:</b>
-
-  authenticated_with "mylogin", "mytoken" do 
-    repo = Repository.find(:name => "api-labrat", :user => "fcoury")
-    issue = repo.open_issue :title => "Sample issue", 
-      :body => "This issue was opened using GitHub API and Octopi"
-    puts issue.number
-  end
-
-<b>2. Providing login and password inline:</b>
-
-  authenticated_with "mylogin", "password" do 
-    repo = Repository.find(:name => "api-labrat", :user => "fcoury")
-    issue = repo.open_issue :title => "Sample issue", 
-      :body => "This issue was opened using GitHub API and Octopi"
-    puts issue.number
-  end
-
-<b>3. Providing a YAML file with authentication information:</b>
-
-Use the following format:
-
-  #
-  # Octopi GitHub API configuration file
-  #
-
-  # GitHub user login and token
-  login: github-username
-  token: github-token
-
-  # Trace level
-  # Possible values:
-  #   false - no tracing, same as if the param is ommited
-  #   true  - will output each POST or GET operation to the stdout
-  #   curl  - same as true, but in addition will output the curl equivalent of each command (for debugging)
-  trace: curl
-  
-And change the way you connect to:
-
-  authenticated_with :config => "github.yml" do |g|
-    (...)
-  end
-  
-== Anonymous Usage
-
-This reflects the usage of the API to retrieve information on a read-only fashion, where the user doesn't have to be authenticated.
-
-=== Users API
-
-Getting user information
-
-  user = User.find("fcoury")
-  puts "#{user.name} is being followed by #{user.followers.join(", ")} and following #{user.following.join(", ")}"
-
-The bang methods `followers!` and `following!` retrieves a full User object for each user login returned, so it has to be used carefully.
-
-  user.followers!.each do |u|
-    puts "  - #{u.name} (#{u.login}) has #{u.public_repo_count} repo(s)"
-  end
-  
-Searching for user
-
-  users = User.find_all("silva")
-  puts "#{users.size} users found for 'silva':"
-  users.each do |u|
-    puts "  - #{u.name}"
-  end
-
-=== Repositories API
-
-  repo = user.repository("octopi") # same as: Repository.find("fcoury", "octopi")
-  puts "Repository: #{repo.name} - #{repo.description} (by #{repo.owner}) - #{repo.url}"
-  puts "      Tags: #{repo.tags and repo.tags.map {|t| t.name}.join(", ")}"
-  
-Search:
-
-  repos = Repository.find_all("ruby", "git")
-  puts "#{repos.size} repository(ies) with 'ruby' and 'git':"
-  repos.each do |r|
-    puts "  - #{r.name}"
-  end
-  
-Issues API integrated into the Repository object:
-
-  issue = repo.issues.first
-  puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"
-
-Single issue information:
-
-  issue = repo.issue(11)
-
-Commits API information from a Repository object:
-
-  first_commit = repo.commits.first
-  puts "First commit: #{first_commit.id} - #{first_commit.message} - by #{first_commit.author['name']}"
-  
-Single commit information:
-
-  puts "Diff:"
-  first_commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
-
-== Author
-
-* Felipe Coury - http://felipecoury.com
-* HasMany.info blog - http://hasmany.info
-
-== Contributors
-
-In alphabetical order:
-
-* Ryan Bigg - http://frozenplague.net
-* Brandon Calloway - http://github.com/bcalloway
-* runpaint - http://github.com/runpaint
-
-Thanks guys!
-
-== Copyright
-
-Copyright (c) 2009 Felipe Coury. See LICENSE for details.

data/lib/ext/hash_ext.rb

@@ -1,5 +0,0 @@
-class Hash
-  def method_missing(method, *args)
-    self[method] || self[method.to_s]
-  end
-end