fcoury-octopi 0.0.6 → 0.0.7

data/README.rdoc

@@ -4,9 +4,20 @@ Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com). It's un
 
 == Authenticated Usage
 
-The following examples requires a valid user authenticated with GitHub using login and API token. This information can be found on our profile (the link is inside the "badge" that is displayed on the upper right corner when you're logged in).
+=== Seamless authentication using .gitconfig defaults
 
-Once you found your login and token you can run authenticated commands using:
+If you have your <tt>~/.gitconfig</tt> file in place, and you have a [github] section (if you don't, take a look at this GitHub Guides entry: http://github.com/guides/tell-git-your-user-name-and-email-address), you can use seamless authentication using this method:
+
+  authenticated do |g|
+    repo = g.repository("api-labrat")
+    (...)
+  end
+  
+=== Explicit authentication
+
+Sometimes, you may not want to get authentication data from <tt>~/.gitconfig</tt>. You want to use GitHub API authenticated as a third party. For this use case, you have a couple of options too.
+
+<b>1. Providing login and token inline:</b>
 
   authenticated_with "mylogin", "mytoken" do |g|
     repo = g.repository("api-labrat")
@@ -15,7 +26,9 @@ Once you found your login and token you can run authenticated commands using:
     puts issue.number
   end
   
-You can also create a YAML file with your information, with the following format:
+<b>2. Providing a YAML file with authentication information:</b>
+
+Use the following format:
 
   #
   # Octopi GitHub API configuration file
@@ -32,20 +45,12 @@ You can also create a YAML file with your information, with the following format
   #   curl  - same as true, but in addition will output the curl equivalent of each command (for debugging)
   trace: curl
   
-And change the way you connect to:
+This changes the way you connect to:
 
   authenticated_with :config => "github.yml" do |g|
     (...)
   end
-
-This way you can benefit from better debugging when something goes wrong. If you choose curl tracing, the curl command equivalent to each command sent to GitHub will be output to the stdout, like this example:
-
-  => Trace on: curl
-  POST: /issues/open/webbynode/api-labrat params: body=This issue was opened using GitHub API and Octopi, title=Sample issue
-  ===== curl version
-  curl -F 'body=This issue was opened using GitHub API and Octopi' -F 'login=mylogin' -F 'token=mytoken' -F 'title=Sample issue' http://github.com/api/v2/issues/open/webbynode/api-labrat
-  ==================
-
+  
 == Anonymous Usage
 
 This reflects the usage of the API to retrieve information, on a read-only mode where the user doesn't have to be authenticated.
@@ -104,13 +109,54 @@ Single commit information:
   puts "Diff:"
   first_commit.details.modified.each {|m| puts "#{m['filename']} DIFF: #{m['diff']}" }
 
+== Tracing
+
+=== Levels
+
+You can can use tracing to enable better debugging output when something goes wrong. There are 3 tracing levels: 
+
+* false (default) - no tracing
+* true - will output each GET and POST calls, along with URL and params
+* curl - same as true, but additionally outputs the curl command to replicate the issue
+
+If you choose curl tracing, the curl command equivalent to each command sent to GitHub will be output to the stdout, like this example:
+
+  => Trace on: curl
+  POST: /issues/open/webbynode/api-labrat params: body=This issue was opened using GitHub API and Octopi, title=Sample issue
+  ===== curl version
+  curl -F 'body=This issue was opened using GitHub API and Octopi' -F 'login=mylogin' -F 'token=mytoken' -F 'title=Sample issue' http://github.com/api/v2/issues/open/webbynode/api-labrat
+  ==================
+  
+=== Enabling
+
+Tracing can be enabled in different ways, depending on the API feature you're using:
+
+<b>Anonymous (this will be improved later):</b>
+
+  ANONYMOUS_API.trace_level = "trace-level"
+  
+<b>Seamless authenticated</b>
+
+  authenticated :trace => "trace-level" do |g|; ...; end
+  
+<b>Explicitly authenticated</b>
+
+Current version of explicit authentication requires a :config param to a YAML file to allow tracing. For enabling tracing on a YAML file refer to the config.yml example presented on the Explicit authentication section.
+
 == Author
 
 * Felipe Coury - http://felipecoury.com
 * HasMany.info blog - http://hasmany.info
 
-== Copyright
+== Contributors
+
+In alphabetical order:
+
+* Brandon Calloway - http://github.com/bcalloway
+* runpaint - http://github.com/runpaint
 
-DISCLAIMER: The name of this library is pronounced <i>octo-pie</i> but no Octocats were harmed during its creation. It's not really an Octo Pie, but a contraction of the words Octocat and API.
+Thanks guys!
+
+== Copyright
 
 Copyright (c) 2009 Felipe Coury. See LICENSE for details.

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:minor: 0
-:patch: 6
 :major: 0
+:minor: 0
+:patch: 7

data/lib/octopi/base.rb

@@ -19,7 +19,12 @@ module Octopi
         :msg => "%s is an invalid filename"},
       :sha => {
         :pat => /^[a-f0-9]{40}$/,
-        :msg => "%s is an invalid SHA hash"}
+        :msg => "%s is an invalid SHA hash"},
+      :state => {
+        # FIXME: Any way to access Issue::STATES from here?
+        :pat => /^(open|closed)$/, 
+        :msg => "%s is an invalid state; should be 'open' or 'closed'."  
+      }
     }  
     
     attr_accessor :api
@@ -35,11 +40,13 @@ module Octopi
         next if k =~ /\./
         instance_variable_set("@#{k}", v)
         
-        self.class.send :define_method, "#{k}=" do |v|
+        method = (TrueClass === v || FalseClass === v) ? "#{k}?" : k
+
+        self.class.send :define_method, "#{method}=" do |v|
           instance_variable_set("@#{k}", v)
         end
 
-        self.class.send :define_method, k do
+        self.class.send :define_method, method do
           instance_variable_get("@#{k}")
         end
       end

data/lib/octopi/issue.rb

@@ -1,7 +1,8 @@
 module Octopi
   class Issue < Base
     include Resource
-    
+    STATES = %w{open closed}
+
     find_path "/issues/list/:query"
     resource_path "/issues/show/:id"
     
@@ -24,12 +25,10 @@ module Octopi
     def self.find_all(*args)
       repo = args.first
       user, repo_name, opts = extract_user_repository(*args)
-      validate_args(user => :user, repo_name => :repo)
       state = opts[:state] || "open"
       state.downcase! if state
-      
-      raise "State should be either 'open' or 'closed'" unless ['open', 'closed'].include? state
-      
+      validate_args(user => :user, repo_name => :repo, state => :state)
+
       issues = super user, repo_name, state
       issues.each { |i| i.repository = repo } if repo.is_a? Repository
       issues

data/lib/octopi/repository.rb

@@ -22,11 +22,19 @@ module Octopi
       find_plural(user, :resource)
     end
 
-    def self.find(user, name)
+    def self.find(*args)
+      api = args.last.is_a?(Api) ? args.pop : ANONYMOUS_API
+      repo = args.pop
+      user = args.pop
+      
       user = user.login if user.is_a? User
-      name = repo.name if name.is_a? Repository
-      self.validate_args(user => :user, name => :repo)
-      super [user, name]
+      if repo.is_a? Repository
+        repo = repo.name 
+        user ||= repo.owner 
+      end
+      
+      self.validate_args(user => :user, repo => :repo)
+      super user, repo, api
     end
 
     def self.find_all(*args)
@@ -50,9 +58,13 @@ module Octopi
     def issues(state = "open")
       Issue.find_all(self, :state => state)
     end
-    
+   
+    def all_issues
+      Issue::STATES.map{|state| self.issues(state)}.flatten
+    end
+
     def issue(number)
       Issue.find(self, number)
     end
   end
-end
+end

data/lib/octopi/resource.rb

@@ -27,17 +27,17 @@ module Octopi
       def resource_path(path)
         (@path_spec||={})[:resource] = path
       end
-    
-      def find(*s)
-        s = s.join('/') if s.is_a? Array
-        result = ANONYMOUS_API.find(path_for(:resource), @resource_name[:singular], s)
+      
+      def find(*args)
+        api = args.last.is_a?(Api) ? args.pop : ANONYMOUS_API
+        args = args.join('/') if args.is_a? Array
+        result = api.find(path_for(:resource), @resource_name[:singular], args)
         key = result.keys.first
+
         if result[key].is_a? Array
-          result[key].map do |r|
-            new(ANONYMOUS_API, r)
-          end  
+          result[key].map { |r| new(api, r) }
         else  
-          Resource.for(key).new(ANONYMOUS_API, result[key])
+          Resource.for(key).new(api, result[key])
         end  
       end
       
@@ -45,12 +45,12 @@ module Octopi
         find_plural(s, :find)
       end
 
-      def find_plural(s, path)
+      def find_plural(s, path, api = ANONYMOUS_API)
         s = s.join('/') if s.is_a? Array
-        ANONYMOUS_API.find_all(path_for(path), @resource_name[:plural], s).
+        api.find_all(path_for(path), @resource_name[:plural], s).
           map do |item|
             payload = block_given? ? yield(item) : item
-            new(ANONYMOUS_API, payload)
+            new(api, payload)
           end
       end
       

data/lib/octopi.rb

@@ -7,6 +7,20 @@ module Octopi
   class Api; end
   ANONYMOUS_API = Api.new
   
+  def authenticated(*args, &block)
+    opts = args.last.is_a?(Hash) ? args.last : {}
+    config = read_gitconfig
+    login = config["github"]["user"]
+    token = config["github"]["token"]
+    
+    api = Api.new(login, token)
+    api.trace_level = opts[:trace]
+    
+    puts "=> Trace on: #{api.trace_level}" if api.trace_level
+
+    yield api
+  end
+  
   def authenticated_with(*args, &block)
     opts = args.last.is_a?(Hash) ? args.last : {}
     if opts[:config]
@@ -23,10 +37,27 @@ module Octopi
     puts "=> Trace on: #{trace}" if trace
     
     api = Api.new(login, token)
-    api.trace = trace if trace
+    api.trace_level = trace if trace
     yield api
   end
   
+  def read_gitconfig
+    config = {}
+    group = nil
+    File.foreach("#{ENV['HOME']}/.gitconfig") do |line|
+      line.strip!
+      if line[0] != ?# and line =~ /\S/
+        if line =~ /^\[(.*)\]$/
+          group = $1
+        else
+          key, value = line.split("=")
+          (config[group]||={})[key.strip] = value.strip
+        end
+      end
+    end
+    config
+  end
+  
   class Api
     include HTTParty
     CONTENT_TYPE = {
@@ -36,7 +67,7 @@ module Octopi
     }  
     base_uri "http://github.com/api/v2"
   
-    attr_accessor :format, :login, :token, :trace, :read_only
+    attr_accessor :format, :login, :token, :trace_level, :read_only
   
     def initialize(login = nil, token = nil, format = "yaml")
       @format = format
@@ -66,7 +97,7 @@ module Octopi
     end
     
     def repository(name)
-      repo = Repository.find(login, name)
+      repo = Repository.find(user, name, self)
       repo.api = self
       repo
     end
@@ -91,7 +122,7 @@ module Octopi
     end
     
     def post(path, params = {}, format = "yaml")
-      trace "POST", path, params
+      trace "POST", "/#{format}#{path}", params
       submit(path, params, format) do |path, params, format|
         resp = self.class.post "/#{format}#{path}", :query => params
         resp
@@ -100,18 +131,23 @@ module Octopi
 
     private
     def submit(path, params = {}, format = "yaml", &block)
-      params.each_pair { |k,v| path = path.gsub(":#{k.to_s}", v) }
+      params.each_pair do |k,v|
+        if path =~ /:#{k.to_s}/
+          params.delete(k)
+          path = path.gsub(":#{k.to_s}", v)
+        end
+      end
       query = login ? { :login => login, :token => token } : {}
       query.merge!(params)
       
-      if @trace
-        case @trace
+      if @trace_level
+        case @trace_level
           when "curl"
             query_trace = []
             query.each_pair { |k,v| query_trace << "-F '#{k}=#{v}'" }
             puts "===== [curl version]"
-            puts "curl #{query_trace.join(" ")} #{self.class.base_uri}#{path}"
-            puts "==================="
+            puts "curl #{query_trace.join(" ")} #{self.class.base_uri}/#{format}#{path}"
+            puts "===================="
         end
       end
       
@@ -130,14 +166,14 @@ module Octopi
     end
     
     def get(path, params = {}, format = "yaml")
-      trace "GET", path, params
+      trace "GET [#{format}]", "/#{format}#{path}", params
       submit(path, params, format) do |path, params, format|
         self.class.get "/#{format}#{path}"
       end
     end
     
     def trace(oper, url, params)
-      return unless @trace
+      return unless trace_level
       par_str = " params: " + params.map { |p| "#{p[0]}=#{p[1]}" }.join(", ") if params and !params.empty?
       puts "#{oper}: #{url}#{par_str}"
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fcoury-octopi
 version: !ruby/object:Gem::Version 
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors: 
 - Felipe Coury
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-21 00:00:00 -07:00
+date: 2009-04-22 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -65,7 +65,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: []