harvest_slack_report 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfb66b329c6e2765209cdf8b26f784d11a60c648
+  data.tar.gz: 49b6298cd91ce335ee9dd3ed323b638ced60b7e3
+SHA512:
+  metadata.gz: 7e62a0cf6d9b594333164bc6660e44d0c2e1da08dea90fe0669a9ca6b2ef6fe815bc74ba457a487c59ad43459de9d58da4d51f3936ba6a3ab68fe64c6cf7b0fe
+  data.tar.gz: 51703594bf954548b0f6113a220decfdbaa7e904f533011501d8e9ab611445d28e6da3c7da619929f20b57ab7735a9e9d75c324e04c5bfff83a7fcb50b264ff0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at matt@bitzesty.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Matthew Ford
+
+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,26 @@
+# HarvestSlackReport
+
+Reporting on daily harvest activity.
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
+
+## Installation
+
+    $ gem install harvest_slack_report
+
+## Usage
+
+The following environment variables must be set:
+
+    HARVEST_DOMAIN=your subdomain
+    HARVEST_USERNAME=your email
+    HARVEST_PASSWORD=password
+    SLACK_API_TOKEN=slack bot token
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bitzesty/harvest_slack_report. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app.json

@@ -0,0 +1,29 @@
+{
+  "name": "HarvestSlackReport: A Slack Timesheet Bot",
+  "description": "A bot that notifies Slack about timespent on projects.",
+  "keywords": [
+    "slack",
+    "harvest"
+  ],
+  "repository": "https://github.com/bitzesty/harvest_slack_report",
+  "env": {
+    "HARVEST_DOMAIN": {
+      "description": "Your Harvest subdomain"
+    },
+    "HARVEST_USERNAME": {
+      "description": "An admin Harvest account username/email"
+    },
+    "HARVEST_PASSWORD": {
+      "description": "The password for that account"
+    },
+    "IGNORE_USERS": {
+      "description": "List of user ids to ignore, e.g. 1234,5678"
+    },
+    "SLACK_API_TOKEN": {
+      "description": "Your Slack Bot API Token (https://my.slack.com/services/new/bot)"
+    },
+  },
+  "addons": [
+    "scheduler"
+  ]
+}

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "harvest_slack_report"
+
+# 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/harvest_slack_report

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'harvest_slack_report'
+
+require 'dotenv'
+Dotenv.load
+
+HarvestSlackReport.run

data/harvest_slack_report.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'harvest_slack_report/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "harvest_slack_report"
+  spec.version       = HarvestSlackReport::VERSION
+  spec.authors       = ["Matthew Ford"]
+  spec.email         = ["matt@bitzesty.com"]
+
+  spec.summary       = %q{Reporting Harvest data to Slack}
+  spec.description   = %q{Reporting Harvest data to Slack}
+  spec.homepage      = "https://github.com/bitzesty/harvest_slack_report"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "slack-ruby-client", "~> 0.7.0"
+  spec.add_dependency "harvested", "~> 3.1.1"
+  spec.add_dependency "activesupport", "~> 4.2.6"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.1.0"
+end

data/lib/harvest_slack_report/version.rb

@@ -0,0 +1,3 @@
+module HarvestSlackReport
+  VERSION = "1.0.0"
+end

data/lib/harvest_slack_report.rb

@@ -0,0 +1,99 @@
+require 'harvest_slack_report/version'
+require 'harvested'
+require 'slack-ruby-client'
+require 'active_support/all'
+
+# Posts summary harvest data to a slack channel
+module HarvestSlackReport
+  def self.fetch_harvest_data(from_date)
+    domain = ENV.fetch 'HARVEST_DOMAIN'
+    username = ENV.fetch 'HARVEST_USERNAME'
+    password = ENV.fetch 'HARVEST_PASSWORD'
+    puts "Collecting Harvest data for #{domain}..."
+    harvest = Harvest.hardy_client(subdomain: domain,
+                                   username: username,
+                                   password: password
+                                  )
+
+    ignore_users = if ENV['IGNORE_USERS'].present?
+      ENV['IGNORE_USERS'].split(',').map{ |user_id| user_id.to_i }
+    else
+      []
+    end
+
+    people = harvest.users.all.select { |u| u.is_active? && !ignore_users.include?(u.id) }
+
+    # puts people.map{ |u| u.email }
+
+    projects = harvest.projects.all
+
+    # puts projects
+
+    puts 'Aggregating data...'
+
+    report = []
+    n_people = people.count
+    people.each_with_index do |person, i|
+      # TODO Make this customisable
+      # Timesheet entries for yesterday
+      entries = harvest.reports.time_by_user(person.id, from_date, Time.now)
+
+      name = "#{person.first_name} #{person.last_name}"
+
+      if entries && entries.any?
+        total_hours = entries.map { |x| x.hours }.sum.round(2)
+
+        hours_by_project = entries.group_by { |x| x.project_id }.map do |project_id, es|
+          proj = projects.find { |pr| pr.id == project_id }
+          title = "#{proj.code.present? ? "[#{proj.code}] " : ''}#{proj.name}"
+          { title:  title, value: es.map { |h| h.hours }.sum.round(2), short: true }
+        end
+
+        color_code = case total_hours
+        when 0..2
+          "#D0021B"
+        when 2..4
+          "#F59423"
+        when 4..5
+          "#F8C61C"
+        else
+          "#72D321"
+        end
+
+        report << { fallback: "#{name} logged #{total_hours} hours",
+                    text: "#{name} logged #{total_hours} hours",
+                    fields: hours_by_project,
+                    color: color_code
+                  }
+
+      else
+        report << { fallback: "#{name} logged no time", text: "#{name} logged no time", color: "#4A4A4A" }
+      end
+      puts "#{i+1}/#{n_people}"
+    end
+
+    report
+  end
+
+  def self.run
+    from_date = Time.now - 24.hours
+    report = fetch_harvest_data(from_date)
+
+    if ENV['SLACK_API_TOKEN'].present?
+      puts 'Posting to Slack'
+      Slack.configure do |config|
+        config.token = ENV['SLACK_API_TOKEN']
+      end
+      client = Slack::Web::Client.new
+      client.auth_test
+      client.chat_postMessage(channel: '#2-standup',
+                              text: "Time Report from #{from_date.to_formatted_s(:rfc822)} to now:",
+                              attachments: report,
+                              as_user: true
+                             )
+    else
+      puts 'SLACK_API_TOKEN needs to be set'
+      puts report.inspect
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: harvest_slack_report
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Ford
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slack-ruby-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+description: Reporting Harvest data to Slack
+email:
+- matt@bitzesty.com
+executables:
+- harvest_slack_report
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app.json
+- bin/console
+- bin/setup
+- exe/harvest_slack_report
+- harvest_slack_report.gemspec
+- lib/harvest_slack_report.rb
+- lib/harvest_slack_report/version.rb
+homepage: https://github.com/bitzesty/harvest_slack_report
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Reporting Harvest data to Slack
+test_files: []