tpitale-octopi 0.3.0

data/lib/octopi/branch.rb

@@ -0,0 +1,31 @@
+module Octopi
+  class Branch < Base
+    attr_accessor :name, :sha
+    include Resource
+    set_resource_name "branch", "branches"
+
+    resource_path "/repos/show/:id"
+    
+    # Called when we ask for a resource.
+    # Arguments are passed in like [<name>, <sha>]
+    # TODO: Find out why args are doubly nested
+    def initialize(*args)
+      args = args.flatten!
+      self.name = args.first
+      self.sha = args.last
+    end
+    
+    def to_s
+      name
+    end
+    
+    def self.all(options={})
+      ensure_hash(options)
+      user, repo = gather_details(options)
+      self.validate_args(user => :user, repo => :repo)
+      BranchSet.new(find_plural([user, repo, 'branches'], :resource)) do |i|
+        { :name => i.first, :hash => i.last }
+      end
+    end
+  end
+end

data/lib/octopi/branch_set.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), "branch")
+class Octopi::BranchSet < Array
+  include Octopi
+  attr_accessor :user, :repository
+  # Takes a name, returns a branch if it exists
+  def find(name)
+    branch = detect { |b| b.name == name }
+    raise NotFound, Branch if branch.nil?
+    branch
+  end
+end

data/lib/octopi/comment.rb

@@ -0,0 +1,20 @@
+module Octopi
+  class Comment < Base
+    attr_accessor :content, :author, :title, :updated, :link, :published, :id, :repository
+    include Resource
+    set_resource_name "tree"
+
+    resource_path "/tree/show/:id"
+
+    def self.find(options={})
+      ensure_hash(options)
+      user, repo, branch, sha = gather_details(options)
+      self.validate_args(sha => :sha, user => :user, repo => :repo)
+      super [user, repo, sha] 
+    end 
+    
+    def commit
+      Commit.find(:user => repository.owner, :repo => repository, :sha => /commit\/(.*?)#/.match(link)[1])
+    end
+  end
+end

data/lib/octopi/commit.rb

@@ -0,0 +1,69 @@
+module Octopi
+  class Commit < Base
+    include Resource
+    find_path "/commits/list/:query"
+    resource_path "/commits/show/:id"
+    
+    attr_accessor :repository, :message, :parents, :author, :url, :id, :committed_date, :authored_date, :tree, :committer, :added, :removed, :modified
+    
+    
+    # Finds all commits for the given options:
+    #
+    # :repo or :repository or :name - A repository object or the name of a repository
+    # :user - A user object or the login of a user
+    # :branch - A branch object or the name of a branch. Defaults to master. 
+    # 
+    # Sample usage:
+    #
+    #   >> find_all(:user => "fcoury", :repo => "octopi")
+    #   => <Latest 30 commits for master branch>
+    #  
+    #   => find_all(:user => "fcoury", :repo => "octopi", :branch => "lazy") # branch is set to lazy.
+    #   => <Latest 30 commits for lazy branch>
+    #
+    def self.find_all(options={})
+      ensure_hash(options)
+      user, repo, branch = gather_details(options)
+      commits = if options[:path]
+        super user, repo.name, branch, options[:path]
+      else
+        super user, repo.name, branch
+      end
+      # Repository is not passed in from the data, set it manually.
+      commits.each { |c| c.repository = repo }
+      commits
+    end
+    
+    # Finds all commits for the given options:
+    #
+    # :repo or :repository or :name - A repository object or the name of a repository
+    # :user - A user object or the login of a user
+    # :branch - A branch object or the name of a branch. Defaults to master. 
+    # :sha - The commit ID
+    # 
+    # Sample usage:
+    #
+    #   >> find(:user => "fcoury", :repo => "octopi", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae")
+    #   => <Commit f6609209c3ac0badd004512d318bfaa508ea10ae for branch master>
+    #
+    #   >> find(:user => "fcoury", :repo => "octopi", :branch => "lazy", :sha => "f6609209c3ac0badd004512d318bfaa508ea10ae") # branch is set to lazy.
+    #   => <Commit f6609209c3ac0badd004512d318bfaa508ea10ae for branch lazy>
+    #
+    def self.find(options={})
+      ensure_hash(options)
+      user, repo, branch, sha = gather_details(options)
+      super [user, repo, sha]
+    end
+    
+    def repo_identifier
+      url_parts = url.split('/')
+      if @repository
+        parts = [@repository.owner, @repository.name, url_parts[6]] 
+      else
+        parts = [url_parts[3], url_parts[4], url_parts[6]]
+      end
+      
+      parts.join('/')
+    end
+  end
+end

data/lib/octopi/error.rb

@@ -0,0 +1,35 @@
+module Octopi
+
+  class FormatError < StandardError
+   def initialize(f)
+     super("Got unexpected format (got #{f.first} for #{f.last})")
+   end
+  end
+  
+  class AuthenticationRequired < StandardError
+  end
+
+  class APIError < StandardError
+  end
+  
+  class InvalidLogin < StandardError
+  end
+
+  class RetryableAPIError < RuntimeError
+    attr_reader :code
+    def initialize(code=nil)
+      @code = code.nil? ? '???' : code
+      @message = "GitHub returned status #{@code}. Retrying request."
+      super @message
+    end  
+  end
+  
+  class ArgumentMustBeHash < Exception; end
+  
+  
+  class NotFound < Exception
+    def initialize(klass)
+      super "The #{klass.to_s.split("::").last} you were looking for could not be found, or is private."
+    end
+  end
+end

data/lib/octopi/file_object.rb

@@ -0,0 +1,16 @@
+module Octopi
+  class FileObject < Base
+    attr_accessor :name, :sha, :mode, :type
+    
+    include Resource
+    set_resource_name "tree"
+    resource_path "/tree/show/:id"
+
+    def self.find(options={})
+      ensure_hash(options)
+      user, repo, branch, sha = gather_details(options)
+      self.validate_args(sha => :sha, user => :user, repo => :repo)
+      super [user, repo, sha] 
+    end  
+  end
+end

data/lib/octopi/gist.rb

@@ -0,0 +1,28 @@
+module Octopi
+  # Gist API is... lacking at the moment.
+  # This class serves only as a reminder to implement it later
+  class Gist < Base
+    include HTTParty
+    attr_accessor :description, :repo, :public, :created_at
+    
+    include Resource
+    set_resource_name "tree"
+    resource_path ":id"
+    
+    def self.base_uri
+      "http://gist.github.com/api/v1/yaml"
+    end
+    
+    def self.find(id)
+      result = get("#{base_uri}/#{id}")
+      # This returns an array of Gists, rather than a single record.
+      new(result["gists"].first)
+    end
+    
+    # def files
+    #   gists_folder = File.join(ENV['HOME'], ".octopi", "gists")
+    #   File.mkdir_p(gists_folder)
+    #   `git clone git://`
+    # end
+  end
+end

data/lib/octopi/issue.rb

@@ -0,0 +1,111 @@
+module Octopi
+  class Issue < Base
+    include Resource
+    STATES = %w{open closed}
+
+    find_path "/issues/list/:query"
+    resource_path "/issues/show/:id"
+    
+    
+    attr_accessor :repository, :user, :updated_at, :votes, :number, :title, :body, :closed_at, :labels, :state, :created_at
+    
+    def self.search(options={})
+      ensure_hash(options)
+      options[:state] ||= "open"
+      user, repo = gather_details(options)
+      Api.api.get("/issues/search/#{user}/#{repo}/#{options[:state]}/#{options[:keyword]}")
+    end
+    
+    # Finds all issues for a given Repository
+    #
+    # You can provide the user and repo parameters as
+    # String or as User and Repository objects. When repo
+    # is provided as a Repository object, user is superfluous.
+    # 
+    # If no state is given, "open" is assumed.
+    #
+    # Sample usage:
+    #
+    #   find_all(repo, :state => "closed") # repo must be an object
+    #   find_all("octopi", :user => "fcoury") # user must be provided
+    #   find_all(:user => "fcoury", :repo => "octopi") # state defaults to open
+    #
+    def self.find_all(options={})
+      ensure_hash(options)
+      user, repo = gather_details(options)
+      state = (options[:state] || "open").downcase
+      validate_args(user => :user, repo.name => :repo, state => :state)
+
+      issues = super user, repo.name, state
+      issues.each { |i| i.repository = repo }
+      issues
+    end
+  
+    # TODO: Make find use hashes like find_all
+    def self.find(options={})
+      ensure_hash(options)
+      # Do not cache issues, as they may change via other means.
+      @cache = false
+      user, repo = gather_details(options)
+      
+      validate_args(user => :user, repo => :repo)
+      issue = super user, repo, options[:number]
+      issue.repository = repo
+      issue
+    end
+    
+    def self.open(options={})
+      ensure_hash(options)
+      user, repo = gather_details(options)
+      data = Api.api.post("/issues/open/#{user}/#{repo.name}", options[:params])
+      issue = new(data['issue'])
+      issue.repository = repo
+      issue
+    end
+    
+    # Re-opens an issue.
+    def reopen!
+      data = Api.api.post(command_path("reopen"))
+      self.state = 'open'
+      self
+    end
+    
+    def close!
+      data = Api.api.post(command_path("close"))
+      self.state = 'closed'
+      self
+    end
+    
+    def save
+      data = Api.api.post(command_path("edit"), { :title => title, :body => body })
+      self
+    end
+    
+    %w(add remove).each do |oper|
+      define_method("#{oper}_label") do |*labels|
+        labels.each do |label|
+          Api.api.post("#{prefix("label/#{oper}")}/#{label}/#{number}", { :cache => false })
+          if oper == "add"
+            self.labels << label
+          else
+            self.labels -= [label]
+          end
+        end
+      end
+    end
+
+    def comment(comment)
+      data = Api.api.post(command_path("comment"), { :comment => comment })
+      IssueComment.new(data['comment'])
+    end
+    
+    private
+    def prefix(command)
+      "/issues/#{command}/#{repository.owner}/#{repository.name}"
+    end
+    
+    def command_path(command)
+      "#{prefix(command)}/#{number}"
+    end
+  end
+end

data/lib/octopi/issue_comment.rb

@@ -0,0 +1,7 @@
+module Octopi
+  class IssueComment < Base
+    include Resource
+    attr_accessor :comment, :status
+    
+  end
+end

data/lib/octopi/issue_set.rb

@@ -0,0 +1,21 @@
+require File.join(File.dirname(__FILE__), "issue")
+class Octopi::IssueSet < Array
+  include Octopi
+  attr_accessor :user, :repository
+  
+  def initialize(array)
+    self.user = array.first.user
+    self.repository = array.first.repository
+    super(array)
+  end
+  
+  def find(number)
+    issue = detect { |issue| issue.number == number }
+    raise NotFound, Issue if issue.nil?
+    issue
+  end
+  
+  def search(options={})
+    Issue.search(options.merge(:user => user, :repo => repository))
+  end
+end

data/lib/octopi/key.rb

@@ -0,0 +1,25 @@
+module Octopi
+  class Key < Base
+    include Resource
+    
+    attr_accessor :title, :id, :key
+    find_path "/user/keys"
+    
+    attr_reader :user
+    
+    def self.find_all
+      Api.api.get("user/keys")
+    end
+    
+    def self.add(options={})
+      ensure_hash(options)
+      Api.api.post("/user/key/add", { :title => options[:title], :key => options[:key], :cache => false })
+      
+    end
+    
+    def remove
+      result = Api.api.post "/user/key/remove", { :id => id, :cache => false }
+      keys = result["public_keys"].select { |k| k["title"] == title }
+    end
+  end
+end

data/lib/octopi/key_set.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), "key")
+class KeySet < Array
+  include Octopi
+  def find(title)
+    key = detect { |key| key.title == title }
+    raise NotFound, Key if key.nil?
+    key
+  end
+  
+  def add(options={})
+    ensure_hash(options)
+    Key.add(options)
+  end
+end

data/lib/octopi/plan.rb

@@ -0,0 +1,5 @@
+module Octopi
+  class Plan < Base
+    attr_accessor :name, :collaborators, :space, :private_repos
+  end
+end

data/lib/octopi/repository.rb

@@ -0,0 +1,130 @@
+module Octopi
+  class Repository < Base
+    include Resource
+    attr_accessor :description, :url, :forks, :name, :homepage, :watchers, 
+                  :owner, :private, :fork, :open_issues, :pledgie, :size,
+                  # And now for the stuff returned by search results
+                  :actions, :score, :language, :followers, :type, :username,
+                  :id, :pushed, :created
+    set_resource_name "repository", "repositories"
+
+    create_path "/repos/create"
+    find_path "/repos/search/:query"
+    resource_path "/repos/show/:id"
+    delete_path "/repos/delete/:id"
+    
+    attr_accessor :private
+    
+    def owner=(owner)
+      @owner = User.find(owner)
+    end
+    
+    # Returns all branches for the Repository
+    #
+    # Example:
+    #   repo = Repository.find("fcoury", "octopi")
+    #   repo.branches.each { |r| puts r.name }
+    #
+    def branches
+      Branch.all(:user => self.owner, :repo => self)
+    end  
+
+    # Returns all tags for the Repository
+    #
+    # Example:
+    #   repo = Repository.find("fcoury", "octopi")
+    #   repo.tags.each { |t| puts t.name }
+    #
+    def tags
+      Tag.all(:user => self.owner, :repo => self)
+    end 
+    
+    
+    # Returns all the comments for a Repository
+    def comments
+      path = "http#{'s' if private}://github.com/#{owner}/#{name}/comments.atom"
+      xml = Crack::XML.parse(Net::HTTP.get(URI.parse(path)))
+
+      # handle crack not always returning an array
+      entries = [xml["feed"]["entry"]].flatten
+
+      comments = entries.map do |entry|
+        Comment.new(
+          :id => entry["id"],
+          :published => Time.parse(entry["published"]),
+          :updated => Time.parse(entry["updated"]),
+          :link => entry["link"]["href"],
+          :title => entry["title"],
+          :content => entry["content"].gsub("&lt;", "<").gsub("&gt;", ">"),
+          :author => entry["author"]["name"],
+          :repository => self
+        )
+      end
+    end
+
+    def clone_url
+      url = private || Api.api.login == self.owner.login ? "git@github.com:" : "git://github.com/"
+      url += "#{self.owner}/#{self.name}.git"
+    end
+    
+    def self.find(options={})
+      ensure_hash(options)
+      # Lots of people call the same thing differently.
+      # Can't call gather_details here because this method is used by it internally.
+      repo = options[:repo] || options[:repository] || options[:name]
+      user = options[:user].to_s
+    
+      return find_plural(user, :resource) if repo.nil?
+      
+      self.validate_args(user => :user, repo => :repo)
+      super user, repo
+    end
+
+    def self.find_all(*args)
+      # FIXME: This should be URI escaped, but have to check how the API
+      # handles escaped characters first.
+      super args.join(" ").gsub(/ /,'+')
+    end
+    
+    class << self 
+      alias_method :search, :find_all
+    end
+    
+    def commits(branch = "master")
+      Commit.find_all(:user => self.owner, :repo => self, :branch => branch)
+    end
+    
+    def issues(state = "open")
+      IssueSet.new(Octopi::Issue.find_all(:user => owner, :repository => self))
+    end
+   
+    def all_issues
+      Issue::STATES.map{|state| self.issues(state)}.flatten
+    end
+
+    def issue(number)
+      Issue.find(:user => self.owner, :repo => self, :number => number)
+    end
+
+    def collaborators
+      property('collaborators', [self.owner, self.name].join('/')).values.map { |v| User.find(v.join) }
+    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"])
+    end
+    
+    def delete!
+      raise APIError, "You must be authenticated as the owner of this repository to delete it" if Api.me.login != owner.login
+      token = Api.api.post(self.class.path_for(:delete), :id => self.name)['delete_token']
+      Api.api.post(self.class.path_for(:delete), :id => self.name, :delete_token => token) unless token.nil?
+    end
+    
+    def to_s
+      name
+    end
+
+  end
+end