intercom 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f26bb35b88b669bfc5225edd1fc7838411dcefe7
-  data.tar.gz: 1636c5b0708ed2ffb05d75e4d381a9cd4e35df87
+  metadata.gz: c9111e19a82bb7d9ffba1c0677d77c629266ac7c
+  data.tar.gz: 02a3c89982a481e6b2b3410d4cbec80630556daa
 SHA512:
-  metadata.gz: 81ec8dad83ea630bfb9dc59c400d190fb8c299a5024b06c8a486563dd45d2be084e6dda5d0e12927f3d0eb09b7fb4be8f2903a4c266e5858301ae5eacae43076
-  data.tar.gz: d34a0ebe575bf3d365eba99f3a3f9e3203e21759213919f616fdf4c2035a4ad4fb850fddf9f9c185e7e4e6f5f541896553017b1c47a04c41473f17a31dd61096
+  metadata.gz: 0695acd0c2f7227c16a2253f90e18b8be2398d2032175ac69c5067e6d6bbfe13d64a5ab85d0c0b1aa734f7aa0bf6acbadc202649c715370a07dd3c405a1d6f73
+  data.tar.gz: 0b6a49e6137e4794199175cdc9b8dca25b71be86b5413146c1cf379a3a324ce6a92a9ffdd1e1ea67e5384c1e13e326e54504dd055ccfe3da2dd0691c1d1b6022

data/README.md

@@ -19,7 +19,7 @@ Additionally, the new version uses Ruby 2.
 
 Using bundler:
 
-    gem 'intercom', "~> 2.2.0"
+    gem 'intercom', "~> 2.2.1"
 
 ## Basic Usage
 
@@ -43,6 +43,9 @@ Resources this API supports:
     https://api.intercom.io/conversations
     https://api.intercom.io/messages
     https://api.intercom.io/counts
+    https://api.intercom.io/subscriptions
+    
+Additionally, the library can handle incoming webhooks from Intercom and convert to `Intercom::` models.
 
 ### Examples
 
@@ -290,6 +293,39 @@ The metadata key values in the example are treated as follows-
 - order_number: a Rich Link (value contains 'url' and 'value' keys)
 - price: An Amount in US Dollars (value contains 'amount' and 'currency' keys)
 
+### Subscriptions
+
+Subscribe to events in Intercom to receive webhooks.
+
+```ruby
+# create a subscription
+Intercom::Subscription.create(:url => "http://example.com", :topics => ["user.created"])
+
+# fetch a subscription
+Intercom::Subscription.find(:id => "nsub_123456789")
+
+# list subscriptions
+Intercom::Subscription.all
+```
+
+### Webhooks
+
+```ruby
+# create a payload from the notification hash (from json).
+payload = Intercom::Notification.new(notification_hash)
+
+payload.type
+# => 'user.created'
+
+payload.model_type
+# => Intercom::User
+
+user = payload.model
+# => Instance of Intercom::User
+```
+
+Note that models generated from webhook notifications might differ slightly from models directly acquired via the API. If this presents a problem, calling `payload.load` will load the model from the API using the `id` field.
+
 ### Errors
 You do not need to deal with the HTTP response from an API call directly. If there is an unsuccessful response then an error that is a subclass of Intercom:Error will be raised. If desired, you can get at the http_code of an Intercom::Error via it's `http_code` method.
 

data/changes.txt

@@ -1,3 +1,7 @@
+2.2.1
+ - Webhook Notification support
+ - Webhook Subscription support
+
 2.2.0
  - Handle blanks on identity attributes (e.g. email) better.
 

data/lib/intercom.rb

@@ -10,6 +10,8 @@ require "intercom/message"
 require "intercom/admin"
 require "intercom/count"
 require "intercom/request"
+require "intercom/subscription"
+require "intercom/notification"
 require "intercom/utils"
 require "intercom/errors"
 require "json"

data/lib/intercom/collection_proxy.rb

@@ -47,7 +47,11 @@ module Intercom
 
     def deserialize_response_hash(response_hash, block)
       top_level_type = response_hash.delete('type')
-      top_level_entity_key = Utils.entity_key_from_type(top_level_type)
+      if resource_name == 'subscriptions'
+        top_level_entity_key = 'items'
+      else
+        top_level_entity_key = Utils.entity_key_from_type(top_level_type)
+      end
       response_hash[top_level_entity_key].each do |object_json|
         block.call Lib::TypedJsonDeserializer.new(object_json).deserialize
       end

data/lib/intercom/notification.rb

@@ -0,0 +1,20 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Notification
+    include Traits::ApiResource
+
+    def model
+      data.item
+    end
+
+    def model_type
+      model.class
+    end
+
+    def load
+      model.load
+    end
+
+  end
+end

data/lib/intercom/subscription.rb

@@ -0,0 +1,15 @@
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/save'
+require 'intercom/api_operations/delete'
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Subscription
+    include ApiOperations::List
+    include ApiOperations::Find
+    include ApiOperations::Save
+    include ApiOperations::Delete
+    include Traits::ApiResource
+  end
+end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/spec/spec_helper.rb

@@ -132,6 +132,163 @@ def test_tag
   }
 end
 
+def test_user_notification
+  {
+    "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" => "joe@example.com",
+        "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_conversation_notification
+  {
+     "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"=>"bill@bill.bill"},
+               "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"=>"bill@bill.bill"},
+                    "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 test_subscription
+  {"request"=>
+       {"type"=>"notification_subscription",
+        "id"=>"nsub_123456789",
+        "created_at"=>1410368642,
+        "updated_at"=>1410368642,
+        "service_type"=>"web",
+        "app_id"=>"3qmk5gyg",
+        "url"=>
+            "http://example.com",
+        "self"=>
+            "https://api.intercom.io/subscriptions/nsub_123456789",
+        "topics"=>["user.created", "conversation.user.replied", "conversation.admin.replied"],
+        "active"=>true,
+        "metadata"=>{},
+        "hub_secret"=>nil,
+        "mode"=>"point",
+        "links"=>
+            {"sent"=>
+                 "https://api.intercom.io/subscriptions/nsub_123456789/sent",
+             "retry"=>
+                 "https://api.intercom.io/subscriptions/nsub_123456789/retry",
+             "errors"=>
+                 "https://api.intercom.io/subscriptions/nsub_123456789/errors"},
+        "notes"=>[]}}
+end
+
 def error_on_modify_frozen
   RUBY_VERSION =~ /1.8/ ? TypeError : RuntimeError
 end

data/spec/unit/intercom/notification_spec.rb

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

data/spec/unit/intercom/subscription_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe "Intercom::Subscription" do
+  it "gets a subscription" do
+    Intercom.expects(:get).with("/subscriptions/nsub_123456789", {}).returns(test_subscription)
+    subscription = Intercom::Subscription.find(:id => "nsub_123456789")
+    subscription.request.topics[0].must_equal "user.created"
+    subscription.request.topics[1].must_equal "conversation.user.replied"
+  end
+
+  it "creates a subscription" do
+    Intercom.expects(:post).with("/subscriptions", {'url' => "http://example.com", 'topics' => ["user.created"]}).returns(test_subscription)
+    subscription = Intercom::Subscription.create(:url => "http://example.com", :topics => ["user.created"])
+    subscription.request.topics[0].must_equal "user.created"
+    subscription.request.url.must_equal "http://example.com"
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-04 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -141,8 +141,10 @@ files:
 - lib/intercom/lib/typed_json_deserializer.rb
 - lib/intercom/message.rb
 - lib/intercom/note.rb
+- lib/intercom/notification.rb
 - lib/intercom/request.rb
 - lib/intercom/segment.rb
+- lib/intercom/subscription.rb
 - lib/intercom/tag.rb
 - lib/intercom/traits/api_resource.rb
 - lib/intercom/traits/dirty_tracking.rb
@@ -157,6 +159,8 @@ files:
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/note_spec.rb
+- spec/unit/intercom/notification_spec.rb
+- spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
@@ -192,6 +196,8 @@ test_files:
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/note_spec.rb
+- spec/unit/intercom/notification_spec.rb
+- spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb