git_hub 0.1.0 → 0.2.0

data/README.rdoc

@@ -18,14 +18,28 @@ Contributors always welcome!
 require 'git_hub'
 include GitHub
 
-# Find existing repos
+# Find existing repos:
 repo = Repo.find(:user=>user_name, :repo=>repo_name)
 repos = Repo.find(:user=>user_name)
 search_repos = Repo.find(:query=>['search','terms'])
 
-# Create new repo (need to authenticate with your github credentials first)
+# Retrieve tags, branches and commits for a repo:
+puts repo.tags['v0.1.0']
+puts repo.branches['master']
+repo.commits.each {|commit| p commit.author}
+
+# Retrieve info for a specific commit:
+commits = Commit.find(:user=>user_name, :repo=>repo_name, :branch=>'master')
+commits = Commit.find(:user=>user_name, :repo=>repo_name, :branch=>'master', :path=>'README.rdoc')
+commit = Commit.find(:user=>user_name, :repo=>repo_name, :sha=>'commit_sha')
+# or, if repo is already retrieved:
+commit = repo.commits.last
+commit = repo.tags['v0.1.0']  #TODO - now returns only sha, not Commit
+
+# Create new repo or delete existing repo (need to authenticate with your github credentials first)
 Api.auth = {:user=>user_name, :token=>token}
 new_repo = Repo.create(:name=>repo_name, :desc=>'Description', :homepage=>'http://your_page.org', :private=> false)
+new_repo.delete
 
 == REQUIREMENTS:
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/git_hub

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(
-    File.join(File.dirname(__FILE__), %w[.. lib git_hub]))
+require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib git_hub]))
 
 # Put your code here
 

data/git_hub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git_hub}
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["arvicco"]
-  s.date = %q{2010-01-07}
+  s.date = %q{2010-01-11}
   s.default_executable = %q{git_hub}
   s.description = %q{Simple interface to github API}
   s.email = %q{arvitallian@gmail.com}
@@ -31,19 +31,45 @@ Gem::Specification.new do |s|
      "lib/git_hub.rb",
      "lib/git_hub/api.rb",
      "lib/git_hub/base.rb",
+     "lib/git_hub/commit.rb",
      "lib/git_hub/repo.rb",
+     "rdoc/classes/GitHub.html",
+     "rdoc/classes/GitHub/Api.html",
+     "rdoc/classes/GitHub/Base.html",
+     "rdoc/classes/GitHub/Repo.html",
+     "rdoc/created.rid",
+     "rdoc/files/README_rdoc.html",
+     "rdoc/files/lib/git_hub/api_rb.html",
+     "rdoc/files/lib/git_hub/base_rb.html",
+     "rdoc/files/lib/git_hub/repo_rb.html",
+     "rdoc/files/lib/git_hub_rb.html",
+     "rdoc/fr_class_index.html",
+     "rdoc/fr_file_index.html",
+     "rdoc/fr_method_index.html",
+     "rdoc/index.html",
+     "rdoc/rdoc-style.css",
      "spec/git_hub/api_spec.rb",
      "spec/git_hub/base_spec.rb",
+     "spec/git_hub/commit_spec.rb",
      "spec/git_hub/repo_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
-     "spec/stubs/repos/create.res",
+     "spec/stubs/api_route_error.res",
+     "spec/stubs/commits/list/joe007/fine_repo/master.res",
+     "spec/stubs/commits/list/joe007/fine_repo/master/README.res",
+     "spec/stubs/commits/show/joe007/fine_repo/5e61f0687c40ca48214d09dc7ae2d0d0d8fbfeb8.res",
+     "spec/stubs/repos/create.1.res",
+     "spec/stubs/repos/create.2.res",
+     "spec/stubs/repos/create.3.res",
+     "spec/stubs/repos/create.4.res",
      "spec/stubs/repos/delete/new_repo.1.res",
      "spec/stubs/repos/delete/new_repo.2.res",
      "spec/stubs/repos/search/joe+repo.res",
      "spec/stubs/repos/show/joe007.res",
      "spec/stubs/repos/show/joe007/err_repo.res",
      "spec/stubs/repos/show/joe007/fine_repo.res",
+     "spec/stubs/repos/show/joe007/fine_repo/branches.res",
+     "spec/stubs/repos/show/joe007/fine_repo/tags.res",
      "spec/stubs/repos/show/joe007/new_repo.res"
   ]
   s.homepage = %q{http://github.com/arvicco/git_hub}
@@ -54,6 +80,7 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/git_hub/api_spec.rb",
      "spec/git_hub/base_spec.rb",
+     "spec/git_hub/commit_spec.rb",
      "spec/git_hub/repo_spec.rb",
      "spec/spec_helper.rb"
   ]

data/lib/git_hub/api.rb

@@ -15,6 +15,12 @@ module GitHub
       auth != {}
     end
 
+    def ensure_auth opts ={}
+      return if authenticated?
+      @auth = {'login'=>opts[:login], 'token'=>opts[:token]}
+      raise("Authentication failed") unless authenticated?
+    end
+
     # Turns string into appropriate class constant, returns nil if class not found
     def classify name
       klass = name.split("::").inject(Kernel) {|klass, const_name| klass.const_get const_name }

data/lib/git_hub/base.rb

@@ -2,24 +2,25 @@ require 'yaml'
 
 module GitHub
   class Base
-    @base_uri = ''
 
     def initialize(attributes={})
+      update_attributes attributes
+    end
+
+    def update_attributes attributes
       attributes.each do |key, value|
         raise "No attr_accessor for #{key} on #{self.class}" unless respond_to?("#{key}=")
-        self.send("#{key}=", value)
+        self.send("#{key.to_s}=", value)
       end
     end
 
-    def self.base_uri uri
-      @base_uri = uri
-    end
-
     class << self
       def request verb, uri, params = {}
-        res = api.request verb, @base_uri+uri, params
-        YAML::load(res.body) if res.respond_to?(:body) # res.kind_of?(Net::HTTPSuccess)
-        #p "in show: #{res}: #{res.code}: #{res.http_version}: #{res.message}", res.body
+        path = uri[0] == '/' ? base_uri+uri : uri
+        #p "request: #{verb} #{path} #{params}"
+        res = api.request verb, path, params
+        YAML::load(res.body) if res.respond_to?(:body)
+        #p "response: #{res}: #{res.code}: #{res.http_version}: #{res.message}", res.body
       end
 
       def get uri, params ={}
@@ -31,7 +32,43 @@ module GitHub
       end
 
       def api
-        @@api ||= GitHub::Api.instance
+        @@api ||= Api.instance
+      end
+
+      def set_resource base_uri, singulars, plurals
+        @base_uri = base_uri
+        @singulars = [singulars].flatten
+        @plurals = [plurals].flatten
+      end
+
+      def base_uri
+        @base_uri || ""
+      end
+
+      private
+
+      def normalize opts
+        opts[:user] ||= opts[:owner] || opts[:username] || opts[:login] || api.auth['login']
+        opts[:repo] ||= opts[:repository] || opts[:name] || opts[:project]
+        opts[:sha] ||= opts[:hash] || opts[:object_id] || opts[:id]
+        opts[:description] ||= opts[:descr] || opts[:desc]
+        opts[:query] ||= opts[:search]
+        opts[:branch] ||= 'master'
+        opts[:public] ||= !opts[:private] unless opts[:public] = false # defaults to true
+      end
+
+      def instantiate hash
+        if res = contains(hash, @singulars)
+          new res
+        elsif res = contains(hash, @plurals)
+          res.map {|r| new r}
+        else
+          hash
+        end
+      end
+
+      def contains hash, keys
+        keys.inject(nil) {|memo, key| memo ||= hash[key.to_s]}
       end
     end
 
@@ -46,5 +83,10 @@ module GitHub
     def api
       self.class.api
     end
+
+    def to_s
+      name
+    end
+
   end
 end

data/lib/git_hub/commit.rb

@@ -0,0 +1,45 @@
+module GitHub
+  class Commit < Base
+
+    set_resource 'http://github.com/api/v2/yaml/commits', 'commit', ['commits', 'tags', 'branches']
+
+    attr_accessor :id, :author, :committer, :parents, :url, :committed_date, :authored_date, :message, :tree,
+                  #  :user, :name, :sha, :repo,
+                  # retrieving commit for a specific sha - "/show/#{opts[:user]}/#{opts[:repo]}/#{opts[:sha]}"
+                  :added, :modified, :removed
+    
+    def initialize opts
+      super
+      raise "Unable to initialize #{self.class} without id(sha)" unless sha
+    end
+
+    alias name id
+    alias name= id=
+    alias sha id
+    alias sha= id=
+
+    class << self
+      # Find commits, accepts Hash with keys:
+      # :user/:owner/:username:: Github user name
+      # :repo/:repository/:project:: Repo name
+      # :branch:: Repo branch - default 'master'
+      # :path:: For specific path
+      # :sha/:hash/:id:: Unique commit id (sha)
+      def find(opts)
+        normalize opts
+        raise "Unable to find Commits for #{opts}" unless opts[:user] && opts[:repo]
+        path = if opts[:sha]
+          "/show/#{opts[:user]}/#{opts[:repo]}/#{opts[:sha]}"
+        elsif opts[:path]
+          "/list/#{opts[:user]}/#{opts[:repo]}/#{opts[:branch]}/#{opts[:path]}"
+        else
+          "/list/#{opts[:user]}/#{opts[:repo]}/#{opts[:branch]}"
+        end
+        instantiate get(path)
+      end
+
+      #alias show find
+    end
+  end
+
+end

data/lib/git_hub/repo.rb

@@ -24,7 +24,7 @@ module GitHub
 #	twitter = username, password, digest
     }
 
-    base_uri 'http://github.com/api/v2/yaml/repos'
+    set_resource 'http://github.com/api/v2/yaml/repos', 'repository', 'repositories'
 
     attr_accessor :name, :owner, :description, :url, :homepage, :open_issues, :watchers, :forks, :fork, :private,
                   # additional attributes from search:
@@ -32,8 +32,8 @@ module GitHub
 
     def initialize options
       super
-      raise "Unable to initialize #{self.class} without name" unless @name
-      @url ||= "http://github.com/#{@owner}/#{@name}"
+      raise "Unable to initialize #{self.class} without name" unless user && name     
+      @url ||= "http://github.com/#{user}/#{name}"
       @type ||= "repo"
     end
 
@@ -41,6 +41,8 @@ module GitHub
     alias followers watchers
     alias username= owner=
     alias username owner
+    alias user= owner=
+    alias user owner
 
     def fork?;
       !!self.fork
@@ -51,71 +53,65 @@ module GitHub
     end
 
     def clone_url
-      url = private? || api.auth['login'] == self.owner ? "git@github.com:" : "git://github.com/"
-      url += "#{self.owner}/#{self.name}.git"
+      url = private? || api.auth['login'] == self.user ? "git@github.com:" : "git://github.com/"
+      url += "#{self.user}/#{self.name}.git"
+    end
+
+    def tags
+      result = get "/show/#{self.user}/#{self.name}/tags"
+      result['tags'] || result
+    end
+
+    def branches
+      result = get "/show/#{self.user}/#{self.name}/branches"
+      result['branches'] || result
+    end
+
+    def commits opts = {}
+       Commit.find opts.merge(:user => self.user, :repo => self.name)
     end
 
     class << self # Repo class methods
-      # Find repo(s) of a (valid) github user
-      # Accepts either options Hash (:owner/:user/:username and :repo/:repository/:project/:name)
-      # or several search terms as strings or symbols 
-      def find(*params)
-        if params.size == 1 && params.first.is_a?(Hash) # this is /show request
-          opts = params.first
-          owner = opts[:owner] || opts[:user] || opts[:username] || opts[:login] || api.auth['login'] || ''
-          repo = opts[:repo] || opts[:repository] || opts[:name] || opts[:project]
-          path = repo ? "/show/#{owner}/#{repo}" : "/show/#{owner}"
-        else # this is /search request, params are search terms
-          query = params.map(&:to_s).join('+')
-          path = "/search/#{query}"
-        end
-        result = get(path)
-        if result['repository']
-          new result['repository']
-        elsif result['repositories']
-          result['repositories'].map {|r| new r}
+
+      # Find repo(s) of a (valid) github user, accepts Hash with keys:
+      # :owner/:user/:username:: Github user name
+      # :repo/:repository/:project/:name:: Repo name
+      # :query/:search:: Array of search terms as Strings or Symbols
+      def find(opts)
+        normalize opts
+        path = if opts[:query]
+          "/search/#{opts[:query].map(&:to_s).join('+')}"
+        elsif opts[:user] && opts[:repo]
+          "/show/#{opts[:user]}/#{opts[:repo]}" 
+        elsif opts[:user]
+          "/show/#{opts[:user]}"
         else
-          result
+          raise "Unable to find #{self.class}(s) for #{opts}"
         end
+        instantiate get(path)
       end
 
       alias show find
       alias search find
 
       # Create new github repo, accepts Hash with :repo, :description, :homepage, :public/:private
-      # or repo name as a single parameter
-      def create(*params)
-        if params.size == 1 && params.first.is_a?(Hash)
-          opts = params.first
-          repo = opts[:repo] || opts[:repository] || opts[:name] || opts[:project]
-          description = opts[:description] || opts[:descr] || opts[:desc]
-          homepage = opts[:homepage]
-          public = opts[:public] || !opts[:private]  # default to true
-        else # repo name as a single parameter
-          repo = params.first.to_s
-          description = nil
-          homepage = nil
-          public = false
-        end
-        raise("Unable to create #{self.class} without authorization") unless api.authenticated?
-        result = post("/create", 'name' => repo, 'description' => description,
-                 'homepage' => homepage, 'public' => (public ? 1 : 0))
-        if result['repository']
-          new result['repository']
-        else
-          result
-        end
+      def create(opts)
+        normalize opts
+        api.ensure_auth opts
+        instantiate post("/create", 'name' => opts[:repo], 'description' => opts[:description],
+                             'homepage' => opts[:homepage], 'public' => (opts[:public] ? 1 : 0))  
       end
     end
 
-    # Delete github repo
-    def delete
-      result = post("/delete/#{@name}")
+    # Delete github repo, accepts optional Hash with authentication
+    def delete(opts = {})
+      api.ensure_auth opts
+      result = post("/delete/#{name}")
       if result['delete_token']
-        post("/delete/#{@name}", 'delete_token' => result['delete_token'])
+        post("/delete/#{name}", 'delete_token' => result['delete_token'])
       else
         result
-      end  
+      end
     end
 
     def add_service