Handle incoming webhook notifications

Author: nurazem

lib/intercom.rb

@@ -10,6 +10,7 @@
 require "intercom/admin"
 require "intercom/count"
 require "intercom/request"
+require "intercom/webhook_payload"
 require "intercom/utils"
 require "intercom/errors"
 require "json"

lib/intercom/webhook_payload.rb

@@ -0,0 +1,22 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  module Webhook
+    class Payload
+      include Traits::ApiResource
+
+      # This method could be renamed, e.g. response_object or model
+      def to_model
+        data.item
+      end
+
+      def model_type
+        to_model.class
+      end
+
+      def load
+        to_model.load
+      end
+    end
+  end
+end

spec/spec_helper.rb

@@ -132,6 +132,136 @@ def test_tag
   }
 end
 
+def test_webhook_user
+  {
+    "type" => "notification_event",
+    "id" => "notif_123456-56465-546546",
+    "topic" => "user.created",
+    "app_id" => "aaaaaa",
+    "data" =>
+    {
+      "type" => "notification_event_data",
+      "item" =>
+      {
+        "type" => "user",
+        "id" => "aaaaaaaaaaaaaaaaaaaaaaaa",
+        "user_id" => nil,
+        "email" => "[email protected]",
+        "name" => "Joe Schmoe",
+        "avatar" =>
+        {
+          "type" => "avatar",
+          "image_url" => nil
+        },
+        "app_id" => "aaaaa",
+        "companies" =>
+        {
+          "type" => "company.list",
+          "companies" => [ ]
+        },
+        "location_data" =>
+        {
+        },
+        "last_request_at" => nil,
+        "created_at" => "1401970114",
+        "remote_created_at" => nil,
+        "updated_at" => "1401970114",
+        "session_count" => 0,
+        "social_profiles" =>
+        {
+          "type" => "social_profile.list",
+          "social_profiles" => [ ]
+        },
+        "unsubscribed_from_emails" => false,
+        "user_agent_data" => nil,
+        "tags" =>
+        {
+          "type" => "tag.list",
+          "tags" => [ ]
+        },
+        "segments" =>
+        {
+          "type" => "segment.list",
+          "segments" => [ ]
+        },
+        "custom_attributes" =>
+        {
+        }
+      }
+    },
+    "delivery_status" => nil,
+    "delivery_attempts" => 1,
+    "delivered_at" => 0,
+    "first_sent_at" => 1410188629,
+    "created_at" => 1410188628,
+    "links" => { },
+    "self" => nil
+  }
+end
+
+def test_webhook_conversation
+  {
+     "type"=>"notification_event",
+     "id"=>"notif_123456-56465-546546",
+     "topic"=>"conversation.user.created",
+     "app_id"=>"aaaaa",
+     "data"=>
+     {
+          "type"=>"notification_event_data",
+          "item"=>
+          {
+               "type"=>"conversation",
+               "id"=>"123456789",
+               "created_at"=>"1410335293",
+               "updated_at"=>"1410335293",
+               "user"=>
+               {
+                    "type"=>"user",
+                    "id"=>"540f1de7112d3d1d51001637",
+                    "name"=>"Kill Bill",
+                    "email"=>"[email protected]"},
+               "assignee"=>
+               {
+                   "type"=>"nobody_admin",
+                   "id"=>nil
+               },
+               "conversation_message"=>
+               {
+                    "type"=>"conversation_message",
+                    "id"=>"321546",
+                    "subject"=>"",
+                    "body"=>"<p>An important message</p>",
+                    "author"=>
+                    {
+                         "type"=>"user",
+                         "id"=>"aaaaaaaaaaaaaaaaaaaaaa",
+                         "name"=>"Kill Bill",
+                         "email"=>"[email protected]"},
+                    "attachments"=>[]
+               },
+               "conversation_parts"=>
+               {
+                   "type"=>"conversation_part.list",
+                   "conversation_parts"=>[]
+               },
+               "open"=>nil,
+               "read"=>true,
+               "links"=>
+               {
+                   "conversation_web"=>
+                    "https://app.intercom.io/a/apps/aaaaaa/inbox/all/conversations/123456789"}
+          }
+     },
+     "delivery_status"=>nil,
+     "delivery_attempts"=>1,
+     "delivered_at"=>0,
+     "first_sent_at"=>1410335293,
+     "created_at"=>1410335293,
+     "links"=>{},
+     "self"=>nil
+  }
+end
+
 def error_on_modify_frozen
   RUBY_VERSION =~ /1.8/ ? TypeError : RuntimeError
 end

spec/unit/intercom/webhook_payload_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe "Intercom::Webhook::Payload" do
+
+  it "converts webhook hash to object" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_user)
+    payload.must_be_instance_of Intercom::Webhook::Payload
+  end
+
+  it "returns correct model type for User" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_user)
+    payload.model_type.must_equal Intercom::User
+  end
+
+  it "returns correct notification topic" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_user)
+    payload.topic.must_equal "user.created"
+  end
+
+  it "returns instance of User" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_user)
+    payload.to_model.must_be_instance_of Intercom::User
+  end
+
+  it "returns instance of Conversation" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_conversation)
+    payload.to_model.must_be_instance_of Intercom::Conversation
+  end
+
+  it "returns correct model type for User" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_conversation)
+    payload.model_type.must_equal Intercom::Conversation
+  end
+
+  it "returns correct notification topic" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_conversation)
+    payload.topic.must_equal "conversation.user.created"
+  end
+
+  it "returns inner User object for Conversation" do
+    payload = Intercom::Webhook::Payload.new(test_webhook_conversation)
+    payload.to_model.user.must_be_instance_of Intercom::User
+  end
+
+end