fcoury-octopi 0.0.7 → 0.0.8

data/README.rdoc

@@ -1,6 +1,10 @@
 = octopi
 
-Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com). It's under early but active development and already works.
+Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com).
+
+To install it as a Gem, just run:
+
+  $ sudo gem install fcoury-octopi --source http://gems.github.com
 
 == Authenticated Usage
 
@@ -45,7 +49,7 @@ Use the following format:
   #   curl  - same as true, but in addition will output the curl equivalent of each command (for debugging)
   trace: curl
   
-This changes the way you connect to:
+And change the way you connect to:
 
   authenticated_with :config => "github.yml" do |g|
     (...)
@@ -53,7 +57,7 @@ This changes the way you connect to:
   
 == 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.
+This reflects the usage of the API to retrieve information on a read-only fashion, where the user doesn't have to be authenticated.
 
 === Users API
 

data/VERSION.yml

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

data/lib/octopi.rb

@@ -65,6 +65,9 @@ module Octopi
       'json' => 'application/json',
       'xml'  => 'application/sml'
     }  
+    RETRYABLE_STATUS = [403]
+    MAX_RETRIES = 10
+    
     base_uri "http://github.com/api/v2"
   
     attr_accessor :format, :login, :token, :trace_level, :read_only
@@ -77,12 +80,17 @@ module Octopi
         @login = login
         @token = token
         @read_only = false
+        self.class.default_params :login => login, :token => token
       end
     end
-  
-    %w[keys emails].each do |action|
+
+    def read_only?
+      read_only
+    end
+
+    {:keys => 'public_keys', :emails => 'emails'}.each_pair do |action, key|
       define_method("#{action}") do
-        get("/user/#{action}")
+        get("/user/#{action}")[key]
       end
     end
 
@@ -121,6 +129,25 @@ module Octopi
      get(path, params, 'plain')
     end
     
+    def get(path, params = {}, format = "yaml")
+      @@retries = 0
+      begin
+        trace "GET [#{format}]", "/#{format}#{path}", params
+        submit(path, params, format) do |path, params, format|
+          self.class.get "/#{format}#{path}"
+        end
+      rescue RetryableAPIError => e
+        if @@retries < MAX_RETRIES 
+          $stderr.puts e.message
+          @@retries += 1
+          retry
+        else  
+          raise APIError, "GitHub returned status #{e.code}, despite" +
+           " repeating the request #{MAX_RETRIES} times. Giving up."
+        end  
+      end  
+    end
+    
     def post(path, params = {}, format = "yaml")
       trace "POST", "/#{format}#{path}", params
       submit(path, params, format) do |path, params, format|
@@ -140,6 +167,12 @@ module Octopi
       query = login ? { :login => login, :token => token } : {}
       query.merge!(params)
       
+      begin
+        resp = yield(path, query.merge(params), format)
+      rescue Net::HTTPBadResponse
+        raise RetryableAPIError
+      end
+      
       if @trace_level
         case @trace_level
           when "curl"
@@ -150,8 +183,7 @@ module Octopi
             puts "===================="
         end
       end
-      
-      resp = yield(path, query, format)
+      raise RetryableAPIError, resp.code.to_i if RETRYABLE_STATUS.include? resp.code.to_i
       raise APIError, 
         "GitHub returned status #{resp.code}" unless resp.code.to_i == 200
       # FIXME: This fails for showing raw Git data because that call returns
@@ -165,13 +197,6 @@ module Octopi
       resp
     end
     
-    def get(path, params = {}, format = "yaml")
-      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_level
       par_str = " params: " + params.map { |p| "#{p[0]}=#{p[1]}" }.join(", ") if params and !params.empty?
@@ -179,7 +204,7 @@ module Octopi
     end
   end
     
-  %w{error base resource user tag repository issue file_object blob commit}.
+  %w{error base resource user tag repository issue file_object blob key commit branch}.
     each{|f| require "#{File.dirname(__FILE__)}/octopi/#{f}"} 
 
 end

data/lib/octopi/branch.rb

@@ -0,0 +1,17 @@
+module Octopi
+  class Branch < Base
+    include Resource
+    set_resource_name "branch", "branches"
+
+    resource_path "/repos/show/:id"
+    
+    def self.find(user, repo)
+      user = user.login if user.is_a? User
+      repo = repo.name if repo.is_a? Repository
+      self.validate_args(user => :user, repo => :repo)
+      find_plural([user,repo,'branches'], :resource){
+        |i| {:name => i.first, :hash => i.last }
+      }
+    end
+  end
+end

data/lib/octopi/error.rb

@@ -12,4 +12,12 @@ module Octopi
    end
   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
 end

data/lib/octopi/key.rb

@@ -0,0 +1,18 @@
+module Octopi
+  class Key < Base
+    include Resource
+    
+    attr_reader :user
+
+    def initialize(api, data, user = nil)
+      super api, data
+      @user = user
+    end
+    
+    def remove!
+      result = @api.post "/user/key/remove", :id => id
+      keys = result["public_keys"].select { |k| puts "#{title} #{k["title"]} #{k["title"] == title}"; k["title"] == title }
+      keys.empty?
+    end
+  end
+end

data/lib/octopi/repository.rb

@@ -5,6 +5,10 @@ module Octopi
 
     find_path "/repos/search/:query"
     resource_path "/repos/show/:id"
+    
+    def branches
+      Branch.find(self.owner, self.name)
+    end  
 
     def tags
       Tag.find(self.owner, self.name)
@@ -66,5 +70,10 @@ module Octopi
     def issue(number)
       Issue.find(self, number)
     end
+
+    def collaborators
+      property('collaborators', [self.owner,self.name].join('/')).values
+    end  
+
   end
 end

data/lib/octopi/user.rb

@@ -24,6 +24,26 @@ module Octopi
       Repository.find(login, name)
     end
     
+    def add_key(title, key)
+      raise APIError, 
+        "To add a key, you must be authenticated" if @api.read_only?
+
+      result = @api.post("/user/key/add", :title => title, :key => key)
+      return if !result["public_keys"]
+      key_params = result["public_keys"].select { |k| puts "#{title} #{k["title"]} #{k["title"] == title}"; k["title"] == title }
+      return if !key_params or key_params.empty?
+      Key.new(@api, key_params.first, self)
+    end
+
+    def keys
+      raise APIError, 
+        "To add a key, you must be authenticated" if @api.read_only?
+
+      result = @api.get("/user/keys")
+      return unless result and result["public_keys"]
+      result["public_keys"].inject([]) { |result, element| result << Key.new(@api, element) }
+    end
+    
     # takes one param, deep that indicates if returns 
     # only the user login or an user object
     %w[followers following].each do |method|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fcoury-octopi
 version: !ruby/object:Gem::Version 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Felipe Coury
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-22 00:00:00 -07:00
+date: 2009-04-26 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -28,10 +28,12 @@ files:
 - lib/octopi
 - lib/octopi/base.rb
 - lib/octopi/blob.rb
+- lib/octopi/branch.rb
 - lib/octopi/commit.rb
 - lib/octopi/error.rb
 - lib/octopi/file_object.rb
 - lib/octopi/issue.rb
+- lib/octopi/key.rb
 - lib/octopi/repository.rb
 - lib/octopi/resource.rb
 - lib/octopi/tag.rb