hammerhead 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14377ccc5ecea39d948921b57b2dbaa0ba3587a3358dd8b157cb1ea62c065903
+  data.tar.gz: 0715f4dfd5fcd3c05dca7f465aaa3786c063962678d6908689e333acee53bb5a
+SHA512:
+  metadata.gz: 8d10e94d35cb84c1b49a798c53a83f7a18569e23cef1fbfdb459225469594828c851dcaaeab45a8aef959847c6e261397a0591dc858c991883c407fbeed150b0
+  data.tar.gz: 7c9f0718653bcf825ac604bb24ac1d3bb827c544a3cd9fc201ab05fa140c1cd78117f1b873f68db9c65d7e80d2b2011086727d519a855973483b2c4e77bba7d4

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Hammerhead Changes
+
+## 0.1.0 (Initial Release)
+
+### Released on [Date]
+
+* Uses TTY Toolkit
+* Calls Harvest v1 API via 'harvested'
+* Returns list of 'active' clients by default
+* Returns all clients
+* Generates weekly status report for specified client
+* Supports client 'nicknames'
+* Supports client exclusions
+* Supports rudimentary configuration file

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mel@juicyparts.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Juicy Parts Software, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,207 @@
+# Hammerhead
+
+A tool to generate status reports from your Harvest timesheet.
+
+With this tool you can produce client-specific status reports from the entries you make in your Harvest timesheet.
+
+## Motivation
+
+That's the reason I created this tool: I produce weekly status reports for my clients. This is the first iteration, and because of this, it is tailored to my needs.
+
+At the end of this document I'll document the road map I have for this tool. Stay tuned.
+
+## Notable Components
+
+### Harvest
+
+You need a [Harvest](https://www.getharvest.com/) account, because this information is used to authenticate this tool against the Harvest V1 API.
+
+**WARNING**: According to the [API V1 Documentation](https://help.getharvest.com/api-v1/), this API is deprecated but will still be available for 'legacy' applications. Upgrading to use Harvest V2 API is already in the Road Map. However, until then, I'm making note that I'm using the [harvested](https://rubygems.org/gems/harvested) gem to provide API access to the Harvest information.
+
+In a configuration file (`'hammerhead.yml'`) you will specify:
+
+```
+subdomain: - Your Harvest subdomain
+username: - Your Harvest username
+password: - Your Harvest password
+```
+
+**NOTE**: This tool uses the Optional Project Code when displaying status reports.
+
+### TTY Toolkit
+
+[TTY Toolkit](https://ttytoolkit.org/) provides the skeleton around which Hammerhead is built. It's a wonderfully easy toolkit to use. I'm barely scratching the surface of its capabilities.
+
+**WARNING**: As of version `'0.10.0'` there is a dependency on an old version of Bundler. Bundler version `1.17.3` works fine. I bring this up because you will receive warnings/errors when trying to use newer versions. When `tty` upgrades I will update this tool. Until then run bundler like so:
+
+```sh
+$ bundle _1.17.3_ <command>
+```
+
+Because of this specific dependency on `bundler` through `tty` I have elected to replicate the dependecy requirement in Hammerhead's gemspec.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hammerhead'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hammerhead
+
+## Usage
+
+### Commands
+
+#### `clients`
+
+Use this command to obtain a list of your clients. The default behavior is to return 'active' clients.
+
+```
+Usage:
+  hammerhead clients [OPTIONS]
+
+Options:
+  -a, [--all], [--no-all]    # Return all clients from Harvest
+  -h, [--help], [--no-help]  # Display usage information
+
+Description:
+  Fetch list of clients from Harvest.
+
+  The default behavior is to return 'active' clients, only.
+
+  Add the --all flag to return entire list of clients.
+```
+
+Displayed in the console will be a table of your clients. The first column will be their numeric id; this is assigned by Harvest. The second column will be the name you assigned to them. The `status` command, in its current form, requires the numeric id to be specified.
+
+#### `status CLIENT`
+
+Use this command to obtain a status report for the specified client.
+
+```
+Usage:
+  hammerhead status [OPTIONS] CLIENT
+
+Options:
+  -s, [--short-cut], [--no-short-cut]  # CLIENT value is a user-defined short-cut
+      [--start-date=YYYY-MM-DD]        # Start date of timesheet query
+      [--end-date=YYYY-MM-DD]          # End date of timesheet query
+  -h, [--help], [--no-help]            # Display usage information
+
+Description:
+  Generate status report for specified client.
+
+  The default behavior is to query up to a week's worth of timesheet entries for
+  the specififed CLIENT.
+
+  CLIENT can either be the Id or Name of one of your Harvest Clients. Obtain this
+  information with the 'clients' command.
+
+  It can also be a user-defined shortcut. Please see the README for details on
+  creating shortcuts. However when used, you must pass the --short-cut flag.
+
+  Start and end dates are automatically calculated. They are based on _your_ 'Start
+  Week On' Setting.
+
+  You can alter this behavior by specifying --start-date or --end-date.
+
+  Constraints when specifying dates:
+
+  - start-date must occur before end-date
+
+  - start-date and end-date must be at least 1 day apart
+
+  - both are optional
+
+  - specifying start-date causes end-date to equal "tomorrow"
+
+  - specifying end-date requies the presense of start-date
+```
+
+**WARNING**: The `--start-date` and `--end-date` flags are currently not supported. Supporting them is already on the Road Map.
+
+This is the heart of the Hammerhead tool. When passed the numeric id of a client, this command attempts to grab timesheet entries for active projects for the specified client. If there are no timesheet entries, or active projects, this command responds with an appropriate message in the console.
+
+If you work on multiple projects for a client, the output will be grouped by project, by timesheet entry.
+
+Again, this version is tailored to my needs and, as such, is a tiny bit complicated. My business weeks run from Monday to Sunday, therefore this tool attempts to figure out the start-date and end-date based on 'Today'. If 'Today' is Monday, a report for the previous Monday to Sunday is generated, otherwise a report from Monday to 'Today' is generated.
+
+##### Client Name Shortcuts
+
+These nicknames, or client name snippets, can be configured in `'hammerhead.yml'`. In lieu of Client Name support you can use this to setup shortcuts for report generation.
+
+```sh
+$ hammerhead status -s <nickname>
+```
+
+### Configuration
+
+Hammerhead requires the presense of a configuration file named: `'hammerhead.yml'`. The tool will search the directory in which the command is executed and in your home directory. An error will be displayed when the file can not be located.
+
+#### Sample Configuration File
+
+```yaml
+# REQUIRED
+harvest:
+  subdomain: SET_ME
+  username: SET_ME
+  password: SET_ME
+
+# OPTIONAL
+clients:
+  exclude:
+    - <client id>
+  shortcuts:
+    <nickname>:
+      id: <client id>
+      name: <client name>
+```
+
+Because of the `harvested` gem, and its use of Basic Authentication, you need to specify your credentials in order for the tool to authenticate itself against the Harvest V1 API. **GUARD YOUR CREDENTIALS!**
+
+There are some optional configuration items that may prove useful to you. If you have a client, for whatever reason, you wish to exclude from any and all client listings, add their Client Id to the list that is `clients.exclude`. Additionally, if you'd like an easy-to-remember nickname for one, or more, of your clients, you can define them until `clients.shortcuts`. For example:
+
+```yaml
+clients:
+  shortcuts:
+    acme:
+      id: 999999999
+      name: ACME Co, Inc
+```
+```sh
+$ hammerhead status -s acme
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Road Map
+
+* Support date range for `status` command
+* Add template support
+* Email status report
+* Use Harvest V2 API
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/juicyparts/hammerhead. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/juicyparts/hammerhead/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Hammerhead project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/juicyparts/hammerhead/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2020 Juicy Parts Software, LLC. See [MIT License](LICENSE.txt) for further details.

data/exe/hammerhead

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib_path = File.expand_path('../lib', __dir__)
+$LOAD_PATH.unshift(lib_path) unless $LOAD_PATH.include?(lib_path)
+require 'hammerhead/cli'
+
+Signal.trap('INT') do
+  warn("\n#{caller.join("\n")}: interrupted")
+  exit(1)
+end
+
+begin
+  Hammerhead::CLI.start
+rescue Hammerhead::CLI::Error => err
+  puts "ERROR: #{err.message}"
+  exit 1
+end

data/lib/hammerhead.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+require 'hammerhead'
+require 'hammerhead/configuration'
+require 'hammerhead/utils'
+require 'hammerhead/version'
+
+require 'harvest'
+
+require 'tty-logger'
+
+require 'pry-byebug'
+require 'ap'
+
+##
+# Wraps the functionality of the hammerhead tool. Contains the commands
+# defined, and implemented, by the +tty+ gem.
+#
+module Hammerhead
+  ##
+  # Commands generated by the +tty+ gem are organized in this module.
+  #
+  module Commands; end
+
+  ##
+  # General error used when something bad, or unexpected, occurs.
+  #
+  class Error < StandardError; end
+
+  class << self
+    ##
+    # Returns a Hammerhead::Configuration instance
+    #
+    def configuration
+      @configuration ||= Hammerhead::Configuration.new
+    end
+
+    ##
+    # Returns a TTY::Logger instance
+    #
+    def logger
+      @logger ||= TTY::Logger.new
+    end
+
+    ##
+    # Provides an alternate way to access the +configuration+
+    def configure
+      yield configuration
+    end
+  end
+end

data/lib/hammerhead/cli.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Hammerhead
+  # Handle the application command line parsing
+  # and the dispatch to various command objects
+  #
+  # @api public
+  class CLI < Thor # :nodoc: all
+    # Error raised by this runner
+    Error = Class.new(StandardError)
+
+    desc 'version', 'hammerhead version'
+    def version
+      require_relative 'version'
+      puts "v#{Hammerhead::VERSION} Hammerhead 🦈"
+    end
+    map %w[--version -v] => :version
+
+    desc 'status [OPTIONS] CLIENT', 'Generate status report for specified client'
+    long_desc <<-DESC
+      Generate status report for specified client.
+
+      The default behavior is to query up to a week's worth of timesheet entries for the specififed CLIENT.
+
+      CLIENT can either be the Id or Name of one of your Harvest Clients. Obtain this information with the 'clients' command.
+
+      It can also be a user-defined shortcut. Please see the README for details on creating shortcuts. However when used, you must pass the --short-cut flag.
+
+      Start and end dates are automatically calculated. They are based on _your_ 'Start Week On' Setting.
+
+      You can alter this behavior by specifying --start-date or --end-date.
+
+      Constraints when specifying dates:\n
+      - start-date must occur before end-date\n
+      - start-date and end-date must be at least 1 day apart\n
+      - both are optional\n
+      - specifying start-date causes end-date to equal "tomorrow"\n
+      - specifying end-date requies the presense of start-date
+    DESC
+    method_option :short_cut, aliases: '-s', type: :boolean, desc: 'CLIENT value is a user-defined short-cut'
+    method_option :start_date, banner: 'YYYY-MM-DD', type: :string, desc: 'Start date of timesheet query'
+    method_option :end_date, banner: 'YYYY-MM-DD', type: :string, desc: 'End date of timesheet query'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+    def status client
+      if options[:help]
+        invoke :help, ['status']
+      else
+        require_relative 'commands/status'
+        Hammerhead::Commands::Status.new(client, options).execute
+      end
+    end
+
+    desc 'clients [OPTIONS]', 'Fetch list of clients from Harvest'
+    long_desc <<-DESC
+      Fetch list of clients from Harvest.
+
+      The default behavior is to return 'active' clients, only.
+
+      Add the --all flag to return entire list of clients.
+    DESC
+    method_option :all, aliases: '-a', type: :boolean, desc: 'Return all clients from Harvest'
+    method_option :help, aliases: '-h', type: :boolean, desc: 'Display usage information'
+    def clients
+      if options[:help]
+        invoke :help, ['clients']
+      else
+        require_relative 'commands/clients'
+        Hammerhead::Commands::Clients.new(options).execute
+      end
+    end
+  end
+end

data/lib/hammerhead/command.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+module Hammerhead
+  class Command # :nodoc: all
+    extend Forwardable
+
+    def_delegators :command, :run
+
+    # Execute this command
+    #
+    # @api public
+    def execute
+      raise NotImplementedError, "#{self.class}##{__method__} must be implemented"
+    end
+
+    # The external commands runner
+    #
+    # @see http://www.rubydoc.info/gems/tty-command
+    #
+    # @api public
+    def command **options
+      require 'tty-command'
+      TTY::Command.new(options)
+    end
+
+    # The cursor movement
+    #
+    # @see http://www.rubydoc.info/gems/tty-cursor
+    #
+    # @api public
+    def cursor
+      require 'tty-cursor'
+      TTY::Cursor
+    end
+
+    # Open a file or text in the user's preferred editor
+    #
+    # @see http://www.rubydoc.info/gems/tty-editor
+    #
+    # @api public
+    def editor
+      require 'tty-editor'
+      TTY::Editor
+    end
+
+    # File manipulation utility methods
+    #
+    # @see http://www.rubydoc.info/gems/tty-file
+    #
+    # @api public
+    def generator
+      require 'tty-file'
+      TTY::File
+    end
+
+    # Terminal output paging
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def pager **options
+      require 'tty-pager'
+      TTY::Pager.new(options)
+    end
+
+    # Terminal platform and OS properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-pager
+    #
+    # @api public
+    def platform
+      require 'tty-platform'
+      TTY::Platform.new
+    end
+
+    # The interactive prompt
+    #
+    # @see http://www.rubydoc.info/gems/tty-prompt
+    #
+    # @api public
+    def prompt **options
+      require 'tty-prompt'
+      TTY::Prompt.new(options)
+    end
+
+    # Get terminal screen properties
+    #
+    # @see http://www.rubydoc.info/gems/tty-screen
+    #
+    # @api public
+    def screen
+      require 'tty-screen'
+      TTY::Screen
+    end
+
+    # The unix which utility
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def which *args
+      require 'tty-which'
+      TTY::Which.which(*args)
+    end
+
+    # Check if executable exists
+    #
+    # @see http://www.rubydoc.info/gems/tty-which
+    #
+    # @api public
+    def exec_exist? *args
+      require 'tty-which'
+      TTY::Which.exist?(*args)
+    end
+  end
+end

data/lib/hammerhead/commands/clients.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'tty-table'
+require 'hammerhead'
+require_relative '../command'
+
+module Hammerhead
+  module Commands
+    ##
+    # Implements the +clients+ command.
+    #
+    # This command, using a Harvest.connection, knows how to obtain a list of clients
+    # and display them in a +TTY::Table+. It also outputs the number of clients returned.
+    #
+    # If any errors are caught, they are sent to the Hammerhead.logger.
+    #
+    class Clients < Hammerhead::Command
+      def initialize options # :nodoc:
+        self.options = options
+      end
+
+      ##
+      # :stopdoc:
+      #
+      # TODO: Format Table
+      # TODO: Display different table with '--all'
+      # TODO: Colorize Output
+      def execute input: $stdin, output: $stdout
+        clients = Harvest.connection.clients options
+
+        output.puts "Pass the Id to the 'status' command, or enough of the name to uniquely match."
+        output.puts
+
+        table = TTY::Table.new headers, data(clients)
+        output.puts table.render(:unicode)
+
+        output.puts
+        output.puts "CLIENTS FOUND: #{clients.size}"
+      rescue StandardError => e
+        Hammerhead.logger.error 'CLIENTS COMMAND ERROR:', e
+      end
+
+      private
+
+      attr_accessor :options
+
+      def headers
+        %w[Id Name]
+      end
+
+      def data clients
+        clients.collect do |client|
+          [client.id, client.name]
+        end
+      end
+    end
+  end
+end

data/lib/hammerhead/commands/status.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'pry-byebug'
+
+require 'date'
+require 'hammerhead'
+require_relative '../command'
+
+module Hammerhead
+  module Commands
+    ##
+    # Implements the +status+ command.
+    #
+    # Using a Harvest.connection and a client Id, like one obtained via the
+    # +clients+ command, this command prepares a 'status report' for display in
+    # the console.
+    #
+    # This command warns about: an inactive client, a client with no active
+    # projects, or no timesheet entries for the period specified.
+    #
+    # The output consists of the client's name, the text: 'Status Report (week
+    # ending <date>)', along with the timesheet entries returned. They are
+    # listed in project order, in entry order:
+    #   ----------------------------------------
+    #
+    #   ACME Co, Inc
+    #
+    #   Status Report (week ending 9/19/20)
+    #
+    #   I worked 0 hours.
+    #   ----------------------------------------
+    #
+    class Status < Hammerhead::Command
+      include Hammerhead::Utils
+
+      def initialize client, options # :nodoc:
+        self.specified_client = client
+        self.options = options
+        configure_query_dates
+      end
+
+      ##
+      # :stopdoc:
+      #
+      def execute input: $stdin, output: $stdout
+        process_short_cut
+        connection = Harvest.connection
+        output.puts "Fetching details for specified client: #{specified_client}"
+        client = connection.client specified_client
+        unless client.active?
+          output.puts "#{client.name} is not active."
+          return
+        end
+        projects = connection.projects_for_client client
+        if projects.empty?
+          output.puts "#{client.name} has no active projects."
+          return
+        end
+        entries = connection.my_time_sheet_entries start_date, end_date
+        if entries.empty?
+          output.puts "There are no timesheet entries for the period specified: #{start_date} -> #{end_date}"
+          return
+        end
+
+        status_output = {
+          hours: 0.0,
+          projects: {},
+          entries: {}
+        }
+
+        projects.each do |project|
+          status_output[:projects][project.id] = project.code
+        end
+
+        entries.each do |entry|
+          next unless status_output[:projects].key? entry.project_id
+
+          status_output[:hours] += entry.hours
+          project_code = status_output[:projects][entry.project_id]
+          status_output[:entries][project_code] = [] unless status_output[:entries].key? project_code
+          status_output[:entries][project_code] << entry.notes
+        end
+
+        output.puts '----------------------------------------'
+        output.puts
+        output.puts client.name.to_s
+        output.puts
+        output.puts "Status Report (week ending #{end_date.strftime('%-m/%-d/%y')})"
+        output.puts
+
+        if status_output[:hours] > 0.0
+          output.puts "I worked #{status_output[:hours]} hours on the following:"
+          status_output[:entries].each do |code, _entries|
+            output.puts "\n[#{code}]"
+            _entries.each do |entry|
+              output.puts "- #{entry}"
+            end
+          end
+        else
+          output.puts 'I worked 0 hours.'
+        end
+
+        output.puts
+        output.puts '----------------------------------------'
+      rescue StandardError => e
+        Hammerhead.logger.error 'STATUS COMMAND ERROR:', e
+      end
+
+      private
+
+      attr_accessor :end_date, :options, :start_date, :specified_client
+
+      def configure_query_dates
+        today = Date.today
+        start_of_week = Date::DAYNAMES.index(Harvest.connection.week_start_day)
+        adjustment = today.wday - start_of_week
+
+        case today.wday
+        when 0 # Sunday
+          self.start_date = if start_of_week.zero?
+            today - 7
+          else
+            today - 6
+                            end
+          self.end_date = start_date + 6
+
+        when 1 # Monday
+          if start_of_week.zero?
+            self.start_date = today - adjustment
+            self.end_date = start_date + adjustment
+          else
+            self.start_date = today - 7
+            self.end_date = start_date + 6
+          end
+        else
+          self.start_date = today - adjustment
+          self.end_date = start_date + adjustment
+        end
+      end
+
+      def process_short_cut
+        return unless options['short_cut']
+
+        configuration = Hammerhead.configuration
+
+        return if digits? specified_client
+
+        client = configuration.client_shortcut specified_client
+        raise Hammerhead::Error, "Specified shortcut: '#{specified_client}' does not exist" if client.nil?
+        self.specified_client = client['id']
+      end
+    end
+  end
+end

data/lib/hammerhead/configuration.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+require 'tty-config'
+
+module Hammerhead
+  ##
+  # :markup: markdown
+  # Represents the configuration for the hammerhead tool. It wraps the [tty-config](https://rubygems.org/gems/tty-config)
+  # gem.
+  #
+  class Configuration
+    attr_reader :config # :nodoc:
+
+    ##
+    # Creates a new instance of TTY::Config, configured with filename
+    # 'hammerhead.yml' and to look for said file in the current working directory
+    # or in the user's home directory.
+    #
+    def initialize
+      self.config = TTY::Config.new
+      config.append_path Dir.pwd  # look in current working directory
+      config.append_path Dir.home # look in user home directory
+      config.filename = File.basename configuration_filename, '.*'
+    end
+
+    ##
+    # :category: harvest
+    # Returns the Harvest +password+ as defined in the configuration file.
+    #
+    # This configuration items is <b>required</b>.
+    #
+    def password
+      harvest_configuration['password']
+    end
+
+    ##
+    # :category: harvest
+    # Returns the Harvest +subdomain+ as defined in the configuration file.
+    #
+    # This configuration items is <b>required</b>.
+    #
+    def subdomain
+      harvest_configuration['subdomain']
+    end
+
+    ##
+    # :category: harvest
+    # Returns the Harvest +username+ as defined in the configuration file.
+    #
+    # This configuration items is <b>required</b>.
+    #
+    def username
+      harvest_configuration['username']
+    end
+
+    ##
+    # :category: clients
+    # Convenience method to obtain a configured +shortcut+. Returns a Hash or nil
+    #
+    #   client_shortcut 'acme' => { id: 999999999, name: 'ACME Co, Inc' }
+    #
+    def client_shortcut shortcut
+      client_shortcuts[shortcut]
+    end
+
+    ##
+    # :category: clients
+    # Returns an Array of entries defined under +clients.shortcuts+
+    #
+    def client_shortcuts
+      config.fetch('clients.shortcuts', default: [])
+    end
+
+    ##
+    # :category: clients
+    # Returns an Array of client ids to be excluded from all operations.
+    #
+    def clients_to_exclude
+      config.fetch('clients.exclude', default: [])
+    end
+
+    ##
+    # :category: validation
+    # Performs 2 important checks: 1) if the file exists and 2) if it contains
+    # the required harvest information. If either of those fail this method
+    # raises an Hammerhead::Error.
+    #
+    def validate!
+      load_configuration!
+      validate_harvest_information
+    end
+
+    private
+
+    attr_writer :config # :nodoc:
+
+    def configuration_filename
+      'hammerhead.yml'
+    end
+
+    def harvest_configuration
+      config.fetch :harvest
+    end
+
+    def load_configuration!
+      unless config.exist?
+        raise Hammerhead::Error, "HarvestClient configuration file, '#{configuration_filename}' does not exist."
+      end
+
+      config.read
+    end
+
+    def validate_harvest_information
+      configuration_missing_messages = []
+      if harvest_configuration.nil?
+        configuration_missing_messages << "'#{configuration_filename}' does not define harvest configuration."
+      else
+        if subdomain.nil?
+          configuration_missing_messages << "'#{configuration_filename}' does not define harvest subdomain."
+        end
+        if username.nil?
+          configuration_missing_messages << "'#{configuration_filename}' does not define harvest username."
+        end
+        if password.nil?
+          configuration_missing_messages << "'#{configuration_filename}' does not define harvest password."
+        end
+      end
+      raise Hammerhead::Error, configuration_missing_messages.join("\n") unless configuration_missing_messages.empty?
+    end
+  end
+end

data/lib/hammerhead/utils.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module Hammerhead
+  ##
+  # Contains utility-type methods available for use throughout the tool.
+  #
+  module Utils
+
+    ##
+    # Returns true if the specified +input+ consists of digits
+    #
+    #   digits? '1234' => true
+    #   digits? 'abcd' => false
+    #
+    # Uses a regular expression to determine if all the specified characters
+    # are numeric.
+    #
+    def digits? input
+      input.match?(/\A\d+\Z/)
+    end
+
+  end
+end

data/lib/hammerhead/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module Hammerhead # :nodoc:
+  VERSION = '0.1.0'
+end

data/lib/harvest.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'harvest/connection'
+
+##
+# Exposes the Harvest API to Hammerhead.
+#
+module Harvest
+  class << self
+    ##
+    # Returns the sole Harvest::Connection instance.
+    #
+    def connection
+      Harvest::Connection.instance
+    end
+  end
+end

data/lib/harvest/connection.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require 'harvested' # NOTE: support for Harvest API V1
+
+module Harvest
+  ##
+  # :markup: markdown
+  # Represents the link between Harvest and Hammerhead and the Harvest V1 API.
+  #
+  # Backed by ['harvested'](https://rubygems.org/gems/harvested) gem.
+  #
+  class Connection
+    include Singleton
+    include Hammerhead::Utils
+
+    ##
+    # Use .instance to grab an initialied harvest connection:
+    #   connection = Harvest::Connection.instance
+    #
+    # Because this attempts to establish a connection to the API, ensure a
+    # correctly defined 'hammerhead.yml' file exists.
+    #
+    # Returns Harvest.hardy_client
+    #
+    def initialize
+      new_connection!
+    end
+
+    ##
+    # This is the hammerhead user, as defined in by the harvest credentials. It
+    # is for this user the client list will be provided, and the status report
+    # will be generated.
+    #
+    def authenticated_user
+      harvest.account.who_am_i
+    end
+
+    ##
+    # For the specified +client_id+ return its Harvest definition.
+    #
+    # If +client_id+ contains alpha-characters NotImplementedError is raised.
+    #
+    def client client_id
+      raise NotImplementedError, 'Client by name is not implemented yet.' unless digits?(client_id)
+      harvest.clients.find client_id
+    end
+
+    ##
+    # Return a list of clients. Currently only +options[:all]+ is supported.
+    # The default behavior is to only return 'active' clients.
+    #
+    # If the configuration file defines a list of ids to exclude, they're removed
+    # before 'active' or all clients are returned.
+    #
+    def clients options = {}
+      clients = harvest.clients.all.reject { |client| clients_to_exclude.include? client.id }
+      clients = clients.select { |client| client.active == true } unless options['all']
+      clients
+    end
+
+    ##
+    # Return a list of timesheet entries between +start_date+ and +end_date+, inclusive.
+    #
+    # This is for the +authenticated_user+.
+    #
+    def my_time_sheet_entries start_date, end_date
+      harvest.reports.time_by_user authenticated_user, start_date, end_date
+    end
+
+    ##
+    # Returns 'active' projects for the specified +client+.
+    #
+    # If the +client+ is not active, an empty list is returned.
+    #
+    def projects_for_client client
+      return [] unless client.active?
+
+      harvest.reports.projects_by_client(client).select(&:active?)
+    end
+
+    ##
+    # Return begining of work week as defined in Harvest
+    #
+    def week_start_day
+      authenticated_user.company.week_start_day
+    end
+
+    private
+
+    attr_accessor :harvest
+
+    def new_connection!
+      Hammerhead.configuration.validate!
+      self.harvest = Harvest.hardy_client subdomain: subdomain, username: username, password: password if harvest.nil?
+      harvest
+    rescue StandardError => e
+      Hammerhead.logger.fatal 'Fatal:', e
+    end
+
+    def subdomain
+      Hammerhead.configuration.subdomain
+    end
+
+    def username
+      Hammerhead.configuration.username
+    end
+
+    def password
+      Hammerhead.configuration.password
+    end
+
+    def clients_to_exclude
+      Hammerhead.configuration.clients_to_exclude
+    end
+  end
+end

data/lib/tasks/hammerhead.rake

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# Define Rake Tasks 'internal' to Hammerhead development
+
+def configuration_filename
+  'hammerhead.yml'
+end
+
+def example_configuration_filename
+  "#{configuration_filename}.example"
+end
+
+namespace :hh do
+  desc %(Flip Config File
+
+    Simple Rake Task to move the configuration file from one state to another.
+
+  )
+  task :flip_config_file do
+    if File.exist? configuration_filename
+      FileUtils.mv configuration_filename, example_configuration_filename, verbose: true
+    elsif File.exist? example_configuration_filename
+      FileUtils.mv example_configuration_filename, configuration_filename, verbose: true
+    end
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: hammerhead
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mel Riffe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: harvested
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Generate status reports from Harvest timesheets. TBD...
+email:
+- mel@juicyparts.com
+executables:
+- hammerhead
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- exe/hammerhead
+- lib/hammerhead.rb
+- lib/hammerhead/cli.rb
+- lib/hammerhead/command.rb
+- lib/hammerhead/commands/clients.rb
+- lib/hammerhead/commands/status.rb
+- lib/hammerhead/configuration.rb
+- lib/hammerhead/utils.rb
+- lib/hammerhead/version.rb
+- lib/harvest.rb
+- lib/harvest/connection.rb
+- lib/tasks/hammerhead.rake
+homepage: http://juicyparts.com/hammerhead
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: http://juicyparts.com/hammerhead
+  source_code_uri: https://github.com/juicyparts/hammerhead
+  changelog_uri: https://github.com/juicyparts/hammerhead/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/juicyparts/hammerhead/issues
+  documentation_uri: https://www.rubydoc.info/gems/hammerhead
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Generate status reports from Harvest timesheets.
+test_files: []