devver-octopi 0.2.8

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,123 @@
+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, 
+    # 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/octopi.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{octopi}
+  s.version = "0.2.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Felipe Coury"]
+  s.date = %q{2009-12-26}
+  s.email = %q{felipe.coury@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     ".yardoc",
+     "CHANGELOG.md",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "contrib/backup.rb",
+     "lib/ext/hash_ext.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.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{octopi}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A Ruby interface to GitHub API v2}
+  s.test_files = [
+    "test/api_test.rb",
+     "test/authenticated_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"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= 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"])
+    else
+      s.add_dependency(%q<nokogiri>, [">= 1.3.1"])
+      s.add_dependency(%q<httparty>, [">= 0.4.5"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, [">= 1.3.1"])
+    s.add_dependency(%q<httparty>, [">= 0.4.5"])
+  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