dcuddeback-octopi 0.2.8

data/lib/octopi.rb

@@ -0,0 +1,135 @@
+require 'rubygems'
+
+require 'httparty'
+require 'mechanize'
+require 'nokogiri'
+require 'api_cache'
+
+require 'yaml'
+require 'pp'
+
+# Core extension stuff
+Dir[File.join(File.dirname(__FILE__), "ext/*.rb")].each { |f| require f }
+
+# Octopi stuff
+# By sorting them we ensure that api and base are loaded first on all sane operating systems
+Dir[File.join(File.dirname(__FILE__), "octopi/*.rb")].sort.each { |f| require f }
+
+# Include this into your app so you can access the child classes easier.
+# This is the root of all things Octopi.
+module Octopi
+  
+  # The authenticated methods are all very similar.
+  # TODO: Find a way to merge them into something... better.
+  
+  def authenticated(options={}, &block)
+    begin
+      config = config = File.open(options[:config]) { |yf| YAML::load(yf) } if options[:config]
+      config = read_gitconfig
+      options[:login] = config["github"]["user"]
+      options[:token] = config["github"]["token"]
+      
+      authenticated_with(options) do
+        yield 
+      end
+    ensure
+      # Reset authenticated so if we were to do an anonymous call it would Just Work(tm)
+      Api.authenticated = false
+      Api.api = AnonymousApi.instance
+    end
+  end
+  
+  def authenticated_with(options, &block)
+    begin
+
+      if options[:token].nil? && !options[:password].nil?
+        options[:token] = grab_token(options[:login], options[:password])
+      end
+      begin
+        User.find(options[:login])
+        # If the user cannot see themselves then they are not logged in, tell them so
+      rescue Octopi::NotFound
+        raise Octopi::InvalidLogin
+      end
+
+      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)
+      Api.authenticated = false
+      Api.api = AnonymousApi.instance
+    end
+  end
+    
+  private
+  
+  def grab_token(username, password)
+    a = Mechanize.new { |agent|
+      # Fake out the agent
+      agent.user_agent_alias = 'Mac Safari'
+    }
+    
+    # Login with the provided 
+    a.get('http://github.com/login') do |page|
+      user_page = page.form_with(:action => '/session') do |login|
+        login.login = username
+        login.password = password
+      end.submit
+
+
+      if Api.api.trace_level
+        File.open("got.html", "w+") do |f|
+          f.write user_page.body
+        end   
+        `open got.html`
+      end
+      
+      body = Nokogiri::HTML(user_page.body)
+      error = body.xpath("//div[@class='error_box']").text
+      raise error if error != ""
+      
+      # Should be clear to go if there is no errors.
+      link = user_page.link_with(:text => "account")
+      @account_page = a.click(link)
+      if Api.api.trace_level
+        File.open("account.html", "w+") do |f|
+          f.write @account_page.body
+        end
+        `open account.html`
+      end
+      
+      return Nokogiri::HTML(@account_page.body).xpath("//p").xpath("strong")[1].text
+    end
+  end
+  
+  
+  def read_gitconfig
+    config = {}
+    group = nil
+    File.foreach("#{ENV['HOME']}/.gitconfig") do |line|
+      line.strip!
+      if line[0] != ?# && line =~ /\S/
+        if line =~ /^\[(.*)\]$/
+          group = $1
+          config[group] ||= {}
+        else
+          key, value = line.split("=").map { |v| v.strip }
+          config[group][key] = value
+        end
+      end
+    end
+    config
+  end
+  
+  def trace(text)
+    if Api.api.trace_level
+      puts text
+    end
+  end
+end

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

data/test/authenticated_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class AuthenticatedTest < Test::Unit::TestCase
+  include Octopi
+  def setup
+    fake_everything
+  end
+  
+  context "Authenticating" do
+    should "be possible with username and password" do
+      authenticated_with(:login => "fcoury", :password => "yruocf") do
+        assert_equal "8f700e0d7747826f3e56ee13651414bd", Api.api.token
+        assert_not_nil User.find("fcoury")
+      end
+    end
+        
+     should "be possible with username and token" do
+       auth do
+         assert_not_nil User.find("fcoury")
+       end
+     end
+     
+     should "be possible using the .gitconfig" do
+       authenticated do
+         assert_not_nil User.find("fcoury")
+       end
+     end
+     # 
+     # should "be denied access when specifying an invalid token and login combination" do
+     #   FakeWeb.clean_registry
+     #   FakeWeb.register_uri(:get, "http://github.com/api/v2/yaml/user/show/fcoury", :status => ["404", "Not Found"])
+     #   assert_raise InvalidLogin do
+     #     authenticated_with :login => "fcoury", :token => "ba7bf2d7f0ebc073d3874dda887b18ae" do
+     #       # Just blank will do us fine.
+     #     end
+     #   end 
+     # end
+  end
+end

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

data/test/blob_test.rb

@@ -0,0 +1,23 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class BlobTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+  end
+
+  context Blob do
+    should "find a blob" do
+      blob = Blob.find(:user => "fcoury", :repo => "octopi", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+      assert_not_nil blob
+      assert blob.is_a?(String)
+    end
+
+    # Can't grab real data for this yet, Github is throwing a 500 on this request.
+    # should "find a file for a blob" do
+    #  assert_not_nil Blob.find(:user => "fcoury", :repo => "octopi", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae", :path => "lib/octopi.rb")
+    # end
+  end
+end
+

data/test/branch_test.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class BranchTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+  end
+
+  context Branch do
+    should "Find all branches for a repository" do
+      assert_not_nil Branch.all(:user => "fcoury", :name => "octopi")
+    end
+    
+    should "Be able to find a specific branch" do
+      assert_not_nil Branch.all(:user => "fcoury", :name => "octopi").find("lazy")
+    end
+  end
+end
+

data/test/commit_test.rb

@@ -0,0 +1,82 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class CommitTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+    @repo = @user.repository(:name => "octopi")
+  end
+
+  context Commit do
+    context "finding all commits" do
+      should "by strings" do
+        commits = Commit.find_all(:user => "fcoury", :repository => "octopi")
+        assert_not_nil commits
+        assert_equal 30, commits.size
+        assert_not_nil commits.first.repository
+      end
+      
+      should "by objects" do
+        commits = Commit.find_all(:user => @user, :repository => @repo)
+        assert_not_nil commits
+        assert_equal 30, commits.size
+      end
+      
+      should "be able to specify a branch" do
+        commits = Commit.find_all(:user => "fcoury", :repository => "octopi", :branch => "lazy")
+        assert_not_nil commits
+        assert_equal 30, commits.size
+      end
+      
+      # Tests issue #28
+      should "be able to find commits in a private repository" do
+        auth do
+          commits = Commit.find_all(:user => "fcoury", :repository => "rboard")
+        end
+        assert_not_nil commits
+        assert_equal 22, commits.size
+      end
+      
+      should "be able to find commits for a particular file" do
+        commits = Commit.find_all(:user => "fcoury", :repository => "octopi", :path => "lib/octopi.rb")
+        assert_not_nil commits
+        assert_equal 44, commits.size
+      end
+    end
+    
+    context "finding a single commit" do
+      should "by strings" do
+        commit = Commit.find(:name => "octopi", :user => "fcoury", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+        assert_not_nil commit
+      end
+      
+      should "by objects" do
+        commit = Commit.find(:name => "octopi", :user => "fcoury", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+        assert_not_nil commit
+      end
+      
+      should "be able to specify a branch" do
+        commit = Commit.find(:name => "octopi", :user => "fcoury", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae", :branch => "lazy")
+        assert_not_nil commit
+      end
+    
+      should "raise an error if not found" do
+        exception = assert_raise Octopi::NotFound do
+          Commit.find(:name => "octopi", :user => "fcoury", :sha => "nothere")
+        end
+        
+        assert_equal "The Commit you were looking for could not be found, or is private.", exception.message
+      end
+    end
+    
+    context "identifying a repository" do
+      should "be possible" do
+        commit = Commit.find(:name => "octopi", :user => "fcoury", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+        assert_equal "fcoury/octopi/f6609209c3ac0badd004512d318bfaa508ea10ae", commit.repo_identifier
+      end
+    end
+  end
+end
+

data/test/file_object_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class FileObjectTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+    @repo = @user.repositories.find("octopi")
+  end
+  
+  context "finding" do
+    context "with strings" do
+      should "work" do
+        FileObject.find(:user => "fcoury", :repository => "octopi", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+      end
+    end
+    
+    context "with objects" do
+      should "work" do
+        FileObject.find(:user => @user, :repository => @repo, :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+      end
+    end
+    
+    context "invalid sha" do
+      should "not work" do
+        # sha below is "ryan"
+        exception = assert_raise NotFound do
+          FileObject.find(:user => @user, :repository => @repo, :sha => "ea3cd978650417470535f3a4725b6b5042a6ab59")
+        end
+        
+        assert_equal "The FileObject you were looking for could not be found, or is private.", exception.message
+        
+      end
+    end
+  end
+  
+end
+

data/test/gist_test.rb

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class GistTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+  end
+
+  context Gist do
+    should "Find a single gist" do
+      assert_not_nil Gist.find(159579)
+    end
+  end
+end
+

data/test/issue_comment.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class IssueTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+    @repo = @user.repository("octopi")
+  end
+  
+  context IssueComment do
+    should "be valid" do
+      comment = IssueComment.new({ :comment => "This is a comment", :status => "saved"})
+      assert_not_nil comment.comment
+      assert_not_nil comment.status
+    end
+  end
+end

data/test/issue_set_test.rb

@@ -0,0 +1,33 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class IssueSetTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+    @repo = @user.repository("octopi")
+  end
+
+  
+  context IssueSet do
+    should "be able to find a specific issue" do
+      assert_not_nil @repo.issues.find(28)
+    end
+    
+    should "not be able to find an issue that doesn't exist" do
+      exception = assert_raise Octopi::NotFound do
+        @repo.issues.find("not-a-number")
+      end
+      
+      assert_equal "The Issue you were looking for could not be found, or is private.", exception.message
+    end
+    
+    should "be able to look for an issue" do
+      results = @repo.issues.search(:keyword => "test")
+      assert_not_nil results
+      assert_equal 1, results.size
+    end
+    
+  end
+end

data/test/issue_test.rb

@@ -0,0 +1,120 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class IssueTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+    @repo = @user.repository("octopi")
+    @issue = Issue.find(:user => @user, :repo => @repo, :number => 28)
+    @closed = Issue.find(:user => @user, :repo => @repo, :number => 27)
+  end
+
+  
+  context Issue do
+    context "finding all the issues" do
+      should "using objects" do
+        issues = Issue.find_all(:user => @user, :repo => @repo)
+        assert_not_nil issues
+        assert_equal 21, issues.size
+      end
+      
+      should "using strings" do
+        issues = Issue.find_all(:user => "fcoury", :repo => "octopi")
+        assert_not_nil issues
+        assert_equal 21, issues.size
+      end
+      
+      should "specifying a state" do
+        issues = Issue.find_all(:user => @user, :repo => @repo, :state => "closed")
+        assert_not_nil issues
+        assert_equal 9, issues.size
+      end
+    end
+    
+    context "finding a single issue" do
+      should "work" do
+        issue = Issue.find(:user => @user, :repo => @repo, :number => 28)
+        assert_not_nil issue
+        assert_not_nil issue.body
+      end
+      
+      should "not work, if issue doesn't exist" do
+        exception = assert_raise NotFound do
+          Issue.find(:user => @user, :repo => @repo, :number => "not-a-number")
+        end
+        
+        assert_equal "The Issue you were looking for could not be found, or is private.", exception.message
+      end
+      
+      should "be able to look for an issue" do
+        results = Issue.search(:user => @user, :repo => @repo, :keyword => "test")
+        assert_not_nil results
+        assert_equal 1, results.size
+      end
+    end
+    
+    context "actions" do
+      should "opening an issue" do
+        issue = Issue.open(:user => @user, :repo => @repo, :params => { :title => "something's broken", :body => "something broke" })
+        assert_not_nil issue
+        assert_equal "open", issue.state
+      end
+    
+      should "re-opening an issue" do
+        assert_equal "closed", @closed.state
+        @closed.reopen!
+        assert_equal "open", @closed.state
+      end
+    
+      should "closing an issue" do
+        assert_equal "open", @issue.state
+        @issue.close!
+        assert_equal "closed", @issue.state
+      end
+    
+      should "editing an issue" do
+        @issue.title = 'Testing'
+        @issue.save
+        assert_equal "Testing", @issue.title
+      end
+    
+      should "adding a label" do
+        assert @issue.labels.empty?
+        @issue.add_label("one-point-oh")
+        assert !@issue.labels.empty?
+      end
+    
+      should "adding multiple labels" do
+        assert @issue.labels.empty?
+        @issue.add_label("one-point-oh", "maybe-two-point-oh")
+        assert !@issue.labels.empty?
+        assert 2, @issue.labels.size
+      end
+    
+      should "removing a label" do
+        assert @issue.labels.empty?
+        @issue.add_label("one-point-oh")
+        assert !@issue.labels.empty?
+        @issue.remove_label("one-point-oh")
+        assert @issue.labels.empty?
+      end
+    
+      should "removing multiple labels" do
+        assert @issue.labels.empty?
+        @issue.add_label("one-point-oh", "maybe-two-point-oh")
+        assert !@issue.labels.empty?
+        assert_equal 2, @issue.labels.size
+        @issue.remove_label("one-point-oh", "maybe-two-point-oh")
+        assert_equal 0, @issue.labels.size
+      
+      end
+    
+      should "be able to comment" do
+        comment = @issue.comment("Yes, it is broken.")
+        assert comment.is_a?(IssueComment)
+      end
+    end
+  end
+end

data/test/key_set_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class KeySetTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+  end
+
+  
+  context KeySet do
+    should "be able to find a key" do
+      auth do
+        assert_not_nil Api.me.keys.find("macbook")
+      end
+    end
+    
+    should "not be able to find a key without a valid title" do
+      exception = assert_raise NotFound do
+        auth do
+          assert_not_nil Api.me.keys.find("windows-box")
+        end
+      end
+      
+      assert_equal "The Key you were looking for could not be found, or is private.", exception.message
+    end
+  end
+end

data/test/key_test.rb

@@ -0,0 +1,35 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class KeyTest < Test::Unit::TestCase
+  include Octopi
+  
+  def setup
+    fake_everything
+    @user = User.find("fcoury")
+    auth do
+      @key = Api.me.keys.first
+    end
+  end
+  
+  context Key do
+    
+    should "be able to add a key" do
+      auth do
+        Key.add(:title => "other-computer", :key => "AAAAB3NzaC1yc2EAAAABIwAAAQEA0dyfPrSHHSVD0u3JQlJfLyUrEVeNDW+9imbMHwiuT/IStf8SOroRjWT+/S5cL9m6qmKQBIU4v3LUnMKLTHfiWlqICnTDVRHuSayrHGp193I9kTSGBdM7wFZ2E8hDv5OqXHvAKGmOJvl5RqK0d42mhoK/x3bLRMQXHxwSDmYIFLy9rXLMvbVbdFJbbcqXP6QjnP4fAeebvTnUs6bVzInL9nh8Tqb3qjB5qji2i0MiCz3IouuZonOlef/VEac3Zpm6NcI5rVthPsMY55G8BMu4rVEStbIUlAJPoSBzqOgEKEXQbmWLh3CZnOoqQlLwIIvrKlwnXx26M1b+oOFm8s712Q==")
+      end
+    end
+    
+    should "be able to remove a key" do
+      auth do
+        assert_equal 2, Api.me.keys.size
+        @key.remove
+        # Just trust me on this one
+        FakeWeb.register_uri(:get, "https://#{yaml_api}/user/keys" + auth_query, :response => stub_file(File.join("users", "key-removed")))
+        assert_equal 1, Api.me.keys.size
+      end
+    end
+      
+      
+    
+  end
+end