fcoury-octopi 0.0.4 → 0.0.5

data/README.rdoc

@@ -4,47 +4,55 @@ Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com). It's un
 
 == Example
 
-  include Octopi
+=== Users API
+
+Getting user information
 
-  # 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
+The bang methods `followers!` and `following!` retrieves a full User object for each user login returned, so it has to be used carefully.
+
   user.followers!.each do |u|
     puts "  - #{u.name} (#{u.login}) has #{u.public_repo_count} repo(s)"
   end
+  
+Searching for user
 
-  # 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
+=== Repositories API
+
   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(", ")}"
+  
+Search:
 
-  # commits of a the repository
-  first_commit = repo.commits.first
-  puts "First commit: #{first_commit.id} - #{first_commit.message} - by #{first_commit.author['name']}"
-
-  # single commit information
-  # details is the same as: Commit.find(commit)
-  puts "Diff:"
-  first_commit.details.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
+  
+Issues API integrated into the Repository object:
+
+  issue = repo.issues.first
+  puts "First open issue: #{issue.number} - #{issue.title} - Created at: #{issue.created_at}"
+
+Commits API information from a Repository object:
+
+  first_commit = repo.commits.first
+  puts "First commit: #{first_commit.id} - #{first_commit.message} - by #{first_commit.author['name']}"
+  
+Single commit information:
+
+  puts "Diff:"
+  first_commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
 
 == Author
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
-:patch: 4
 :major: 0
+:minor: 0
+:patch: 5

data/lib/octopi.rb

@@ -51,6 +51,7 @@ module Octopi
     def find_all(path, result_key, query)
       get(path, { :query => query, :id => query })[result_key]
     end
+    
     def get_raw(path, params)
      get(path, params, 'plain')
     end
@@ -75,7 +76,7 @@ module Octopi
     end
   end
   
-  %w{base resource user tag repository file_object blob commit}.
+  %w{base resource user tag repository issue file_object blob commit}.
     each{|f| require "#{File.dirname(__FILE__)}/octopi/#{f}"} 
     
   class FormatError < StandardError

data/lib/octopi/base.rb

@@ -1,3 +1,4 @@
+module Octopi
   class Base
     def initialize(api, hash)
       @api = api
@@ -24,9 +25,41 @@
       path = "#{self.class.path_for(:resource)}/#{p}"
       @api.find(path, self.class.resource_name(:singular), v)
     end
+    
     def save
       hash = {}
       @keys.each { |k| hash[k] = send(k) }
       @api.save(self.path_for(:resource), hash)
     end
+    
+    private
+    def self.extract_user_repository(*args)
+      opts = args.last.is_a?(Hash) ? args.pop : {}
+      if opts.empty?
+        user, repo = *args
+      else
+        opts[:repo] = opts[:repository] if opts[:repository]
+        repo = args.pop || opts[:repo]
+        user = opts[:user]
+      end
+      
+      user ||= repo.owner if repo.is_a? Repository
+      
+      if repo.is_a?(String) and !user
+        raise "Need user argument when repository is identified by name"
+      end
+      
+      ret = extract_names(user, repo)
+      ret << opts
+      ret
+    end
+
+    def self.extract_names(*args)
+      args.map do |v|
+        v = v.name  if v.is_a? Repository
+        v = v.login if v.is_a? User
+        v
+      end
+    end
   end
+end

data/lib/octopi/commit.rb

@@ -6,16 +6,32 @@ module Octopi
     
     attr_accessor :repository
     
-    def self.find_all(user, name, branch = "master", repo = nil)
-      repository = repo if repo.is_a? Repository
-      user = user.login if user.is_a? User
-      repo = repo.name  if repo.is_a? Repository
-      name = repo.name  if name.is_a? Repository
-      commits = super [user, name, branch]
-      commits.each { |c| c.repository = repository } if repository
+    # Finds all commits for a given Repository's branch
+    #
+    # 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 branch is given, "master" is assumed.
+    #
+    # Sample usage:
+    #
+    #   find_all(repo, :branch => "develop") # repo must be an object
+    #   find_all("octopi", :user => "fcoury") # user must be provided
+    #   find_all(:user => "fcoury", :repo => "octopi") # branch defaults to master
+    #
+    def self.find_all(*args)
+      repo = args.first
+      user ||= repo.owner if repo.is_a? Repository
+      user, repo_name, opts = extract_user_repository(*args)
+      branch = opts[:branch] || "master"
+      
+      commits = super user, repo_name, branch
+      commits.each { |c| c.repository = repo } if repo.is_a? Repository
       commits
     end
     
+    # TODO: Make find use hashes like find_all
     def self.find(*args)
       if args.last.is_a?(Commit)
         commit = args.pop
@@ -40,7 +56,6 @@ module Octopi
         parts = [url_parts[3], url_parts[4], url_parts[6]]
       end
       
-      puts parts.join('/')
       parts.join('/')
     end
   end

data/lib/octopi/issue.rb

@@ -0,0 +1,50 @@
+module Octopi
+  class Issue < Base
+    include Resource
+    
+    find_path "/issues/list/:query"
+    resource_path "/user/show/:id"
+    
+    attr_accessor :repository
+    
+    # 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(*args)
+      repo = args.first
+      user, repo_name, opts = extract_user_repository(*args)
+      state = opts[:state] || "open"
+      state.downcase! if state
+      
+      raise "State should be either 'open' or 'closed'" unless ['open', 'closed'].include? state
+      
+      issues = super user, repo_name, state
+      issues.each { |i| i.repository = repo } if repo.is_a? Repository
+      issues
+    end
+  
+    # TODO: Make find use hashes like find_all
+    def self.find(*args)
+      if args.last.is_a?(Issue)
+        commit = args.pop
+        super "#{issue.number}"
+      else
+        user, name, number = *args
+        user = user.login if user.is_a? User
+        name = repo.name  if name.is_a? Repository
+        super user, name, number
+      end
+    end
+  end
+end

data/lib/octopi/repository.rb

@@ -34,7 +34,11 @@ module Octopi
     end
     
     def commits(branch = "master")
-      Commit.find_all(owner, name, branch, self)
+      Commit.find_all(self, :branch => branch)
+    end
+    
+    def issues(state = "open")
+      Issue.find_all(self, :state => state)
     end
   end
 end

data/lib/octopi/resource.rb

@@ -20,10 +20,6 @@ module Octopi
         @resource_name[key]
       end
       
-      def declassify(s)
-        (s.split('::').last || '').downcase if s
-      end
-    
       def find_path(path)
         (@path_spec||={})[:find] = path
       end
@@ -45,11 +41,11 @@ module Octopi
         end  
       end
       
-      def find_all(s)
+      def find_all(*s)
         find_plural(s, :find)
       end
 
-      def find_plural(s,path)
+      def find_plural(s, path)
         s = s.join('/') if s.is_a? Array
         ANONYMOUS_API.find_all(path_for(path), @resource_name[:plural], s).
           map do |item|
@@ -58,6 +54,10 @@ module Octopi
           end
       end
       
+      def declassify(s)
+        (s.split('::').last || '').downcase if s
+      end
+    
       def path_for(type)
         @path_spec[type]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fcoury-octopi
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors: 
 - Felipe Coury
@@ -30,6 +30,7 @@ files:
 - lib/octopi/blob.rb
 - lib/octopi/commit.rb
 - lib/octopi/file_object.rb
+- lib/octopi/issue.rb
 - lib/octopi/repository.rb
 - lib/octopi/resource.rb
 - lib/octopi/tag.rb
@@ -63,7 +64,7 @@ requirements: []
 rubyforge_project: 
 rubygems_version: 1.2.0
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A Ruby interface to GitHub API v2
 test_files: []