hubmaster 0.0.08 → 0.0.09

data/README.md

@@ -6,12 +6,17 @@ Hubmaster is a rubygem that allows GitHub API interaction in Terminal. The curre
 
 * [Installation](#install)
 * [Overview](#overview)
+* [Authentication Documentation](#authdoc)
+  * [Basic Authentication](#basicauth)
+  * [Stored Basic Authentication](#sbasicauth)
+  * [OAuth 2.0](#oauth)
+  * [Resetting Login](#reset)
 * [Repository Documentation](#repos)
-    * [List](#reposList)
-    * [Get](#reposGet)
-    * [Create](#reposCreate)
-    * [Edit](#reposEdit)
-    * [Delete](#reposDelete)
+  * [List](#reposList)
+  * [Get](#reposGet)
+  * [Create](#reposCreate)
+  * [Edit](#reposEdit)
+  * [Delete](#reposDelete)
 
 <a name="install"/>
 ## Installation
@@ -34,9 +39,58 @@ To use as a command line tool, run:
 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.
 
-1. 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 [class] --modifier [params]`. All parameters that include spaces must be encased in quotes.
 
-2. **BEWARE:** For the purposes of this document, when words are surrounded by brackets, the indicated value should be placed there **without brackets**.
+2. Any parameter that you ommit, you will be prompted for later. This can be helpful when dealing with multi-word parameters or absent-mindedness.
+
+**BEWARE:** For the purposes of this document, when words are surrounded by brackets, the indicated value should be placed there **without brackets**.
+<a name="authdoc"/>
+## Authentication Documentation
+
+Hubmaster allows you to connect in several different ways to your Github account. You can use basic auth, stored bashic auth, or OAuth 2.0.
+We do suggest, however, that you use OAuth 2.0 over stored basic authentication because it is more secure.
+
+<a name="basicauth"/>
+### Basic Authentication
+***
+
+If you only want to use basic authentication without storing information for later use, you dont have to do anything. If you just execute
+the desired command, you will be automatically prompted for your login information.
+
+<a name="sbasicauth"/>
+### Stored Basic Authentication
+***
+
+If you want to use basic authentication but store your login information, run the following:
+
+    hub login --new -basic [optional username]
+
+  *If you don't include your username as a parameter, you will be prompted for it later*
+
+**Note:** this method of storing your information makes you vulnerable should someone gain access to your computer.
+Your username and password will both be saved in a hidden file. Your password will be sent through a cipher first, 
+but the cipher is **easily** crackable. The prefered method for saving login data is through OAuth.
+
+<a name="oauth"/>
+### OAuth 2.0
+***
+
+To add a new login using OAuth 2.0, just run:
+
+    hub login --new -oauth [optional username]
+  *If you don't include your username as a parameter, you will be prompted for it later*
+
+OAuth is the most secure method of saving your login for later use because it doesnt actually save your credentials.
+Instead, hubmaster generates and saves a OAuth token which is passed to Github and grants authorization to the program.
+The privelages associated with this token can be revoked at any time from github.com (or from hubmaster in the future).
+
+<a name="reset">
+### Resetting Login
+***
+
+If you ever accidentally input your login information incorrectly or change your password (basic auth), you can allways reset your login by running the following:
+
+    hub login --reset -[basic or oauth] [optional username]
 
 <a name="repos"/>
 ## Repository Documentation
@@ -46,48 +100,138 @@ There are five main functions that will be described in further detail: List, Ge
 
 <a name="reposList"/>
 ### List
+***
+
+The list function provides an easy way to see both your repositories, or the repositories of someone you know. 
 
-To list all repositories under your account:
+To list all of the repositories associated with your account, you would execute:
 
     hub repos --list
 
 
-To list all repositories under someone elses account:
+To list all of the repositories linked with someone elses account, you would execute:
 
     hub repos --list [username]
 
+**Remember:** In place of "[username]" you should place the username of the person whos repositories you would like to see.
+
 <a name="reposGet">
-### Get
+### Get 
+***
+
+The "get" function carries out operations that refer to a single repository. There are 7 simple modifiers bundled within this function that do the following:
+
+1. [List the contributors of a repository,](#getC)
+2. [List the languages used in a repository,](#getL)
+3. [List the teams associated with a repository,](#getT)
+4. [List the tags of a repository,](#getTags)
+5. [List the various branches of a repository,](#getBs)
+6. [Return information on a specific branch, and](#getB)
+7. [Return information on a specific repository.](#getR)
+
+The general form for making get requests is as follows:
+
+    hub repos --get -operator [user] [repository name] [sometimes branch]
+
+If you wish to get information on one of your own repositories, either use your login or "self" for the [user] parameter
+
+<a name="getC"/>
+#### Get Contributors
+***
 
+To list all of the contributors for a specific repository, execute the following:
+
+    hub repos --get -contributors [user] [repository name]
+
+<a name="getL"/>
+#### Get Languages
+***
+
+To display all of the languages used and how many bits of each were used, the following can be used:
+
+    hub repos --get -languages [user] [repository name]
+
+<a name="getT"/>
+#### Get Teams
+***
+
+To show all of the teams associated with a specific repository, run:
+
+    hub repos --get -teams [user] [repository name]
+
+<a name="getTags"/>
+#### Get Tags
+***
+
+If you want to find all of the tags for a given repository, type:
+
+    hub repos --get -tags [user] [repository name]
+
+<a name="getBs"/>
+#### Get Branches
+***
+
+To list all of branches under a given repository, run:
+    
+    hub repos --get -branches [user] [repository name]
+
+<a name="getB"/>
+#### Get Branch
+***
+
+If you want to get information on a specific branch of a repository, use:
+
+    hub repos --get -branch [user] [repository name] [branch name]
+
+<a name="getR"/>
+#### Get Repository
+***
+
+To get information on a specific repository, all you need to do is execute:
+
+    hub repos --get -repository [user] [repository name]
 
 <a name="reposCreate"/>
 ### Create
+***
 
-To create a new repository:
+Creating repositories from terminal is both extreemly easy and usefull.
 
-    hub repos --create [name] "[description]"
-  *Additionaly this command can be run with no parameters and you will be prompted for them later.*
+To create a new repository, all you have to do is run:
+
+    hub repos --create [name] [description]
+
+If the description of your repository contains multiple words (usually they do), you have two options:
+
+1. Encase the description in quotes
+2. Execute the command with no description parameter and you will be prompted for it later.
 
 <a name="reposEdit"/>
 ### Edit
+***
 
-To edit an existing repository:
+If you wish to edit an existing repository, the general form is as follows:
 
     hub repos --edit [name] -option [option dependent variable]
 
-  *The edit command takes several parameters and can be kind of confusing. First you specify
-  the name of the repository you would like to edit, followed by the part you would like to edit.
-  Currently all that can be edited is the the description, so the '-option' would look like '-description'.
-  Finally, you can either specify the change now or be prompted for it later.*
+The edit command takes several parameters and can be kind of canfusing, so let me break it down a bit for you:
+
+1. Identify the name of the repository you wish to edit -> [name].
+
+2. Specify an option, or element, that you wish to edit -> -option.
+
+3. Provide the new value for the element that you specified in step two -> [option dependent variable]
 
-**REMEMBER: IF ANY PARAMETERS INCLUDE SPACES, THEY MUST BE ENCASED IN QUOTES**
+*The edit command only allows you to modify the description of a repository at this time. An description specific example of this would look like:
+ `hub repos --edit [name] -description [description]`*
 
 <a name="reposDelete"/>
 ### Delete
+***
 
-To delete an existing repository:
+If you wish to delete an existing repository, all you have to do is:
 
     hub repos --delete [name]
-  *Andy you will be asked to confirm by typing the name of the repository specified.*
 
+To confirm that you do in fact wish to delete this repository, you will be prompted to enter the name of the repository again.
 

data/bin/hub

@@ -19,8 +19,8 @@ if ARGV.length > 0
           Github.connect
 
           case ARGV[2]
-          when "-contributers", "-contribs"
-            Github::Repos.get(ARGV[3], ARGV[4], :contributers)
+          when "-contributors", "-contribs"
+            Github::Repos.get(ARGV[3], ARGV[4], :contributors)
           when "-repo", "-repository"
             Github::Repos.get(ARGV[3], ARGV[4], :repository)
           when "-langs", "-languages"
@@ -51,9 +51,28 @@ if ARGV.length > 0
       Github.help
     when "login"
       case ARGV[1]
+      when "--new"
+        if ARGV[2] == "-basic"
+          Github::Login.create(:basic) if ARGV[3].nil?
+          Github::Login.create(:basic, ARGV[3]) unless ARGV[3].nil?
+        elsif ARGV[2] == "-oauth"
+          Github::Login.create(:oauth) if ARGV[3].nil?
+          Github::Login.create(:oauth, ARGV[3]) unless ARGV[3].nil?
+        else
+           puts "Unknown modifier for login '#{ARGV[2]}'. Tyle hub help for assistance."
+        end
       when "--reset"
-        Github.resetLogin
+        if ARGV[2] == "-basic"
+          Github::Login.create(:basic) if ARGV[3].nil?
+          Github::Login.create(:basic, ARGV[3]) unless ARGV[3].nil?
+        elsif ARGV[2] == "-oauth"
+          Github::Login.create(:oauth) if ARGV[3].nil?
+          Github::Login.create(:oauth, ARGV[3]) unless ARGV[3].nil?
+        else
+           puts "Unknown modifier for login '#{ARGV[2]}'. Tyle hub help for assistance."
+        end
       else
+        puts "Unknown Command: Type hub help for usage instructions."
       end
     else
       puts "Unknown Command: Type hub help for usage instructions."

data/hubmaster.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Tommy Schaefer"]
   gem.email         = ["me@tommyschaefer.net"]
-  gem.description   = %q{Hubmaster is a tool built in ruby that allows github interactions to be made outside the browser.}
-  gem.summary       = %q{Hubmaster is simple and easy to use. Visit the github page for more details.}
+  gem.description   = %q{Hubmaster is a tool built in Ruby that allows Github interactions to be made outside the browser.}
+  gem.summary       = %q{Hubmaster is simple and easy to use. Visit the Github page for more details.}
   gem.homepage      = "https://github.com/tommyschaefer/hubmaster"
 
   gem.files         = `git ls-files`.split($\)

data/lib/hubmaster.rb

@@ -10,6 +10,7 @@ require 'uri'
 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"))
+require File.expand_path(File.join(File.dirname(__FILE__), "hubmaster", "login.rb"))
 
 def putLess(array)
   string = array.join("\n")

data/lib/hubmaster/base.rb

@@ -1,30 +1,25 @@
 module Github
   def self.connect
     if File.exists? "#{Dir.home}/.hubmaster"
-      content = []
-      File.open("#{Dir.home}/.hubmaster", "rb") do |fileC|
-        while (line = fileC.gets)
-          content << line.gsub("\n", "")
-        end
-      end
+      line1 = File.open("#{Dir.home}/.hubmaster").first.gsub("\n", "")
 
-      @user = content[0]
-      @pass = Github::Cipher.new.decrypt(content[1])
+      if line1 == "basic"
+        auth = Github::Login.authenticate(:basic)
+        @user = auth[0]
+        @pass = auth[1]
+      elsif line1 == "oauth"
+        auth = Github::Login.authenticate(:oauth)
+        @user = auth[0]
+        @token = auth[1]  
+      end
     else
-      print "Username: "
-      @user = STDIN.gets.chomp
-      @pass = ask("Password: ") {|q| q.echo = "*"}
-      File.open("#{Dir.home}/.hubmaster", "w") {|f| f.write("#{@user}\n#{@pass = Github::Cipher.new.encrypt(@pass)}")}
-    end
-
-    return nil
-  end
+      puts "No login file was detected. To add one, use hub login --new. Unstored basic auth will be used at this point."
+      puts ""
 
-  def self.resetLogin
-    print "Username: "
-    @user = STDIN.gets.chomp
-    @pass = ask("Password: ") {|q| q.echo = "*"}
-    File.open("#{Dir.home}/.hubmaster", "w") {|f| f.write("#{@user}\n#{@pass = Github::Cipher.new.encrypt(@pass)}")}
+      auth = Github::Login.basic
+      @user = auth[0]
+      @pass = auth[1]
+    end
     return nil
   end
 
@@ -32,16 +27,34 @@ module Github
     return @user
   end
 
-  def self.makeGetRequest(path, username = @user, password = @pass, server = "api.github.com")
+  def self.makeGetRequest(path, username = @user, password = @pass, token = @token, server = "api.github.com")
+    if password.nil?
+      http = Net::HTTP.new(server, 443)
+      req = Net::HTTP::Get.new("#{path}?access_token=#{token}") if path.include?("?") == false
+      req = Net::HTTP::Get.new("#{path}&&access_token=#{token}") if path.include?("?") == true
+      http.use_ssl = true
+      response = http.request(req)
+      return response.body
+    else 
       http = Net::HTTP.new(server,443)
       req = Net::HTTP::Get.new(path)
       http.use_ssl = true
       req.basic_auth username, password
       response = http.request(req)
       return response.body
+    end
   end
 
-  def self.makePostRequest(path, body, username = @user, password = @pass, server = "api.github.com")
+  def self.makePostRequest(path, body, username = @user, password = @pass, token = @token, server = "api.github.com")
+    if password.nil?
+      http = Net::HTTP.new(server,443)
+      req = Net::HTTP::Post.new("#{path}?access_token=#{token}") if path.include?("?") == false
+      req = Net::HTTP::Post.new("#{path}&&access_token=#{token}") if path.include?("?") == true
+      http.use_ssl = true
+      req.body = body
+      response = http.request(req)
+      return response.body
+    else
       http = Net::HTTP.new(server,443)
       req = Net::HTTP::Post.new(path)
       http.use_ssl = true
@@ -49,18 +62,37 @@ module Github
       req.body = body
       response = http.request(req)
       return response.body
+    end
   end
 
-  def self.makeDeleteRequest(path, username = @user, password = @pass, server = "api.github.com")
+  def self.makeDeleteRequest(path, username = @user, password = @pass, token = @token, server = "api.github.com")
+    if password.nil?
+      http = Net::HTTP.new(server,443)
+      req = Net::HTTP::Delete.new("#{path}?access_token=#{token}") if path.include?("?") == false
+      req = Net::HTTP::Delete.new("#{path}&&access_token=#{token}") if path.include?("?") == true
+      http.use_ssl = true
+      response = http.request(req)
+      return response.body
+    else
       http = Net::HTTP.new(server,443)
       req = Net::HTTP::Delete.new(path)
       http.use_ssl = true
       req.basic_auth username, password
       response = http.request(req)
       return response.body
+    end
   end
 
-  def self.makeEditRequest(path, body, username = @user, password = @pass, server = "api.github.com")
+  def self.makeEditRequest(path, body, username = @user, password = @pass, token = @token, server = "api.github.com")
+    if password.nil?
+      http = Net::HTTP.new(server,443)
+      req = Net::HTTP::Post.new("#{path}?access_token=#{token}") if path.include?("?") == false
+      req = Net::HTTP::Post.new("#{path}&&access_token=#{token}") if path.include?("?") == true
+      http.use_ssl = true
+      req.body = body
+      response = http.request(req)
+      return response.body
+    else
       http = Net::HTTP.new(server,443)
       req = Net::HTTP::Post.new(path)
       http.use_ssl = true
@@ -68,8 +100,8 @@ module Github
       req.body = body
       response = http.request(req)
       return response.body
+    end
   end
-
   def self.help
     puts "Hubmaster Help: "
   end

data/lib/hubmaster/login.rb

@@ -0,0 +1,69 @@
+module Github
+  class Login
+    def self.create(type, username = nil)
+      if username.nil?  
+        print "Username: " 
+        @user = STDIN.gets.chomp
+      else
+        @user = username
+      end
+      
+      @pass = ask("Password: ") {|q| q.echo = "*"}
+
+      if type == :basic
+        File.open("#{Dir.home}/.hubmaster", "w") {|f| f.write("basic\n#{@user}\n#{@pass = Github::Cipher.new.encrypt(@pass)}")}
+      elsif type == :oauth
+        jsonHash = {"note" => "Token for hubmaster", "scopes" => ["user", "public_repo", "repo", "repo:status", "delete_repo", "notifications", "gist"]}.to_json
+        request = Github.makePostRequest("/authorizations", jsonHash, @user, @pass)
+      
+        response = JSON.parse(request)
+
+        @token = response["token"]
+
+        File.open("#{Dir.home}/.hubmaster", "w") {|f| f.write("oauth\n#{@user}\n#{@token}")}
+      end
+    end
+
+    def self.authenticate(type)
+      if !File.exists?("#{Dir.home}/.hubmaster")
+        puts "A login file was not detected. Please use 'hub login --new' to create a new one"
+        puts ""
+      else
+        if type == :basic
+          content = []
+
+          File.open("#{Dir.home}/.hubmaster", "rb") do |fileC|
+            while (line = fileC.gets)
+              content << line.gsub("\n", "")
+            end
+          end
+
+          @user = content[1]
+          @pass = Github::Cipher.new.decrypt(content[2])
+
+          return [@user, @pass]
+        elsif type == :oauth
+          content = []
+
+          File.open("#{Dir.home}/.hubmaster", "rb") do |fileC|
+            while (line = fileC.gets)
+              content << line.gsub("\n", "")
+            end
+          end
+
+          @user = content[1]
+          @token = content[2]
+
+          return [@user, @token]
+        end
+      end
+    end
+
+    def self.basic
+      print "Username: "
+      @user = STDIN.gets.chomp
+      @pass = ask("Password: ") {|q| q.echo = "*"}
+      return [@user, @pass]
+    end
+  end
+end

data/lib/hubmaster/repo.rb

@@ -137,7 +137,7 @@ module Github
       end
 
       case operator
-      when :contributers
+      when :contributors
         request = Github.makeGetRequest("/repos/#{owner}/#{name}/contributors")  
         response = JSON.parse(request)
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 class Github
-  VERSION = "0.0.08"
+  VERSION = "0.0.09"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubmaster
 version: !ruby/object:Gem::Version
-  version: 0.0.08
+  version: 0.0.09
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-10 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
@@ -43,7 +43,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Hubmaster is a tool built in ruby that allows github interactions to
+description: Hubmaster is a tool built in Ruby that allows Github interactions to
   be made outside the browser.
 email:
 - me@tommyschaefer.net
@@ -58,6 +58,7 @@ files:
 - lib/hubmaster.rb
 - lib/hubmaster/base.rb
 - lib/hubmaster/cipher.rb
+- lib/hubmaster/login.rb
 - lib/hubmaster/repo.rb
 - lib/version.rb
 homepage: https://github.com/tommyschaefer/hubmaster
@@ -83,5 +84,5 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Hubmaster is simple and easy to use. Visit the github page for more details.
+summary: Hubmaster is simple and easy to use. Visit the Github page for more details.
 test_files: []