panthoot 0.1.0 → 0.2.0

data/Gemfile

@@ -1,11 +1,3 @@
-source :rubygems
-
-gem 'combustion',
-  :git => 'git://github.com/freelancing-god/combustion',
-  :ref => 'd7a6836269a8fb528bc3721e9b8c06b5a62ef3cc'
+source 'https://rubygems.org'
 
 gemspec
-
-gem 'grape',
-  :git => 'git://github.com/intridea/grape.git',
-  :ref => '212c96cdfb253a59bc93790808c568e559d04468'

data/README.textile

@@ -8,26 +8,30 @@ h2. Usage
 
 Add the gem to your Gemfile:
 
-<pre><code>gem 'panthoot', '~> 0.0.1'</code></pre>
+<pre><code>gem 'panthoot', '~> 0.2.0'</code></pre>
 
-If you're using Rails, this will automatically add a route at @/panthoot/hooks@ to capture messages from MailChimp. Otherwise, mount the Rack app @Panthoot::App@ to wherever you like. Make sure you add that URL to your MailChimp account settings, otherwise this will all be for naught.
+If you're using Rails, this will automatically add a route at @/panthoot/hooks@ to capture messages from MailChimp. Otherwise, mount the Rack app @Panthoot::App.new@ to wherever you like. Make sure you add that URL to your MailChimp account settings, otherwise this will all be for naught.
 
 The next step is to tell Panthoot that you want to be informed whenever MailChimp sends something your way. In Rails, stick the configuration in an initializer, but for Rack just make sure it's set as part of your app load process.
 
-<pre><code>Panthoot.configure do |config|
-  config.listener = MailChimpListener
+<pre><code>ActiveSupport::Notifications.subscribe('subscribe.panthoot') do |*args|
+  event        = ActiveSupport::Notifications::Event.new(*args)
+  subscription = event.payload[:subscription]
+  fired_at     = event.payload[:fired_at]
+
+  # use subscription data however you wish
 end</code></pre>
 
-The listener class is something you'll need to define. You can call this class whatever you like, but it should respond to the following methods:
+The above sample is just listening to new subscriptions, but there's other events as well - the event prefix matches the payload key in each case:
 
-* #subscribe(subscription, fired_at)
-* #unsubscribe(unsubscription, fired_at)
-* #profile_update(update, fired_at)
-* #email_address_change(change, fired_at)
-* #email_cleaned(clean, fired_at)
-* #campaign_sending_status(status, fired_at)
+* subscribe
+* unsubscribe
+* profile_update
+* email_address_change
+* email_cleaned
+* campaign_sending_status
 
-As you can probably guess from the method signatures, each notification will provide an object with all the data from MailChimp, plus the time the notification was fired. When the methods get called, you get to do your thing with the data provided. Have fun!
+As you can see in the example, each notification will provide an object with all the data from MailChimp, plus the time the notification was fired. When the notification is fired, you get to do your thing with the data provided. Have fun!
 
 h2. Contributing
 
@@ -41,4 +45,4 @@ Pull requests without tests may be rejected purely on that basis. You've been wa
 
 h2. Credits
 
-Copyright (c) 2012, Panthoot is developed and maintained by Pat Allan on behalf of "Inspire9":http://inspire9.com, and is released under the open MIT Licence.
+Copyright (c) 2013, Panthoot is developed and maintained by Pat Allan on behalf of "Inspire9":http://inspire9.com, and is released under the open MIT Licence.

data/config/routes.rb

@@ -1,3 +1,3 @@
 Rails.application.routes.draw do
-  mount Panthoot::App => '/panthoot/hooks'
+  mount Panthoot::App.new => '/panthoot/hooks'
 end

data/lib/panthoot.rb

@@ -1,23 +1,11 @@
-require 'grape'
 require 'hashie'
 
 module Panthoot
-  def self.configure
-    yield self
-  end
-
-  def self.listener
-    @listener
-  end
-
-  def self.listener=(listener)
-    @listener = listener
-  end
+  #
 end
 
 require 'panthoot/app'
 require 'panthoot/data'
 require 'panthoot/translator'
-require 'panthoot/version'
 
 require 'panthoot/engine' if defined?(Rails)

data/lib/panthoot/app.rb

@@ -1,5 +1,7 @@
-class Panthoot::App < Grape::API
-  post do
-    Panthoot::Translator.translate! params
+class Panthoot::App
+  def call(env)
+    Panthoot::Translator.translate! Rack::Request.new(env).params
+
+    [200, {}, [' ']]
   end
 end

data/lib/panthoot/translator.rb

@@ -9,9 +9,9 @@ class Panthoot::Translator
   }
 
   LISTENER_METHODS = {
-    'subscribe' => 'subscribe',    'unsubscribe' => 'unsubscribe',
-    'profile' => 'profile_update', 'upemail' => 'email_address_change',
-    'cleaned' => 'email_cleaned',  'campaign' => 'campaign_sending_status'
+    'subscribe' => 'subscribe',      'unsubscribe' => 'unsubscribe',
+    'profile'   => 'profile_update', 'upemail'     => 'email_address_change',
+    'cleaned'   => 'email_cleaned',  'campaign'    => 'campaign_sending_status'
   }
 
   def self.translate!(params)
@@ -23,7 +23,9 @@ class Panthoot::Translator
   end
 
   def translate!
-    Panthoot.listener.send LISTENER_METHODS[type], translated_object, fired_at
+    key = LISTENER_METHODS[type]
+    ActiveSupport::Notifications.instrument "#{key}.panthoot",
+      key.to_sym => translated_object, :fired_at => fired_at
   end
 
   private

data/panthoot.gemspec

@@ -1,22 +1,21 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/panthoot/version', __FILE__)
-
 Gem::Specification.new do |gem|
+  gem.name          = 'panthoot'
   gem.authors       = ['Pat Allan']
   gem.email         = ['pat@freelancing-gods.com']
-  gem.description   = 'Listener for MailChimp callbacks'
-  gem.summary       = 'Provides a listener for MailChimp callbacks for Rack/Rails apps'
+  gem.summary       = 'ActiveSupport::Notifications for MailChimp callbacks'
+  gem.description   = 'Provides an Rack/Rails API endpoint for MailChimp callbacks with corresponding ActiveSupport::Notifications.'
   gem.homepage      = 'https://github.com/inspire9/panthoot'
 
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = 'panthoot'
+
   gem.require_paths = ['lib']
-  gem.version       = Panthoot::VERSION
+  gem.version       = '0.2.0'
 
   gem.add_runtime_dependency 'hashie', '1.2.0'
 
-  gem.add_development_dependency 'rails',       '3.2.2'
-  gem.add_development_dependency 'rspec-rails', '2.10.1'
+  gem.add_development_dependency 'combustion',  '~> 0.5.0'
+  gem.add_development_dependency 'rails',       '~> 3.2.13'
+  gem.add_development_dependency 'rspec-rails', '~> 2.13.2'
 end

data/spec/requests/notifications_spec.rb

@@ -3,9 +3,26 @@ require 'spec_helper'
 describe 'MailChimp Webhook Notifications' do
   let(:fired_at) { Time.zone.local(2009, 3, 26, 21, 35, 57) }
 
+  def subscribe(type, &block)
+    ActiveSupport::Notifications.subscribe type, &block
+  end
+
+  before :each do
+    @lodged = false
+  end
+
+  after :each do
+    ActiveSupport::Notifications.unsubscribe @subscription
+
+    @lodged.should be_true
+  end
+
   describe 'subscribes' do
     it "sends the listener a subscription object" do
-      MailChimpListener.should_receive(:subscribe) do |subscription, fired_at|
+      @subscription = subscribe('subscribe.panthoot') { |*args|
+        event        = ActiveSupport::Notifications::Event.new *args
+        subscription = event.payload[:subscribe]
+
         subscription.id.should         == '8a25ff1d98'
         subscription.list_id.should    == 'a6b5da1054'
         subscription.email.should      == 'api@mailchimp.com'
@@ -17,7 +34,9 @@ describe 'MailChimp Webhook Notifications' do
           'FNAME' => 'MailChimp',
           'LNAME' => 'API'
         }
-      end
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'subscribe',
         'fired_at' => fired_at.to_s(:db), 'data[id]' => '8a25ff1d98',
@@ -30,7 +49,12 @@ describe 'MailChimp Webhook Notifications' do
     end
 
     it "sends the listener the fired at timestamp" do
-      MailChimpListener.should_receive(:subscribe).with(anything, fired_at)
+      @subscription = subscribe('subscribe.panthoot') { |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        event.payload[:fired_at].should == fired_at
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'subscribe',
         'fired_at' => fired_at.to_s(:db), 'data[id]' => '8a25ff1d98',
@@ -45,7 +69,10 @@ describe 'MailChimp Webhook Notifications' do
 
   describe 'unsubscribes' do
     it "sends the listener an unsubscription object" do
-      MailChimpListener.should_receive(:unsubscribe) do |unsubscription, fired_at|
+      @subscription = subscribe('unsubscribe.panthoot') { |*args|
+        event          = ActiveSupport::Notifications::Event.new *args
+        unsubscription = event.payload[:unsubscribe]
+
         unsubscription.action.should      == 'unsub'
         unsubscription.reason.should      == 'manual'
         unsubscription.id.should          == '8a25ff1d98'
@@ -60,12 +87,15 @@ describe 'MailChimp Webhook Notifications' do
           'LNAME'     => 'API',
           'INTERESTS' => 'Group1,Group2'
         }
-      end
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'unsubscribe',
         'fired_at' => fired_at.to_s(:db), 'data[action]' => 'unsub',
         'data[reason]' => 'manual', 'data[id]' => '8a25ff1d98',
-        'data[list_id]' => 'a6b5da1054', 'data[email]' => 'api@mailchimp.com',
+        'data[list_id]' => 'a6b5da1054',
+        'data[email]' => 'api+unsub@mailchimp.com',
         'data[email_type]' => 'html',
         'data[merges][EMAIL]' => 'api@mailchimp.com',
         'data[merges][FNAME]' => 'MailChimp',
@@ -76,12 +106,18 @@ describe 'MailChimp Webhook Notifications' do
     end
 
     it "sends the listener the fired at timestamp" do
-      MailChimpListener.should_receive(:unsubscribe).with(anything, fired_at)
+      @subscription = subscribe('unsubscribe.panthoot') { |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        event.payload[:fired_at].should == fired_at
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'unsubscribe',
         'fired_at' => fired_at.to_s(:db), 'data[action]' => 'unsub',
         'data[reason]' => 'manual', 'data[id]' => '8a25ff1d98',
-        'data[list_id]' => 'a6b5da1054', 'data[email]' => 'api@mailchimp.com',
+        'data[list_id]' => 'a6b5da1054',
+        'data[email]' => 'api+unsub@mailchimp.com',
         'data[email_type]' => 'html',
         'data[merges][EMAIL]' => 'api@mailchimp.com',
         'data[merges][FNAME]' => 'MailChimp',
@@ -94,10 +130,13 @@ describe 'MailChimp Webhook Notifications' do
 
   describe 'profile updates' do
     it "sends the listener a profile object" do
-      MailChimpListener.should_receive(:profile_update) do |profile, fired_at|
+      @subscription = subscribe('profile_update.panthoot') { |*args|
+        event   = ActiveSupport::Notifications::Event.new *args
+        profile = event.payload[:profile_update]
+
         profile.id.should          == '8a25ff1d98'
         profile.list_id.should     == 'a6b5da1054'
-        profile.email.should       == 'api+unsub@mailchimp.com'
+        profile.email.should       == 'api@mailchimp.com'
         profile.email_type.should  == 'html'
         profile.ip_opt.should      == '10.20.10.30'
         profile.merges.should == {
@@ -106,11 +145,14 @@ describe 'MailChimp Webhook Notifications' do
           'LNAME'     => 'API',
           'INTERESTS' => 'Group1,Group2'
         }
-      end
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'profile',
         'fired_at' => fired_at.to_s(:db), 'data[id]' => '8a25ff1d98',
-        'data[list_id]' => 'a6b5da1054', 'data[email]' => 'api@mailchimp.com',
+        'data[list_id]' => 'a6b5da1054',
+        'data[email]' => 'api@mailchimp.com',
         'data[email_type]' => 'html',
         'data[merges][EMAIL]' => 'api@mailchimp.com',
         'data[merges][FNAME]' => 'MailChimp',
@@ -120,11 +162,17 @@ describe 'MailChimp Webhook Notifications' do
     end
 
     it "sends the listener the fired at timestamp" do
-      MailChimpListener.should_receive(:profile_update).with(anything, fired_at)
+      @subscription = subscribe('profile_update.panthoot') { |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        event.payload[:fired_at].should == fired_at
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'profile',
         'fired_at' => fired_at.to_s(:db), 'data[id]' => '8a25ff1d98',
-        'data[list_id]' => 'a6b5da1054', 'data[email]' => 'api@mailchimp.com',
+        'data[list_id]' => 'a6b5da1054',
+        'data[email]' => 'api@mailchimp.com',
         'data[email_type]' => 'html',
         'data[merges][EMAIL]' => 'api@mailchimp.com',
         'data[merges][FNAME]' => 'MailChimp',
@@ -136,12 +184,17 @@ describe 'MailChimp Webhook Notifications' do
 
   describe 'email address changes' do
     it "sends the listener an email address change object" do
-      MailChimpListener.should_receive(:email_address_change) do |email_change, fired_at|
+      @subscription = subscribe('email_address_change.panthoot') { |*args|
+        event        = ActiveSupport::Notifications::Event.new *args
+        email_change = event.payload[:email_address_change]
+
         email_change.list_id.should   == 'a6b5da1054'
         email_change.new_id.should    == '51da8c3259'
         email_change.new_email.should == 'api+new@mailchimp.com'
         email_change.old_email.should == 'api+old@mailchimp.com'
-      end
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'upemail',
         'fired_at' => fired_at.to_s(:db), 'data[list_id]' => 'a6b5da1054',
@@ -151,8 +204,12 @@ describe 'MailChimp Webhook Notifications' do
     end
 
     it "sends the listener the fired at timestamp" do
-      MailChimpListener.should_receive(:email_address_change).
-        with(anything, fired_at)
+      @subscription = subscribe('email_address_change.panthoot') { |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        event.payload[:fired_at].should == fired_at
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'upemail',
         'fired_at' => fired_at.to_s(:db), 'data[list_id]' => 'a6b5da1054',
@@ -164,12 +221,17 @@ describe 'MailChimp Webhook Notifications' do
 
   describe 'cleaned emails' do
     it "sends the listener a cleaned email object" do
-      MailChimpListener.should_receive(:email_cleaned) do |cleaned, fired_at|
+      @subscription = subscribe('email_cleaned.panthoot') { |*args|
+        event   = ActiveSupport::Notifications::Event.new *args
+        cleaned = event.payload[:email_cleaned]
+
         cleaned.list_id.should     == 'a6b5da1054'
         cleaned.campaign_id.should == '4fjk2ma9xd'
         cleaned.reason.should      == 'hard'
         cleaned.email.should       == 'api+cleaned@mailchimp.com'
-      end
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'cleaned',
         'fired_at' => fired_at.to_s(:db), 'data[list_id]' => 'a6b5da1054',
@@ -178,7 +240,12 @@ describe 'MailChimp Webhook Notifications' do
     end
 
     it "sends the listener the fired at timestamp" do
-      MailChimpListener.should_receive(:email_cleaned).with(anything, fired_at)
+      @subscription = subscribe('email_cleaned.panthoot') { |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        event.payload[:fired_at].should == fired_at
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'cleaned',
         'fired_at' => fired_at.to_s(:db), 'data[list_id]' => 'a6b5da1054',
@@ -187,15 +254,20 @@ describe 'MailChimp Webhook Notifications' do
     end
   end
 
-  describe 'cleaned emails' do
+  describe 'campaign sending status' do
     it "sends the listener a campaign sending status object" do
-      MailChimpListener.should_receive(:campaign_sending_status) do |status, fired_at|
+      @subscription = subscribe('campaign_sending_status.panthoot') { |*args|
+        event  = ActiveSupport::Notifications::Event.new *args
+        status = event.payload[:campaign_sending_status]
+
         status.id.should      == '5aa2102003'
         status.subject.should == 'Test Campaign Subject'
         status.status.should  == 'sent'
         status.reason.should  == ''
         status.list_id.should == 'a6b5da1054'
-      end
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'campaign',
         'fired_at' => fired_at.to_s(:db), 'data[list_id]' => 'a6b5da1054',
@@ -204,8 +276,12 @@ describe 'MailChimp Webhook Notifications' do
     end
 
     it "sends the listener the fired at timestamp" do
-      MailChimpListener.should_receive(:campaign_sending_status).
-        with(anything, fired_at)
+      @subscription = subscribe('campaign_sending_status.panthoot') { |*args|
+        event = ActiveSupport::Notifications::Event.new *args
+        event.payload[:fired_at].should == fired_at
+
+        @lodged = true
+      }
 
       post '/panthoot/hooks', 'type' => 'campaign',
         'fired_at' => fired_at.to_s(:db), 'data[list_id]' => 'a6b5da1054',

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
-require 'rubygems'
 require 'bundler'
 
-Bundler.require :default, :development
+Bundler.setup :default, :development
+
+require 'rails'
+require 'combustion'
+require 'panthoot'
 
 Combustion.initialize! :action_controller
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: panthoot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,42 +9,74 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-17 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70232992118500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70232992118500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70232992110760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.2
+        version: 3.2.13
   type: :development
   prerelease: false
-  version_requirements: *70232992110760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.13
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70232992106780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 2.10.1
+        version: 2.13.2
   type: :development
   prerelease: false
-  version_requirements: *70232992106780
-description: Listener for MailChimp callbacks
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.2
+description: Provides an Rack/Rails API endpoint for MailChimp callbacks with corresponding
+  ActiveSupport::Notifications.
 email:
 - pat@freelancing-gods.com
 executables: []
@@ -70,10 +102,8 @@ files:
 - lib/panthoot/data/unsubscription.rb
 - lib/panthoot/engine.rb
 - lib/panthoot/translator.rb
-- lib/panthoot/version.rb
 - panthoot.gemspec
 - spec/internal/app/listeners/mail_chimp_listener.rb
-- spec/internal/config/initializers/panthoot.rb
 - spec/internal/config/routes.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
@@ -91,24 +121,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -426635896039990755
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -426635896039990755
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.16
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Provides a listener for MailChimp callbacks for Rack/Rails apps
+summary: ActiveSupport::Notifications for MailChimp callbacks
 test_files:
 - spec/internal/app/listeners/mail_chimp_listener.rb
-- spec/internal/config/initializers/panthoot.rb
 - spec/internal/config/routes.rb
 - spec/internal/log/.gitignore
 - spec/internal/public/favicon.ico
 - spec/requests/notifications_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/panthoot/version.rb

@@ -1,3 +0,0 @@
-module Panthoot
-  VERSION = '0.1.0'
-end

data/spec/internal/config/initializers/panthoot.rb

@@ -1,3 +0,0 @@
-Panthoot.configure do |config|
-  config.listener = MailChimpListener
-end