hubmaster 0.0.06 → 0.0.07

data/README.md

@@ -1,7 +1,19 @@
 # Hubmaster
 
-Hubmaster is a rubygem that allows GitHub API interaction in Terminal. The current version only permit repository interactions (list, create, delete), but feel free to fork and contribute!
+Hubmaster is a rubygem that allows GitHub API interaction in Terminal. The current version only permits repository interactions, but feel free to fork and contribute!
 
+## Table of Contents
+
+* [Installation](#install)
+* [Overview](#overview)
+* [Repository Documentation](#repos)
+    * [List](#reposList)
+    * [Get](#reposGet)
+    * [Create](#reposCreate)
+    * [Edit](#reposEdit)
+    * [Delete](#reposDelete)
+
+<a name="install"/>
 ## Installation
 
 To use as a library, add this line to your application's Gemfile:
@@ -16,39 +28,48 @@ To use as a command line tool, run:
 
     sudo gem install hubmaster
 
-## Usage
+<a name="overview"/>
+## Overview
+
+Hubmaster is a library written in ruby that makes interfacing with github a snap! In adition to being a library, hubmaster also includes an executable 
+command line tool that allows github web operations to be carried out in terminal. The rest of the document details how hubmaster should be used, but there are a few things to note beforehand.
 
-The general form for executing commands is `hub repos --modifier [params]`. All parameters that include spaces must be encased in quotes.
+1. The general form for executing commands is `hub repos --modifier [params]`. All parameters that include spaces must be encased in quotes.
 
-**BEWARE:** For the purposes of this document, when words are surrounded by brackets, the indicated value should be placed there **without brackets**.
+2. **BEWARE:** For the purposes of this document, when words are surrounded by brackets, the indicated value should be placed there **without brackets**.
 
-***
+<a name="repos"/>
+## Repository Documentation
+
+This section of the documentation includes all the necessary information on interfacing with repositories through hubmaster. 
+There are five main functions that will be described in further detail: List, Get, Create, Edit, and Delete.
+
+<a name="reposList"/>
+### List
 
 To list all repositories under your account:
 
     hub repos --list
 
-***
 
 To list all repositories under someone elses account:
 
     hub repos --list [username]
 
-***
+<a name="reposGet">
+### Get
+
+
+<a name="reposCreate"/>
+### Create
 
 To create a new repository:
 
     hub repos --create [name] "[description]"
   *Additionaly this command can be run with no parameters and you will be prompted for them later.*
 
-***
-
-To delete an existing repository:
-
-    hub repos --delete [name]
-  *Andy you will be asked to confirm by typing the name of the repository specified.*
-
-***
+<a name="reposEdit"/>
+### Edit
 
 To edit an existing repository:
 
@@ -60,3 +81,13 @@ To edit an existing repository:
   Finally, you can either specify the change now or be prompted for it later.*
 
 **REMEMBER: IF ANY PARAMETERS INCLUDE SPACES, THEY MUST BE ENCASED IN QUOTES**
+
+<a name="reposDelete"/>
+### Delete
+
+To delete an existing repository:
+
+    hub repos --delete [name]
+  *Andy you will be asked to confirm by typing the name of the repository specified.*
+
+

data/bin/hub

@@ -17,7 +17,25 @@ if ARGV.length > 0
           Github::Repos.delete(ARGV[2])
         when "--get"
           Github.connect
-          Github::Repos.get(ARGV[2], ARGV[3])
+
+          case ARGV[2]
+          when "-contributers", "-contribs"
+            Github::Repos.get(ARGV[3], ARGV[4], :contributers)
+          when "-repo", "-repository"
+            Github::Repos.get(ARGV[3], ARGV[4], :repository)
+          when "-langs", "-languages"
+            Github::Repos.get(ARGV[3], ARGV[4], :languages)
+          when "-teams"
+            Github::Repos.get(ARGV[3], ARGV[4], :teams)
+          when "-tags"
+            Github::Repos.get(ARGV[3], ARGV[4], :tags)
+          when "-branches"
+            Github::Repos.get(ARGV[3], ARGV[4], :branches)
+          when "-branch"
+            Github::Repos.get(ARGV[3], ARGV[4], :branch, ARGV[5])
+          else
+            puts "Unknown modifier for get '#{ARGV[2]}'. Tyle hub help for assistance."
+          end  
         when "--edit"
           Github.connect
           case ARGV[3]

data/lib/hubmaster.rb

@@ -10,28 +10,3 @@ require File.expand_path(File.join(File.dirname(__FILE__), "hubmaster", "base.rb
 require File.expand_path(File.join(File.dirname(__FILE__), "hubmaster", "repo.rb"))
 require File.expand_path(File.join(File.dirname(__FILE__), "hubmaster", "cipher.rb"))
 
-def run_pager
-  return if RUBY_PLATFORM =~ /win32/
-  return unless STDOUT.tty?
-  
-  read, write = IO.pipe
-  
-  unless Kernel.fork # Child process
-    STDOUT.reopen(write)
-    STDERR.reopen(write) if STDERR.tty?
-    read.close
-    write.close
-    return
-  end
-  
-  STDIN.reopen(read)
-  read.close
-  write.close
-
-  ENV['LESS'] = 'FSRX' # Don't page if the input is short enough
-
-  Kernel.select [STDIN] # Wait until we have input before we start the pager
-  pager = ENV['PAGER'] || 'less'
-  exec pager rescue exec "/bin/sh", "-c", pager
-end
-

data/lib/hubmaster/base.rb

@@ -1,6 +1,5 @@
 module Github
   def self.connect
-    run_pager
     if File.exists? "#{Dir.home}/.hubmaster"
       content = []
       File.open("#{Dir.home}/.hubmaster", "rb") do |fileC|

data/lib/hubmaster/repo.rb

@@ -117,14 +117,142 @@ module Github
       puts ""
     end
 
-    def self.get(owner, name)
-      if !name.nil?
-        if owner == "self"
-          request = Github.makeGetRequest("/repos/#{Github.user}/#{name}")  
-        else
-          request = Github.makeGetRequest("/repos/#{owner}/#{name}")  
+    def self.get(owner, name, operator, branch = nil)
+      owner = Github.user if owner == "self"
+
+      if owner.nil?
+        print "Name of owner: "
+        owner = STDIN.gets.chomp
+      end
+      
+      if name.nil? 
+        print "Name of repository: "
+        name = STDIN.gets.chomp
+      end
+
+      case operator
+      when :contributers
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}/contributors")  
+        response = JSON.parse(request)
+
+        if response.kind_of?(Array)
+          response.each do |contributer|
+            puts "User #{contributer["login"]}"
+            puts " - URL: #{contributer["url"]}"
+            puts " - Contributions #{contributer["contributions"]}"
+            puts ""
+          end
+        elsif !response["errors"].nil?
+          puts "ERROR: #{response['errors'][0]['message']}"
+          puts ""
+        elsif !response["message"].nil?
+          puts "ERROR: #{response["message"]}"
+          puts ""
         end
+      when :languages
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}/languages")  
+        response = JSON.parse(request)
 
+        if response["errors"].nil? && response["message"].nil?
+          response.each do |language, bytes|
+            puts "#{bytes} bytes written in #{language}."
+            puts ""
+          end
+        elsif !response["errors"].nil?
+          puts "ERROR: #{response['errors'][0]['message']}"
+          puts ""
+        elsif !response["message"].nil?
+          puts "ERROR: #{response["message"]}"
+          puts ""
+        end
+      when :teams #UNTESTED METHOD BECAUSE I DONT KNOW ANY EXAMPLES
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}/teams")  
+        response = JSON.parse(request)
+
+        if response.kind_of?(Array)
+          response.each do |team|
+            puts "Team: #{team["name"]}"
+            puts " - URL: #{team["url"]}"
+            puts ""
+          end
+        elsif !response["errors"].nil?
+          puts "ERROR: #{response['errors'][0]['message']}"
+          puts ""
+        elsif !response["message"].nil?
+          puts "ERROR: #{response["message"]}"
+          puts ""
+        end
+      when :tags 
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}/tags")  
+        response = JSON.parse(request)
+
+        if response.kind_of?(Array)
+          response.each do |tag|
+            puts "Tag Name: #{tag["name"]}"
+            puts " - Commit URL: #{tag["commit"]["url"]}"
+            puts " - Commit SHA: #{tag["commit"]["sha"]}"
+            puts ""
+          end
+        elsif !response["errors"].nil?
+          puts "ERROR: #{response['errors'][0]['message']}"
+          puts ""
+        elsif !response["message"].nil?
+          puts "ERROR: #{response["message"]}"
+          puts ""
+        end
+      when :branches 
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}/branches")  
+        response = JSON.parse(request)
+
+        if response.kind_of?(Array)
+          response.each do |branch|
+            puts "Branch Name: #{branch["name"]}"
+            puts " - Commit URL: #{branch["commit"]["url"]}"
+            puts " - Commit SHA: #{branch["commit"]["sha"]}"
+            puts ""
+          end
+        elsif !response["errors"].nil?
+          puts "ERROR: #{response['errors'][0]['message']}"
+          puts ""
+        elsif !response["message"].nil?
+          puts "ERROR: #{response["message"]}"
+          puts ""
+        end
+      when :branch
+        if branch.nil?
+          print "Branch to view: "
+          branch = STDIN.gets.chomp
+        end
+
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}/branches/#{branch}")  
+        response = JSON.parse(request)
+        
+        if response["errors"].nil? && response["message"].nil?
+          puts "Branch Name: #{response['name']}"  
+          puts " - Commit SHA: #{response["commit"]["sha"]}"
+          puts " - Message: #{response["commit"]["commit"]["message"]}"
+          puts " - Author: #{response["commit"]["author"]["login"]}"
+          puts "   - Author Name: #{response["commit"]["commit"]["author"]["name"]}"
+          puts "   - Author Email: #{response["commit"]["commit"]["author"]["email"]}"
+          
+          if response["commit"]["committer"]["login"] != response["commit"]["author"]["login"]
+            puts " - Commiter: #{response["commit"]["committer"]["login"]}"
+            puts "   - Commiter Name: #{response["commit"]["commit"]["committer"]["name"]}"
+            puts "   - Commiter Email: #{response["commit"]["commit"]["committer"]["email"]}"
+          end
+
+          puts " - Parents:"
+          response["commit"]["parents"].each do |parent|
+            puts "   - Parent SHA: #{parent["sha"]}"
+          end
+        elsif !response["errors"].nil?
+          puts "ERROR: #{response['errors'][0]['message']}"
+        elsif !response["message"].nil?
+          puts "ERROR: #{response["message"]}"
+        end
+        puts ""
+      when :repository
+        request = Github.makeGetRequest("/repos/#{owner}/#{name}")  
         response = JSON.parse(request)
         
         if response["errors"].nil? && response["message"].nil?
@@ -151,9 +279,6 @@ module Github
         elsif !response["message"].nil?
           puts "ERROR: #{response["message"]}"
         end
-         puts ""
-      else
-        puts "A repository name must be specified."
         puts ""
       end      
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 class Github
-  VERSION = "0.0.06"
+  VERSION = "0.0.07"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubmaster
 version: !ruby/object:Gem::Version
-  version: 0.0.06
+  version: 0.0.07
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-09 00:00:00.000000000 Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline