octopi 0.4.3 → 0.4.4

data/.gitignore

@@ -0,0 +1,5 @@
+examples/github.yml
+doc/
+pkg/
+contrib/nothingspecial.rb
+**/*.swp

data/Rakefile

@@ -1,60 +1,8 @@
 require 'rubygems'
 require 'rake'
-require 'yaml'
+require 'bundler'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "octopi"
-    gem.summary = %Q{A Ruby interface to GitHub API v2}
-    gem.email = "felipe.coury@gmail.com"
-    gem.homepage = "http://github.com/fcoury/octopi"
-    gem.authors = ["Felipe Coury"]
-    gem.rubyforge_project = "octopi"
-    gem.add_dependency('nokogiri', '>= 1.3.1')
-    gem.add_dependency('httparty', '>= 0.4.5')
-    gem.add_dependency('mechanize', '>= 0.9.3')
-    gem.add_dependency('api_cache', '>= 0')
-    gem.add_development_dependency 'shoulda'
-    gem.add_development_dependency 'fakeweb' 
-    gem.files.exclude 'test/**/*'
-    gem.files.exclude 'test*'
-    gem.files.exclude 'doc/**/*'
-    gem.files.exclude 'examples/**/*'
-    
-
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
-
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/octopi/"
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -64,34 +12,4 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = false
 end
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-
 task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "octopi #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-

data/examples/authenticated.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'octopi')
+
+include Octopi
+
+authenticated :trace => "curl" do |g|
+  repo = g.repository("api-labrat")
+  
+  issue = repo.open_issue :title => "Sample issue", 
+    :body => "This issue was opened using GitHub API and Octopi"
+  puts "Successfully opened issue \##{issue.number}"
+  
+  # # labels = issue.add_label "Working", "Todo"
+  # # puts "Labels: #{labels.inspect}"
+  
+  issue.close
+  puts "Successfully closed issue \##{issue.number}"
+  
+  # labels = issue.remove_label "Todo"
+  # puts "Successfully removed label Todo. Current labels: #{labels.inspect}"
+end

data/examples/github.yml.example

@@ -0,0 +1,14 @@
+#
+# 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

data/examples/issues.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'octopi')
+
+include Octopi
+
+user = User.find("fcoury")
+puts user.name
+
+repo = user.repository("octopi")
+puts repo.description
+
+issue = Issue.find_all(user.login, repo.name).first
+puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"
+
+issue2 = repo.issues.first
+puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"
+
+issue3 = repo.issue(issue2.number)
+puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"

data/examples/overall.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), '..', 'lib', 'octopi')
+
+include Octopi
+
+# user information
+user = User.find("fcoury")
+puts "#{user.name} is being followed by #{user.followers.join(", ")} and following #{user.following.join(", ")}"
+
+# the bang version of followers and following 
+# fetches user object for each user, but is 
+# a lot more expensive
+user.followers!.each do |u|
+  puts "  - #{u.name} (#{u.login}) has #{u.public_repo_count} repo(s)"
+end
+
+# search user
+users = User.find_all("silva")
+puts "#{users.size} users found for 'silva':"
+users.each do |u|
+  puts "  - #{u.name}"
+end
+
+# repository information
+# to get all repos for user: user.repositories
+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(", ")}"
+
+issue = repo.issues.first
+puts "Sample open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"
+
+# commits of a the repository
+commit = repo.commits.first
+puts "Commit: #{commit.id} - #{commit.message} - by #{commit.author['name']}"
+
+# single commit information
+# details is the same as: Commit.find(commit)
+puts "Diff:"
+commit.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
+
+# repository search
+repos = Repository.find_all("ruby", "git")
+puts "#{repos.size} repository(ies) with 'ruby' and 'git':"
+repos.each do |r|
+  puts "  - #{r.name}"
+end
+
+# connect "user", "<< token >>" do |github|
+#   puts github.user.name
+# end

data/lib/octopi/version.rb

@@ -0,0 +1,3 @@
+module Octopi
+  VERSION = "0.4.4"
+end

data/octopi.gemspec

@@ -1,99 +1,26 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "octopi/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{octopi}
-  s.version = "0.4.3"
+  s.name        = "octopi"
+  s.version     = Octopi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Felipe Coury", "Ryan Bigg"]
+  s.email       = ["felipe.coury@gmail.com", "radarlistener@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{A Ruby interface to GitHub API v2}
+  s.description = %q{A Ruby interface to GitHub API v2}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Felipe Coury"]
-  s.date = %q{2011-05-12}
-  s.email = %q{felipe.coury@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.markdown"
-  ]
-  s.files = [
-    ".yardoc",
-    "CHANGELOG.md",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "VERSION.yml",
-    "contrib/backup.rb",
-    "lib/ext/string_ext.rb",
-    "lib/octopi.rb",
-    "lib/octopi/api.rb",
-    "lib/octopi/base.rb",
-    "lib/octopi/blob.rb",
-    "lib/octopi/branch.rb",
-    "lib/octopi/branch_set.rb",
-    "lib/octopi/comment.rb",
-    "lib/octopi/commit.rb",
-    "lib/octopi/error.rb",
-    "lib/octopi/file_object.rb",
-    "lib/octopi/gist.rb",
-    "lib/octopi/issue.rb",
-    "lib/octopi/issue_comment.rb",
-    "lib/octopi/issue_set.rb",
-    "lib/octopi/key.rb",
-    "lib/octopi/key_set.rb",
-    "lib/octopi/plan.rb",
-    "lib/octopi/repository.rb",
-    "lib/octopi/repository_set.rb",
-    "lib/octopi/resource.rb",
-    "lib/octopi/self.rb",
-    "lib/octopi/tag.rb",
-    "lib/octopi/user.rb",
-    "octopi.gemspec"
-  ]
-  s.homepage = %q{http://github.com/fcoury/octopi}
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubyforge_project = %q{octopi}
-  s.rubygems_version = %q{1.6.2}
-  s.summary = %q{A Ruby interface to GitHub API v2}
-
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<octopi>, [">= 0"])
-      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<fakeweb>, [">= 0"])
-      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"])
-      s.add_runtime_dependency(%q<api_cache>, [">= 0"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<fakeweb>, [">= 0"])
-    else
-      s.add_dependency(%q<octopi>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<fakeweb>, [">= 0"])
-      s.add_dependency(%q<nokogiri>, [">= 1.3.1"])
-      s.add_dependency(%q<httparty>, [">= 0.4.5"])
-      s.add_dependency(%q<mechanize>, [">= 0.9.3"])
-      s.add_dependency(%q<api_cache>, [">= 0"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<fakeweb>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<octopi>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<fakeweb>, [">= 0"])
-    s.add_dependency(%q<nokogiri>, [">= 1.3.1"])
-    s.add_dependency(%q<httparty>, [">= 0.4.5"])
-    s.add_dependency(%q<mechanize>, [">= 0.9.3"])
-    s.add_dependency(%q<api_cache>, [">= 0"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<fakeweb>, [">= 0"])
-  end
+  
+  s.add_dependency(%q<nokogiri>, [">= 1.3.1"])
+  s.add_dependency(%q<httparty>, [">= 0.4.5"])
+  s.add_dependency(%q<mechanize>, [">= 0.9.3"])
+  s.add_dependency(%q<api_cache>, [">= 0"])
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<fakeweb>, [">= 0"])
 end
-

data/real_world_test/commit_test.rb

@@ -0,0 +1,20 @@
+# IF TEST FAILS PLEASE SEE TEST_HELPER FOR REASON
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class CommitTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    @user = User.find("radar")
+  end
+
+  
+  context Commit do
+    should "return a commit for a private repository when authed" do
+      authenticated do
+        repository = @user.repository(:name => "select-copiers")
+        assert_not_nil repository.commits
+      end
+    end
+  end
+end

data/real_world_test/repository_test.rb

@@ -0,0 +1,19 @@
+# IF TEST FAILS PLEASE SEE TEST_HELPER FOR REASON
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class RepositoryTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    @user = User.find("radar")
+  end
+
+  
+  context Repository do
+    should "return a private repository when authed" do
+      authenticated do
+        assert_not_nil @user.repository(:name => "select-copiers")
+      end
+    end
+  end
+end

data/real_world_test/test_helper.rb

@@ -0,0 +1,11 @@
+# These are the real world tests using real world data.
+# Whilst the tests are good for ensuring Nothing Goes Wrong,
+# It isn't good to always use fake data because you're fooling yourself.
+# This test data uses my own personal ~/.gitconfig and will probably not work for you.
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'octopi'

data/test/.gitconfig

@@ -0,0 +1,3 @@
+[github]
+  user = fcoury
+  token = 8f700e0d7747826f3e56ee13651414bd

data/test/api_test.rb

@@ -0,0 +1,58 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class AuthenticatedTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+  end
+
+  context "following" do  
+  
+    should "not be able to follow anyone if not authenticated" do
+      exception = assert_raise AuthenticationRequired do
+        Api.me.follow!("rails")
+      end
+    end
+    
+    should "be able to follow a user" do
+      auth do
+        assert_not_nil Api.me.follow!("rails")
+      end
+    end
+  end
+  
+  context "unfollowing" do  
+  
+    should "not be able to follow anyone if not authenticated" do
+      exception = assert_raise AuthenticationRequired do
+        Api.me.unfollow!("rails")
+      end
+    end
+    
+    should "be able to follow a user" do
+      auth do
+        assert_not_nil Api.me.unfollow!("rails")
+      end
+    end
+  end
+  
+  context "keys" do
+    should "not be able to see keys if not authenticated" do
+      exception = assert_raise AuthenticationRequired do
+        Api.me.keys
+      end
+   
+      assert_equal "To view keys, you must be authenticated", exception.message
+    end
+   
+    should "have some keys" do
+      auth do
+        keys = Api.me.keys
+        assert keys.is_a?(KeySet)
+        assert_equal 2, keys.size
+      end
+    end
+  end
+end