flowdock 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.bundle
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    flowdock (0.1.0)
+      httparty (~> 0.7.8)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.4)
+    crack (0.1.8)
+    diff-lcs (1.1.2)
+    httparty (0.7.8)
+      crack (= 0.1.8)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flowdock!
+  rspec
+  webmock (~> 1.6.0)

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Flowdock Ltd
+
+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

@@ -0,0 +1,49 @@
+flowdock
+========
+
+Ruby Gem for using the Flowdock API.
+
+* http://www.flowdock.com/api
+
+Compatibility
+-------------
+
+flowdock gem has been tested under Ruby 1.8.7.
+
+Requirements
+------------
+
+* HTTParty
+
+Install
+-------
+
+* gem install flowdock
+
+Example
+-------
+
+  require 'flowdock'
+
+  # create a new Flow object with target flow's api token and sender information
+  flow = Flowdock::Flow.new(:api_token => "56188e2003e370c6efa9711988f7bf02", 
+    :source => "myapp", 
+    :from => {:name => "John Doe", :address => "john.doe@yourdomain.com"})
+
+  # send message to the flow
+  flow.send_message(:subject => "Greetings from Flowdock API Gem!", 
+    :content => "<h2>It works!</h2><p>Now you can start developing your awesome application for Flowdock.</p>", 
+    :tags => ["cool", "stuff"])
+	 
+API methods
+-----------
+
+* Flow methods
+
+  send_message(params) - Send message to flow. Required parameters for message are :subject and :content. Optional parameter :tags can be used to add tags to message. Currently messages are always sent in the HTML format.
+
+
+Copyright
+---------
+
+Copyright (c) 2011 Flowdock Ltd. See MIT-LICENSE for further details.

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')

data/flowdock.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "flowdock/version"
+
+Gem::Specification.new do |s|
+  s.name        = "flowdock"
+  s.authors     = ["anttipitkanen"]
+  s.version     = Flowdock::GEM_VERSION
+  s.email       = ["team@flowdock.com"]
+  s.homepage    = "https://www.flowdock.com/api"
+  s.summary     = %q{Ruby Gem for using Flowdock's API.}
+
+  s.rubyforge_project = "flowdock"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("httparty", "~>0.7.8")
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("webmock", "~>1.6.0")
+end

data/lib/flowdock.rb

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'httparty'
+
+module Flowdock
+  FLOWDOCK_API_URL = "https://api.flowdock.com/v1/messages/influx"
+
+  class Flow
+    include HTTParty
+    class InvalidParameterError < StandardError; end
+    class ApiError < StandardError; end
+
+    # Required options keys: :api_token, :source, :from => { :name, :address }
+    def initialize(options = {})
+      @api_token = options[:api_token]
+      raise InvalidParameterError, "Flow must have :api_token attribute" if @api_token.blank?
+      
+      @source = options[:source]
+      raise InvalidParameterError, "Flow must have valid :source attribute, only alphanumeric characters and underscores can be used" if @source.blank? || !@source.match(/^[a-z0-9\-_ ]+$/i)
+
+      @project = options[:project]
+      raise InvalidParameterError, "Optional attribute :project can only contain alphanumeric characters and underscores" if !@project.blank? && !@project.match(/^[a-z0-9\-_ ]+$/i)
+
+      @from = options[:from] || {}
+    end
+
+    def send_message(params)
+      raise InvalidParameterError, "Message must have both :subject and :content" if params[:subject].blank? || params[:content].blank?
+      
+      from = (params[:from].kind_of?(Hash)) ? params[:from] : @from
+      raise InvalidParameterError, "Flow's :from attribute must have both :name and :address" if from[:name].blank? || from[:address].blank?
+
+      tags = (params[:tags].kind_of?(Array)) ? params[:tags] : []
+      tags.reject! { |tag| !tag.kind_of?(String) || tag.blank? }
+
+      params = {
+        :source => @source,
+        :format => 'html', # currently only supported format
+        :from_name => from[:name],
+        :from_address => from[:address],
+        :subject => params[:subject],
+        :content => params[:content]
+      }
+      params[:tags] = tags.join(",") if tags.size > 0
+      params[:project] = @project unless @project.blank?
+
+      # Send the request
+      resp = self.class.post(get_flowdock_api_url, :body => params)
+      raise ApiError, (resp.code == 500 ? "Flowdock API returned error: #{resp.body}" : "HTTP Error #{resp.code}") unless resp.code == 200
+      true
+    end
+  
+    private
+  
+    def get_flowdock_api_url
+      "#{FLOWDOCK_API_URL}/#{@api_token}"
+    end
+  end
+end

data/lib/flowdock/capistrano.rb

@@ -0,0 +1,56 @@
+require 'flowdock'
+require 'grit'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set :flowdock_send_notification, false
+
+  namespace :flowdock do
+    task :set_flowdock_api do
+      set :repo, Grit::Repo.new(".")
+      config = Grit::Config.new(repo)
+      set :flowdock_api, Flowdock::Flow.new(:api_token => flowdock_api_token, 
+        :source => "Capistrano deployment", :project => flowdock_project_name,
+        :from => {:name => config["user.name"], :address => config["user.email"]})
+    end
+
+    task :trigger_notification do
+      set :flowdock_send_notification, true
+    end
+
+    task :notify_deploy_finished do
+      # send message to the flow
+      flowdock_api.send_message(:format => "html", 
+        :subject => "#{flowdock_project_name} deployed with branch #{branch} on ##{rails_env}", 
+        :content => notification_message, 
+        :tags => ["deploy", "#{rails_env}"] | flowdock_deploy_tags)
+    end
+
+    def notification_message
+      if branch == current_branch || stage == :production
+        message = "<p>The following changes were just deployed to #{host}:</p>"
+        commits = repo.commits_between(capture("cat #{previous_release}/REVISION").chomp, current_revision).reverse
+
+        unless commits.empty?
+          commits.each do |c|
+            short, long = c.message.split(/\n+/, 2)
+
+            message << "\n<div style=\"margin-bottom: 10px\"><div style=\"height:30px;width:30px;float:left;margin-right:5px;\"><img src=\"http://gravatar.com/avatar/#{MD5::md5(c.author.email.downcase)}?s=30\" /></div>"
+            message << "<div style=\"padding-left: 35px;\">#{CGI.escapeHTML(short)}<br/>"
+            if long
+              long.gsub!(/\n/, '<br />')
+              message << '<p style="margin:5px 0px; padding: 0 5px; border-left: 3px solid #ccc">' + long + '</p>'
+            end
+            message << "<span style=\"font-size: 90%; color: #333\"><code>#{c.id_abbrev}</code> <a href=\"mailto:#{CGI.escapeHTML(c.author.email)}\">#{CGI.escapeHTML(c.author.name)}</a> on #{c.authored_date.strftime("%b %d, %H:%M")}</span></div></div>"
+          end
+        end
+      else
+        message = "Branch #{source.head} was deployed to #{host}. Previously deployed branch was #{current_branch}."
+      end
+      message
+    end
+  end
+
+  before "deploy", "flowdock:trigger_notification"
+  before "flowdock:notify_deploy_finished", "flowdock:set_flowdock_api"
+  after "deploy", "flowdock:notify_deploy_finished"
+end

data/lib/flowdock/version.rb

@@ -0,0 +1,3 @@
+module Flowdock
+  GEM_VERSION = "0.1.0"
+end

data/spec/flowdock_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe Flowdock do
+  describe "with initializing flow" do
+    it "should succeed with correct token and source" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "test", :source => "myapp")
+      }.should_not raise_error
+    end
+    
+    it "should succeed with correct token, source and sender information" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "test", :source => "myapp",
+          :from => {:name => "test", :address => "invalid@nodeta.fi"})
+      }.should_not raise_error
+    end
+    
+    it "should succeed with correct token, sender information, source and project" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "test", :source => "myapp", :project => "myproject",
+          :from => {:name => "test", :address => "invalid@nodeta.fi"})
+      }.should_not raise_error
+    end
+  
+    it "should fail without token" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "", :source => "myapp")
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+  
+    it "should fail without source" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "test", :source => "")
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+  
+    it "should fail when source is not alphanumeric" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "test", :source => "$foobar")
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+    
+    it "should fail when project is not alphanumeric" do
+      lambda {
+        @flow = Flowdock::Flow.new(:api_token => "test", :source => "myapp", :project => "$foobar")
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+  end
+  
+  describe "with sending messages" do
+    before(:each) do
+      @token = "test"
+      @flow = Flowdock::Flow.new(:api_token => @token, :source => "myapp", :project => "myproject",
+       :from => {:name => "Eric Example", :address => "eric@example.com"})
+      @example_content = "<h1>Hello</h1>\n<p>Let's rock and roll!</p>"
+    end
+    
+    it "should not send without subject" do
+      lambda {
+        @flow.send_message(:subject => "", :content => "Test")
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+    
+    it "should not send without content" do
+      lambda {
+        @flow.send_message(:subject => "Test", :content => "")
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+    
+    it "should not send without sender information" do
+      @flow = Flowdock::Flow.new(:api_token => @token, :source => "myapp")
+      lambda {
+        @flow.send_message(:subject => "Test", :content => @example_content)
+      }.should raise_error(Flowdock::Flow::InvalidParameterError)
+    end
+    
+    it "should send with valid parameters and return true" do
+      lambda {
+        stub_request(:post, "#{Flowdock::FLOWDOCK_API_URL}/#{@token}").
+          with(:body => {
+            :source => "myapp",
+            :project => "myproject",
+            :format => "html",
+            :from_name => "Eric Example",
+            :from_address => "eric@example.com",
+            :subject => "Hello World",
+            :content => @example_content,
+            :tags => "cool,stuff"
+          }).
+          to_return(:body => "", :status => 200)
+
+        @flow.send_message(:subject => "Hello World", :content => @example_content, :tags => ["cool", "stuff"]).should be_true
+      }.should_not raise_error
+    end
+    
+    it "should allow overriding sender information per message" do
+      lambda {
+        stub_request(:post, "#{Flowdock::FLOWDOCK_API_URL}/#{@token}").
+          with(:body => {
+            :source => "myapp",
+            :project => "myproject",
+            :format => "html",
+            :from_name => "Test",
+            :from_address => "invalid@nodeta.fi",
+            :subject => "Hello World",
+            :content => @example_content,
+            :tags => "cool,stuff"
+          }).
+          to_return(:body => "", :status => 200)
+
+        @flow.send_message(:subject => "Hello World", :content => @example_content, :tags => ["cool", "stuff"],
+          :from => {:name => "Test", :address => "invalid@nodeta.fi"}).should be_true
+      }.should_not raise_error
+    end
+    
+    it "should raise error if backend returns anything but 200 OK" do
+      lambda {
+        stub_request(:post, "#{Flowdock::FLOWDOCK_API_URL}/#{@token}").
+          with(:body => {
+            :source => "myapp",
+            :project => "myproject",
+            :format => "html",
+            :from_name => "Eric Example",
+            :from_address => "eric@example.com",
+            :subject => "Hello World",
+            :content => @example_content
+          }).
+          to_return(:body => "Internal Server Error", :status => 500)
+
+        @flow.send_message(:subject => "Hello World", :content => @example_content).should be_false
+      }.should raise_error(Flowdock::Flow::ApiError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'webmock/rspec'
+
+require 'flowdock'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: flowdock
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- anttipitkanen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-11 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 0
+        - 7
+        - 8
+        version: 0.7.8
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 6
+        - 0
+        version: 1.6.0
+  type: :development
+  version_requirements: *id003
+description: 
+email: 
+- team@flowdock.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README
+- Rakefile
+- flowdock.gemspec
+- lib/flowdock.rb
+- lib/flowdock/capistrano.rb
+- lib/flowdock/version.rb
+- spec/flowdock_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.flowdock.com/api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: flowdock
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Ruby Gem for using Flowdock's API.
+test_files: 
+- spec/flowdock_spec.rb
+- spec/spec_helper.rb