time_cop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2258a186bbf4d192ec0abac9e6f22dd176d3f8c9
+  data.tar.gz: 958bf194c3cb02fc9d43bda2fab21c6f0ff71ab9
+SHA512:
+  metadata.gz: e482ce70b329d5cc198d869e781689d4984275e5a30743e1724e0e004f4489033d056a8e196d1ac2bded0669395f6c10566216c872c635c7ce0afb04b5e369b3
+  data.tar.gz: e2430db898725e400db4bdc078ff6f9f14af33c285a860ce32cc862104254c9f989e04fe3622ed3f16dd2c24a01649a87fcbf67e85ad3c6cc1106926b1fd365a

data/.editorconfig

@@ -0,0 +1,42 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.rb]
+indent_style = space
+indent_size = 2
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[*.js]
+indent_style = space
+indent_size = 2
+
+[*.hbs]
+indent_style = space
+indent_size = 2
+
+[*.css]
+indent_style = space
+indent_size = 2
+
+[*.html]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

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 samsinite@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in time_cop.gemspec
+gemspec

data/README.md

@@ -0,0 +1,36 @@
+# TimeCop
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/time_cop`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_cop'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_cop
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/time_cop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test
+
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require 'pry'
+  require 'time_cop' # You know what to do.
+  ARGV.clear
+  IRB.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "time_cop"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/time_cop

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'time_cop'
+require 'time_cop/runner'
+
+TimeCop::Runner.invoke

data/lib/time_cop/accountability.rb

@@ -0,0 +1,156 @@
+require 'harvested'
+require 'date'
+
+module TimeCop
+  class Accountability
+    attr_reader :report_builder, :client, :date
+
+    DAYS_PER_WEEK = 5
+    HOURS_PER_WEEK = 32
+    HOURS_PER_DAY = HOURS_PER_WEEK / DAYS_PER_WEEK
+
+    QUARTERLY_PERIODS = {
+      q1: [{month: 1, day: 1}, {month: 3, day: 31}],
+      q2: [{month: 4, day: 1}, {month: 6, day: 30}],
+      q3: [{month: 7, day: 1}, {month: 9, day: 30}],
+      q4: [{month: 10, day: 1}, {month: 12, day: 31}]
+    }
+
+    def initialize(username:, password:, subdomain: 'wildland', date: Date.today, report_builder: nil)
+      @client = Harvest.client(username: username, password: password, subdomain: subdomain)
+      @date = date
+      @report_builder = report_builder ||
+        ReportBuilder.new(
+          client: client,
+          user: user,
+          start_date: start_of_quarter_date,
+          end_date: end_of_quarter_date
+        )
+    end
+
+    def account
+      client.account
+    end
+
+    def user
+      account.who_am_i
+    end
+
+    def date_from_period(period)
+        Date.new(date.year, period[:month], period[:day])
+    end
+
+    def select_quarter
+      QUARTERLY_PERIODS.select do |quarter, range|
+        start_of_range = range[0]
+        end_of_range = range[1]
+
+        start_date_of_range = date_from_period(start_of_range)
+        end_date_of_range = date_from_period(end_of_range)
+
+        (date >= start_date_of_range) && (date <= end_date_of_range)
+      end
+    end
+
+    def get_quarter
+      select_quarter.first[1]
+    end
+
+    def start_of_quarter_date
+      date_from_period(get_quarter[0])
+    end
+
+    def end_of_quarter_date
+      date_from_period(get_quarter[1])
+    end
+
+    def quarterly_tracked_time_by_user
+      @quarterly_tracked_time_by_user ||= report_builder.generate
+    end
+
+    def total_quarter_time_tracked
+      quarterly_tracked_time_by_user.map { |t| t.hours }.reduce(:+)
+    end
+
+    def total_quarter_days
+      (end_of_quarter_date - start_of_quarter_date).to_i
+    end
+
+    def business_days_between(start_date, end_date)
+      days_between = (end_date - start_date).to_i
+      return 0 unless days_between > 0
+
+      # Assuming we need to calculate days from 9th to 25th, 10-23 are covered
+      # by whole weeks, and 24-25 are extra days.
+      #
+      # Su Mo Tu We Th Fr Sa    # Su Mo Tu We Th Fr Sa
+      #        1  2  3  4  5    #        1  2  3  4  5
+      #  6  7  8  9 10 11 12    #  6  7  8  9 ww ww ww
+      # 13 14 15 16 17 18 19    # ww ww ww ww ww ww ww
+      # 20 21 22 23 24 25 26    # ww ww ww ww ed ed 26
+      # 27 28 29 30 31          # 27 28 29 30 31
+      whole_weeks, extra_days = days_between.divmod(7)
+
+      unless extra_days.zero?
+        # Extra days start from the week day next to start_day,
+        # and end on end_date's week date. The position of the
+        # start date in a week can be either before (the left calendar)
+        # or after (the right one) the end date.
+        #
+        # Su Mo Tu We Th Fr Sa    # Su Mo Tu We Th Fr Sa
+        #        1  2  3  4  5    #        1  2  3  4  5
+        #  6  7  8  9 10 11 12    #  6  7  8  9 10 11 12
+        # ## ## ## ## 17 18 19    # 13 14 15 16 ## ## ##
+        # 20 21 22 23 24 25 26    # ## 21 22 23 24 25 26
+        # 27 28 29 30 31          # 27 28 29 30 31
+        #
+        # If some of the extra_days fall on a weekend, they need to be subtracted.
+        # In the first case only corner days can be days off,
+        # and in the second case there are indeed two such days.
+        extra_days -= if start_date.next_day.wday <= end_date.wday
+                        [start_date.next_day.sunday?, end_date.saturday?].count(true)
+                      else
+                        2
+                      end
+      end
+
+      (whole_weeks * 5) + extra_days
+    end
+
+    def total_week_days
+      business_days_between(start_of_quarter_date, end_of_quarter_date)
+    end
+
+    def expected_quarter_hours
+      total_week_days.to_f * HOURS_PER_DAY
+    end
+
+    def expected_quarter_hours_to_today
+      business_days_between(start_of_quarter_date, date) * HOURS_PER_DAY
+    end
+
+    def current_hours_delta
+      total_quarter_time_tracked - expected_quarter_hours_to_today
+    end
+
+    def quarterly_hours_delta
+      expected_quarter_hours - total_quarter_time_tracked
+    end
+
+    def quarterly_hours_per_business_day_needed
+      if business_days_between(date, end_of_quarter_date) == 0
+        quarterly_hours_delta
+      else
+        quarterly_hours_delta / business_days_between(date, end_of_quarter_date).to_f
+      end
+    end
+
+    def print_report
+      puts "Current Surplus(+)/Deficit(-): #{current_hours_delta.round(2)}"
+      puts "Quarterly Hour Target: #{expected_quarter_hours.round(2)}"
+      puts "Current Quarterly Charged Hours: #{total_quarter_time_tracked.round(2)}"
+      puts "Total Hours Needed By End Of Quarter: #{quarterly_hours_delta.round(2)}"
+      puts "Hours Per Business Day Average Needed To Reach Goal: #{quarterly_hours_per_business_day_needed.round(2)}"
+    end
+  end
+end

data/lib/time_cop/option_parser.rb

@@ -0,0 +1,39 @@
+require 'optparse'
+
+module TimeCop
+  class OptionParser
+    attr_reader :args
+
+    def initialize(args)
+      @args = args
+    end
+
+    def parse
+      options = {}
+      option_parser = ::OptionParser.new do |opts|
+        opts.on("-u USERNAME", "--username=USERNAME", "Username to authenticate as") do |username|
+          options[:username] = username
+        end
+
+        opts.on("-p PASSWORD", "--password=PASSWORD", "Passsword to authenticate with") do |password|
+          options[:password] = password
+        end
+
+        opts.on("-h", "--help", "Prints help") do
+          puts opts
+          exit
+        end
+      end
+
+      option_parser.parse(args)
+
+      unless options[:username] && options[:password]
+        puts "Please specify a username and password"
+        puts option_parser
+        exit
+      end
+
+      options
+    end
+  end
+end

data/lib/time_cop/report_builder.rb

@@ -0,0 +1,22 @@
+module TimeCop
+  class ReportBuilder
+    attr_reader :client, :user, :start_date, :end_date
+
+    def initialize(client:, user:, start_date:, end_date:)
+      @client = client
+      @user = user
+      @start_date = start_date
+      @end_date = end_date
+    end
+
+    def generate
+      reports.time_by_user(user, start_date, end_date)
+    end
+
+    private
+
+    def reports
+      client.reports
+    end
+  end
+end

data/lib/time_cop/runner.rb

@@ -0,0 +1,13 @@
+require 'time_cop/option_parser'
+
+module TimeCop
+  class Runner
+    def self.invoke
+      options_parser = OptionParser.new(ARGV)
+      options = options_parser.parse
+
+      accountability = Accountability.new(username: options[:username], password: options[:password])
+      accountability.print_report
+    end
+  end
+end

data/lib/time_cop/version.rb

@@ -0,0 +1,3 @@
+module TimeCop
+  VERSION = "0.1.0"
+end

data/lib/time_cop.rb

@@ -0,0 +1,7 @@
+require "time_cop/version"
+require "time_cop/accountability"
+require "time_cop/report_builder"
+
+module TimeCop
+  # Your code goes here...
+end

data/time_cop.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'time_cop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_cop"
+  spec.version       = TimeCop::VERSION
+  spec.authors       = ["Sam Clopton"]
+  spec.email         = ["samsinite@gmail.com"]
+
+  spec.summary       = %q{Wildland Time Accountability App}
+  spec.description   = %q{Helps Wildland employees know how much time they have tracked, what their target hours are, and more.}
+  spec.homepage      = "https://github.com/wildland/time_cop"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "harvested", "~> 3.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: time_cop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Clopton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: harvested
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helps Wildland employees know how much time they have tracked, what their
+  target hours are, and more.
+email:
+- samsinite@gmail.com
+executables:
+- time_cop
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/time_cop
+- lib/time_cop.rb
+- lib/time_cop/accountability.rb
+- lib/time_cop/option_parser.rb
+- lib/time_cop/report_builder.rb
+- lib/time_cop/runner.rb
+- lib/time_cop/version.rb
+- time_cop.gemspec
+homepage: https://github.com/wildland/time_cop
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Wildland Time Accountability App
+test_files: []