fcoury-octopi 0.0.3 → 0.0.4

data/README.rdoc

@@ -28,6 +28,7 @@ Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com). It's un
   # to get all repos for user: user.repositories
   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(", ")}"
 
   # commits of a the repository
   first_commit = repo.commits.first
@@ -47,8 +48,8 @@ Octopi is a Ruby interface to GitHub API v2 (http://develop.github.com). It's un
 
 == Author
 
-Felipe Coury - http://felipecoury.com<br/>
-HasMany.info blog - http://hasmany.info
+* Felipe Coury - http://felipecoury.com
+* HasMany.info blog - http://hasmany.info
 
 == Copyright
 

data/VERSION.yml

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

data/lib/octopi/base.rb

@@ -0,0 +1,32 @@
+  class Base
+    def initialize(api, hash)
+      @api = api
+      @keys = []
+      
+      raise "Missing data for #{@resource}" unless hash
+      
+      hash.each_pair do |k,v|
+        @keys << k
+        next if k =~ /\./
+        instance_variable_set("@#{k}", v)
+        
+        self.class.send :define_method, "#{k}=" do |v|
+          instance_variable_set("@#{k}", v)
+        end
+
+        self.class.send :define_method, k do
+          instance_variable_get("@#{k}")
+        end
+      end
+    end
+    
+    def property(p, v)
+      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
+  end

data/lib/octopi/blob.rb

@@ -0,0 +1,20 @@
+module Octopi
+  class Blob < Base
+    include Resource
+    set_resource_name "blob"
+
+    resource_path "/blob/show/:id"
+
+    def self.find(user, repo, sha, path=nil)
+      user = user.login if user.is_a? User
+      repo = repo.name if repo.is_a? Repository
+      if path
+        super [user,repo,sha,path]
+      else
+        blob = ANONYMOUS_API.get_raw(path_for(:resource), 
+              {:id => [user,repo,sha].join('/')})
+        new(ANONYMOUS_API, {:text => blob})
+      end  
+    end  
+  end
+end

data/lib/octopi/commit.rb

@@ -0,0 +1,47 @@
+module Octopi
+  class Commit < Base
+    include Resource
+    find_path "/commits/list/:query"
+    resource_path "/commits/show/:id"
+    
+    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
+      commits
+    end
+    
+    def self.find(*args)
+      if args.last.is_a?(Commit)
+        commit = args.pop
+        super "#{commit.repo_identifier}"
+      else
+        user, name, sha = *args
+        user = user.login if user.is_a? User
+        name = repo.name  if name.is_a? Repository
+        super [user, name, sha]
+      end
+    end
+    
+    def details
+      self.class.find(self)
+    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
+      
+      puts parts.join('/')
+      parts.join('/')
+    end
+  end
+end

data/lib/octopi/file_object.rb

@@ -0,0 +1,14 @@
+module Octopi
+  class FileObject < Base
+    include Resource
+    set_resource_name "tree"
+
+    resource_path "/tree/show/:id"
+
+    def self.find(user, repo, sha)
+      user = user.login if user.is_a? User
+      repo = repo.name if repo.is_a? Repository
+      super [user,repo,sha] 
+    end  
+  end
+end

data/lib/octopi/repository.rb

@@ -0,0 +1,40 @@
+module Octopi
+  class Repository < Base
+    include Resource
+    set_resource_name "repository", "repositories"
+
+    find_path "/repos/search/:query"
+    resource_path "/repos/show/:id"
+
+    def tags
+      Tag.find(self.owner, self.name)
+    end  
+    
+    def clone_url
+      #FIXME: Return "git@github.com:#{self.owner}/#{self.name}.git" if
+      #user's logged in and owns this repo.
+      "git://github.com/#{self.owner}/#{self.name}.git"  
+    end
+
+    def self.find_by_user(user)
+      user = user.login if user.is_a? User
+      find_plural(user, :resource)
+    end
+
+    def self.find(user, name)
+      user = user.login if user.is_a? User
+      name = repo.name if name.is_a? Repository
+      super [user,name]
+    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
+    
+    def commits(branch = "master")
+      Commit.find_all(owner, name, branch, self)
+    end
+  end
+end

data/lib/octopi/resource.rb

@@ -0,0 +1,66 @@
+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 declassify(s)
+        (s.split('::').last || '').downcase if s
+      end
+    
+      def find_path(path)
+        (@path_spec||={})[:find] = path
+      end
+    
+      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)
+        key = result.keys.first
+        if result[key].is_a? Array
+          result[key].map do |r|
+            new(ANONYMOUS_API, r)
+          end  
+        else  
+          Resource.for(key).new(ANONYMOUS_API, 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
+        ANONYMOUS_API.find_all(path_for(path), @resource_name[:plural], s).
+          map do |item|
+            payload = block_given? ? yield(item) : item
+            new(ANONYMOUS_API, payload)
+          end
+      end
+      
+      def path_for(type)
+        @path_spec[type]
+      end
+    end
+  end
+end

data/lib/octopi/tag.rb

@@ -0,0 +1,16 @@
+module Octopi
+  class Tag < Base
+    include Resource
+    set_resource_name "tag"
+
+    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
+      find_plural([user,repo,'tags'], :resource){
+        |i| {:name => i.first, :hash => i.last }
+      }
+    end
+  end
+end

data/lib/octopi/user.rb

@@ -0,0 +1,38 @@
+module Octopi
+  class User < Base
+    include Resource
+    
+    find_path "/user/search/:query"
+    resource_path "/user/show/:id"
+    
+    def repositories
+      Repository.find_by_user(login)
+    end
+    
+    def repository(name)
+      Repository.find(login, name)
+    end
+    
+    # takes one param, deep that indicates if returns 
+    # only the user login or an user object
+    %w[followers following].each do |method|
+      define_method(method) do
+        user_property(method, false)
+      end
+      define_method("#{method}!") do
+        user_property(method, true)
+      end
+    end
+    
+    def user_property(property, deep)
+      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/lib/octopi.rb

@@ -12,6 +12,11 @@ module Octopi
   
   class Api
     include HTTParty
+    CONTENT_TYPE = {
+      'yaml' => 'application/x-yaml',
+      'json' => 'application/json',
+      'xml'  => 'application/sml'
+    }  
     base_uri "http://github.com/api/v2"
   
     attr_accessor :format
@@ -46,207 +51,42 @@ 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
+
     private
     def get(path, params = {}, format = "yaml")
       params.each_pair do |k,v|
         path = path.gsub(":#{k.to_s}", v)
       end
-      # puts "GET: /#{format}#{path}"
-      self.class.get("/#{format}#{path}") 
-    end
-  end
-  
-  class Base
-    def initialize(api, hash)
-      @api = api
-      @keys = []
-      
-      raise "Missing data for #{@resource}" unless hash
-      
-      hash.each_pair do |k,v|
-        @keys << k
-        instance_variable_set("@#{k}", v)
-        
-        self.class.send :define_method, "#{k}=" do |v|
-          instance_variable_set("@#{k}", v)
-        end
-
-        self.class.send :define_method, k do
-          instance_variable_get("@#{k}")
-        end
-      end
-    end
-    
-    def property(p, v)
-      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
-  end
-  
-  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 declassify(s)
-        (s.split('::').last || '').downcase if s
-      end
-    
-      def find_path(path)
-        (@path_spec||={})[:find] = path
-      end
-    
-      def resource_path(path)
-        (@path_spec||={})[:resource] = path
-      end
-    
-      def find(s)
-        result = ANONYMOUS_API.find(path_for(:resource), @resource_name[:singular], s)
-        key = result.keys.first
-        Resource.for(key).new(ANONYMOUS_API, result[key])
-      end
-      
-      def find_all(s)
-        find_plural(s, :find)
-      end
-
-      def find_plural(s,path)
-        all = []
-        result = ANONYMOUS_API.find_all(path_for(path), @resource_name[:plural], s)
-        result.each do |item|
-          all << new(ANONYMOUS_API, item)
-        end
-        all
-      end
-      
-      def path_for(type)
-        @path_spec[type]
-      end
-    end
-  end
-  
-  class User < Base
-    include Resource
-    
-    find_path "/user/search/:query"
-    resource_path "/user/show/:id"
-    
-    def repositories
-      Repository.find_by_user(login)
-    end
-    
-    def repository(name)
-      Repository.find(login, name)
-    end
-    
-    # takes one param, deep that indicates if returns 
-    # only the user login or an user object
-    %w[followers following].each do |method|
-      define_method(method) do
-        user_property(method, false)
-      end
-      define_method("#{method}!") do
-        user_property(method, true)
-      end
-    end
-    
-    def user_property(property, deep)
-      users = []
-      property(property, login).each_pair do |k,v|
-        return v unless deep
-        
-        v.each { |u| users << User.find(u) } 
-      end
-      
-      users
+      resp = self.class.get("/#{format}#{path}")
+      # FIXME: This fails for showing raw Git data because that call returns
+      # text/html as the content type. This issue has been reported.
+      ctype = resp.headers['content-type'].first
+      raise FormatError, [ctype, format] unless 
+        ctype.match(/^#{CONTENT_TYPE[format]};/)
+      raise APIError, 
+        "GitHub returned status #{resp.code}" unless resp.code.to_i == 200
+      if format == 'yaml' && resp['error']
+        raise APIError, resp['error'].first['error']
+      end  
+      resp
     end
   end
   
-  class Repository < Base
-    include Resource
-    set_resource_name "repository", "repositories"
-
-    find_path "/repos/search/:query"
-    resource_path "/repos/show/:id"
-
-    def self.find_by_user(user)
-      find_plural(user, :resource)
-    end
-
-    def self.find(user, name)
-      super "#{user}/#{name}"
-    end
-
-    def self.find_all(*args)
-      super args.join("+")
-    end
-    
-    def commits(branch = "master")
-      Commit.find_all(owner, name, branch, self)
-    end
-  end
+  %w{base resource user tag repository file_object blob commit}.
+    each{|f| require "#{File.dirname(__FILE__)}/octopi/#{f}"} 
+    
+  class FormatError < StandardError
+   def initialize(f)
+     $stderr.puts "Got unexpected format (got #{f.first} for #{f.last})"
+   end
+  end 
   
-  class Commit < Base
-    include Resource
-    find_path "/commits/list/:query"
-    resource_path "/commits/show/:id"
-    
-    attr_accessor :repository
-    
-    def self.find_all(user, name, branch = "master", repo = nil)
-      commits = super("#{user}/#{name}/#{branch}")
-      commits.each { |c| c.repository = repo } if repo
-      commits
-    end
-    
-    def self.find(*args)
-      if args.last.is_a?(Commit)
-        commit = args.pop
-        super "#{commit.repo_identifier}"
-      else
-        user, name, sha = *args
-        super "#{user}/#{name}/#{sha}"
-      end
-    end
-    
-    def details
-      self.class.find(self)
-    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
-      
-      puts parts.join('/')
-      parts.join('/')
-    end
-  end
-  class APIError < StandardError; end  
+  class APIError < StandardError
+   def initialize(m)
+     $stderr.puts m 
+   end
+  end 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: fcoury-octopi
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Felipe Coury
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-19 00:00:00 -07:00
+date: 2009-04-20 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,15 @@ extra_rdoc_files:
 files: 
 - README.rdoc
 - VERSION.yml
+- lib/octopi
+- lib/octopi/base.rb
+- lib/octopi/blob.rb
+- lib/octopi/commit.rb
+- lib/octopi/file_object.rb
+- lib/octopi/repository.rb
+- lib/octopi/resource.rb
+- lib/octopi/tag.rb
+- lib/octopi/user.rb
 - lib/octopi.rb
 - test/octopi_test.rb
 - test/test_helper.rb