timetrap-hipchat 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50c306c84dc2f34f59fbf1487043891953a155da
+  data.tar.gz: b9ceeb90873208adaed095d686062bd6296596ef
+SHA512:
+  metadata.gz: 231df442192c607fea361002314bc72a5b76b3b50f24c73293a5eff5ad599727c88e81811000a6b49b17afeea32894e5d2afff8b19038a66ef5c418fbacbb387
+  data.tar.gz: b206189ef6af9bdc42765b1514f05fcd05ec25f2573064123255e0246fe39b88bbfb3c3d2110a66612c1d9b2fe16b7afb00fb6adfb8faa5b732617fd64610d71

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'timetrap'
+gem 'hipchat'
+gem 'thor'
+gem 'jeweler'

data/Gemfile.lock

@@ -0,0 +1,71 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    chronic (0.10.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    git (1.2.6)
+    github_api (0.11.3)
+      addressable (~> 2.3)
+      descendants_tracker (~> 0.0.1)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 1.2)
+      multi_json (>= 1.7.5, < 2.0)
+      nokogiri (~> 1.6.0)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.18)
+    hipchat (1.1.0)
+      httparty
+    httparty (0.13.1)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    mini_portile (0.5.2)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.1)
+      mini_portile (~> 0.5.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.3.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+    sequel (4.0.0)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    thread_safe (0.3.2)
+    timetrap (1.8.14)
+      chronic (~> 0.10.2)
+      sequel (~> 4.0.0)
+      sqlite3 (~> 1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hipchat
+  jeweler
+  thor
+  timetrap

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2014-04-22
+
+* Initial release

data/README.md

@@ -0,0 +1,74 @@
+# timetrap-hipchat
+
+This Ruby gem extends the popular
+[Timetrap](https://github.com/samg/timetrap) time tracker to notify a
+[Hipchat](https://hipchat.com) room any time you use the `in`, `out`, and
+`resume` commands.
+
+![Example](https://raw.githubusercontent.com/logankoester/timetrap-hipchat/master/demo.png)
+
+## Requirements
+
+* Ruby 1.9+
+* My [fork of Timetrap](https://github.com/logankoester/timetrap/tree/hooks)
+  (until **hook support** is accepted and released upstream)
+* A Hipchat API token
+
+## Installation
+
+Once you've installed and configured my forked `timetrap` gem, install
+timetrap-hipchat.
+
+```bash
+$ gem install timetrap-hipchat
+```
+
+Then use the `timetrap-hipchat` command to add the relevant hooks to your
+sheets.
+
+```bash
+$ timetrap-hipchat <sheet>
+```
+
+Example...
+
+```bash
+$ timetrap-hipchat install example
+Configuring hipchat hooks for timetrap sheet example
+HipChat API Token: YOUR_TOKEN
+HipChat Room Name: YOUR_ROOM
+Your name: Your Name
+      create  /home/ldk/.timetrap/hooks/example/hipchat.yml
+      create  /home/ldk/.timetrap/hooks/example/in.rb
+      create  /home/ldk/.timetrap/hooks/example/out.rb
+      create  /home/ldk/.timetrap/hooks/example/resume.rb
+All done!
+```
+
+**You're done!** Any time you run `timetrap [in|out|resume]`, the channel
+you configured will be notified.
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2014 Logan Koester
+
+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/Rakefile

@@ -0,0 +1,45 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :xzibit, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = 'timetrap-hipchat'
+  gem.version = '1.0.0'
+  gem.summary = 'Timetrap hooks to notify a Hipchat room'
+  gem.description = 'Extends the Timetrap timetracker by providing command hooks to notify a Hipchat room when you clock in/out/resume'
+  gem.homepage = 'https://github.com/logankoester/timetrap-hipchat'
+  gem.authors = ['Logan Koester']
+  gem.email = ['logan@logankoester.com']
+  gem.license = 'MIT'
+
+  gem.files.include 'History.txt'
+  gem.files.include 'README.md'
+  gem.files.include 'Rakefile'
+  gem.files.include 'bin/timetrap-hipchat'
+  gem.files.include 'lib/timetrap/hipchat/templates/hipchat.yml.tt'
+  gem.files.include 'lib/timetrap/hipchat/templates/in.rb'
+  gem.files.include 'lib/timetrap/hipchat/templates/out.rb'
+  gem.files.include 'lib/timetrap/hipchat/templates/resume.rb'
+  gem.files.include 'lib/timetrap/hipchat.rb'
+
+  # dependencies defined in Gemfile
+
+  gem.executables = ['timetrap-hipchat']
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+# vim: syntax=ruby

data/bin/timetrap-hipchat

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'timetrap'
+require 'hipchat'
+require 'thor'
+
+module Timetrap
+  module Hipchat
+    class CLI < Thor
+      include Thor::Actions
+
+      source_root File.join(File.dirname(__FILE__), '..', 'lib', 'timetrap', 'hipchat', 'templates')
+
+      desc 'install <sheet>', 'Install & configure for the specified sheet'
+      def install(sheet)
+        say "Configuring hipchat hooks for timetrap sheet #{sheet}", :green
+        @@destination_root = hooks_path(sheet)
+
+        @hipchat_token = ask 'HipChat API Token:'
+        @hipchat_room = ask 'HipChat Room Name:'
+        @hipchat_display_name = ask 'Your name:'
+
+        template 'hipchat.yml.tt', File.join(@@destination_root, 'hipchat.yml')
+        copy_file 'in.rb', File.join(@@destination_root, 'in.rb')
+        copy_file 'out.rb', File.join(@@destination_root, 'out.rb')
+        copy_file 'resume.rb', File.join(@@destination_root, 'resume.rb')
+
+        say 'All done!', :green
+      end
+
+      private
+      def hooks_path(sheet)
+        File.join Timetrap::Config['hooks_path'], sheet
+      end
+
+    end
+  end
+end
+
+Timetrap::Hipchat::CLI.start

data/lib/timetrap/hipchat.rb

@@ -0,0 +1,55 @@
+require 'hipchat'
+
+module Timetrap
+  class Hipchat
+    include Timetrap::Helpers
+
+    def initialize(api_token, room, user)
+      @client = HipChat::Client.new api_token, api_version: 'v2'
+      @room = room
+      @user = user
+    end
+
+    def in
+      entry = Timetrap::Timer.active_entry
+      image = shield 'started', 'green'
+
+      send 'green', <<-MSG
+        <img src="#{image}" /> 
+        <strong>#{entry.note}</strong>
+      MSG
+    end
+
+    def out
+      entry = Timetrap::Timer.last_checkout
+      duration = format_seconds entry.duration
+      image = shield 'stopped', 'red'
+
+      send 'red', <<-MSG
+        <img src="#{image}" /> 
+        <strong>#{entry.note}</strong> after <em>#{duration}</em>
+      MSG
+    end
+
+    def resume
+      entry = Timetrap::Timer.active_entry
+      image = shield 'resumed', 'yellow'
+
+      send 'yellow', <<-MSG
+        <img src="#{image}" /> 
+        <strong>#{entry.note}</strong>
+      MSG
+    end
+
+    private
+
+    def shield(subject = @user, status, color)
+      "http://img.shields.io/badge/#{subject}-#{status}-#{color}.svg?style=flat"
+    end
+
+    def send(color, msg)
+      @client[@room].send 'Timetrap', msg, color: color
+    end
+
+  end
+end

data/lib/timetrap/hipchat/templates/hipchat.yml.tt

@@ -0,0 +1,5 @@
+---
+hipchat:
+  token: '<%= @hipchat_token %>'
+  room: '<%= @hipchat_room %>'
+  display_name: '<%= @hipchat_display_name %>'

data/lib/timetrap/hipchat/templates/in.rb

@@ -0,0 +1,7 @@
+require 'timetrap/hipchat'
+require 'yaml'
+
+@hipchat_config = YAML.load_file File.join(File.dirname(__FILE__), 'hipchat.yml')
+Timetrap::Hipchat.new(@hipchat_config['hipchat']['token'],
+  @hipchat_config['hipchat']['room'],
+  @hipchat_config['hipchat']['display_name']).in

data/lib/timetrap/hipchat/templates/out.rb

@@ -0,0 +1,7 @@
+require 'timetrap/hipchat'
+require 'yaml'
+
+@hipchat_config = YAML.load_file File.join(File.dirname(__FILE__), 'hipchat.yml')
+Timetrap::Hipchat.new(@hipchat_config['hipchat']['token'],
+  @hipchat_config['hipchat']['room'],
+  @hipchat_config['hipchat']['display_name']).out

data/lib/timetrap/hipchat/templates/resume.rb

@@ -0,0 +1,7 @@
+require 'timetrap/hipchat'
+require 'yaml'
+
+@hipchat_config = YAML.load_file File.join(File.dirname(__FILE__), 'hipchat.yml')
+Timetrap::Hipchat.new(@hipchat_config['hipchat']['token'],
+  @hipchat_config['hipchat']['room'],
+  @hipchat_config['hipchat']['display_name']).resume

data/timetrap-hipchat.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "timetrap-hipchat"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Logan Koester"]
+  s.date = "2014-04-22"
+  s.description = "Extends the Timetrap timetracker by providing command hooks to notify a Hipchat room when you clock in/out/resume"
+  s.email = ["logan@logankoester.com"]
+  s.executables = ["timetrap-hipchat"]
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "History.txt",
+    "README.md",
+    "Rakefile",
+    "bin/timetrap-hipchat",
+    "demo.png",
+    "lib/timetrap/hipchat.rb",
+    "lib/timetrap/hipchat/templates/hipchat.yml.tt",
+    "lib/timetrap/hipchat/templates/in.rb",
+    "lib/timetrap/hipchat/templates/out.rb",
+    "lib/timetrap/hipchat/templates/resume.rb",
+    "timetrap-hipchat.gemspec"
+  ]
+  s.homepage = "https://github.com/logankoester/timetrap-hipchat"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.14"
+  s.summary = "Timetrap hooks to notify a Hipchat room"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<timetrap>, [">= 0"])
+      s.add_runtime_dependency(%q<hipchat>, [">= 0"])
+      s.add_runtime_dependency(%q<thor>, [">= 0"])
+      s.add_runtime_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<timetrap>, [">= 0"])
+      s.add_dependency(%q<hipchat>, [">= 0"])
+      s.add_dependency(%q<thor>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<timetrap>, [">= 0"])
+    s.add_dependency(%q<hipchat>, [">= 0"])
+    s.add_dependency(%q<thor>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: timetrap-hipchat
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Logan Koester
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: timetrap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends the Timetrap timetracker by providing command hooks to notify
+  a Hipchat room when you clock in/out/resume
+email:
+- logan@logankoester.com
+executables:
+- timetrap-hipchat
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- History.txt
+- README.md
+- Rakefile
+- bin/timetrap-hipchat
+- demo.png
+- lib/timetrap/hipchat.rb
+- lib/timetrap/hipchat/templates/hipchat.yml.tt
+- lib/timetrap/hipchat/templates/in.rb
+- lib/timetrap/hipchat/templates/out.rb
+- lib/timetrap/hipchat/templates/resume.rb
+- timetrap-hipchat.gemspec
+homepage: https://github.com/logankoester/timetrap-hipchat
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Timetrap hooks to notify a Hipchat room
+test_files: []