multi_notifier 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 242f1682aeef6370a9462a404e0958e00fbf675d
-  data.tar.gz: 6d89c616166db72999c83ee68c364281a59078ff
+  metadata.gz: 18b7272fe9939ff98ed918124e371a36c7578a4d
+  data.tar.gz: 59486d4edfcbd4ae618480405cd45837e387dc8c
 SHA512:
-  metadata.gz: 458a7da9a429f0751b103e3a6f100d5d060132576609ccf4465e4a68e2b29753daf0d5b9b53db56f5b26d34d7f6482518ae0eaf4e4ae19de091178e4dad62c94
-  data.tar.gz: 9b12e09f5ddbfdd266940cda7d2423ad64098eaec4de5c37551744e992d07a0879a44b385f3ba25254bd452c96e773ad2d55f0324de7a581cf273cfd2f56c8a9
+  metadata.gz: 96d5a244e31af51af0247be7b2237ea145fd75ebb72f3720f021246bd40053c02266e389ee5c0142e99c6bac3bf4bc2b69f002c24b3f421c7fce2852f252005b
+  data.tar.gz: 0b30d55e430443b34929413251abfd2ef2a37510d50c0cd5e2a1751429a349cb24e4d834eed27a3cf862e55d5966d1df68e013ffef156b605a89c34ef1889104

data/Gemfile

@@ -8,4 +8,5 @@ gem "rake"
 group :test do
   gem "rspec"
   gem "actionmailer"
+  gem "travis"
 end

data/README.md

@@ -1,6 +1,7 @@
 # MultiNotifier
 
-TODO: Write a gem description
+MultiNotifier provides a minimal, modular and adaptable interface for sending notifications in Ruby.
+It unifies and distills the API for sending notifications to multiple sources with [middlewares](http://en.wikipedia.org/wiki/Middleware).
 
 ## Installation
 
@@ -18,7 +19,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+MultiNotifier.build do |builder|
+  builder.use :mail, :from => "from@owenou.com", :to => "to@owenou.com", :subject => "MultiNotifier notification"
+  builder.use :campfire, :access_token => "123", :room => "123", :message => "Hello world"
+end.notify_all!
+```
+
+## Middlewares
+
+### Mail
+
+The [mail middleware](https://github.com/jingweno/multi_notifier/blob/master/lib/multi_notifier/middlewares/mail.rb) sends email with the provided settings.
+
+```ruby
+builder.adapter :mail,
+  :delivery => {
+    :method => Rails.configuration.action_mailer.delivery_method, # delivery method
+    :settings => Rails.configuration.action_mailer.send("#{Rails.configuration.action_mailer.delivery_method}_settings") # deivery settings
+  },
+  :from => "notifications@aclgrc.com", # from email
+  :to => "devs@workpapers.com", # to email
+  :subject => "subject", # email subject
+  :text_body => mail_text_body, # email body in text
+  :html_body => mail_html_body # email body in html
+```
+
+### Travis
+
+The [travis middleware](https://github.com/jingweno/multi_notifier/blob/master/lib/multi_notifier/middlewares/travis.rb) restart the latest build with the provided repo.
+
+```ruby
+builder.adapter :travis,
+  :access_token => "123", # travis-ci access token
+  :repo => "jingweno/multiple_notifier", # travis-ci repo in the format of OWNER/REPO
+  :travis_pro => true # whether this repo is built in travis-ci pro
+```
 
 ## Contributing
 

data/lib/multi_notifier/builder.rb

@@ -8,9 +8,9 @@ module MultiNotifier
       @adapters = []
     end
 
-    def adapter(type, configs = {})
-      require "multi_notifier/adapters/#{type}"
-      adapter = "MultiNotifier::Adapters::#{type.to_s.classify}".constantize
+    def use(type, configs = {})
+      require "multi_notifier/middlewares/#{type}"
+      adapter = "MultiNotifier::Middlewares::#{type.to_s.classify}".constantize
       adapters << adapter.new(configs)
 
       adapter

data/lib/multi_notifier/{adapter.rb → middleware.rb}

@@ -2,7 +2,7 @@ require "active_model"
 require_relative "model" unless defined?(ActiveModel::Model)
 
 module MultiNotifier
-  class Adapter
+  class Middleware
     include ActiveModel::Model
 
     def notify

data/lib/multi_notifier/{adapters → middlewares}/mail.rb

@@ -1,9 +1,9 @@
 require "action_mailer" unless defined?(::ActionMailer)
-require "multi_notifier/adapter"
+require "multi_notifier/middleware"
 
 module MultiNotifier
-  module Adapters
-    class Mail < Adapter
+  module Middlewares
+    class Mail < Middleware
       class DeliveryValidator < ::ActiveModel::Validator
         def validate(model)
           if model.delivery.present?

data/lib/multi_notifier/middlewares/travis.rb

@@ -0,0 +1,29 @@
+require "travis" unless defined?(::Travis)
+require "multi_notifier/middleware"
+
+module MultiNotifier
+  module Middlewares
+    class Travis < Middleware
+      attr_accessor :access_token, :repo, :travis_pro
+
+      validates_presence_of :access_token, :repo
+
+      def notify
+        host = travis_pro? ? ::Travis::Client::PRO_URI : ::Travis::Client::ORG_URI
+        client = travis_client(host, access_token)
+        repo = client.repo(repo)
+        repo.last_build.restart
+      end
+
+      def travis_pro?
+        !!travis_pro
+      end
+
+      private
+
+      def travis_client(host, access_token)
+        ::Travis::Client.new "uri" => host, "access_token" => access_token
+      end
+    end
+  end
+end

data/lib/multi_notifier/version.rb

@@ -1,3 +1,3 @@
 module MultiNotifier
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/spec/multi_notifier/builder_spec.rb

@@ -3,10 +3,10 @@ require "spec_helper"
 describe MultiNotifier::Builder do
   it "builds adapter by types" do
     builder = described_class.new
-    builder.adapter :mail
+    builder.use :mail
 
     builder.adapters.size.should == 1
     adapter = builder.adapters.first
-    adapter.class.name.should == "MultiNotifier::Adapters::Mail"
+    adapter.class.name.should == "MultiNotifier::Middlewares::Mail"
   end
 end

data/spec/multi_notifier/{adapters → middleware}/mail_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
-require "multi_notifier/adapters/mail"
+require "multi_notifier/middlewares/mail"
 
-describe MultiNotifier::Adapters::Mail do
+describe MultiNotifier::Middlewares::Mail do
   context "validations" do
     [:delivery, :from, :to, :subject, :text_body].each do |field|
       it "#{field} can't be blank" do
@@ -22,7 +22,7 @@ describe MultiNotifier::Adapters::Mail do
 
   context "notify" do
     it "sends email" do
-      mail = MultiNotifier::Adapters::Mail.new
+      mail = MultiNotifier::Middlewares::Mail.new
       mail.delivery = {
         :method => :test
       }

data/spec/multi_notifier/middleware/travis_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+require "multi_notifier/middlewares/travis"
+
+describe MultiNotifier::Middlewares::Travis do
+  context "validations" do
+    [:access_token, :repo].each do |field|
+      it "#{field} can't be blank" do
+        instance = described_class.new
+        instance.should be_invalid
+        instance.errors[field].should include("can't be blank")
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_notifier
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jingwen Owen Ou
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-16 00:00:00.000000000 Z
+date: 2013-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -37,14 +37,16 @@ files:
 - README.md
 - Rakefile
 - lib/multi_notifier.rb
-- lib/multi_notifier/adapter.rb
-- lib/multi_notifier/adapters/mail.rb
 - lib/multi_notifier/builder.rb
+- lib/multi_notifier/middleware.rb
+- lib/multi_notifier/middlewares/mail.rb
+- lib/multi_notifier/middlewares/travis.rb
 - lib/multi_notifier/model.rb
 - lib/multi_notifier/version.rb
 - multi_notifier.gemspec
-- spec/multi_notifier/adapters/mail_spec.rb
 - spec/multi_notifier/builder_spec.rb
+- spec/multi_notifier/middleware/mail_spec.rb
+- spec/multi_notifier/middleware/travis_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -66,11 +68,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Simple and flexbile library for sending notifications
 test_files:
-- spec/multi_notifier/adapters/mail_spec.rb
 - spec/multi_notifier/builder_spec.rb
+- spec/multi_notifier/middleware/mail_spec.rb
+- spec/multi_notifier/middleware/travis_spec.rb
 - spec/spec_helper.rb