flowdock 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24e1cb19dbf59f9a6e46d8bd350acba328186ceb
+  data.tar.gz: 1e4a0a89662cf13e4f7f2d494450b356942bb6e6
+SHA512:
+  metadata.gz: 892e801cc9d9fa275bad3809f7bdf69fd90060b9f27701c9ffc50fb33c798a688c8d08a6c976439f1aa9a04f94e5780fbaa6deb38eee95603172dbeccfa64485
+  data.tar.gz: ae229181dfcebb6c491d42d80181e12dc32a8e96b8122bb58e8f34c744d0ffc5253fefdee099b57890b0d8e5a9763661840b415973f0d43357b4104d8c03bd39

data/.travis.yml

@@ -1,4 +1,3 @@
 rvm:
-  - 1.8.7
   - 1.9.3
   - jruby

data/Gemfile

@@ -11,6 +11,6 @@ group :development do
   gem "rspec", "~> 2.6"
   gem "webmock"
   gem "bundler", "~> 1.0"
-  gem "jeweler", "~> 1.6.4"
+  gem "jeweler", ">= 2.0.1"
   gem "jruby-openssl", :platforms => :jruby
 end

data/README.md

@@ -6,7 +6,7 @@ Ruby Gem for using the Flowdock Push API. See [Push API documentation](http://ww
 
 [![Build Status](https://secure.travis-ci.org/flowdock/flowdock-api.png)](http://travis-ci.org/flowdock/flowdock-api)
 
-flowdock gem is tested on Ruby 1.8.7, 1.9.3 and JRuby.
+flowdock gem is tested on Ruby 1.9.3 and JRuby.
 
 ## Dependencies
 
@@ -25,60 +25,59 @@ To post content to Chat or Team Inbox, you need to use the target flow's API tok
 
 ### Posting to Chat
 
-    require 'rubygems'
-    require 'flowdock'
+```ruby
+require 'rubygems'
+require 'flowdock'
 
-    # create a new Flow object with target flow's api token and external user name (enough for posting to Chat)
-    flow = Flowdock::Flow.new(:api_token => "__FLOW_TOKEN__", :external_user_name => "John")
+# create a new Flow object with target flow's api token and external user name (enough for posting to Chat)
+flow = Flowdock::Flow.new(:api_token => "__FLOW_TOKEN__", :external_user_name => "John")
 
-    # send message to Chat
-    flow.push_to_chat(:content => "Hello!", :tags => ["cool", "stuff"])
+# send message to Chat
+flow.push_to_chat(:content => "Hello!", :tags => ["cool", "stuff"])
+```
 
 ### Posting to Team Inbox
 
-    # create a new Flow object with target flow's api token and sender information for Team Inbox posting
-    flow = Flowdock::Flow.new(:api_token => "__FLOW_TOKEN__",
-      :source => "myapp", :from => {:name => "John Doe", :address => "john.doe@example.com"})
+```ruby
+# create a new Flow object with target flow's api token and sender information for Team Inbox posting
+flow = Flowdock::Flow.new(:api_token => "__FLOW_TOKEN__",
+  :source => "myapp", :from => {:name => "John Doe", :address => "john.doe@example.com"})
 
-    # send message to Team Inbox
-    flow.push_to_team_inbox(: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"], :link => "http://www.flowdock.com/")
+# send message to Team Inbox
+flow.push_to_team_inbox(: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"], :link => "http://www.flowdock.com/")
+```
 
 ### Posting to multiple flows
 
-    require 'rubygems'
-    require 'flowdock'
+```ruby
+require 'rubygems'
+require 'flowdock'
 
-    # create a new Flow object with the api tokens of the target flows
-    flow = Flowdock::Flow.new(:api_token => ["__FLOW_TOKEN__", "__ANOTHER_FLOW_TOKEN__"], ... )
+# create a new Flow object with the api tokens of the target flows
+flow = Flowdock::Flow.new(:api_token => ["__FLOW_TOKEN__", "__ANOTHER_FLOW_TOKEN__"], ... )
 
-    # see above examples of posting to Chat or Team Inbox
+# see above examples of posting to Chat or Team Inbox
+```
 
 ## API methods
 
 * Flow methods
 
-  *push_to_team_inbox* - Send message to Team Inbox. See [API documentation](http://www.flowdock.com/api/team-inbox) for details.
-
-  *push_to_chat* - Send message to Chat. See [API documentation](http://www.flowdock.com/api/chat) for details.
+  `push_to_team_inbox` - Send message to Team Inbox. See [API documentation](http://www.flowdock.com/api/team-inbox) for details.
 
-  *send_message(params)* - Deprecated. Please use *push_to_team_inbox* instead.
+  `push_to_chat` - Send message to Chat. See [API documentation](http://www.flowdock.com/api/chat) for details.
 
+  `send_message(params)` - Deprecated. Please use `push_to_team_inbox` instead.
 
-## Capistrano deployment task
 
-The Flowdock API Ruby Gem includes a ready task for sending deployment notifications with Capistrano (you need to have Grit installed too). Just add the task into your deploy.rb file and configure the settings to match your project and flow:
+## Deployment notifications
 
-```
- require 'flowdock/capistrano'
-
- # for Flowdock Gem notifications
- set :flowdock_project_name, "My project"
- set :flowdock_deploy_tags, ["frontend"]
- set :flowdock_api_token, ["_YOUR_API_TOKEN_HERE_"]
-```
+There are separate gems for deployment notifications:
 
+* [capistrano-flowdock](https://github.com/flowdock/capistrano-flowdock)
+* [mina-flowdock](https://github.com/elskwid/mina-flowdock)
 
 ## Copyright
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/flowdock.gemspec

@@ -2,14 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+# stub: flowdock 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "flowdock"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Antti Pitk\u{e4}nen"]
-  s.date = "2013-04-05"
+  s.date = "2014-04-10"
   s.email = "team@flowdock.com"
   s.extra_rdoc_files = [
     "LICENSE",
@@ -32,12 +34,11 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/flowdock/flowdock-api"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.23"
+  s.rubygems_version = "2.2.1"
   s.summary = "Ruby Gem for using Flowdock's API"
 
   if s.respond_to? :specification_version then
-    s.specification_version = 3
+    s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<httparty>, ["~> 0.7"])
@@ -46,7 +47,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<rspec>, ["~> 2.6"])
       s.add_development_dependency(%q<webmock>, [">= 0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<jeweler>, [">= 2.0.1"])
       s.add_development_dependency(%q<jruby-openssl>, [">= 0"])
     else
       s.add_dependency(%q<httparty>, ["~> 0.7"])
@@ -55,7 +56,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, ["~> 2.6"])
       s.add_dependency(%q<webmock>, [">= 0"])
       s.add_dependency(%q<bundler>, ["~> 1.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<jeweler>, [">= 2.0.1"])
       s.add_dependency(%q<jruby-openssl>, [">= 0"])
     end
   else
@@ -65,7 +66,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<rspec>, ["~> 2.6"])
     s.add_dependency(%q<webmock>, [">= 0"])
     s.add_dependency(%q<bundler>, ["~> 1.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<jeweler>, [">= 2.0.1"])
     s.add_dependency(%q<jruby-openssl>, [">= 0"])
   end
 end

data/lib/flowdock/capistrano.rb

@@ -1,89 +1 @@
-require 'flowdock'
-require 'digest/md5'
-require 'cgi'
-
-Capistrano::Configuration.instance(:must_exist).load do
-
-  namespace :flowdock do
-    task :read_current_deployed_branch do
-      current_branch = capture("cat #{current_path}/BRANCH").chomp rescue "master"
-      set :current_branch, current_branch
-    end
-
-    task :save_deployed_branch do
-      begin
-        run "echo '#{source.head.chomp}' > #{current_path}/BRANCH"
-      rescue => e
-        puts "Flowdock: error in saving deployed branch information: #{e.to_s}"
-      end
-    end
-
-    task :set_flowdock_api do
-      set :flowdock_deploy_env, fetch(:stage, fetch(:rails_env, ENV["RAILS_ENV"] || "production"))
-      begin
-        require 'grit'
-        set :repo, Grit::Repo.new(".")
-        config = Grit::Config.new(repo)
-      rescue LoadError => e
-        puts "Flowdock: you need to have Grit gem installed: #{e.to_s}"
-      rescue => e
-        puts "Flowdock: error in fetching your git repository information: #{e.to_s}"
-      end
-
-      begin
-        flows = Array(flowdock_api_token).map do |api_token|
-          Flowdock::Flow.new(:api_token => api_token,
-          :source => "Capistrano deployment", :project => flowdock_project_name,
-          :from => {:name => config["user.name"], :address => config["user.email"]})
-        end
-        set :flowdock_api, flows
-      rescue => e
-        puts "Flowdock: error in configuring Flowdock API: #{e.to_s}"
-      end
-    end
-
-    task :notify_deploy_finished do
-      # send message to the flow
-      begin
-        flowdock_api.each do |flow|
-          flow.push_to_team_inbox(:format => "html",
-            :subject => "#{flowdock_project_name} deployed with branch #{branch} on ##{flowdock_deploy_env}",
-            :content => notification_message,
-            :tags => ["deploy", "#{flowdock_deploy_env}"] | flowdock_deploy_tags)
-        end
-      rescue => e
-        puts "Flowdock: error in sending notification to your flow: #{e.to_s}"
-      end
-    end
-
-    def notification_message
-      if branch == current_branch
-        message = "<p>The following changes were just deployed to #{flowdock_deploy_env}:</p>"
-        commits = repo.commits_between(previous_revision, 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=\"https://secure.gravatar.com/avatar/#{Digest::MD5::hexdigest(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 #{flowdock_deploy_env}. Previously deployed branch was #{current_branch}."
-      end
-      message
-    end
-  end
-
-  before "deploy:update_code", "flowdock:read_current_deployed_branch"
-  before "flowdock:notify_deploy_finished", "flowdock:set_flowdock_api"
-  ["deploy", "deploy:migrations"].each do |task|
-    after task, "flowdock:notify_deploy_finished"
-    after task, "flowdock:save_deployed_branch"
-  end
-end
+warn "Capistrano notifier has been extracted to `capistrano-flowdock` gem"

metadata

@@ -1,144 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: flowdock
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Antti Pitkänen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-05 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
   name: httparty
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
+- !ruby/object:Gem::Dependency
   name: multi_json
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.4.2
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: rdoc
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.2
   type: :development
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: 2.4.2
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
   type: :development
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
+- !ruby/object:Gem::Dependency
   name: webmock
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: '1.0'
+- !ruby/object:Gem::Dependency
   name: jeweler
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.6.4
+        version: 2.0.1
   type: :development
-- !ruby/object:Gem::Dependency
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
   name: jruby-openssl
-  prerelease: false
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email: team@flowdock.com
 executables: []
@@ -147,9 +130,9 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files:
-- .document
-- .rspec
-- .travis.yml
+- ".document"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -163,29 +146,25 @@ files:
 homepage: http://github.com/flowdock/flowdock-api
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: 2786572984791329864
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby Gem for using Flowdock's API
 test_files: []