intercom 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9111e19a82bb7d9ffba1c0677d77c629266ac7c
-  data.tar.gz: 02a3c89982a481e6b2b3410d4cbec80630556daa
+  metadata.gz: 1105afd003920f148d703151927542f8174aae57
+  data.tar.gz: 13cd1a35776e6b353ed85884157992b9f7750a77
 SHA512:
-  metadata.gz: 0695acd0c2f7227c16a2253f90e18b8be2398d2032175ac69c5067e6d6bbfe13d64a5ab85d0c0b1aa734f7aa0bf6acbadc202649c715370a07dd3c405a1d6f73
-  data.tar.gz: 0b6a49e6137e4794199175cdc9b8dca25b71be86b5413146c1cf379a3a324ce6a92a9ffdd1e1ea67e5384c1e13e326e54504dd055ccfe3da2dd0691c1d1b6022
+  metadata.gz: 37bf3114fcb13dda58f34ce37623ab33adee640ded7d45c1aeb4e452ee4ebe7492fcc3f76ce48d53bfddd559795e1dc83e76e6e0a48eef696b3590a866729769
+  data.tar.gz: 8bc6eb1b8e44ca74e095ea3f74ea848bba15cafadf1421802921b3f43f599d31154d2f5fc124824eb72a703ff8a70a239a0e31377be7f0d310c7d2bcfa952235

data/README.md

@@ -19,7 +19,7 @@ Additionally, the new version uses Ruby 2.
 
 Using bundler:
 
-    gem 'intercom', "~> 2.2.1"
+    gem 'intercom', "~> 2.2.2"
 
 ## Basic Usage
 
@@ -44,7 +44,7 @@ Resources this API supports:
     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
@@ -113,7 +113,7 @@ Intercom::Tag.find_all_for_user(:user_id => '3')
 # Tag companies
 tag = Intercom::Tag.tag_companies('red', ["42ea2f1b93891f6a99000427"])
 # Untag companies
-Intercom::Tag.untag_users('blue', ["42ea2f1b93891f6a99000427"])
+Intercom::Tag.untag_companies('blue', ["42ea2f1b93891f6a99000427"])
 # Iterate over all tags for company
 Intercom::Tag.find_all_for_company(:id => '43357e2c3c77661e25000026')
 Intercom::Tag.find_all_for_company(:company_id => '6')
@@ -205,9 +205,10 @@ Intercom::Segment.count
 Intercom::Tag.count
 ```
 
-#### Full loading of and embedded entity
+#### Full loading of an embedded entity
 ```ruby
-# Given a converation with a partial user, load the full user. This can be done for any entity
+# Given a conversation with a partial user, load the full user. This can be
+# done for any entity
 conversation.user.load
 ```
 
@@ -223,7 +224,7 @@ Intercom::Message.create({
     :id   => "1234"
   },
   :to => {
-    :type => :user,
+    :type => "user",
     :id   => "5678"
   }
 })
@@ -271,16 +272,16 @@ Metadata Objects support a few simple types that Intercom can present on your be
 
 ```ruby
 Intercom::Event.create(:event_name => "placed-order", :email => current_user.email,
-  :created_at => 1403001013
+  :created_at => 1403001013,
   :metadata => {
-    :order_date => Time.now.to_i,  
+    :order_date => Time.now.to_i,
     :stripe_invoice => 'inv_3434343434',
     :order_number => {
       :value => '3434-3434',
       :url => 'https://example.org/orders/3434-3434'
     },
     price: {
-      :currency => 'usd',  
+      :currency => 'usd',
       :amount => 2999
     }
   }
@@ -336,6 +337,7 @@ else rescue the more specific error subclass.
 Intercom::AuthenticationError
 Intercom::ServerError
 Intercom::ServiceUnavailableError
+Intercom::ServiceConnectionError
 Intercom::ResourceNotFound
 Intercom::BadRequestError
 Intercom::RateLimitExceeded

data/changes.txt

@@ -1,3 +1,9 @@
+2.2.2
+ - Improve spec strings (thanks to @jkeyes)
+ - Improve README readability (thanks to @jkeyes)
+ - Raise Intercom::ServiceConnectionError on connection failure
+ - Fix creation of Intercom::Message with stringy keys in to/from fields
+
 2.2.1
  - Webhook Notification support
  - Webhook Subscription support

data/lib/intercom/errors.rb

@@ -20,9 +20,12 @@ module Intercom
   # Raised when we have bad gateway errors.
   class BadGatewayError < IntercomError; end
 
-  # Raised when we reach socket connect timeout
+  # Raised when we experience a socket read timeout
   class ServiceUnavailableError < IntercomError; end
 
+  # Raised when we experience socket connect timeout
+  class ServiceConnectionError < IntercomError; end
+
   # Raised when requesting resources on behalf of a user that doesn't exist in your application on Intercom.
   class ResourceNotFound < IntercomError; end
 

data/lib/intercom/request.rb

@@ -57,18 +57,24 @@ module Intercom
     def execute(target_base_url=nil)
       base_uri = URI.parse(target_base_url)
       set_common_headers(net_http_method, base_uri)
-      client(base_uri).start do |http|
-        response = http.request(net_http_method)
-        decoded = decode(response['content-encoding'], response.body)
-        unless decoded.strip.empty?
-          parsed_body = JSON.parse(decoded)
-          raise_application_errors_on_failure(parsed_body, response.code.to_i) if parsed_body['type'] == 'error.list'
+      begin
+        client(base_uri).start do |http|
+          begin
+            response = http.request(net_http_method)
+            decoded = decode(response['content-encoding'], response.body)
+            unless decoded.strip.empty?
+              parsed_body = JSON.parse(decoded)
+              raise_application_errors_on_failure(parsed_body, response.code.to_i) if parsed_body['type'] == 'error.list'
+            end
+            raise_errors_on_failure(response)
+            parsed_body
+          rescue Timeout::Error
+            raise Intercom::ServiceUnavailableError.new('Service Unavailable [request timed out]')
+          end
         end
-        raise_errors_on_failure(response)
-        parsed_body
+      rescue Timeout::Error
+        raise Intercom::ServiceConnectionError.new('Failed to connect to service [connection attempt timed out]')
       end
-    rescue Timeout::Error
-      raise Intercom::ServiceUnavailableError.new('Service Unavailable')
     end
 
     def decode(content_encoding, body)

data/lib/intercom/traits/api_resource.rb

@@ -67,7 +67,7 @@ module Intercom
       end
 
       def set_property(attribute, value)
-        if typed_value?(value) && !custom_attribute_field?(attribute)
+        if typed_value?(value) && !custom_attribute_field?(attribute) && !message_from_field?(attribute, value) && !message_to_field?(attribute, value)
           value_to_set = Intercom::Lib::TypedJsonDeserializer.new(value).deserialize
         elsif flat_store_attribute?(attribute)
           value_to_set = Intercom::Lib::FlatStore.new(value)
@@ -80,6 +80,14 @@ module Intercom
       def custom_attribute_field?(attribute)
         attribute == 'custom_attributes'
       end
+      
+      def message_from_field?(attribute, value)
+        attribute.to_s == 'from' && value.is_a?(Hash) && value['type']
+      end
+      
+      def message_to_field?(attribute, value)
+        attribute.to_s == 'to' && value.is_a?(Hash) && value['type']
+      end
 
       def typed_value?(value)
         value.is_a? Hash and !!value['type']

data/lib/intercom/version.rb

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

data/spec/unit/intercom/message_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "Intercom::Message" do
+
+  let (:user) {Intercom::User.new("email" => "jim@example.com", :user_id => "12345", :created_at => Time.now, :name => "Jim Bob")}
+
+  it 'creates an user message with symbol keys' do
+    Intercom.expects(:post).with('/messages', {'from' => { :type => 'user', :email => 'jim@example.com'}, 'body' => 'halp'}).returns(:status => 200)
+    Intercom::Message.create(:from => { :type => "user", :email => "jim@example.com" }, :body => "halp")
+  end
+  
+  it "creates an user message with string keys" do
+    Intercom.expects(:post).with('/messages', {'from' => { 'type' => 'user', 'email' => 'jim@example.com'}, 'body' => 'halp'}).returns(:status => 200)
+    Intercom::Message.create('from' => { 'type' => "user", 'email' => "jim@example.com" }, 'body' => "halp")
+  end
+  
+  it "creates a admin message" do
+    Intercom.expects(:post).with('/messages', {'from' => { 'type' => "admin", 'id' => "1234" }, 'to' => { 'type' => 'user', 'id' => '5678' }, 'body' => 'halp', 'message_type' => 'inapp'}).returns(:status => 200)
+    Intercom::Message.create('from' => { 'type' => "admin", 'id' => "1234" }, :to => { 'type' => 'user', 'id' => '5678' }, 'body' => "halp", 'message_type' => 'inapp')
+  end
+end

data/spec/unit/intercom/notification_spec.rb

@@ -12,7 +12,7 @@ describe "Intercom::Notification" do
     payload.model_type.must_equal Intercom::User
   end
 
-  it "returns correct notification topic" do
+  it "returns correct User notification topic" do
     payload = Intercom::Notification.new(test_user_notification)
     payload.topic.must_equal "user.created"
   end
@@ -27,12 +27,12 @@ describe "Intercom::Notification" do
     payload.model.must_be_instance_of Intercom::Conversation
   end
 
-  it "returns correct model type for User" do
+  it "returns correct model type for Conversation" do
     payload = Intercom::Notification.new(test_conversation_notification)
     payload.model_type.must_equal Intercom::Conversation
   end
 
-  it "returns correct notification topic" do
+  it "returns correct Conversation notification topic" do
     payload = Intercom::Notification.new(test_conversation_notification)
     payload.topic.must_equal "conversation.user.created"
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -158,6 +158,7 @@ files:
 - spec/unit/intercom/collection_proxy_spec.rb
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
+- spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/notification_spec.rb
 - spec/unit/intercom/subscription_spec.rb
@@ -195,6 +196,7 @@ test_files:
 - spec/unit/intercom/collection_proxy_spec.rb
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
+- spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/notification_spec.rb
 - spec/unit/intercom/subscription_spec.rb