flowdock-notifications 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef42929a22a7cfa9910b07dffe2fb137217413df
+  data.tar.gz: 33b2bb041e8bcdfd767eb068cf380ebae3c3fb0d
+SHA512:
+  metadata.gz: bad1115da8241d13c21222c8e5ff1399d674f20ee9aaa50df4ddb2718e7a6805208525d16f6881250c995cd781548d9220d2f11186d0d4c6b2f37a7deb76b8dc
+  data.tar.gz: bfe0ca9ab3939f9f32946b0a74117314291981f6b2a2039b1c63e11bd9d93ef8ab51248e92f28595687775796b88ef1716493ed2b9e75199a1a06f8068eb4c58

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Kent Mewhort
+
+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,22 @@
+# Flowdock::Notifications
+
+This gem provides cross-platform message notifications for flowdock (through libnotify on linux, growl on mac). Currently only
+supports showing all messages across all flows.
+
+## Installation
+
+Install the gem globally:
+
+    $ gem install flowdock-notifications
+
+Add `FLOWDOCK_API_TOKEN=<your flowdock api token>` to your environment variables.
+
+Then run `bin/flowdock-notifications' as periodic as you'd like to receive messages (eg. every 30 seconds) from your cron.
+
+## Contributing
+
+1. Fork it ( https://github.com/kmewhort/flowdock-notifications/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/flowdock-notifications

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flowdock-notifications"
+
+FlowdockNotifications::Notifier.send
+

data/bin/setup

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

data/flowdock-notifications.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flowdock-notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flowdock-notifications"
+  spec.version       = FlowdockNotifications::VERSION
+  spec.authors       = ["Kent Mewhort"]
+  spec.email         = ["kent@openissues.ca"]
+
+  spec.summary       = %q{Cross-platform desktop notifications for Flowdock}
+  spec.homepage      = "http://github.com/kmewhort/flowdock-notifications"
+  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_runtime_dependency "flowdock"
+  spec.add_runtime_dependency "notify"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/flowdock-notifications.rb

@@ -0,0 +1,8 @@
+require "flowdock-notifications/version"
+require "flowdock-notifications/flowdock_client"
+require "flowdock-notifications/simple_store"
+require "flowdock-notifications/message_notification"
+require "flowdock-notifications/notifier"
+
+module FlowdockNotifications
+end

data/lib/flowdock-notifications/flowdock_client.rb

@@ -0,0 +1,65 @@
+require 'flowdock'
+require 'tmpdir'
+require 'open-uri'
+
+class FlowdockNotifications::FlowdockClient
+  def initialize
+    @client = Flowdock::Client.new(api_token: token)
+  end
+
+  def flow_names
+    flows.map {|flow| flow['parameterized_name']}
+  end
+
+  def messages_since(flow_name, since_msg_id)
+    @client.get("#{flow_url(flow_name)}/messages", since_id: since_msg_id)
+  end
+
+  def latest_message_id(flow_name)
+    latest_msg = @client.get("#{flow_url(flow_name)}/messages", limit: 1).first
+    latest_msg.nil? ? 0 : latest_msg['id']
+  end
+
+  def user(user_id)
+    return nil if user_id.nil? || user_id == '0'
+    @client.get "/users/#{user_id}"
+  end
+
+  def avatar(user_id)
+    u = user(user_id)
+    return nil if u.nil?
+
+    url = u['avatar']
+    return nil if url.nil? || url.empty?
+
+    avatar_id = url.match(/\/([^\/]+)\/\Z/)[1]
+    return nil if avatar_id.nil?
+
+    # cached local copy of the avatar
+    local_filename = "#{Dir.tmpdir}/#{avatar_id}"
+    unless File.exists? local_filename
+      File.open(local_filename, "wb") do |saved_file|
+        open(url, "rb") {|read_file| saved_file.write(read_file.read)}
+      end
+    end
+    local_filename
+  end
+
+  private
+  def token
+    ENV['FLOWDOCK_API_TOKEN'] or raise "Must configure FLOWDOCK_API_TOKEN in your environment variables"
+  end
+
+  def flows
+    @flows ||= @client.get('/flows')
+  end
+
+  def flow(flow_name)
+    flows.find {|f| f['parameterized_name'] == flow_name}
+  end
+
+  def flow_url(flow_name)
+    f = flow(flow_name)
+    "/flows/#{f['organization']['parameterized_name']}/#{f['parameterized_name']}"
+  end
+end

data/lib/flowdock-notifications/message_notification.rb

@@ -0,0 +1,47 @@
+require 'notify'
+require 'json'
+
+class FlowdockNotifications::MessageNotification
+  def initialize(client, flow_name, message)
+    @message = message
+    @flow_name = flow_name
+    @client = client
+  end
+
+  def show!
+    Notify.notify title, content, options
+  end
+
+  protected
+  def options
+    opts = {
+        app_name: "flowdock-notifications"
+    }
+    opts[:icon] = icon if icon
+    opts
+  end
+
+  def title
+    return @title if @title
+    user = @client.user(@message['user'])
+    @title ||= "[#{@flow_name}] #{user.nil? ? '' : user['nick']}"
+  end
+
+  def content
+    return nil if @message['content'].nil?
+
+    if @message['content'].is_a? String
+      @message['content']
+    elsif @message['content']['subject']
+      @message['content']['subject']
+    elsif @message['content']['content']
+      @message['content']['content']
+    else
+      @message['content'].to_json
+    end
+  end
+
+  def icon
+    @icon ||= @client.avatar(@message['user'])
+  end
+end

data/lib/flowdock-notifications/notifier.rb

@@ -0,0 +1,31 @@
+require 'tmpdir'
+
+class FlowdockNotifications::Notifier
+  # send out notifications for new messages on throughout all flows
+  def self.send
+    store = FlowdockNotifications::SimpleStore.new
+    client = FlowdockNotifications::FlowdockClient.new
+
+    client.flow_names.each do |flow_name|
+      # if there are no last retrieved messages, this must be the first run and there are no notifications yet:
+      # simply store the latest message id so we can find new messages the next time
+      flow_stored_vars = store.get(flow_name)
+      last_id = flow_stored_vars ? flow_stored_vars['last_retrieved_id'] : nil
+      unless last_id
+        store.set(flow_name, { 'last_retrieved_id' => client.latest_message_id(flow_name) })
+        next
+      end
+
+      new_messages = client.messages_since(flow_name, last_id)
+      new_messages.each do |msg|
+        notification = FlowdockNotifications::MessageNotification.new(client, flow_name, msg)
+        notification.show!
+      end
+
+      unless new_messages.empty?
+        store.set(flow_name, { 'last_retrieved_id' => new_messages.map {|m| m['id'].to_i}.max })
+      end
+    end
+    true
+  end
+end

data/lib/flowdock-notifications/simple_store.rb

@@ -0,0 +1,25 @@
+# simple JSON variable store to a tempfile
+require 'json'
+class FlowdockNotifications::SimpleStore
+  def initialize
+    if File.exists?(temp_filename) && File.size(temp_filename) > 0
+      @store = JSON.parse(IO.read(temp_filename))
+    else
+      @store = {}
+    end
+  end
+
+  def get(variable)
+    @store[variable]
+  end
+
+  def set(variable, value)
+    @store[variable] = value
+    File.open(temp_filename, "w") { |f| f.write(@store.to_json) }
+  end
+
+  private
+  def temp_filename
+     "#{Dir.tmpdir}/flowdock-notifications.json"
+  end
+end

data/lib/flowdock-notifications/version.rb

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

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: flowdock-notifications
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kent Mewhort
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flowdock
+  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: notify
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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'
+description: 
+email:
+- kent@openissues.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/flowdock-notifications
+- bin/setup
+- flowdock-notifications.gemspec
+- lib/flowdock-notifications.rb
+- lib/flowdock-notifications/flowdock_client.rb
+- lib/flowdock-notifications/message_notification.rb
+- lib/flowdock-notifications/notifier.rb
+- lib/flowdock-notifications/simple_store.rb
+- lib/flowdock-notifications/version.rb
+homepage: http://github.com/kmewhort/flowdock-notifications
+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: Cross-platform desktop notifications for Flowdock
+test_files: []