toolshed 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9bdfea21a3da3ced44701c4030023a41dffd6f24
-  data.tar.gz: 0e1abc6ed334b5e07390c356242f7e9de3033f54
+  metadata.gz: 8a8dfde43412cec6304d3bc7b42485ea14d225c5
+  data.tar.gz: 52bbbc59f4384c7ead365df2a4aed53d3f486521
 SHA512:
-  metadata.gz: 669886428374a6dfe17cbdfecf5e06b51594cc31d913bc92c526c797b1e8611cfb5fab7ac4bf1e10a6079e7e17d0dd758441679deff0f19f2175cfca74152da8
-  data.tar.gz: d1876a1cd4ee6d45347210254f206ee1ea12fece621139195c43170b006a0ca0c9d936225d0d2e00f11a751ccd325c1be08a281fd4abcbbdd6b4b6b5301a9c2c
+  metadata.gz: 6ddf6b5dcce569a0bc312f8a266b70cbc5d79be95ea318d7fadded6036b99143d394fcab632fc7d8c7c156cf324677d28de154fa56edab22308f91ddf79efbbc
+  data.tar.gz: 50c8a2c080727e008ab404f5b03d34481c9cc9cf892cd5cf89f24f42e608f9f772f2393af4f0c315e8182e34b76923a6641b9e5aa4801a229d02e75c66255d44

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+logs
+.toolshedrc

data/.rubocop.yml

@@ -0,0 +1,11 @@
+AllCops:
+  Exclude:
+    - 'test/**/*'
+Metrics/LineLength:
+  Max: 90
+Metrics/MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15
+Style/IndentationConsistency:
+  Description: 'Keep indentation straight.'
+  Enabled: false

data/.toolshedrc.sample

@@ -0,0 +1,32 @@
+---
+# Command line tool for toolshed. More information about toolshed can be found at https://github.com/wallerjake/toolshed
+
+# Before using this tool you should create a file called .toolshedrc in your projects directory or home directory. This is read as a yaml file so format it as you would a yaml file.
+# If added to the projects directory settings will be applied to that specific project. If applied to your home directory all projects under home will get those settings. It will take the first .toolshedrc file it finds so you can override the home directory global one when needed.
+
+# log_path: ~/toolshed/logs
+
+# ticket_tracking_tool: 'pivotal_tracker' (required)
+# pivotal_tracker_username: [pivotal_tracker_username] (optional)
+# pivotal_tracker_password: [pivotal_tracker_password] (optional)
+# default_pivotal_tracker_project_id: [project_id] (optional)
+# ticket_status_for_complete: [status] (required (only if using pull requests)) example: "Code Review"
+
+# github_username:  [github_username] (optional)
+# github_password:  [github_password] (optional)
+# github_token:     [github_token] (optional) - create the token if your account require two factor you can disable token or enable through Github. See https://github.com/settings/tokens/new for details.
+# git_tool: github (optional default `github`)
+# use_git_submodules: false (optional default `false`)
+# pull_from_remote_name: [pull_from_remote_name] (required)
+# pull_from_repository_user: [pull_from_repository_username] (required)
+# pull_from_repository_name: [pull_from_repository_name] (required)
+# push_to_repository_user: [push_to_repository_user] (required)
+# push_to_repository_name: [push_to_repository_name] (required)
+# push_to_remote_name: [push_to_remote_name] (required)
+# default_pull_request_title_format: [id] - [summary] (optional)
+
+# time_tracking_username: [username] (optional)
+# time_tracking_password: [password] (optional)
+# time_tracking_owner: [owner] (optional)
+# time_tracking_default_project_id: [project_id] (optional)
+# time_tracking_tool: [tool] (required unless you are not going to be doing time tracking)

data/README.md

@@ -3,7 +3,7 @@
 
 # Toolshed
 
-Toolshed is a utility gem. The purpose of toolshed is to make small to complex command line tasks easier. This includes tasks related to Git like creating a pull request or creating a branch. It also includes tasks like ticket tracking. Currently only a limited set of products is supported but this can be expanded over time as needed.
+Toolshed was made to make every day tasks for a developer easier and faster. It gives yout the ability to configure your environment with settings and then run tasks with one command. For example creating a pull request can require you to go up to Github. Click on create pull request. Select which branch you are creating the pull request for. Put in a title and a description. Then hit create pull request. Also Possibly needing to copy the pull request URL over the ticket it's related to. This can be a time consuming process. With Toolshed you can automated this process and get it down to one command for all of your tickets. If it does not do everything you disire it's easy to extend what is already there and add your own ticket tracking system in. Pull requests are always welcome for adding a new system in.
 
 ## Installation
 
@@ -21,7 +21,164 @@ Or install it yourself as:
 
 ## Usage
 
-After installing the gem run toolshed from the command line for help menu. It will list the available commands.
+After installing the gem run toolshed from the command line for help menu.
+
+### .toolshedrc
+
+The .toolshedrc file is the configuration file for toolshed. This file shall never be committed to version control as you are storing password and other secure data inside of it. The purpose of this file is to store configuration per project or globally. You can store this file in your projects directory or store it in any below directories. For example it could be stored at /home/sample/.toolshedrc for a global configuration. Otherwise it can be stored at /home/sample/projects/sample_project/.toolshedrc for configuration specific to that project. Once it finds a configuration file it will no longer look down the chain. So if you use a project specific .toolshedrc file that is the only configuration file it will look at.
+
+#### Options
+
+* Required
+  * ticket_tracking_tool: github
+    * Options: github, jira and pivital_tracker
+  * pull_from_remote_name: origin
+    * This is where pulling will come from. This is the name you call the remote locally. By default of course it's origin but you can change this.
+  * pull_from_repository_user: origin
+    * This is the repository name you are pulling from. By default it's called origin.
+  * pull_from_repository_name: origin
+    * This is the repository name you are pulling from. By default it's called origin.
+  * push_to_repository_name: origin
+    * This is where pushing will come from. This is the name you call the remote locally. By default of course it's origin but you can change this.
+  * push_to_repository_user: origin
+    * This is the repository name you are pushing from. By default it's called origin.
+  * push_to_remote_name: sample
+    * This is the repository name you are pushing from. By default it's called origin.
+
+* Optional
+  * git_tool: github
+    * This is not required but should be provided if using a different tool than Github.
+  * github_username: sample_user
+  * github_password: sample_password
+  * github_token: token_123
+    * Create the token if your account require's two factor authentication. You can disable this token or enable it through Github. See https://github.com/settings/tokens/new for details.
+  * use_git_submodules: false
+    * If you are using Git submodules you may want to turn this option on. By default it's off and not in use.
+  * default_pull_request_title_format: [id] - [title]
+    * If you want to provide formatting for the pull request title. The default is just to provide the title of the ticket. But you can add this line to format it to include other fields like id. You will need to figure out what the ticket system calls it. For example Pivital Tracker may call it a story_name while Jira may call it a title.
+  * pivotal_tracker_username: sample_user
+  * pivotal_tracker_password: sample_password
+  * default_pivotal_tracker_project_id: 123
+    * If no project_id is pass in on commands this will be used by default.
+  * ticket_status_for_complete: 'Complete'
+    * This is only used when creating a pull request. This will allow the tool to flip the status of a ticket to the next stage. Allows you to automate creating a pull request.
+  * time_tracking_username: sample_username
+    * If you are using a time tracking system you can use this to set it up. Currently only Harvest is supported.
+  * time_tracking_password: sample_password
+    * Same as time_tracking_username just for the password field.
+  * time_tracking_owner: owner_name
+    * Some time tracking systems require an owner to be set. This is probably the company name if using Harvest.
+  * time_tracking_default_project_id: 123
+    * If the time tracking system has project_ids you can set the default here.
+  * time_tracking_tool: harvest
+    * Options: harvest
+      * Additional time tracking tools could be supported in the future.
+  * home_server_password: "sample1234"
+    * You can provide a name for reference when using the SSH command.
+    * Example: toolshed ssh --user="sample" --host="localhost" --commands="sudo apt-get update;sudo apt-get dist-upgrade;" --password="home_server_password" --sudo-password="home_server_password"
+      * This command will allow you to automate updates on an Ubuntu server. This should really only be used for small commands that do not require a lot of logic.
+
+### Available Commands
+
+* **help**
+ * Commands that are available and what the commands do.
+* **create_pull_request**
+  * Give's the ability to create a pull request. Currently only Github is supported at this time.
+  * Options
+    * **--tool** "github"
+      * You can provide the tool you are creating the pull request for. Currently only Github is available but other tools could be added in the future.
+    * **--ticket-system** "pivotal_tracker"
+      * The ticket system you are using. This can be provided to automatically put the pull request URI into the ticket provided.
+      * **Supports**
+        * pivotal_tracker
+        * jira
+    * **--use-defaults** "true"
+      * If provided it will just select defaults for each step instead of requiring a prompt for you to input the values.
+    * **--title** "Title of pull request"
+      * If provided it will not prompt you for the title of the pull request but instead use this value.
+    * **--body** "Body of pull request"
+      * If provided it will not prompt you for the body of the pull request but instead use this value.
+* **ticket_information**
+  * Get the ticket information
+  * Options
+    * **--use-defaults**  "true|false"
+      * If you want to use defaults ticket_id is taken from branch_name otherwise configuration is used
+    * **--clipboard** "true|false"
+      * Copy the output to the system clipboard (Mac OSx) tested
+    * **--field** "field_name"
+      * The field you want to either output or copy to the clipboard
+    * **--formatted-string** "{name} - {url}"
+      * Pass a formatted string in ticket name and url in this case and it will return that string replaced by the actual value
+* **create_pivotal_tracker_note**
+  * create a note for a specific PivotalTracker story based on project_id and story_id
+* **update_pivotal_tracker_story_status**
+  * Update the status of PivotalTracker story
+* **create_branch**
+  * Create a branch default (git) and push it to your local repository
+  * Options
+    * **--branch-name** "123_test"
+      * The branch name. The standard is [ticket_id]_description
+    * **--branch-from** "master"
+      * What branch do you want to branch from
+* **checkout_branch**
+  * Checkout a branch [default git] and update the submodules if true
+  * Options
+    * **--branch-name** "123"
+      * Branch name or part of the branch name you want to checkout
+* **push_branch**
+  * Push your current working branch to your own repository
+  * Options
+    * **--force**
+      * Push your current working branch up with --force after
+    * **--branch-name** "another"
+      * Push this specific branch up instead of your current working branch
+* **get_daily_time_update**
+  * Get a daily update from your time tracking tool currently *harvest* is supported
+  * Options
+    * **--format** "html|text"
+      * Format you want. If you want html it will open an html page in your broswer otherwise puts out plain text
+    * **--use-defaults** "true|false"
+      * If you want to use your default project_id instead of entering it
+    * **--project-id** "1234"
+      * If you want to use a project id other than your defaults.
+* **list_branches**
+  * List branches for your remote repository.
+  * Options
+    * **--repository-name** "depot"
+      * The repository name you want to list branches for. If it's not passed pull_from_repository_name is used.
+* **delete_branch**
+  * Delete a branch both locally and remote.
+  * Options
+    * **--branch-name** "134_mybranch" | "134"
+      * Either the full branch name or some unique string in the branch i.e. ticket id
+* **create_ticket_comment**
+  * Add a comment to a specific ticket.
+    * **--use-defaults** "true"
+      * Use the defaults instead of getting prompts. If you don't want to supply project name
+* **update_ticket_status**
+  * Update a specific tickets status.
+* **ssh**
+  * Options
+    * **--use-sudo** "true|false"
+      * If you want the command to run under sudo i.e. sudo ssh ..
+    * **--host** "ip_address"
+      * The host you want to connect to
+    * **--connection-string-options** "-p 4000"
+      * A string of options that will be added onto the command
+    * **--commands 'command1;command2'**
+      * A list of commands either a string array "["command1", "command2"]" or "command1;command2" or put string into toolshedrc file and call it "main_server_commands"
+    * **--password "password1"**
+      * The password you are using to login to the server
+    * **--prompt-for-password "true|false"**
+      * If you want to be more secure and just prompt for passwords
+    * **--user "username"**
+      * The user you want to connect with
+    * **--keys "path/to/file"**
+      * IdentityFile you want to use for authentication if passed no password will be asked
+    * **--sudo-password "password1"**
+      * If you need to use sudo provide a sudo password this can be taken from toolshedrc file also
+    * **--verbose-output "true|flase"**
+      * If you want to see commands being ran and other verbose output set this flag to true
 
 ## Contributing
 

data/Rakefile

@@ -1,12 +1,12 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-require File.expand_path(File.dirname(__FILE__)) + "/test/config"
+require File.expand_path(File.dirname(__FILE__)) + '/test/config'
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
   t.test_files = FileList['test/**/*_test.rb', 'test/*_test.rb']
 end
 
-desc "Run tests"
+desc 'Run tests'
 task default: :test

data/bin/toolshed

@@ -7,5 +7,10 @@ begin
 rescue LoadError
 end
 
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
 require 'rake'
-require File.dirname(__FILE__) + '/toolshed'
+require 'toolshed/entry_point'
+require 'awesome_print'
+
+EntryPoint.instance.execute

data/lib/toolshed.rb

@@ -1,37 +1,47 @@
-require "toolshed/version"
+require 'toolshed/base'
+require 'toolshed/client'
+require 'toolshed/error'
+require 'toolshed/logger'
+require 'toolshed/version'
+
 require 'httparty'
-require 'pivotal-tracker'
-require 'jira'
-require 'harvested'
-require 'veto'
 require 'launchy'
 require 'clipboard'
+require 'fileutils'
 
+# Helper methods for toolshed
 module Toolshed
   BLANK_REGEX = /\S+/
 
-  # Echoes a deprecation warning message.
-  #
-  # @param  [String] message The message to display.
-  # @return [void]
-  #
-  # @api internal
-  # @private
-  def self.deprecate(message = nil)
-    message ||= "You are using deprecated behavior which will be removed from the next major or minor release."
-    warn("DEPRECATION WARNING: #{message}")
+  class << self
+    def add_file_log_source(command_name = '')
+      log_path = Toolshed::Client.instance.log_path
+      return if log_path.nil? || log_path.empty?
+
+      FileUtils.mkdir_p(log_path)
+      command_name_string = '_'
+      command_name_string = "_#{command_name}_" unless command_name.nil? || command_name.empty? # rubocop:disable Metrics/LineLength
+      file_name = "toolshed#{command_name_string}#{Time.now.utc.strftime('%Y%m%d%H%M%S%L')}" # rubocop:disable Metrics/LineLength
+      file = "#{log_path}/#{file_name}"
+      FileUtils.touch(file)
+      logger.add_log_source(file)
+    end
+
+    def deprecate(message = nil)
+      message ||= 'You are using deprecated behavior which will be removed from the next major or minor release.' # rubocop:disable Metrics/LineLength
+      warn("DEPRECATION WARNING: #{message}")
+    end
+
+    def die(message = '', exit_code = -1)
+      logger.fatal message unless message.nil? || message.empty?
+      Kernel.exit(exit_code)
+    end
+
+    def logger
+      @logger ||= begin
+        Toolshed::Logger.create(log_sources: [STDOUT])
+        Toolshed::Logger.instance
+      end
+    end
   end
 end
-
-require 'toolshed/base'
-require 'toolshed/client'
-require 'toolshed/git/git'
-require 'toolshed/git/github'
-require 'toolshed/ticket_tracking/ticket_tracking'
-require 'toolshed/ticket_tracking/pivotal_tracker'
-require 'toolshed/ticket_tracking/jira'
-require 'toolshed/time_tracking/time_tracking'
-require 'toolshed/time_tracking/harvest'
-require 'toolshed/error'
-require 'toolshed/password'
-require 'toolshed/server_administration/ssh'

data/lib/toolshed/base.rb

@@ -1,17 +1,39 @@
+require 'open3'
+require 'timeout'
+
 module Toolshed
+  # Base class for toolshed responsible for methods used all over.
   class Base
-    def self.wait_for_command(command, seconds=10)
-      begin
-        Timeout::timeout(seconds) {
-          until (system(command))
-            sleep 1
+    def initialize
+    end
+
+    def self.wait_for_command(command, seconds = 10) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/LineLength
+      result = {}
+      Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+        begin
+          Timeout.timeout(seconds) do
+            stdin.close  # make sure the subprocess is done
+
+            a_stdout = []
+            while line = stdout.gets
+              a_stdout << line
+            end
+            a_stderr = []
+            while line = stderr.gets
+              a_stderr << line
+            end
+
+            all = a_stdout + a_stderr
+            exit_status = wait_thr.value # Process::Status object returned.
+            result.merge!(stdout: a_stdout, stderr: a_stderr, all: all, process_status: exit_status) # rubocop:disable Metrics/LineLength
           end
-          return
-        }
-      rescue Timeout::Error => e
-        puts "Unable to execute command after #{seconds} seconds"
-        return
+        rescue Timeout::Error
+          Process.kill('KILL', wait_thr.pid)
+          Toolshed.logger.fatal "Unable to perform the '#{command}' command in the allowed amount of time of #{seconds} seconds. Exiting." # rubocop:disable Metrics/LineLength
+          Toolshed.die
+        end
       end
+      result
     end
   end
 end
@@ -19,6 +41,6 @@ end
 String.class_eval do
   def camel_case
     return self if self !~ /_/ && self =~ /[A-Z]+.*/
-    split('_').map{|e| e.capitalize}.join
+    split('_').map(&:capitalize).join
   end
 end

data/lib/toolshed/cli.rb

@@ -1,56 +1,48 @@
+require 'toolshed'
+
 module Toolshed
+  # Command not found
   class CommandNotFound < RuntimeError
   end
 
+  # CLI is responsible for executing the initial command
   class CLI
-    def execute(command_name, args, options={})
-      Toolshed::Client.load_credentials_if_necessary
-      command = commands[command_name]
+    def execute(command_name, args, options = {})
+      load_config(command_name)
+      command = send(command_name)
       if command
         begin
           command.new.execute(args, options)
         rescue Toolshed::Error => e
-          puts "An error occurred: #{e.message}"
+          Toolshed.logger.fatal "An error occurred: #{e.message}"
         rescue RuntimeError => e
-          puts "An error occurred: #{e.message}"
+          Toolshed.logger.fatal "An error occurred: #{e.message}"
         end
       else
-        raise CommandNotFound, "Unknown command: #{command_name}"
+        fail CommandNotFound, "Unknown command: #{command_name}"
       end
     end
 
-    def commands
-      {
-        'create_pull_request'                   => Toolshed::Commands::CreatePullRequest,
-        'create_pivotal_tracker_note'           => Toolshed::Commands::CreatePivotalTrackerNote,
-        'ticket_information'                    => Toolshed::Commands::TicketInformation,
-        'update_pivotal_tracker_story_status'   => Toolshed::Commands::UpdatePivotalTrackerStoryStatus,
-        'create_branch'                         => Toolshed::Commands::CreateBranch,
-        'checkout_branch'                       => Toolshed::Commands::CheckoutBranch,
-        'push_branch'                           => Toolshed::Commands::PushBranch,
-        'get_daily_time_update'                 => Toolshed::Commands::GetDailyTimeUpdate,
-        'list_branches'                         => Toolshed::Commands::ListBranches,
-        'delete_branch'                         => Toolshed::Commands::DeleteBranch,
-        'create_ticket_comment'                 => Toolshed::Commands::CreateTicketComment,
-        'update_ticket_status'                  => Toolshed::Commands::UpdateTicketStatus,
-        'ssh'                                   => Toolshed::Commands::SSH,
-      }
+    def load_config(command_name)
+      Toolshed::Client.load_credentials
+      Toolshed.add_file_log_source(command_name)
+      Toolshed.logger.info "Credentials loaded from #{File.absolute_path(Toolshed::Client.instance.credentials_loaded_from)}" # rubocop:disable Metrics/LineLength
+    rescue => e
+      Toolshed.logger.fatal "Error loading your credentials: #{e.message}"
+    end
+
+    def method_missing(method_name)
+      require "toolshed/commands/#{method_name}"
+      "Toolshed::Commands::#{translate_method_name(method_name)}".split('::').inject(Object) { |o, c| o.const_get c } # rubocop:disable Metrics/LineLength
+    rescue NameError => e
+      Toolshed.logger.fatal e.message
+      Toolshed.die
+    end
+
+    def translate_method_name(name)
+      name = name.to_s
+      name.upcase! if %w(ssh).include?(name.downcase)
+      name.camel_case
     end
   end
 end
-
-require 'toolshed/commands/base'
-require 'toolshed/commands/create_pull_request'
-require 'toolshed/commands/create_pivotal_tracker_note'
-require 'toolshed/commands/ticket_information'
-require 'toolshed/commands/update_pivotal_tracker_story_status'
-require 'toolshed/commands/create_branch'
-require 'toolshed/commands/checkout_branch'
-require 'toolshed/commands/push_branch'
-require 'toolshed/commands/get_daily_time_update'
-require 'toolshed/commands/get_daily_time_update'
-require 'toolshed/commands/list_branches'
-require 'toolshed/commands/delete_branch'
-require 'toolshed/commands/create_ticket_comment'
-require 'toolshed/commands/update_ticket_status'
-require 'toolshed/commands/ssh'