tpitale-octopi 0.3.0

data/lib/octopi/repository_set.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), "repository")
+class Octopi::RepositorySet < Array
+  include Octopi
+  attr_accessor :user
+  
+  def find(name)
+    Octopi::Repository.find(:user => self.user, :repository => name)
+  end
+end

data/lib/octopi/resource.rb

@@ -0,0 +1,70 @@
+module Octopi
+  module Resource
+    def self.included(base)
+      base.extend ClassMethods
+      base.set_resource_name(base.name)
+      (@@resources||={})[base.resource_name(:singular)] = base
+      (@@resources||={})[base.resource_name(:plural)] = base
+    end
+    
+    def self.for(name)
+      @@resources[name]
+    end
+    
+    module ClassMethods
+      def set_resource_name(singular, plural = "#{singular}s")
+        @resource_name = {:singular => declassify(singular), :plural => declassify(plural)}
+      end
+      
+      def resource_name(key)
+        @resource_name[key]
+      end
+      
+      def create_path(path)
+        (@path_spec||={})[:create] = path
+      end
+      
+      def find_path(path)
+        (@path_spec||={})[:find] = path
+      end
+    
+      def resource_path(path)
+        (@path_spec||={})[:resource] = path
+      end
+  
+      def delete_path(path)
+        (@path_spec||={})[:delete] = path
+      end
+      
+      def find(*args)
+        args = args.join('/') if args.is_a? Array
+        result = Api.api.find(path_for(:resource), @resource_name[:singular], args, self, @cache)
+        key = result.keys.first
+
+        if result[key].is_a? Array
+          result[key].map { |r| new(r) }
+        else
+          Resource.for(key).new(result[key])
+        end
+      end
+
+      def find_all(*s)
+        find_plural(s, :find)
+      end
+      
+      def find_plural(s, path)
+        s = s.join('/') if s.is_a? Array
+        resources = Api.api.find_all(path_for(path), @resource_name[:plural], s, self)
+        resources.map { |item| self.new(item) }
+      end
+      
+      def declassify(s)
+        (s.split('::').last || '').downcase if s
+      end
+    
+      def path_for(type)
+        @path_spec[type]
+      end
+    end
+  end
+end

data/lib/octopi/self.rb

@@ -0,0 +1,33 @@
+module Octopi
+  module Self
+    # Returns a list of Key objects containing all SSH Public Keys this user
+    # currently has. Requires authentication.
+    def keys
+      raise AuthenticationRequired, "To view keys, you must be authenticated" if Api.api.read_only?
+      result = Api.api.get("/user/keys", { :cache => false })
+      return unless result and result["public_keys"]
+      KeySet.new(result["public_keys"].inject([]) { |result, element| result << Key.new(element) })
+    end
+  
+    # Returns a list of Email objects containing the email addresses associated with this user.
+    # Requires authentication.
+    def emails
+      raise AuthenticationRequired, "To view emails, you must be authenticated" if Api.api.read_only?
+      get("/user/emails")['emails']
+    end
+
+    # Start following a user.
+    # Can only be called if you are authenticated.
+    def follow!(login)
+      raise AuthenticationRequired, "To begin following someone, you must be authenticated" if Api.api.read_only?
+      Api.api.post("/user/follow/#{login}")
+    end
+    
+    # Stop following a user.
+    # Can only be called if you are authenticated.
+    def unfollow!(login)
+      raise AuthenticationRequired, "To stop following someone, you must be authenticated" if Api.api.read_only?
+      Api.api.post("/user/unfollow/#{login}")
+    end
+  end
+end

data/lib/octopi/tag.rb

@@ -0,0 +1,23 @@
+module Octopi
+  class Tag < Base
+    include Resource
+    
+    attr_accessor :name, :sha
+    set_resource_name "tag"
+
+    resource_path "/repos/show/:id"
+    
+    def initialize(*args)
+      args = args.flatten!
+      self.name = args.first
+      self.sha = args.last
+    end
+    
+    def self.all(options={})
+      ensure_hash(options)
+      user, repo = gather_details(options)
+      self.validate_args(user => :user, repo => :repo)
+      find_plural([user, repo, 'tags'], :resource) { |i| Tag.new(i) }
+    end
+  end
+end

data/lib/octopi/user.rb

@@ -0,0 +1,131 @@
+module Octopi
+  class User < Base
+    include Resource
+    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)
+    end
+    
+    find_path "/user/search/:query"
+    resource_path "/user/show/:id"
+    
+    # Finds a single user identified by the given username
+    #
+    # Example:
+    #   
+    #   user = User.find("fcoury")
+    #   puts user.login # should return 'fcoury'
+    def self.find(username)
+      self.validate_args(username => :user)
+      super username
+    end
+
+    # Finds all users whose username matches a given string
+    # 
+    # Example:
+    #
+    #   User.find_all("oe") # Matches joe, moe and monroe
+    #
+    def self.find_all(username)
+      self.validate_args(username => :user)
+      super username
+    end
+    
+    class << self
+      alias_method :search, :find_all
+    end
+
+    # Returns a collection of Repository objects, containing
+    # all repositories of the user.
+    #
+    # If user is the current authenticated user, some
+    # additional information will be provided for the
+    # Repositories.
+    def repositories
+      rs = RepositorySet.new(Repository.find(:user => self.login))
+      rs.user = self
+      rs
+    end
+    
+    # Searches for user Repository identified by name
+    def repository(options={})
+      options = { :name => options } if options.is_a?(String)
+      self.class.ensure_hash(options)
+      Repository.find({ :user => login }.merge!(options))
+    end
+    
+    def create_repository(name, options = {})
+      self.class.validate_args(name => :repo)
+      Repository.create(self, name, options)
+    end
+    
+    def watching
+      repositories = []
+      Api.api.get("/repos/watched/#{login}")["repositories"].each do |repo|
+        repositories << Repository.new(repo)
+      end
+      repositories
+    end
+    
+
+    # Gets a list of followers.
+    # Returns an array of logins.
+    def followers
+      user_property("followers")
+    end
+
+    # Gets a list of followers.
+    # Returns an array of user objects.
+    # If user has a large number of followers you may be rate limited by the API.
+    def followers!
+      user_property("followers", true)
+    end
+
+    # Gets a list of people this user is following.
+    # Returns an array of logins.
+    def following
+      user_property("following")
+    end
+
+    # Gets a list of people this user is following.
+    # Returns an array of user objectrs.
+    # If user has a large number of people whom they follow, you may be rate limited by the API.
+    def following!
+      user_property("following", true)
+    end
+
+    
+    # If a user object is passed into a method, we can use this.
+    # It'll also work if we pass in just the login.
+    def to_s
+      login
+    end
+    
+    private
+    
+    # Helper method for "deep" finds.
+    # Determines whether to return an array of logins (light) or user objects (heavy).
+    def user_property(property, deep=false)
+      users = []
+      property(property, login).each_pair do |k,v|
+        return v unless deep
+        
+        v.each { |u| users << User.find(u) } 
+      end
+      
+      users
+    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,38 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class AuthenticatedTest < Test::Unit::TestCase
+  include Octopi
+  def setup
+    fake_everything
+  end
+
+  context "Authenticating" do
+    should "not be possible with username and password" do
+      assert_raises(RuntimeError) do
+        authenticated_with(:login => "fcoury", :password => "yruocf") {}
+      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
+