octopi 0.2.8 → 0.3.0

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/Rakefile

@@ -57,6 +57,7 @@ end
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
+  test.libs << File.dirname(__FILE__)
   test.pattern = 'test/**/*_test.rb'
   test.verbose = false
 end

data/VERSION.yml

@@ -1,4 +1,5 @@
 --- 
+:patch: 0
+:build: 
 :major: 0
-:minor: 2
-:patch: 8
+:minor: 3

data/lib/octopi.rb

@@ -42,8 +42,6 @@ module Octopi
   def authenticated_with(options, &block)
     begin
 
-      Api.api.trace_level = options[:trace] if options[:trace]
-      
       if options[:token].nil? && !options[:password].nil?
         options[:token] = grab_token(options[:login], options[:password])
       end
@@ -53,13 +51,14 @@ module Octopi
       rescue Octopi::NotFound
         raise Octopi::InvalidLogin
       end
-    
-      trace("=> Trace on: #{options[:trace]}")
-    
+
       Api.api = AuthApi.instance
+      Api.api.trace_level = options[:trace] if options[:trace]
       Api.api.login = options[:login]
       Api.api.token = options[:token]
-    
+
+      trace("=> Trace on: #{options[:trace]}")
+
       yield
     ensure
       # Reset authenticated so if we were to do an anonymous call it would Just Work(tm)
@@ -71,7 +70,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'
     }
@@ -130,7 +129,7 @@ module Octopi
   
   def trace(text)
     if Api.api.trace_level
-      puts "text"
+      puts text
     end
   end
 end

data/lib/octopi/api.rb

@@ -195,7 +195,8 @@ module Octopi
       
       # It happens, in tests.
       return resp if resp.headers.empty?
-      ctype = resp.headers['content-type'].first.split(";").first
+      content_type = Array === resp.headers['content-type'] ? resp.headers['content-type'] : [resp.headers['content-type']]
+      ctype = content_type.first.split(";").first
       raise FormatError, [ctype, format] unless CONTENT_TYPE[format.to_s].include?(ctype)
       if format == 'yaml' && resp['error']
         raise APIError, resp['error']

data/lib/octopi/repository.rb

@@ -111,11 +111,15 @@ module Octopi
     def collaborators
       property('collaborators', [self.owner, self.name].join('/')).values.map { |v| User.find(v.join) }
     end  
+
+    def languages
+      property('languages', [self.owner, self.name].join('/')).values.inject({}){|sum,map| map.each{|k,v| sum[k] = v}}
+    end  
     
     def self.create(options={})
       raise AuthenticationRequired, "To create a repository you must be authenticated." if Api.api.read_only?
       self.validate_args(options[:name] => :repo)
-      new(Api.api.post(path_for(:create), options)["repository"])
+      new(Api.api.post(path_for(:create), options.merge( :cache => false ))["repository"])
     end
     
     def delete!

data/octopi.gemspec

@@ -1,26 +1,26 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{octopi}
-  s.version = "0.2.8"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Felipe Coury"]
-  s.date = %q{2010-01-18}
+  s.date = %q{2010-09-22}
   s.email = %q{felipe.coury@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.markdown"
   ]
   s.files = [
     ".gitignore",
      ".yardoc",
      "CHANGELOG.md",
      "LICENSE",
-     "README.rdoc",
+     "README.markdown",
      "Rakefile",
      "VERSION.yml",
      "contrib/backup.rb",
@@ -54,7 +54,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{octopi}
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby interface to GitHub API v2}
   s.test_files = [
     "test/api_test.rb",
@@ -85,7 +85,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<nokogiri>, [">= 1.3.1"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.4.5"])
       s.add_runtime_dependency(%q<mechanize>, [">= 0.9.3"])
@@ -103,3 +103,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<api_cache>, [">= 0"])
   end
 end
+

data/test/issue_test.rb

@@ -90,7 +90,7 @@ class IssueTest < Test::Unit::TestCase
         assert @issue.labels.empty?
         @issue.add_label("one-point-oh", "maybe-two-point-oh")
         assert !@issue.labels.empty?
-        assert 2, @issue.labels.size
+        assert_equal 2, @issue.labels.size
       end
     
       should "removing a label" do

data/test/repository_test.rb

@@ -100,6 +100,12 @@ class RepositoryTest < Test::Unit::TestCase
       assert_equal 1, @collaborators.size
       assert @collaborators.first.is_a?(User)
     end
+
+    should "be able to find all languages" do
+      @languages = @repository.languages
+      assert_equal 2, @languages.size
+      assert_equal 111555, @languages["Ruby"]
+    end
     
     should "be able to create a repository" do
       auth do 

data/test/tag_test.rb

@@ -12,7 +12,7 @@ class TagTest < Test::Unit::TestCase
     should "be able to find all tags" do
       tags = Tag.all(:user => "fcoury", :repository => "octopi")
       assert_not_nil tags
-      assert 12, tags.size
+      assert_equal 9, tags.size
       assert tags.first.is_a?(Tag)
     end
   end

data/test/test_helper.rb

@@ -71,6 +71,7 @@ def fake_everything
         "issues/show/fcoury/octopi/28" => issues("28"),
         
         "repos/show/fcoury/octopi/collaborators" => File.join("repos", "fcoury", "octopi", "collaborators"), 
+        "repos/show/fcoury/octopi/languages" => File.join("repos", "fcoury", "octopi", "languages"), 
         "repos/show/fcoury" => File.join("repos", "show", "fcoury"),
         "repos/search/ruby+testing" => File.join("repos", "search"),
         "repos/show/fcoury/octopi" => repos("master"),

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: octopi
 version: !ruby/object:Gem::Version 
-  version: 0.2.8
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Felipe Coury
@@ -9,49 +15,71 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-18 00:00:00 +10:00
+date: 2010-09-22 00:00:00 -04: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 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 25
+        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 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 5
+        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 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 61
+        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 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id004
 description: 
 email: felipe.coury@gmail.com
 executables: []
@@ -60,13 +88,13 @@ 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
@@ -95,6 +123,28 @@ files:
 - lib/octopi/tag.rb
 - lib/octopi/user.rb
 - octopi.gemspec
+- test/api_test.rb
+- test/authenticated_test.rb
+- test/base_test.rb
+- test/blob_test.rb
+- test/branch_test.rb
+- test/commit_test.rb
+- test/file_object_test.rb
+- test/gist_test.rb
+- test/issue_comment.rb
+- test/issue_set_test.rb
+- test/issue_test.rb
+- test/key_set_test.rb
+- test/key_test.rb
+- test/repository_set_test.rb
+- test/repository_test.rb
+- test/stubs/commits/fcoury/octopi/octopi.rb
+- test/tag_test.rb
+- test/test_helper.rb
+- test/user_test.rb
+- examples/authenticated.rb
+- examples/issues.rb
+- examples/overall.rb
 has_rdoc: true
 homepage: http://github.com/fcoury/octopi
 licenses: []
@@ -105,21 +155,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: octopi
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to GitHub API v2

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.