flowdock-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Björn Wolf
+
+MIT License
+
+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,54 @@
+# Flowdock::Rails
+
+This gem adds a class method to send notifications to specific flows for create and update events on the enabled resource
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flowdock-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flowdock-rails
+
+## Usage
+
+Just put the `notify_flow` method to your model
+
+    class Model < ActiveRecord::Base
+      notify_flow
+    end
+
+and dont forget to set the ENV:
+
+    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
+
+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
+
+or as ENV:
+
+    FLOWDOCK_RAILS_API_TOKEN=__FLOW_API_TOKEN__1,__FLOW_API_TOKEN__2
+
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/flowdock-rails.gemspec

@@ -0,0 +1,27 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flowdock/rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flowdock-rails"
+  spec.version       = Flowdock::Rails::VERSION
+  spec.authors       = ["Björn Wolf"]
+  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"
+  spec.homepage      = "http://github.com/dreimannzelt/flowdock-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "flowdock", "~> 0.5"
+  spec.add_dependency "activerecord", "> 3.0"
+  spec.add_dependency "activesupport", "> 3.0"
+end

data/lib/flowdock/rails/version.rb

@@ -0,0 +1,5 @@
+module Flowdock
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/lib/flowdock/rails.rb

@@ -0,0 +1,64 @@
+require "flowdock/rails/version"
+require "flowdock"
+
+module Flowdock
+  module Rails
+    extend ActiveSupport::Concern
+
+    included do
+      def push_create_notification_to_flow
+        self.class.flow.push_to_team_inbox(
+          subject: "#{self.class.model_name.human} created",
+          content: %Q{
+            <h2>#{self.class.model_name.human} created</h2>
+            <blockquote>
+              #{self.inspect}
+            </blockquote>
+          },
+          tags: [self.class.model_name.param_key, "resource", "created"]
+        )
+      end
+
+      def push_update_notification_to_flow
+        self.class.flow.push_to_team_inbox(
+          subject: "#{self.class.model_name.human} updated",
+          content: %Q{
+            <h2>#{self.class.model_name.human} updated</h2>
+            <blockquote>
+              #{self.changes}
+            </blockquote>
+          },
+          tags: [self.class.model_name.param_key, "resource", "updated"]
+        )
+      end
+    end
+
+    module ClassMethods
+      def flow
+        api_token = (ENV["FLOWDOCK_RAILS_API_TOKEN"].try(:split, ",") || []).map(&:strip)
+
+        @flow ||= Flowdock::Flow.new(
+          flowdock_rails_options.reverse_merge(
+            api_token: api_token,
+            source: "Flowdock Notifier",
+            from: {
+              name: "Marv",
+              address: "marv@dreimannzelt.de"
+            }
+          )
+        )
+      end
+
+      def notify_flow(options = {})
+        cattr_accessor :flowdock_rails_options
+        self.flowdock_rails_options = options
+
+        after_create :push_create_notification_to_flow
+        after_update :push_update_notification_to_flow
+      end
+    end
+
+  end
+end
+
+ActiveRecord::Base.send :include, Flowdock::Rails

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: flowdock-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Björn Wolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70105221004800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70105221004800
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70105221004380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70105221004380
+- !ruby/object:Gem::Dependency
+  name: flowdock
+  requirement: &70105221003820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105221003820
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70105221003160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105221003160
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70105221002700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70105221002700
+description: Gem for notifying flows about the creation and updating of ActiveRecord
+  models.
+email:
+- bjoern@dreimannzelt.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- flowdock-rails.gemspec
+- lib/flowdock/rails.rb
+- lib/flowdock/rails/version.rb
+homepage: http://github.com/dreimannzelt/flowdock-rails
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      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.10
+signing_key: 
+specification_version: 3
+summary: Notify flows of model creations and updates
+test_files: []