time_log_robot 0.1.3 → 0.1.4

data/README.md

@@ -1,3 +1,7 @@
+[![CircleCI](https://circleci.com/gh/supremebeing7/time_log_robot/tree/master.svg?style=svg)](https://circleci.com/gh/supremebeing7/time_log_robot/tree/master)
+[![Code Climate](https://codeclimate.com/github/supremebeing7/time_log_robot/badges/gpa.svg)](https://codeclimate.com/github/supremebeing7/time_log_robot)
+[![Test Coverage](https://codeclimate.com/github/supremebeing7/time_log_robot/badges/coverage.svg)](https://codeclimate.com/github/supremebeing7/time_log_robot/coverage)
+
 # Time Log Robot
 ***Let the robot do your work time logging.***
 
@@ -40,11 +44,11 @@ This is an integration between project management tools (like JIRA) and time log
 
 The simplest usage is just to invoke the robot:
 
-    time_log_robot
+    $ time_log_robot
 
 By default, the robot will get all time entries since the previous Saturday. To specify a different time, run it with the optional `--since` flag (Note: the date given must be in YYYY-MM-DD format):
 
-    time_log_robot --since 2016-05-01
+    $ time_log_robot --since 2016-05-01
 
 On start, the robot will ask you for these details:
 
@@ -59,7 +63,7 @@ The robot has a memory like a steel trap, so after you run it the first time, it
 
     time_log_robot --overwrite
 
-Or, if you want to pop open the internals, the robot saves all configuration in `path/to/gem/config/settings.yml`, so open up that file and edit to your heart's content.
+Or, if you want to pop open the internals, the robot saves all configuration in a file in your home directory: `~/.time_log_robot_settings.yml`, so open up that file and edit to your heart's content.
 
 ### Configuration
 
@@ -79,32 +83,43 @@ Here are some notes about how to find the appropriate values for those environme
 
 ### Mapping keys
 
-You can now map JIRA keys to specific phrases so that in your Toggl time entries, you won't need to enter the JIRA key. These mappings are stored in a YAML file in the gem root directory:
+You can now map JIRA keys to specific phrases so that in your Toggl time entries, you won't need to enter the JIRA key. These mappings are stored by default in a YAML file in your home directory:
 
-    path/to/gem/mapping.yml
+    ~/.time_log_robot_mapping.yml
 
     # Example usage
     # --
     # phrase: JIRA-KEY
     weekly planning: PM-1
 
-With this mapping, when logging time on on Toggl, instead of having to enter "weekly planning [PM-1]", you can just enter "weekly planning" and the robot will get the JIRA key from the `mapping.yml` file.
+With this mapping, when logging time on on Toggl, instead of having to enter "weekly planning [PM-1]", you can just enter "weekly planning" and the robot will get the JIRA key from the `.time_log_robot_mapping.yml` file.
+
+#### Moving the mapping file
+
+If you don't care about keeping your mapping file hidden or out of the way, or if you want it somewhere it can be accessed more easily, feel free to create your own, then just tell the robot where it's located using the `--mapping` flag:
+
+    $ time_log_robot --mapping
+    # or `time_log_robot -m`
+    Enter your MAPPING_FILE_PATH: /full/path/to/your_mapping_file.yml
 
 ### Help
 
 For more details use the help flag:
 
-    time_log_robot --help
+    $ time_log_robot --help
+
+Or ask for help with the `run` command:
 
+    $ time_log_robot run --help
 
 ## Development
 To see available rake tasks for development
 
-    rake -T
+    $ rake -T
 
 To run the app in IRB for debugging run
 
-    rake console
+    $ rake console
 
 (Note: If you've built the gem and have committed the `.gem` file, none of your `rake` commands will work. You'll need to remove the built gem and commit the deletion.)
 
@@ -112,9 +127,11 @@ To run the app in IRB for debugging run
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request to Dev
+3. Write tests for your new code (uses `minitest`)
+4. Make sure all tests pass (`rake test`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request to Dev
 
 ## License
 

data/bin/time_log_robot

@@ -28,10 +28,12 @@ command :run do |c|
   c.example 'shorthand', 'time_log_robot'
   c.example 'with optional parameter "since"', 'time_log_robot run --since "2015-10-21"'
 
-  c.option '--since STRING', String, 'The date from which to log time entries. Must be in YYYY-MM-DD format. Default is the previous Saturday.'
+  c.option '-m', '--mapping', 'Description to JIRA key mapping file is located by default at `~/.time_log_robot_mapping.yml`. Use this flag if you have a mapping file eslewhere and would like to define the path to point to your file instead.'
 
   c.option '--overwrite', 'Your settings are automatically written to a file - `~/.time_log_robot_settings.yml` - to be used again the next time you invoke the robot. Use this flag if you need to overwrite those settings.'
 
+  c.option '-s', '--since STRING', String, 'The date from which to log time entries. Must be in YYYY-MM-DD format. Default is the previous Saturday.'
+
   c.action do |args, options|
     if options.inputs_help
       print_inputs_help
@@ -41,6 +43,9 @@ command :run do |c|
       fetch_envars_from_config unless options.overwrite
 
       missing_envars = get_missing_envars
+      if options.mapping
+        missing_envars['MAPPING_FILE_PATH'] = get_envar('MAPPING_FILE_PATH')
+      end
 
       since = DateTime.parse(options.since).to_s unless options.since.nil?
 
@@ -62,22 +67,24 @@ def get_missing_envars
   missing_envars = {}
 
   TimeLogRobot.envars.each do |key|
-    string_key = key.to_s
-    unless ENV[string_key]
-      ENV[string_key] = ask "Enter your #{string_key}: " do |char|
-        char.echo = '*' if string_key =~ /password|token/i
-      end
-      if ENV[string_key].length == 0
-        puts 'Invalid input. This is a required field.'
-        exit
-      end
-      missing_envars[string_key] = ENV[string_key]
-    end
+    next if key == 'MAPPING_FILE_PATH' || ENV[key]
+    missing_envars[key] = get_envar(key)
   end
 
   return missing_envars
 end
 
+def get_envar(key)
+  ENV[key] = ask "Enter your #{key}: " do |char|
+    char.echo = '*' if key =~ /password|token/i
+  end
+  if ENV[key].length == 0
+    puts 'Invalid input. This is a required field.'
+    exit
+  end
+  ENV[key]
+end
+
 def fetch_envars_from_config
   return unless envars = YAML.load_file(settings_file_path)
   envars.each_pair do |key, value|
@@ -101,11 +108,11 @@ def write_missing_envars(missing_envars={})
 end
 
 def create_settings_file_if_nonexistent
-  File.new(settings_file_path, "w+") unless File.exists?(settings_file_path)
+  File.new(settings_file_path, "w+") unless File.file?(settings_file_path)
 end
 
 def settings_file_path
-  File.join(TimeLogRobot.root, '.settings.yml')
+  File.join(ENV['HOME'], '.time_log_robot_settings.yml')
 end
 
 # set default action for gem

data/lib/time_log_robot/jira/issue_key_parser.rb

@@ -19,10 +19,18 @@ module TimeLogRobot
 
         def mappings
           YAML.load_file(keymap_file_path) || {}
+        rescue Errno::ENOENT
+          {}
         end
 
         def keymap_file_path
-          File.join(TimeLogRobot.root, 'mapping.yml')
+          ENV['MAPPING_FILE_PATH'] || default_keymap_file_path
+        end
+
+        def default_keymap_file_path
+          path = File.join(ENV['HOME'], '.time_log_robot_mapping.yml')
+          return path if File.file?(path)
+          File.new(path, "w+").path
         end
       end
     end

data/lib/time_log_robot/version.rb

@@ -1,3 +1,3 @@
 module TimeLogRobot
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/time_log_robot.rb

@@ -25,31 +25,30 @@ module TimeLogRobot
 
   def self.envars_help
     {
-      TOGGL_TOKEN:
+      'MAPPING_FILE_PATH' =>
+        "This is the path to your mapping file. By default, this file is named `.time_log_robot_mapping.yml` and lives in your home directory.\n\n",
+
+      'TOGGL_TOKEN' =>
         "In your Toggl account, go to your profile page and look for the API token at the bottom.\n\n",
 
-      TOGGL_WORKSPACE_ID:
+      'TOGGL_WORKSPACE_ID' =>
         "This is a little trickier. Your workspaces usually only show a human-readable name to you in Toggl's UI, and here you need the workspace machine ID. But you can do a curl request to find it like this (replacing TOGGL_TOKEN with your token from above):
 
         \tcurl -v -u TOGGL_TOKEN:api_token \ -X GET https://www.toggl.com/api/v8/workspaces
 
         Look at the result and find the id given for the workspace you want to use.\n\n",
 
-      TOGGL_USER_AGENT:
+      'TOGGL_USER_AGENT' =>
         "This is your Toggl username, usually your email.\n\n",
 
-      TOGGL_DEFAULT_LOG_TAG:
+      'TOGGL_DEFAULT_LOG_TAG' =>
         "This is the tag name you would like to use for tagging your Toggl time entries as they are logged to JIRA.\n\n",
 
-      JIRA_USERNAME:
+      'JIRA_USERNAME' =>
         "This is your JIRA username, which is not an email, but usually your email minus the '@domain.com'\n\n",
 
-      JIRA_PASSWORD:
-        "I know there's a lot of jargon, but some of these are pretty self-explanatory
-        ┌─┐
-        ┴─┴
-        ಠ_ರೃ
-      \n"
+      'JIRA_PASSWORD' =>
+        "I know there's a lot of jargon, but some of these are pretty self-explanatory\n"
     }
   end
 end

data/test/test_helper.rb

@@ -1,6 +1,8 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'minitest/autorun'
 require 'minitest/pride'
-require 'minitest/emoji'
 require 'minitest/reporters'
 require 'yaml'
 require 'active_support'

data/time_log_robot.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'minitest', '~> 5.8'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.5'
 
   spec.add_runtime_dependency 'activesupport', '~> 4.2', '>= 4.2.6'
   spec.add_runtime_dependency 'commander', '~> 4.1', '>= 4.1.6'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_log_robot
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Mark J. Lehman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-27 00:00:00.000000000 Z
+date: 2016-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -155,8 +169,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
-- ".settings.yml"
+- ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -170,7 +185,6 @@ files:
 - lib/time_log_robot/toggl/report.rb
 - lib/time_log_robot/toggl/tagger.rb
 - lib/time_log_robot/version.rb
-- mapping.yml
 - test/test_helper.rb
 - test/time_log_robot/jira/issue_key_parser_test.rb
 - time_log_robot.gemspec

data/.settings.yml

@@ -1,7 +0,0 @@
----
-toggl_token: 5f85129ba262ce647e2914b7eeaa4cbc
-toggl_workspace_id: '702788'
-toggl_user_agent: markopolo@gmail.com
-toggl_default_log_tag: logged
-jira_username: markl
-jira_password: XDR%t6yhn

data/mapping.yml

@@ -1,8 +0,0 @@
-monday meeting: PM-1
-weekly planning meeting: PM-1
-architecture planning: PM-1
-architecture meeting: PM-1
-time log robot: OSS-5
-code review: PM-38
-daily planning: PM-35
-hw checkin meeting: HW-10