time_log_robot 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52cd7b6a841d97f0192f93853dacb1ade788dcc8
-  data.tar.gz: 340b5c943e86df6b343f1c8b5615697032c80bd3
+  metadata.gz: 8d5097db263a7073c5b5c858536dabfe61ced24e
+  data.tar.gz: 381891c32f3499ecbcb611395db2294f1018b923
 SHA512:
-  metadata.gz: 2250a3e8a1a997d4cb973cf7486cdc312e90250917947dd670b7339432eea8b93185a33a107a1236f85ad3a9cd2710316a32395693d9ab3bec6f1d1d72daeef5
-  data.tar.gz: cc8a7c5b10d7947b462a794fed49a38b98f9be98c582507b200f7554ba45aeedbe1e8ca2c1faefecd53f78c48d814970983ab343fbb009dee9b2a8a599352bd5
+  metadata.gz: 03c8d6335b209654b4b4f37c18b894cce613639d40e4167e5a8aefb79f02f6f40f64a0a6ba8eaf1c468a8cf1087ffdd1f162fd597b6a4e04af09f2693bfd2fbd
+  data.tar.gz: 791e6755bfd9a6a6768eba806a709c94713f1d273d8215dbb4d37f6d7d19c15eac1e3420e9280e10661de07d9013a103f6d9fae7e53ac5b8f5f0e9fca1e2f907

data/Gemfile.lock

@@ -1,30 +1,25 @@
 PATH
   remote: .
   specs:
-    time_log_robot (0.2.2)
-      activesupport (>= 4.2.6)
-      commander (>= 4.1.6)
-      httparty (>= 0.13.0)
-      json (= 1.8.1)
+    time_log_robot (0.3.0)
+      activesupport (~> 4.2, >= 4.2.6)
+      httparty (~> 0.13, >= 0.13.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     ansi (1.5.0)
     builder (3.2.2)
     codeclimate-test-reporter (0.6.0)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
-    commander (4.4.0)
-      highline (~> 1.7.2)
-    concurrent-ruby (1.0.2)
     docile (1.1.5)
-    highline (1.7.8)
     httparty (0.14.0)
       multi_xml (>= 0.5.2)
     i18n (0.7.0)

data/bin/time_log_robot

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
 
-require 'commander/import'
 require 'time_log_robot'
 require 'time_log_robot/entry'
 require 'time_log_robot/reporter'
@@ -14,117 +13,4 @@ require 'time_log_robot/jira/payload_builder'
 require 'time_log_robot/jira/work_logger'
 require 'yaml'
 
-program :name, 'time_log_robot'
-program :version, TimeLogRobot::VERSION
-program :description, 'Logs work from a time tracker tool to a project
-management tool. Currently only supports Toggl and JIRA.'
-
-program :help, 'Author', 'Mark J. Lehman <markopolo@gmail.com>'
-
-global_option('-i', '--inputs_help', 'Learn how and where to find the inputs you need to get this working')
-
-command :run do |c|
-  c.syntax = 'time_log_robot run [options]'
-
-  c.description = 'Logs your time with optional since (default is the previous Saturday).'
-
-  c.example 'usage', 'time_log_robot run'
-  c.example 'shorthand', 'time_log_robot'
-  c.example 'with optional parameter "since"', 'time_log_robot run --since "2015-10-21"'
-
-  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
-    else
-      create_settings_file_if_nonexistent
-
-      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?
-
-      TimeLogRobot.start(since)
-
-      write_missing_envars(missing_envars) if missing_envars.any?
-    end
-  end
-end
-
-def print_inputs_help
-  TimeLogRobot.envars_help.each_pair do |envar, help_text|
-    puts envar
-    puts help_text
-  end
-end
-
-def get_missing_envars
-  missing_envars = {}
-
-  TimeLogRobot.envars.each do |key|
-    next if key == 'MAPPING_FILE_PATH' || ENV[key]
-    missing_envars[key] = get_envar(key)
-  end
-
-  return missing_envars
-end
-
-def get_envar(key)
-  env_value = ask "Enter your #{key}: " do |char|
-    char.echo = '*' if key =~ /password|token/i
-  end
-  env_value.strip! unless should_not_strip?(key)
-  ENV[key] = env_value
-  if ENV[key].length == 0
-    puts 'Invalid input. This is a required field.'
-    exit
-  end
-  ENV[key]
-end
-
-def should_not_strip?(key)
-  %w(JIRA_PASSWORD).include? key
-end
-
-def fetch_envars_from_config
-  return unless envars = YAML.load_file(settings_file_path)
-  envars.each_pair do |key, value|
-    value.strip! unless should_not_strip?(key)
-    ENV[key.upcase] = value
-  end
-end
-
-def write_missing_envars(missing_envars={})
-  puts "\nTo avoid entering setup information each time, the following configuration has been stored in `#{settings_file_path}`:"
-  missing_envars.each_pair do |key, value|
-    if key =~ /password|token/i
-      puts "\t#{key}=[FILTERED]"
-    else
-      puts "\t#{key}=#{value}"
-    end
-
-    data = YAML.load_file(settings_file_path) || {}
-    data[key.downcase] = value
-    File.open(settings_file_path, 'w') { |f| YAML.dump(data, f) }
-  end
-end
-
-def create_settings_file_if_nonexistent
-  File.new(settings_file_path, "w+") unless File.file?(settings_file_path)
-end
-
-def settings_file_path
-  File.join(ENV['HOME'], '.time_log_robot_settings.yml')
-end
-
-# set default action for gem
-default_command :run
+TimeLogRobot.run(ARGV)

data/lib/time_log_robot/version.rb

@@ -1,3 +1,3 @@
 module TimeLogRobot
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/lib/time_log_robot.rb

@@ -1,57 +1,205 @@
+require 'optparse'
+require 'optparse/date'
+require 'ostruct'
 require 'json'
 require 'httparty'
 
 module TimeLogRobot
-  def self.root
-    File.dirname __dir__
-  end
+  class << self
+    def run(args)
+      options = TimeLogRobot.parse(args)
 
-  def self.start(since)
-    report = fetch_time_report(since)
-    JIRA::WorkLogger.log_all(
-      service: report[:service],
-      time_entries: report[:entries]
-    )
-  end
+      create_settings_file_if_nonexistent
+
+      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 = options.since.to_time unless options.since.nil?
+
+      TimeLogRobot.start(since)
 
-  def self.fetch_time_report(since)
-    if since.nil?
-      Toggl::Report.fetch
-    else
-      Toggl::Report.fetch(since: since)
+      write_missing_envars(missing_envars) if missing_envars.any?
     end
-  end
 
-  def self.envars
-    envars_help.keys
-  end
+    def parse(args)
+      options = OpenStruct.new
+      options.mapping   = nil
+      options.overwrite = false
+      options.since     = nil
+
+      opt_parser = OptionParser.new do |opts|
+        opts.separator ''
+        opts.banner = 'Usage: time_log_robot [options]'
+
+        opts.separator ''
+        opts.separator 'Specific options:'
+
+        opts.separator ''
+        opts.on('-m', '--mapping PATH', String,
+                '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 elsewhere and would like to define the path to', 'point to your file instead.') do |mapping|
+          options.mapping = mapping
+        end
+
+        opts.separator ''
+        opts.on('-o', '--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.') do |overwrite|
+          options.overwrite = overwrite
+        end
 
-  def self.envars_help
-    {
-      '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",
+        opts.separator ''
+        opts.on('-s', '--since DATE', Date,
+                'The date from which to log time entries.',
+                'Must be in YYYY-MM-DD format.',
+                'Default is the previous Saturday.') do |date|
+          options.since = date
+        end
 
-      'TOGGL_TOKEN' =>
-        "In your Toggl account, go to your profile page and look for the API token at the bottom.\n\n",
+        opts.separator ''
+        opts.separator 'Common options:'
 
-      '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):
+        opts.on_tail('-i', '--inputs_help',
+                     'Learn how and where to find the inputs you need to get', 'this working') do
+          print_inputs_help
+          exit
+        end
 
-        \tcurl -v -u TOGGL_TOKEN:api_token \ -X GET https://www.toggl.com/api/v8/workspaces
+        opts.on_tail('-h', '--help', 'Show this message') do
+          puts opts
+          exit
+        end
 
-        Look at the result and find the id given for the workspace you want to use.\n\n",
+        opts.on_tail('-v', '--version', 'Show version') do
+          puts TimeLogRobot::VERSION
+          exit
+        end
+      end
 
-      'TOGGL_USER_AGENT' =>
-        "This is your Toggl username, usually your email.\n\n",
+      opt_parser.parse!(args)
+      options
+    end
+
+    def get_missing_envars
+      missing_envars = {}
+
+      TimeLogRobot.envars.each do |key|
+        next if key == 'MAPPING_FILE_PATH' || ENV[key]
+        missing_envars[key] = get_envar(key)
+      end
+
+      return missing_envars
+    end
+
+    def get_envar(key)
+      print "Enter your #{key}: "
+      env_value = gets.chomp
+      env_value.strip! unless should_not_strip?(key)
+      ENV[key] = env_value
+      if ENV[key].length == 0
+        puts 'Invalid input. This is a required field.'
+        exit
+      end
+      ENV[key]
+    end
+
+    def should_not_strip?(key)
+      %w(JIRA_PASSWORD).include? key
+    end
 
-      '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",
+    def fetch_envars_from_config
+      return unless envars = YAML.load_file(settings_file_path)
+      envars.each_pair do |key, value|
+        value.strip! unless should_not_strip?(key)
+        ENV[key.upcase] = value
+      end
+    end
+
+    def write_missing_envars(missing_envars={})
+      puts "\nTo avoid entering setup information each time, the following configuration has been stored in `#{settings_file_path}`:"
+      missing_envars.each_pair do |key, value|
+        if key =~ /password|token/i
+          puts "\t#{key}=[FILTERED]"
+        else
+          puts "\t#{key}=#{value}"
+        end
 
-      'JIRA_USERNAME' =>
-        "This is your JIRA username, which can be found in your JIRA user profile.\n\n",
+        data = YAML.load_file(settings_file_path) || {}
+        data[key.downcase] = value
+        File.open(settings_file_path, 'w') { |f| YAML.dump(data, f) }
+      end
+    end
 
-      'JIRA_PASSWORD' =>
-        "I know there's a lot of jargon, but some of these are pretty self-explanatory\n"
-    }
+    def create_settings_file_if_nonexistent
+      File.new(settings_file_path, "w+") unless File.file?(settings_file_path)
+    end
+
+    def settings_file_path
+      File.join(ENV['HOME'], '.time_log_robot_settings.yml')
+    end
+
+    def print_inputs_help
+      TimeLogRobot.envars_help.each_pair do |envar, help_text|
+        puts envar
+        puts help_text
+      end
+    end
+
+    def root
+      File.dirname __dir__
+    end
+
+    def start(since)
+      report = fetch_time_report(since)
+      JIRA::WorkLogger.log_all(
+        service: report[:service],
+        time_entries: report[:entries]
+      )
+    end
+
+    def fetch_time_report(since)
+      if since.nil?
+        Toggl::Report.fetch
+      else
+        Toggl::Report.fetch(since: since)
+      end
+    end
+
+    def envars
+      envars_help.keys
+    end
+
+    def envars_help
+      {
+        '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' =>
+          "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' =>
+          "This is your Toggl username, usually your email.\n\n",
+
+        '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' =>
+          "This is your JIRA username, which can be found in your JIRA user profile.\n\n",
+
+        'JIRA_PASSWORD' =>
+          "I know there's a lot of jargon, but some of these are pretty self-explanatory\n"
+      }
+    end
   end
 end

data/time_log_robot.gemspec

@@ -27,7 +27,5 @@ Gem::Specification.new do |spec|
   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'
-  spec.add_runtime_dependency 'httparty', '~> 0.13', '>= 0.13.0'
-  spec.add_runtime_dependency 'json', '1.8.1'
+  spec.add_runtime_dependency 'httparty',      '~> 0.13', '>= 0.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: time_log_robot
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark J. Lehman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-12 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -114,26 +114,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.6
-- !ruby/object:Gem::Dependency
-  name: commander
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.6
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -154,20 +134,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.13.0
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.8.1
 description: Automate time logging from tools like Toggl to project management software
   such as JIRA
 email:
@@ -227,4 +193,3 @@ summary: Automate work time logging
 test_files:
 - test/test_helper.rb
 - test/time_log_robot/jira/issue_key_parser_test.rb
-has_rdoc: