git_hub 0.2.10 → 0.3.0

data/README.rdoc

@@ -18,29 +18,58 @@ Contributors always welcome!
   require 'git_hub'
   include GitHub
 
+=== General notes
+There is more than one way to name things, for example when looking for repository,
+following option keys have the same effect - :repository, :repo, :project.
+
+Most methods just retrieve the state of remote github objects. Any method that intends
+to CHANGE the state of remote objects, create or delete remote objects is followed by
+exclamation (create!, delete!, set!, add!, etc) and requires authentication.
+
+=== Authentication
+
+=== Repositories API
 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 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!
+
 Retrieve tags, branches and commits for a repo:
   puts repo.tags['v0.1.0'].committer
   puts repo.branches['master'].committed_date
-  repo.commits.each {|commit| p commit.author}
+  repo.commits(:branch=>'left').each {|commit| p commit.author}
+
+#tags and #branches return Hash of (latest) commits, with tag/branch name as keys.
+#commits returns an Array of commit objects for a given repo. If no options given,
+a whole set of commits for this repo is returned (this takes a while to load).
+
+=== Commits API
+You can work either with commit objects either directly, or via Repo API
 
-Retrieve info for a specific commit:
+Retrieve info for a specific commit or a set of commits:
+  commit = Commit.find(:user=>user_name, :repo=>repo_name, :sha=>'commit_sha')
   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']
   commit = repo.branches['master']  # returns most recent commit for a branch
 
-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
+=== Users API
+Find existing repos:
+  user = User.find(:user=>user_name)
+  search_users = User.find(:query=>['search','terms'])
+
+Retrieve/manage user's network:
+  user.followers.each {|githubber| p githubber.fullname}
+  user.following.each {|githubber| p githubber.fullname}
+  user.follow! :user=>githubber_name
+  user.unfollow! :user=>githubber_name
 
 == REQUIREMENTS:
 
@@ -50,6 +79,13 @@ Create new repo or delete existing repo (need to authenticate with your github c
 
   $ sudo gem install git_hub
 
+== PRIOR ART:
+
+  Le-Git - http://github.com/technicalpickles/le-git
+  Octopi - http://github.com/fcoury/octopi
+  Github-gem  - http://github.com/defunkt/github-gem
+  Github-control - http://github.com/halorgium/github-control
+
 == LICENSE:
 
 Copyright (c) 2009 Arvicco. See LICENSE for details

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gem.authors = ["arvicco"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency "cucumber", ">= 0"
+    gem.executables = ['git_hub']
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.2.10
+0.3.0

data/bin/git_hub

@@ -3,4 +3,5 @@
 require File.expand_path(File.join(File.dirname(__FILE__), %w[.. lib git_hub]))
 
 # Put your code here
+puts 'Nothing interesting here yet'
 

data/git_hub.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{git_hub}
-  s.version = "0.2.10"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["arvicco"]
-  s.date = %q{2010-01-14}
+  s.date = %q{2010-01-16}
   s.default_executable = %q{git_hub}
   s.description = %q{Simple interface to github API}
   s.email = %q{arvitallian@gmail.com}
@@ -32,46 +32,49 @@ Gem::Specification.new do |s|
      "lib/git_hub/api.rb",
      "lib/git_hub/base.rb",
      "lib/git_hub/commit.rb",
+     "lib/git_hub/extensions.rb",
      "lib/git_hub/repo.rb",
      "lib/git_hub/user.rb",
      "spec/git_hub/api_spec.rb",
      "spec/git_hub/base_spec.rb",
      "spec/git_hub/commit_spec.rb",
+     "spec/git_hub/extensions_spec.rb",
      "spec/git_hub/repo_spec.rb",
      "spec/git_hub/user_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
-     "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/3a70f86293b719f193f778a8710b1f83f2f7bf38.res",
-     "spec/stubs/commits/show/joe007/fine_repo/5e61f0687c40ca48214d09dc7ae2d0d0d8fbfeb8.res",
-     "spec/stubs/commits/show/joe007/fine_repo/f7f5dddaa37deacc83f1f56876e2b135389d03ab.res",
      "spec/stubs/http/users/follow.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/delete/new_repo.res",
-     "spec/stubs/repos/search/fine+repo.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",
-     "spec/stubs/user/follow/arvicco.res",
-     "spec/stubs/user/search/joe+007.res",
-     "spec/stubs/user/show/arvicco.res",
-     "spec/stubs/user/show/joe007.auth.res",
-     "spec/stubs/user/show/joe007.res",
-     "spec/stubs/user/show/joe007/followers.res",
-     "spec/stubs/user/show/joe007/following.empty.res",
-     "spec/stubs/user/show/joe007/following.res",
-     "spec/stubs/user/show/joe_is_not_github_user.res"
+     "spec/stubs/yaml/api_route_error.res",
+     "spec/stubs/yaml/commits/list/joe007/fine_repo/master.res",
+     "spec/stubs/yaml/commits/list/joe007/fine_repo/master/README.res",
+     "spec/stubs/yaml/commits/show/joe007/fine_repo/3a70f86293b719f193f778a8710b1f83f2f7bf38.res",
+     "spec/stubs/yaml/commits/show/joe007/fine_repo/5e61f0687c40ca48214d09dc7ae2d0d0d8fbfeb8.res",
+     "spec/stubs/yaml/commits/show/joe007/fine_repo/f7f5dddaa37deacc83f1f56876e2b135389d03ab.res",
+     "spec/stubs/yaml/repos/create.1.res",
+     "spec/stubs/yaml/repos/create.2.res",
+     "spec/stubs/yaml/repos/create.3.res",
+     "spec/stubs/yaml/repos/create.4.res",
+     "spec/stubs/yaml/repos/delete/new_repo.1.res",
+     "spec/stubs/yaml/repos/delete/new_repo.2.res",
+     "spec/stubs/yaml/repos/delete/new_repo.res",
+     "spec/stubs/yaml/repos/search/fine+repo.res",
+     "spec/stubs/yaml/repos/search/joe+repo.res",
+     "spec/stubs/yaml/repos/show/invalid_github_user/err_repo.res",
+     "spec/stubs/yaml/repos/show/joe007.res",
+     "spec/stubs/yaml/repos/show/joe007/err_repo.res",
+     "spec/stubs/yaml/repos/show/joe007/fine_repo.res",
+     "spec/stubs/yaml/repos/show/joe007/fine_repo/branches.res",
+     "spec/stubs/yaml/repos/show/joe007/fine_repo/tags.res",
+     "spec/stubs/yaml/repos/show/joe007/new_repo.res",
+     "spec/stubs/yaml/user/follow/arvicco.res",
+     "spec/stubs/yaml/user/search/joe+007.res",
+     "spec/stubs/yaml/user/show/arvicco.res",
+     "spec/stubs/yaml/user/show/invalid_github_user.res",
+     "spec/stubs/yaml/user/show/joe007.auth.res",
+     "spec/stubs/yaml/user/show/joe007.res",
+     "spec/stubs/yaml/user/show/joe007/followers.res",
+     "spec/stubs/yaml/user/show/joe007/following.empty.res",
+     "spec/stubs/yaml/user/show/joe007/following.res"
   ]
   s.homepage = %q{http://github.com/arvicco/git_hub}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -82,6 +85,7 @@ Gem::Specification.new do |s|
     "spec/git_hub/api_spec.rb",
      "spec/git_hub/base_spec.rb",
      "spec/git_hub/commit_spec.rb",
+     "spec/git_hub/extensions_spec.rb",
      "spec/git_hub/repo_spec.rb",
      "spec/git_hub/user_spec.rb",
      "spec/spec_helper.rb"

data/lib/git_hub.rb

@@ -27,11 +27,9 @@ module GitHub
   # in. Optionally, a specific _directory_ name can be passed in such that
   # the _filename_ does not have to be equivalent to the directory.
   #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(::File.join(::File.dirname(fname), dir, '**', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
+  def self.require_all_libs_relative_to( fname )
+    ruby_files = ::File.expand_path(::File.join(::File.dirname(fname), '**', '*.rb'))
+    Dir.glob(ruby_files).sort.each {|rb| require rb}
   end
 
 end  # module GitHub

data/lib/git_hub/api.rb

@@ -15,29 +15,24 @@ module GitHub
       auth != {}
     end
 
+    #TODO: need to fix it in terms of options and add tests
     def ensure_auth opts ={}
       return if authenticated?
-      @auth = {'login'=>opts[:login], 'token'=>opts[:token]}
-      raise("Authentication failed") unless authenticated?
+      login = opts[:login]
+      token = opts[:token]
+      raise("Authentication failed") unless login && token
+      @auth = {'login'=>login, 'token'=>token}
     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 }
-      klass.is_a?(Class) ? klass : nil
-    rescue NameError
-      nil
-    end
-
-    def request verb, url, params = {}
-      method = classify('Net::HTTP::' + verb.to_s.capitalize)
+    def request verb, url, data = {}
+      method = ('Net::HTTP::' + verb.to_s.capitalize).to_class
       uri = URI.parse url
       server = Net::HTTP.new(uri.host, uri.port)
       server.use_ssl = (uri.scheme == 'https')
       server.verify_mode = OpenSSL::SSL::VERIFY_NONE if server.use_ssl?
       server.start do |http|
         req = method.new(uri.path)
-        req.form_data = params.merge(auth)
+        req.form_data = data.merge(auth)
         http.request(req)
       end
     end

data/lib/git_hub/base.rb

@@ -1,6 +1,7 @@
 require 'yaml'
 
 module GitHub
+  API = Api.instance
   class Base
 
     def initialize(attributes={})
@@ -15,11 +16,9 @@ module GitHub
     end
 
     class << self
-      def request verb, uri, params = {}
+      def request verb, uri, data = {}
         full_uri = uri[0] == '/' ? base_uri+uri : uri
-        #p "request: #{verb} #{full_uri} #{params}"
-        res = api.request verb, full_uri, params
-        #p "response: #{res}: #{res.code}: #{res.http_version}: #{res.message}", res.body
+        res = API.request verb, full_uri, data
         if res.respond_to?(:content_type, :body) && res.content_type =~ /application\/x-yaml/
           YAML::load(res.body)
         else
@@ -27,22 +26,18 @@ module GitHub
         end
       end
 
-      def get uri, params ={}
-        request :get, uri, params
+      def get uri, data = {}
+        request :get, uri, data
       end
 
-      def post uri, params = {}
-        request :post, uri, params
+      def post uri, data = {}
+        request :post, uri, data
       end
 
-      def api
-        Api.instance
-      end
-
-      def set_resource base_uri, singulars, plurals
+      def set_resource base_uri, singular, plural
         @base_uri = base_uri
-        @singulars = [singulars].flatten
-        @plurals = [plurals].flatten
+        @singular = singular.to_s
+        @plural = plural.to_s
       end
 
       def base_uri
@@ -61,56 +56,63 @@ module GitHub
 
       private
 
-      # extracts arguments described by *args from an opts Hash
+      # matches arguments supplied by args Array to parameters specified by *params Array of Symbols
       # TODO: replace opts[:name] with class-specific opts[:@singular]?
-      def extract(opts, *args)
-        raise "Expected options Hash, got #{opts}" unless opts.kind_of? Hash
-        args.map do |arg|
-          opts[arg] || opts[arg.to_sym] || case arg.to_sym
+      def extract(args, *params)
+        args, opts = args.args_and_opts
+        name = extract_value opts, :name
+        opts.merge!(@singular.to_sym => name ) if name
+        params.map do |param| #                 for every symbol in params Array:
+          arg = args.next rescue nil #            try to assign sequential argument from args
+          arg ||= extract_value opts, param #     try to assign named argument from opts
+          arg || case param #                     assign defaults if no other value found
             when :user
-              opts[:owner] || opts[:username] || opts[:login] || api.auth['login']
-            when :repo
-              opts[:repository] || opts[:name] || opts[:project]
-            when :sha
-              opts[:hash] || opts[:object_id] || opts[:id]
-            when :desc
-              opts[:description] || opts[:descr]
-            when :query
-              opts[:search]
+              API.auth['login']
             when :branch
               'master'
             when :public
-              !opts[:private] unless opts[:public] == false
+              !extract_value(opts, :private) unless arg == false
             else
-              nil
+              nil #                               no default found, parameter is nil
           end
         end
       end
 
+      NICKNAMES = { :user => [:owner, :username, :login],
+                    :repo => [:repository, :project],
+                    :sha => [:id, :object_id, :hash],
+                    :desc => [:description, :descr],
+                    :query => :search }
+
+      # extracts from opts value indexed by param or any of its nicknames
+      def extract_value opts, param
+        nicks = [param, NICKNAMES[param]].flatten.compact
+        opts.values_at(*nicks+nicks.map(&:to_s)).compact.first
+      end
+
       # Creates single instance or Array of instances for a given Hash of
       # attribute Hash(es), returns original Hash if unsuccessful
       def instantiate hash, extra_attributes={}
         return hash unless hash.kind_of? Hash
-        if init = hash.values_at(*@singulars).compact.first
+#        init = hash.values_at(*@singulars).compact.first
+        init = hash[@singular]
+        inits = hash[@plural]
+        if init
           new init.merge extra_attributes
-        elsif inits = hash.values_at(*@plurals).compact.first
-          inits.map {|init| new init.merge extra_attributes}
+        elsif inits
+          inits.map {|each| new each.merge extra_attributes}
         else
           hash
         end
       end
     end
 
-    def get uri, params ={}
-      self.class.get uri, params
-    end
-
-    def post uri, params ={}
-      self.class.post uri, params
+    def get uri, data = {}
+      self.class.get uri, data
     end
 
-    def api
-      self.class.api
+    def post uri, data = {}
+      self.class.post uri, data
     end
 
     def to_s

data/lib/git_hub/commit.rb

@@ -3,17 +3,19 @@ module GitHub
 
     set_resource 'http://github.com/api/v2/yaml/commits', 'commit', 'commits'
 
-    attr_accessor :id, :author, :committer, :parents, :url, :committed_date, :authored_date, :message, :tree,
+    attr_accessor :id, :author, :committer, :parents, :url, :committed, :authored, :message, :tree,
                   # retrieving commit for a specific sha - "/show/:user/:repo/:sha" adds:
                   :added, :modified, :removed,
                   # extra attributes:
                   :user, :repo
 
-    aliases_for :id => [:sha, :name]
+    aliases_for :id => [:sha, :name], :committed => :committed_date, :authored => :authored_date
 
     def initialize(opts)
       super
       raise "Unable to initialize #{self.class} without id(sha)" unless sha
+      @committed = Time.parse(@committed) unless @committed.is_a?(Time)
+      @authored = Time.parse(@authored) unless @authored.is_a?(Time)
     end
 
     class << self
@@ -23,8 +25,8 @@ module GitHub
       # :branch:: Only commits for specific branch - default 'master'
       # :path:: Only commits for specific path
       # :sha/:id:: Only one commit with specific id (sha)
-      def find(opts)
-        user, repo, branch, sha, path = extract opts, :user, :repo, :branch, :sha, :path 
+      def find( *args )
+        user, repo, branch, sha, path = extract args, :user, :repo, :branch, :sha, :path 
         repo_given = branch && user && repo
         path = if sha && repo_given
           "/show/#{user}/#{repo}/#{sha}"

data/lib/git_hub/extensions.rb

@@ -0,0 +1,25 @@
+class String
+  # Turns string into appropriate class constant, returns nil if class not found
+  def to_class
+    klass = self.split("::").inject(Kernel) do |namespace, const|
+      const == '' ? namespace : namespace.const_get(const)
+    end
+    klass.is_a?(Class) ? klass : nil
+  rescue NameError
+    nil
+  end
+end
+
+class Array
+
+  # Splits (arguments) Array into two components: enum for args and options Hash
+  # options Hash (if any) should be the last component of Array
+  def args_and_opts 
+      opts = self.last
+      if opts.is_a?(Hash)
+        [self[0..-2].to_enum, opts]
+      else
+        [self.to_enum, {}]
+      end
+    end
+end