flowdock-rails 0.0.5 → 0.0.6

data/README.md

@@ -1,5 +1,7 @@
 # Flowdock::Rails
 
+[![Gem Version](https://badge.fury.io/rb/flowdock-rails.svg)](http://badge.fury.io/rb/flowdock-rails)
+
 This gem adds a class method to send notifications to specific flows for create and update events on the enabled resource
 
 ## Installation
@@ -20,56 +22,92 @@ Or install it yourself as:
 
 Just put the `notify_flow` method to your model
 
-    class Model < ActiveRecord::Base
-      notify_flow
-    end
+```ruby
+class Model < ActiveRecord::Base
+  notify_flow
+end
+```
 
 and dont forget to set the ENV:
 
-    FLOWDOCK_RAILS_API_TOKEN=__FLOW_API_TOKEN__
+```
+FLOWDOCK_RAILS_API_TOKEN=__FLOW_API_TOKEN__
+```
 
 You can also set the API token directly in your model:
 
-    class Model < ActiveRecord::Base
-      notify_flow api_token: "__FLOW_API_TOKEN__"
-    end
+```ruby
+class Model < ActiveRecord::Base
+  notify_flow api_token: "__FLOW_API_TOKEN__"
+end
+```
 
 and of course your are able to notify multiple flows:
 
-    class Model < ActiveRecord::Base
-      notify_flow api_token: ["__FLOW_API_TOKEN__1", "__FLOW_API_TOKEN__2"]
-    end
+```ruby
+class Model < ActiveRecord::Base
+  notify_flow api_token: ["__FLOW_API_TOKEN__1", "__FLOW_API_TOKEN__2"]
+end
+```
 
 or as ENV:
 
-    FLOWDOCK_RAILS_API_TOKEN=__FLOW_API_TOKEN__1,__FLOW_API_TOKEN__2
+```
+FLOWDOCK_RAILS_API_TOKEN=__FLOW_API_TOKEN__1,__FLOW_API_TOKEN__2
+```
 
-### Enabling/Disabling
+### Enabling and Disabling
 
 It is enabled for production environments per default. You can enable it by setting ENV for other environments:
 
-    FLOWDOCK_RAILS_ENABLED=true
+```
+FLOWDOCK_RAILS_ENABLED=true
+```
 
 You can also explicitly disable it on production with:
 
-    FLOWDOCK_RAILS_ENABLED=false
+```
+FLOWDOCK_RAILS_ENABLED=false
+```
 
 If a global enabling/disabling mechanism is not sufficient enough for you, just override it on a per-class basis:
 
-    class Model < ActiveRecord::Base
-      def self.push_to_flow_enabled?
-        false
-      end
-    end
+```ruby
+class Model < ActiveRecord::Base
+  def self.push_to_flow_enabled?
+    false
+  end
+end
+```
+
+#### WARNING !!!
+
+It's force-disabled on RAILS_ENV=test by default. Currently there is no way to enable it besides overriding the class method `self.push_to_flow_enabled?`
+
+### All ENV variables
+
+| Variable | Description | Default |
+|---|---|---|
+| FLOWDOCK_RAILS_API_TOKEN  | YOUR_API_TOKEN |
+| FLOWDOCK_RAILS_ENABLED    | Explicitly enable pushing for anything else than production.| "true" |
+| FLOWDOCK_RAILS_NAME       | Set the name of your project| Rails.application.class.parent_name |
+| FLOWDOCK_RAILS_FROM_NAME  | Name for the sender| Marv |
+| FLOWDOCK_RAILS_FROM_EMAIL | Email for the sender| marv@dreimannzelt.de |
+| FLOWDOCK_RAILS_FORMAT     | Format of output of attributes and changes. Possible values: "table",  "json" | "table" |
+
 
 ## TODO
 
 1. Spec, specs, specs, specs!
 2. Asynchronous and background job options
 3. Option for enabling/disabling specific events (create/update)
-4 Option for notification of deletion
+4. Option for notification of deletion
 5. Better documentation on how to override the content for the notifications
 
+## Thanks to
+
+* @flowdock for this amazing product
+* @benedikt for the patches
 
 ## Contributing
 

data/flowdock-rails.gemspec

@@ -6,7 +6,7 @@ require 'flowdock/rails/version'
 Gem::Specification.new do |spec|
   spec.name          = "flowdock-rails"
   spec.version       = Flowdock::Rails::VERSION
-  spec.authors       = ["Björn Wolf"]
+  spec.authors       = ["Björn Wolf", "Benedikt Deicke"]
   spec.email         = ["bjoern@dreimannzelt.de"]
   spec.description   = "Gem for notifying flows about the creation and updating of ActiveRecord models."
   spec.summary       = "Notify flows of model creations and updates"

data/lib/flowdock/rails/version.rb

@@ -1,5 +1,5 @@
 module Flowdock
   module Rails
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/flowdock/rails.rb

@@ -13,18 +13,21 @@ module Flowdock
           flowdock_rails_options.reverse_merge(
             api_token: api_token,
             source: "Flowdock Notifier",
-            project: ::Rails.application.class.parent_name,
+            project: ( ENV["FLOWDOCK_RAILS_NAME"] || ::Rails.application.class.parent_name ).parameterize,
             from: {
-              name: "Marv",
-              address: "marv@dreimannzelt.de"
+              name: ( ENV["FLOWDOCK_RAILS_FROM_NAME"] || "Marv" ),
+              address: ( ENV["FLOWDOCK_RAILS_FROM_EMAIL"] || "marv@dreimannzelt.de")
             }
           )
         )
       end
 
       def push_to_flow_enabled?
-        ( ENV["FLOWDOCK_RAILS_ENABLED"] == "true" ) ||
-        ( !(ENV["FLOWDOCK_RAILS_ENABLED"] == "false") && ::Rails.env.production? )
+        ( !::Rails.env.test? ) &&
+        (
+          ( ENV["FLOWDOCK_RAILS_ENABLED"] == "true" ) ||
+          ( !(ENV["FLOWDOCK_RAILS_ENABLED"] == "false") && ::Rails.env.production? )
+        )
       end
 
       def push_to_flow(options = {})
@@ -51,15 +54,34 @@ module Flowdock
 
     private
 
+    def formatted_attributes_for_flow(hash, changes=false)
+      case ENV["FLOWDOCK_RAILS_FORMAT"]
+      when "json"
+        "<pre>#{ JSON.pretty_generate(hash) }</pre>"
+      else
+        if hash.any?
+          %Q{
+            <table class="diff">
+              <tbody>
+                #{ hash.map{|k,v| "<tr><th>#{k}</th><td>#{changes ? v.first : v}</td><td>#{changes ? v.last : ""}</td></tr>" }.join("\n") }
+              </tbody>
+            </table>
+          }.strip
+        else
+          "<pre>Nothing to show!</pre>"
+        end
+      end
+    end
+
     def push_create_notification_to_flow
       self.class.push_to_flow(
         subject: "#{self.class.model_name.human} created",
         content: %Q{
           <h2>#{self.class.model_name.human} created</h2>
           <h3>Attributes</h3>
-          <pre>#{JSON.pretty_generate(self.attributes)}</pre>
+          #{formatted_attributes_for_flow self.attributes}
         },
-        tags: [self.class.model_name.param_key, "resource", "created"]
+        tags: [self.class.model_name.param_key, "resource", "created", ::Rails.env]
       )
     end
 
@@ -69,11 +91,11 @@ module Flowdock
         content: %Q{
           <h2>#{self.class.model_name.human} updated</h2>
           <h3>Changes</h3>
-          <pre>#{JSON.pretty_generate(self.changes)}</pre>
+          #{formatted_attributes_for_flow self.changes, true}
           <h3>Attributes</h3>
-          <pre>#{JSON.pretty_generate(self.attributes)}</pre>
+          #{formatted_attributes_for_flow self.attributes}
         },
-        tags: [self.class.model_name.param_key, "resource", "updated"]
+        tags: [self.class.model_name.param_key, "resource", "updated", ::Rails.env]
       )
     end
   end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: flowdock-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
 - Björn Wolf
+- Benedikt Deicke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-04 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70252281048500 !ruby/object:Gem::Requirement
+  requirement: &70309030445240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +22,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70252281048500
+  version_requirements: *70309030445240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70252281048060 !ruby/object:Gem::Requirement
+  requirement: &70309030444660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70252281048060
+  version_requirements: *70309030444660
 - !ruby/object:Gem::Dependency
   name: flowdock
-  requirement: &70252281047520 !ruby/object:Gem::Requirement
+  requirement: &70309030443940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +44,10 @@ dependencies:
         version: '0.5'
   type: :runtime
   prerelease: false
-  version_requirements: *70252281047520
+  version_requirements: *70309030443940
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70252281046860 !ruby/object:Gem::Requirement
+  requirement: &70309030443040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -54,10 +55,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70252281046860
+  version_requirements: *70309030443040
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70252281046400 !ruby/object:Gem::Requirement
+  requirement: &70309030442400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>'
@@ -65,10 +66,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70252281046400
+  version_requirements: *70309030442400
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70252281045960 !ruby/object:Gem::Requirement
+  requirement: &70309030441840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +77,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70252281045960
+  version_requirements: *70309030441840
 description: Gem for notifying flows about the creation and updating of ActiveRecord
   models.
 email: