mina-flowdock 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46b182d653465271aaf7e6ab1c5ab4dd61146d8a
+  data.tar.gz: b6c0583f4580f765df222dcca135378ebf6b0f46
+SHA512:
+  metadata.gz: 8de3c513cd91b36876c75a18e5a73d3d8f0b3f25e1df15d0cc665f59311adc67e2d6214bb98dd776f02fb8361c9a7f2b44608ce8bbd7ae27747778bc7383dba0
+  data.tar.gz: 4edd364f8605efa8255914d6ce979e8d56836ce4bbf479e7818e9631c42e86f8c7a48266d89d0035568ce4d73b51af1e26890deff210fd8ea139cde011c63302

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "mina-flowdock Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,8 @@
+### 0.2 (unreleased)
+
+### 0.1 / 2013-12-02
+
+* Initial release:
+  * Add plugin, task, and mina/flowdock.rb
+  * Add README
+  * Add initial test setup

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "kramdown"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Don Morrison
+
+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,190 @@
+# mina-flowdock
+
+* [Homepage](https://github.com/elskwid/mina-flowdock#readme)
+* [Issues](https://github.com/elskwid/mina-flowdock/issues)
+* [Documentation](http://rubydoc.info/gems/mina-flowdock/frames)
+* [Email](mailto:don at elskwid.net)
+
+## Description
+
+Mina plugin to add [Flowdock](http://flowdock.com) deployment notifications.
+
+`mina-flowdock` pushes deployment notifications to Flowdock team inboxes using
+the Flowdock [API](https://github.com/flowdock/flowdock-api/).
+
+## Features
+
+### Notify multiple flows
+
+Add multiple Flowdock API tokens to send notifications to multiple flows.
+
+### Default tags
+
+Notifications are tagged with `#deploy` and the stage (deploy env). More
+tags can be added. See (Settings).
+
+### Supports notifications for commit/branch
+
+The Mina git module supports deployment using a specific commit or branch.
+The option used is detected and included in the notifications.
+
+### Verifies the commit/branch
+
+The bare checkout on the server is used to find the sha for the commit/branch
+being deployed which is then returned in the notification. An error is raised
+if it can't be retrieved.
+
+### Respects Mina simulate option
+
+The notifications are not sent if mina is run with the `--simulate` option.
+
+### Uses git for user name and email
+
+The `grit` library is used to access the git config for the local repository
+and send the notification from the user configured there.
+
+### Configurable settings
+
+Most of the settings are easily overridden. See (Settings).
+
+## Comparison to flowdock/capistrano
+
+There are some differences between the Mina notifications and those sent
+from [flowdock/capistrano](https://github.com/flowdock/flowdock-api/blob/master/lib/flowdock/capistrano.rb)
+because of the assumptions made by each deployment library.
+
+The capistrano notifications will list deployed commits when possible. Cap
+has access to a full git checkout and with that the currently deployed branch.
+Mina uses a bare repository and so the branch or commit for the current
+deploy is not known. `mina-flowdock` just sends a simple notification that a
+branch or commit has been deployed to a specific stage.
+
+## Usage
+
+```ruby
+# In your deploy tasks...
+
+require 'mina/flowdock'
+
+# required settings
+set :flowdock_project_name, "my_project"
+set :flowdock_api_token, ["firstflowapitoken", "secondflowapitoken"]
+set :flowdock_deploy_env, stage
+
+# optional settings
+set :flowdock_deploy_tags, ["my_tag1", "my_tag2]
+```
+
+Then run `mina deploy ...` as usual. Requiring `mina/flowdock` extends the
+file with some helper methods, includes the Flowdock notification task
+(`flowdock:notify`), and uses `mina-hooks` to queue the notifications to
+run after the deployment.
+
+## Settings
+
+### Required
+
+The `flowdock:notify` task will exit with an error if any of the required
+settings are missing.
+
+#### `flowdock_project_name`
+
+The name of the project being deployed. Used in the subject of the notfications.
+
+**Default:** not set
+
+#### `flowdock_api_token`
+
+List of one or more api tokens for the flows that should receive notifications.
+Used to authorize inbox notifications.
+
+**Default:** not set
+
+#### `flowdock_deploy_env`
+
+Deployment environment for this deploy. (i.e. production, staging, qa). Used
+in the default notification message.
+
+**Default:** not set
+
+### Other / Optional
+
+These settings aren't required to be set in your deployment scripts or may
+be otherwise configurable.
+
+#### `flowdock_deploy_tags`
+
+List of tags used to tag the team inbox notification. Always includes both
+the `deploy` and deploy env name as tags.
+
+**Default:** ["deploy", flowdock_deploy_env]
+
+#### `flowdock_source`
+
+Source for Flowdock notifications.
+
+**Default:** "Mina deployment"
+
+#### `flowdock_from_name`
+
+Name of the person sending the notifications. Used as the user link in
+notifications.
+
+**Default:** "user.name" retrieved from git config for the local repository.
+
+#### `flowdock_from_email`
+
+Email of the person sending the notifications. Used as the user link in
+notificiations.
+
+**Default:** "user.email" retrieved from git config for the local repository.
+
+#### `flowdock_message_subject`
+
+ERB string used as the notification subject.
+
+**Default:** "<%= flowdock_project_name %> deployed to #<%= flowdock_deploy_env %>"
+
+Example: MyProject deployed to staging.
+
+#### `flowdock_message`
+
+ERB string used as the notification body.
+
+**Default:** "<%= flowdock_deploy_type %> <%= flowdock_deploy_ref %> (<%= flowdock_deploy_sha %>) was deployed to <%= flowdock_deploy_env %>."
+
+Example: Branch feature-branch (git-sha) was deployed to staging.
+
+### Internal
+
+These can't be overridden. Well, not easily overridden.
+
+#### `flowdock_deploy_type`
+
+One of "Branch" or "Commit" depending on the option passed to mina.
+
+#### `flowdock_deploy_ref`
+
+Either the branch name or the commit sha passed ot mina.
+
+#### `flowdock_deploy_sha`
+
+The git sha retrieved from the server after deployment. Uses the
+`flowdock_deploy_ref` to get the sha and return it for use in notifications.
+
+## Requirements
+
+  * [flowdock](https://github.com/flowdock/flowdock-api/)
+  * [grit](https://github.com/mojombo/grit)
+  * [mina](https://github.com/nadarei/mina)
+  * [mina-hooks](https://github.com/elskwid/mina-hooks)
+
+## Install
+
+    $ gem install mina-flowdock
+
+## Copyright
+
+Copyright (c) 2013 Don Morrison
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require "rubygems"
+
+begin
+  require "bundler"
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require "rake"
+
+require "rubygems/tasks"
+Gem::Tasks.new
+
+require "rake/testtask"
+
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.pattern = "test/**/*_test.rb"
+  test.verbose = true
+end
+
+require "yard"
+YARD::Rake::YardocTask.new
+task :doc => :yard

data/lib/mina/flowdock.rb

@@ -0,0 +1,9 @@
+require "mina/flowdock/version"
+require "mina/flowdock/plugin"
+
+extend Mina::Flowdock::Plugin
+
+require "mina/flowdock/notify" # task
+
+# Hook our task in after mina is done running
+after_mina :"flowdock:notify"

data/lib/mina/flowdock/notify.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+set_default :flowdock_deploy_tags,  []
+set_default :flowdock_source,       "Mina deployment"
+set_default :flowdock_from_name,    git_config["user.name"]
+set_default :flowdock_from_address, git_config["user.email"]
+
+
+set_default :flowdock_message_subject,
+  "<%= flowdock_project_name %> deployed to #<%= flowdock_deploy_env %>"
+
+set_default :flowdock_message,
+  "<%= flowdock_deploy_type %> <%= flowdock_deploy_ref %> (<%= flowdock_deploy_sha %>) was deployed to <%= flowdock_deploy_env %>."
+
+set :flowdock_deploy_tags,
+  ["deploy", "#{flowdock_deploy_env}"] + flowdock_deploy_tags
+
+namespace :flowdock do
+  task :notify do
+
+    %w(
+      flowdock_project_name
+      flowdock_api_token
+      flowdock_deploy_env
+    ).each do |required|
+      unless self.send("#{required}?")
+        error "Mina Flowdock notifications require '#{required}' to be set."
+        exit
+      end
+    end
+
+    # mina git module uses commit if given
+    type, ref = if commit? && !commit.nil?
+      ["Commit", commit]
+    else
+      ["Branch", branch]
+    end
+
+    sha = capture("cd #{deploy_to}/scm && git --no-pager show -s -v --format=%H #{ref}").strip
+
+    unless sha
+      error "Mina Flowdock notifications couldn't find the configured #{type} [#{ref}] on the server."
+      exit
+    end
+
+    set :flowdock_deploy_type, type
+    set :flowdock_deploy_ref,  ref
+    set :flowdock_deploy_sha,  sha
+
+    flows = Array(flowdock_api_token).map do |token|
+      Flowdock::Flow.new(
+        api_token: token,
+        source:    flowdock_source,
+        project:   flowdock_project_name,
+        from: {
+          name:    flowdock_from_name,
+          address: flowdock_from_address
+        }
+      )
+    end
+
+    print_local_status "Notify configured Flowdock flows"
+
+    flows.each do |flow|
+      print_notification_debug(flow) if verbose_mode?
+      next if  simulate_mode?
+
+      flow.push_to_team_inbox(
+        format:  "html",
+        subject: flowdock_message_subject,
+        content: flowdock_message,
+        tags:    flowdock_deploy_tags
+      )
+    end
+  end
+end

data/lib/mina/flowdock/plugin.rb

@@ -0,0 +1,55 @@
+%w(flowdock grit mina/hooks).each do |lib|
+  begin
+    require lib
+  rescue LoadError => e
+    warn e.message
+    warn "Mina Flowdock notifications require '#{lib}' to be installed."
+    exit -1
+  end
+end
+
+module Mina
+  module Flowdock
+    module Plugin
+      def flowdock_message_subject
+        erb_string(settings.send :flowdock_message_subject)
+      end
+
+      def flowdock_message
+        erb_string(settings.send :flowdock_message)
+      end
+
+      def git_config
+        Grit::Config.new(Grit::Repo.new("."))
+      end
+
+      def erb_string(string, b = binding)
+        require "erb"
+        erb = ERB.new(string)
+        erb.result b
+      end
+
+      def print_notification_debug(flow)
+        flow = "flow: #{flow.api_token} [#{flow.project}]"
+        subj = "subject: #{flowdock_message_subject}"
+        msg  = "message: #{flowdock_message}"
+
+        [flow, subj, msg].each do |debug|
+            print_local_debug(debug)
+        end
+      end
+
+      def print_local_debug(msg)
+        puts "       #{color(">>", 32)} #{color(msg, 32)}"
+      end
+
+      unless defined?(:print_local_status)
+        # Prints a status message. (`<-----`)
+        def print_local_status(msg)
+          puts ""  if verbose_mode?
+          puts "#{color('<-----', 32)} #{msg}"
+        end
+      end
+    end # Plugin
+  end # Flowdock
+end # Mina

data/lib/mina/flowdock/version.rb

@@ -0,0 +1,6 @@
+module Mina
+  module Flowdock
+    # mina-flowdock version
+    VERSION = "0.1"
+  end
+end

data/mina-flowdock.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/mina/flowdock/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "mina-flowdock"
+  gem.version       = Mina::Flowdock::VERSION
+  gem.summary       = %q{Mina plugin to add Flowdock deployment notifications.}
+  gem.description   = %q{Mina plugin to add Flowdock deployment notifications.}
+  gem.license       = "MIT"
+  gem.authors       = ["Don Morrison"]
+  gem.email         = "don@elskwid.net"
+  gem.homepage      = "https://github.com/elskwid/mina-flowdock#readme"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "flowdock", "~> 0.3"
+  gem.add_dependency "grit", "~> 2.5"
+  gem.add_dependency "mina-hooks", "~> 0.2"
+
+  gem.add_development_dependency "bundler", "~> 1.2"
+  gem.add_development_dependency "minitest", "~> 5.0"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rubygems-tasks", "~> 0.2"
+  gem.add_development_dependency "yard", "~> 0.8"
+end

data/test/flowdock_test.rb

@@ -0,0 +1,10 @@
+require "helper"
+require "mina/flowdock/version"
+
+describe Mina::Flowdock do
+  it "has a version constant" do
+    version = Mina::Flowdock.const_get("VERSION")
+
+    refute_empty version
+  end
+end

data/test/helper.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+
+begin
+  require "bundler"
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require "minitest/autorun"

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: mina-flowdock
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Don Morrison
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flowdock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: mina-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: 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: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Mina plugin to add Flowdock deployment notifications.
+email: don@elskwid.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mina/flowdock.rb
+- lib/mina/flowdock/notify.rb
+- lib/mina/flowdock/plugin.rb
+- lib/mina/flowdock/version.rb
+- mina-flowdock.gemspec
+- test/flowdock_test.rb
+- test/helper.rb
+homepage: https://github.com/elskwid/mina-flowdock#readme
+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.3
+signing_key: 
+specification_version: 4
+summary: Mina plugin to add Flowdock deployment notifications.
+test_files:
+- test/flowdock_test.rb
+- test/helper.rb