github_helper 1.0.0 → 1.0.1

data/README.md

@@ -23,10 +23,17 @@ Just install the gem using :
 
     gem install github_helper
 
+## Configuration
+The first time you run a `ghh` command in your git repository, a prompt will ask you your credentials (**But won't store** your password, only the OAuth token) and your target user/repo.
+
+It will then save the configuration in `.git/githelper.config.yml`  
+
 ## Usage
+The **"fast mode"** just needs the `-f` option. It will take your latest commit message and use it as the Pull request's title. Optionnaly, you can use `-fm [message]` to commit/push/open the PR. 
+
 To add an issue ID to the Pull request's description, just use the `-i` option.
 
-To get some help, just run `ghh -h`
+To get some more help, just run `ghh -h`
 
 Here are the detailed options :
 
@@ -45,3 +52,8 @@ Here are the detailed options :
     -v, --verbose                    Enables verbose mode
     -h, --help                       Displays this screen
 
+### ToDo list
+* More documentation
+* A commit-amending feature ?
+* A better error handling
+* Share a single token over multiple repos

data/github_helper.gemspec

@@ -12,6 +12,8 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{A useful tool to commit, push to remote and open a pull request, in a single line.}
   gem.homepage      = "https://github.com/Esya/GithubHelper"
 
+  gem.post_install_message = "GithubHelper is ready!\nJust type ghh in your terminal in a git folder to start using it."
+
   gem.files         = `git ls-files`.split($/)
   gem.executables   << 'ghh'
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})

data/lib/github_helper/first_time.rb

@@ -1,12 +1,18 @@
+require 'io/console'
+
 # First time run ? Let's make the config file !
 class GithubHelper::FirstTime
   include HTTParty
   base_uri 'https://api.github.com'
 
   # Outputs the string as a question then waits for the user input
-  def ask(string,default=nil)
+  def ask(string,hidden=false,default=nil)
     puts string
-    input = gets.strip
+    if hidden
+      input = STDIN.noecho {|i| i.gets}.chomp
+     else
+      input = gets.strip
+    end
     puts ""
     input = (input == "") ? default : input
   end
@@ -34,7 +40,7 @@ class GithubHelper::FirstTime
   def fillArray!
     puts "Setting your credentials"
     user = ask("What's your github user name (Won't work with your email) ?")
-    password = ask("What's your git password ?\n(This won't be logged, used to get an OAuth token)")
+    password = ask("What's your git password ?\n(This won't be logged, used to get an OAuth token)",true)
     self.class.basic_auth user, password
 
     @config['credentials']['user'] = user
@@ -45,7 +51,7 @@ class GithubHelper::FirstTime
     @config['remote']['repo'] = ask("What's the user's repo ?")
 
     puts "Writing to config file : .git/githelper.config.yml"
-    header = "# GitHelper.rb config file\n# You can edit your credentials here\n"
+    header = "# GithubHelper config file\n# You can edit your configuration here\n"
     yaml = @config.to_yaml
 
     output = header + yaml

data/lib/github_helper/version.rb

@@ -1,3 +1,3 @@
 module GithubHelper
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: github_helper
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -81,7 +81,9 @@ files:
 - lib/github_helper/version.rb
 homepage: https://github.com/Esya/GithubHelper
 licenses: []
-post_install_message: 
+post_install_message: ! 'GithubHelper is ready!
+
+  Just type ghh in your terminal in a git folder to start using it.'
 rdoc_options: []
 require_paths:
 - lib
@@ -105,3 +107,4 @@ specification_version: 3
 summary: A useful tool to commit, push to remote and open a pull request, in a single
   line.
 test_files: []
+has_rdoc: