mandrill-rails 1.2.0 → 1.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NWQzYTE1ZWNjNzdlMzdhNzg3ZTczOWM5Y2QzN2NlY2EyMWU2NDI3ZQ==
+    ZTYyZjcwNGMzNTlkMmQ1ODZlZTRkMzI5OWNmZDQwNmVmMWIzYjFmYw==
   data.tar.gz: !binary |-
-    YzAzOWJmN2E1OGQ5YmQ2YWI2MGI2MmM1MjFmYTBlYjg0NTNlM2E5Zg==
+    YWQ4MDI4OGU0MTYzNDM0OTMyNzcwNDkyZjNiN2ZlNTY5MGU2YTk4YQ==
 SHA512:
   metadata.gz: !binary |-
-    ZmQ2Y2ZiZTgxNzZkM2QwMzVmMmFiNjM0YTcyYTUzZmVjM2YwZDFkMGY4NTgw
-    YWJhMGRmYmZhZmI0Y2UzZjdhNDI4MzYyYjhkZmVjYjRlOWQwYTYxYjIxMTFl
-    Nzg4M2Y0YTQyZDBjZmJjZTgwYTI1NTVkMWFhNzI5OGIwNzcwZjc=
+    MjA5ZDRkMGNlYzA0MTQ4MWYxNDdiODZkNTU4Nzc3OTUwNzMwMTQ4ODllYzJi
+    ZmMyNWFhN2E1ZDJmYjZiOTQxMTcyYmVhNjEzMmI2NWExYjg2ZWFmMzM5ZTk5
+    MGQxOGFiM2VmZTcyODhlZDg0ZmQwNjJkNmM2ODY3NzdiYTA2ZDU=
   data.tar.gz: !binary |-
-    MTYyMGMxNzM0MjQ0ZWMyZWFiZWYwNjU3MDJlZTQxZTI1NjEwY2UyMGI0Nzlh
-    ZjY3NjNjZDY2NmY0NWY1YTNmNDBjOTczMTRlZTc5NjNlMWM3MDI3YTQzYjUw
-    MDk1MzEwMzhjOGZhNTdmNWRlZDk0ODlmMzYwMTZhNTAzNDQyM2I=
+    NzRhZmI4YTM2ZDA1YTlkYzU3ZTkwMjVlZGVkNTA3NjgwMGM2NjNjYTRkOTUy
+    YTljZmJkNGUwNDRmOWVlMDM1NzI3YTAyNTU0OGQ4ZDIzZGM3ZTU2NTBjYTdl
+    YjQ4MDk2MGNlMGExN2VhYzY2ZTYzMGI4YTE0YWZiODEwMjI2ZjU=

data/lib/mandrill-rails/version.rb

@@ -3,5 +3,5 @@ module Mandrill
   end
 end
 unless defined?(Mandrill::Rails::VERSION)
-  Mandrill::Rails::VERSION = "1.2.0"
+  Mandrill::Rails::VERSION = "1.3.0"
 end

data/lib/mandrill/web_hook/event_decorator.rb

@@ -13,7 +13,23 @@ class Mandrill::WebHook::EventDecorator < Hash
   # Returns the event type.
   # Applicable events: all
   def event_type
-    self['event']
+    self['event'] || if sync_type.present?
+      'sync'
+    end
+  end
+
+  # Returns the sync type.
+  # Applicable events: sync
+  def sync_type
+    if %w(blacklist whitelist).include?(type = self['type'])
+      type
+    end
+  end
+
+  # Returns the reject Hash.
+  # Applicable events: sync
+  def reject
+    self['reject']||{}
   end
 
   # Returns the message subject.
@@ -69,14 +85,14 @@ class Mandrill::WebHook::EventDecorator < Hash
   # Inbound messages: references 'from_email' message attribute.
   # Send/Open/Click messages: references 'sender' message attribute.
   def sender_email
-    msg['from_email']||msg['sender']
+    msg['from_email'] || msg['sender'] || reject['sender']
   end
 
   # Returns the subject user email address.
   # Inbound messages: references 'email' message attribute (represents the sender).
   # Send/Open/Click messages: references 'email' message attribute (represents the recipient).
   def user_email
-    msg['email']
+    msg['email'] || reject['email']
   end
 
   # Returns an array of all unique recipients (to/cc)

data/lib/mandrill/web_hook/processor.rb

@@ -12,41 +12,17 @@ class Mandrill::WebHook::Processor
   end
 
   def mandrill_events
-    @mandrill_events ||= JSON.parse(params['mandrill_events'] || '[]')
-  rescue
-    @mandrill_events = []
+    @mandrill_events ||= JSON.parse(params['mandrill_events']) rescue []
   end
 
   # Command: processes all +mandrill_events+
   def run!
     mandrill_events.each do |raw_payload|
-      event_payload = wrap_payload(raw_payload)
-      handler = "handle_#{event_payload.event_type}".to_sym
-      if callback_host && callback_host.respond_to?(handler, true)
-        callback_host.send(handler,event_payload)
-      elsif self.respond_to?(handler)
-        self.send(handler,event_payload)
-      else
-        error_message = "Expected handler method `#{handler}` for event type `#{event_payload.event_type}`"
-        case on_unhandled_mandrill_events
-        when :ignore
-          # NOP
-        when :raise_exception
-          raise Mandrill::Rails::Errors::MissingEventHandler, error_message
-        else
-          Rails.logger.error error_message rescue nil
-        end
-      end
+      process_event(Mandrill::WebHook::EventDecorator[raw_payload])
     end
   end
 
-  # Returns a suitably ecapsulated +raw_event_payload+
-  def wrap_payload(raw_event_payload)
-    Mandrill::WebHook::EventDecorator[raw_event_payload]
-  end
-
   class << self
-
     # Returns true if +params+ sent to +original_url+ are authentic given +expected_signature+ and +mandrill_webhook_keys+.
     def authentic?(expected_signature, mandrill_webhook_keys, original_url, params)
       result = true
@@ -67,7 +43,29 @@ class Mandrill::WebHook::Processor
       end
       Base64.encode64("#{OpenSSL::HMAC.digest('sha1', webhook_key, signed_data)}").strip
     end
-
   end
 
+  private
+
+
+  # Command: attempts to process +event_payload+
+  def process_event(event_payload)
+    handler = "handle_#{event_payload.event_type}".to_sym
+
+    if callback_host && callback_host.respond_to?(handler, true)
+      callback_host.send(handler,event_payload)
+    elsif self.respond_to?(handler)
+      self.send(handler,event_payload)
+    else
+      error_message = "Expected handler method `#{handler}` for event type `#{event_payload.event_type}`"
+      case on_unhandled_mandrill_events
+      when :ignore
+        # NOP
+      when :raise_exception
+        raise Mandrill::Rails::Errors::MissingEventHandler, error_message
+      else
+        Rails.logger.error error_message rescue nil
+      end
+    end
+  end
 end

data/spec/fixtures/webhook_examples/sync_blacklist.json

@@ -0,0 +1,18 @@
+[
+  {
+    "type": "blacklist",
+    "action": "add",
+    "reject": {
+      "reason": "test",
+      "detail": "this is a mock event, replace with a real example when available",
+      "last_event_at": "2015-01-01 01:02:03",
+      "email": "test@example.net",
+      "created_at": "2015-02-01 01:02:03",
+      "expires_at": "2016-01-01 01:02:03",
+      "expired": "false",
+      "subaccount": "",
+      "sender": "sender@example.net"
+    },
+    "ts": 1350377135
+  }
+]

data/spec/fixtures/webhook_examples/sync_whitelist.json

@@ -0,0 +1,12 @@
+[
+  {
+    "type": "whitelist",
+    "action": "add",
+    "reject": {
+      "detail": "this is a mock event, replace with a real example when available",
+      "email": "test@example.net",
+      "created_at": "2015-02-01 01:02:03"
+    },
+    "ts": 1350377135
+  }
+]

data/spec/mandrill-rails/web_hook_processor_spec.rb

@@ -24,12 +24,16 @@ describe Mandrill::Rails::WebHookProcessor do
 
   describe "##skip_before_filter settings" do
     subject { processor_class.skip_before_filter_settings }
-    it { should eql([:verify_authenticity_token]) }
+    it "includes verify_authenticity_token" do
+      expect(subject).to eql([:verify_authenticity_token])
+    end
   end
 
   describe "##before_filter settings" do
     subject { processor_class.before_filter_settings }
-    it { should eql([:authenticate_mandrill_request!, {:only=>[:create]}]) }
+    it "includes authenticate_mandrill_request" do
+      expect(subject).to eql([:authenticate_mandrill_request!, {:only=>[:create]}])
+    end
   end
 
   describe "#mandrill_webhook_keys" do
@@ -135,7 +139,9 @@ describe Mandrill::Rails::WebHookProcessor do
     subject { processor_instance.send(:authenticate_mandrill_request!) }
 
     context "when authentication not enabled" do
-      it { should eql(true) }
+      it "passes" do
+        expect(subject).to eql(true)
+      end
     end
     context "when authentication enabled" do
       before do
@@ -143,15 +149,19 @@ describe Mandrill::Rails::WebHookProcessor do
       end
       context "with valid key" do
         let(:mandrill_webhook_keys) { valid_webhook_key }
-        it { should eql(true) }
+        it "passes" do
+          expect(subject).to eql(true)
+        end
       end
       context "with mix of valid and invalid keys" do
         let(:mandrill_webhook_keys) { ['bogative',valid_webhook_key] }
-        it { should eql(true) }
+        it "passes" do
+          expect(subject).to eql(true)
+        end
       end
       context "with invalid key" do
         let(:mandrill_webhook_keys) { 'bogative' }
-        it "should call head(:forbidden) and return false" do
+        it "calls head(:forbidden) and return false" do
           expect(processor_instance).to receive(:head).with(:forbidden, :text => "Mandrill signature did not match.")
           expect(subject).to eql(false)
         end

data/spec/mandrill/web_hook/event_decorator_spec.rb

@@ -20,6 +20,8 @@ describe Mandrill::WebHook::EventDecorator do
   {
     'inbound' => {
       :event_type => 'inbound',
+      :sync_type => nil,
+      :reject => {},
       :subject => '[inbound] Sample Subject',
       :message_id => '<CAGBx7GhULS7d6ZsdLREHnKQ68V6w2fbGmD85dPn63s6RtpsZeQ@mail.gmail.com>',
       :message_version => nil,
@@ -47,6 +49,8 @@ describe Mandrill::WebHook::EventDecorator do
     },
     'inbound_reply' => {
       :event_type => 'inbound',
+      :sync_type => nil,
+      :reject => {},
       :subject => '[inbound] Sample Subject 2',
       :message_id => '<CAGBx7GhsVk7Q-aO-FQ-m+Oix7GQyEVHyL60qv0__G8EpH8pA4w@mail.gmail.com>',
       :message_version => nil,
@@ -80,6 +84,8 @@ describe Mandrill::WebHook::EventDecorator do
     },
     'click' => {
       :event_type => 'click',
+      :sync_type => nil,
+      :reject => {},
       :subject => '[click] Sample Subject',
       :message_id => '8606637.6692f6cac28e45a9b371e182d5ca0a35',
       :message_version => 5,
@@ -107,6 +113,8 @@ describe Mandrill::WebHook::EventDecorator do
     },
     'send' => {
       :event_type => 'send',
+      :sync_type => nil,
+      :reject => {},
       :subject => '[send] Sample Subject',
       :message_id => '9a32184309ad4d5e9bfd20368d9d7981',
       :message_version => nil,
@@ -124,6 +132,8 @@ describe Mandrill::WebHook::EventDecorator do
     },
     'open' => {
       :event_type => 'open',
+      :sync_type => nil,
+      :reject => {},
       :subject => '[open] Sample Subject',
       :message_id => '12847763.9a32184309ad4d5e9bfd20368d9d7981',
       :message_version => 3,
@@ -139,6 +149,58 @@ describe Mandrill::WebHook::EventDecorator do
       :all_clicks => [{"ts"=>1350693098, "url"=>"http://feedproxy.google.com/~r/AccidentalTechnologist/~3/Jc7hYTVjcmM/"}],
       :all_clicked_links => ["http://feedproxy.google.com/~r/AccidentalTechnologist/~3/Jc7hYTVjcmM/"]
     },
+    'sync_blacklist' => {
+      :event_type => 'sync',
+      :sync_type => 'blacklist',
+      :reject => {
+        "reason"=>"test",
+        "detail"=>"this is a mock event, replace with a real example when available",
+        "last_event_at"=>"2015-01-01 01:02:03",
+        "email"=>"test@example.net",
+        "created_at"=>"2015-02-01 01:02:03",
+        "expires_at"=>"2016-01-01 01:02:03",
+        "expired"=>"false",
+        "subaccount"=>"",
+        "sender"=>"sender@example.net"
+      },
+      :subject => nil,
+      :message_id => nil,
+      :message_version => nil,
+      :in_reply_to => nil,
+      :references => [],
+      :headers => {},
+      :sender_email => "sender@example.net",
+      :user_email => "test@example.net",
+      :recipients => [],
+      :recipient_emails => [],
+      :message_body => nil,
+      :click => nil,
+      :all_clicks => [],
+      :all_clicked_links => []
+    },
+    'sync_whitelist' => {
+      :event_type => 'sync',
+      :sync_type => 'whitelist',
+      :reject => {
+        "detail"=>"this is a mock event, replace with a real example when available",
+        "email"=>"test@example.net",
+        "created_at"=>"2015-02-01 01:02:03"
+      },
+      :subject => nil,
+      :message_id => nil,
+      :message_version => nil,
+      :in_reply_to => nil,
+      :references => [],
+      :headers => {},
+      :sender_email => nil,
+      :user_email => "test@example.net",
+      :recipients => [],
+      :recipient_emails => [],
+      :message_body => nil,
+      :click => nil,
+      :all_clicks => [],
+      :all_clicked_links => []
+    }
   }.each do |event_type,expectations|
     context "with #{event_type} event_type" do
       let(:raw_event) { webhook_example_event(event_type) }
@@ -281,7 +343,7 @@ describe Mandrill::WebHook::EventDecorator do
         expect(image.content).to match(/^iVBORw0K/)
         expect(image.decoded_content).to match(/^\x89PNG\r\n/n)
       end
-      it "decoded_content exactly matches the original" do
+      it "has decoded_content exactly matching the original" do
         original_digest = Digest::SHA1.hexdigest(payload_example('sample.png'))
         decoded_digest = Digest::SHA1.hexdigest(image.decoded_content)
         expect(original_digest).to eql(decoded_digest)

data/spec/mandrill/web_hook/processor_spec.rb

@@ -9,16 +9,27 @@ describe Mandrill::WebHook::Processor do
   describe "#run!" do
 
     context "when handler methods are present" do
+      let(:event1) { { "event" => "inbound" } }
+      let(:event2) { { "event" => "click" } }
+      let(:event3) { { "type" => "blacklist" } }
+      let(:params) { { "mandrill_events" => [event1, event2, event3].to_json } }
+
       before do
         allow(processor_class).to receive(:handle_inbound)
         allow(processor_class).to receive(:handle_click)
+        allow(processor_class).to receive(:handle_sync)
       end
-      let(:event1) { { "event" => "inbound" } }
-      let(:event2) { { "event" => "click" } }
-      let(:params) { { "mandrill_events" => [event1,event2].to_json } }
-      it "should pass all event payloads to the handler" do
+
+      it "passes all event payloads to the handler" do
         expect(processor).to receive(:handle_inbound)
         expect(processor).to receive(:handle_click)
+        expect(processor).to receive(:handle_sync)
+        processor.run!
+      end
+    end
+    context "but no valid handler methods are present" do
+      let(:params) { nil }
+      it "keeps calm and carries on" do
         processor.run!
       end
     end
@@ -39,7 +50,7 @@ describe Mandrill::WebHook::Processor do
           end
         end
 
-        it "should pass event payload to the handler" do
+        it "passes event payload to the handler" do
           expect(callback_host).to receive(:handle_inbound).twice
           processor.run!
         end
@@ -53,7 +64,7 @@ describe Mandrill::WebHook::Processor do
           end
         end
 
-        it "should pass event payload to the handler" do
+        it "passes event payload to the handler" do
           expect(callback_host).to receive(:handle_inbound).twice
           processor.run!
         end
@@ -67,7 +78,7 @@ describe Mandrill::WebHook::Processor do
           end
         end
 
-        it "should pass event payload to the handler" do
+        it "passes event payload to the handler" do
           expect(callback_host).to receive(:handle_inbound).twice
           processor.run!
         end
@@ -96,7 +107,7 @@ describe Mandrill::WebHook::Processor do
         end
 
         context "and ignore missing handler behaviour" do
-          it "logs an error" do
+          it "keeps calm and carries on" do
             processor.on_unhandled_mandrill_events = :ignore
             expect { processor.run! }.to_not raise_error
           end
@@ -109,19 +120,7 @@ describe Mandrill::WebHook::Processor do
             .to raise_error(Mandrill::Rails::Errors::MissingEventHandler)
           end
         end
-
       end
-
-    end
-
-
-  end
-
-  describe "#wrap_payload" do
-    let(:raw_payload) { {} }
-    subject { processor.wrap_payload(raw_payload) }
-    it "returns a decorated hash" do
-      expect(subject.class).to eql(Mandrill::WebHook::EventDecorator)
     end
   end
 
@@ -134,19 +133,27 @@ describe Mandrill::WebHook::Processor do
     let(:params) { example_payload['raw_params'] }
     subject { processor_class.authentic?(expected_signature, mandrill_webhook_keys, original_url, params) }
     context "when valid" do
-      it { should eql(true) }
+      it "passes" do
+        expect(subject).to eql(true)
+      end
     end
     context "when no keys" do
       let(:mandrill_webhook_keys) { [] }
-      it { should eql(true) }
+      it "passes" do
+        expect(subject).to eql(true)
+      end
     end
     context "when keys don't match" do
       let(:mandrill_webhook_keys) { ['bogative'] }
-      it { should eql(false) }
+      it "fails" do
+        expect(subject).to eql(false)
+      end
     end
     context "when signature don't match" do
       let(:expected_signature) { 'bogative' }
-      it { should eql(false) }
+      it "fails" do
+        expect(subject).to eql(false)
+      end
     end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mandrill-rails
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Paul Gallagher
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,6 +139,8 @@ files:
 - spec/fixtures/webhook_examples/inbound_without_msg.json
 - spec/fixtures/webhook_examples/open.json
 - spec/fixtures/webhook_examples/send.json
+- spec/fixtures/webhook_examples/sync_blacklist.json
+- spec/fixtures/webhook_examples/sync_whitelist.json
 - spec/mandrill-rails/web_hook_processor_spec.rb
 - spec/mandrill/web_hook/attachment_spec.rb
 - spec/mandrill/web_hook/event_decorator_spec.rb
@@ -191,6 +193,8 @@ test_files:
 - spec/fixtures/webhook_examples/inbound_without_msg.json
 - spec/fixtures/webhook_examples/open.json
 - spec/fixtures/webhook_examples/send.json
+- spec/fixtures/webhook_examples/sync_blacklist.json
+- spec/fixtures/webhook_examples/sync_whitelist.json
 - spec/mandrill-rails/web_hook_processor_spec.rb
 - spec/mandrill/web_hook/attachment_spec.rb
 - spec/mandrill/web_hook/event_decorator_spec.rb