intercom 0.1.17 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2542e949c8790fdda2853591a4ff6ba813d012d2
-  data.tar.gz: 4a56e18ab1676b9101b2e00441a66e7e1079c544
+  metadata.gz: e0f05d2c37716b065556503a2b8f4db41bb80431
+  data.tar.gz: f0ab697881c32c597a7ab7a176936f3f9b0e327d
 SHA512:
-  metadata.gz: 0569d66b5412fb386aa66f79f5cc72284a78853b5a111cf3b704246cf153f2acfb024d659f519b5723307472984a95c6bd949a19e727f4cfd12cbe96600d2c8d
-  data.tar.gz: 98eed931b9e8ef92484af33fb5b8d315126f4f0d1c08b52a2d6b25d8209aa422998729b4ab112accd9fab8ed8be6c95db092b6c42fac42557044e1cff7f21352
+  metadata.gz: fe1d59e7f7aa6b898803b3a49649524d8de5fdb718996d9b86af0b70d98f29de67ecc988e47ae501ae1aeb95024892669757e6c06685a9f8150b3496b9a9379e
+  data.tar.gz: e0490f3a22078191de4d259c558181cc12871e183665b481aabc90600ceb5b5747e706bc0399ee62a23152bdde804d4aec98710583402645a5c0f2ef02df3024

data/.gitignore

@@ -8,3 +8,4 @@ pkg/*
 .yardoc
 spike.rb
 html
+.idea

data/README.md

@@ -2,7 +2,7 @@
 
 Ruby bindings for the Intercom API (https://api.intercom.io).
 
-[API Documentation](https://api.intercom.io)
+[API Documentation](https://api.intercom.io/docs)
 
 [Gem Documentation](http://rubydoc.info/github/intercom/intercom-ruby/master/frames)
 
@@ -20,8 +20,10 @@ Using bundler:
 
 ### Configure your access credentials
 
-    Intercom.app_id = "my_app_iddd"
-    Intercom.api_key = "my-super-crazy-api-key"
+```ruby
+Intercom.app_id = "my_app_id"
+Intercom.api_key = "my-super-crazy-api-key"
+```
 
 ### Resources
 
@@ -35,44 +37,55 @@ The API supports:
 ### Examples
 
 #### Users
-    user = Intercom::User.find_by_email("bob@example.com")
-    user.custom_data["average_monthly_spend"] = 1234.56
-    user.save
-    user = Intercom::User.find_by_user_id("bob@example.com")
-    user = Intercom::User.create(:email => "bob@example.com", :name => "Bob Smith")
-    user = Intercom::User.new(params)
-    user.save
-    Intercom::User.all.count
-    Intercom::User.all.each {|user| puts %Q(#{user.email} - #{user.custom_data["average_monthly_spend"]}) }
-    Intercom::User.all.map {|user| user.email }
+
+```ruby
+user = Intercom::User.find_by_email("bob@example.com")
+user.custom_data["average_monthly_spend"] = 1234.56
+user.save
+user = Intercom::User.find_by_user_id("bob@example.com")
+user = Intercom::User.create(:email => "bob@example.com", :name => "Bob Smith")
+user = Intercom::User.new(params)
+user.save
+Intercom::User.all.count
+Intercom::User.all.each {|user| puts %Q(#{user.email} - #{user.custom_data["average_monthly_spend"]}) }
+Intercom::User.all.map {|user| user.email }
+```
 
 #### Companies
-    user = Intercom::User.find_by_email("bob@example.com")
-    user.company = {:id => 6, :name => "Intercom"}
-    user.companies = [{:id => 6, :name => "Intercom"}, {:id => 9, :name => "Test Company"}]
+```ruby
+user = Intercom::User.find_by_email("bob@example.com")
+user.company = {:id => 6, :name => "Intercom"}
+user.companies = [{:id => 6, :name => "Intercom"}, {:id => 9, :name => "Test Company"}]
+```
 
 You can also pass custom data within a company:
 
-    user.company = {:id => 6, :name => "Intercom", :referral_source => "Google"}
+```ruby
+user.company = {:id => 6, :name => "Intercom", :referral_source => "Google"}
+```
 
 #### Message Threads
-
-    Intercom::MessageThread.create(:email => "bob@example.com", :body => "Example message from bob@example.com to your application on Intercom.")
-    Intercom::MessageThread.find(:email => "bob@example.com", :thread_id => 123)
-    Intercom::MessageThread.find_all(:email => "bob@example.com")
-    Intercom::MessageThread.mark_as_read(:email => "bob@example.com", :thread_id => 123)
+```ruby
+Intercom::MessageThread.create(:email => "bob@example.com", :body => "Example message from bob@example.com to your application on Intercom.")
+Intercom::MessageThread.find(:email => "bob@example.com", :thread_id => 123)
+Intercom::MessageThread.find_all(:email => "bob@example.com")
+Intercom::MessageThread.mark_as_read(:email => "bob@example.com", :thread_id => 123)
+```
 
 #### Impressions
-
-    Intercom::Impression.create(:email => "bob@example.com", :location => "/path/in/my/app", :user_ip => "1.2.3.4", :user_agent => "my-savage-iphone-app-0.1"
+```ruby
+Intercom::Impression.create(:email => "bob@example.com", :location => "/path/in/my/app", :user_ip => "1.2.3.4", :user_agent => "my-savage-iphone-app-0.1"
+```
 
 #### Notes
-
-    Intercom::Note.create(:email => "bob@example.com", :body => "This is the text of the note")
+```ruby
+Intercom::Note.create(:email => "bob@example.com", :body => "This is the text of the note")
+```
 
 ### Errors
-
-    Intercom::AuthenticationError
-    Intercom::ServerError
-    Intercom::ServiceUnavailableError
-    Intercom::ResourceNotFound
+```ruby
+Intercom::AuthenticationError
+Intercom::ServerError
+Intercom::ServiceUnavailableError
+Intercom::ResourceNotFound
+```

data/changes.txt

@@ -1,3 +1,9 @@
+0.1.19
+- Update DELETE request to fix issue.
+
+0.1.18
+- Increase connection and read timeouts
+
 0.1.16
 - Add BadGatewayError to properly report that sort of error.
 

data/intercom.gemspec

@@ -23,4 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'mocha'
   spec.add_development_dependency "fakeweb", ["~> 1.3"]
+
+  spec.add_dependency 'json'
 end

data/lib/intercom/request.rb

@@ -25,7 +25,7 @@ module Intercom
     end
 
     def self.delete(path, params)
-      new(path, Net::HTTP::Delete.new(append_query_string_to_url(path, params), default_headers))
+      new(path, method_with_body(Net::HTTP::Delete, path, params))
     end
 
     def self.put(path, form_data)
@@ -50,8 +50,8 @@ module Intercom
         net.verify_mode = OpenSSL::SSL::VERIFY_PEER
         net.ca_file = File.join(File.dirname(__FILE__), '../data/cacert.pem')
       end
-      net.read_timeout = 30
-      net.open_timeout = 3
+      net.read_timeout = 90
+      net.open_timeout = 30
       net
     end
 
@@ -93,4 +93,4 @@ module Intercom
       url + "?#{query_string}"
     end
   end
-end
+end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "0.1.17"
+  VERSION = "0.1.19"
 end

data/spec/integration/fixtures/v1-user.json

@@ -0,0 +1,45 @@
+{
+  "intercom_id": "528f291df8d4a41d8c000088",
+  "email": "somebody@example.com",
+  "user_id": "123",
+  "name": "Somebody",
+  "created_at": 1270000000,
+  "last_impression_at": 1300000000,
+  "custom_data": {
+    "app_name": "Genesis",
+    "monthly_spend": 155.5,
+    "team_mates": 7
+  },
+  "social_profiles": [
+    {
+      "type": "twitter",
+      "url": "http://twitter.com/abc",
+      "username": "abc"
+    },
+    {
+      "type": "facebook",
+      "url": "http://facebook.com/vanity",
+      "username": "vanity",
+      "id": "13241141441141413"
+    }
+  ],
+  "location_data": {
+    "city_name": "Santiago",
+    "continent_code": "SA",
+    "country_name": "Chile",
+    "latitude": -33.44999999999999,
+    "longitude": -70.6667,
+    "postal_code": "",
+    "region_name": "12",
+    "timezone": "Chile/Continental",
+    "country_code": "CHL"
+  },
+  "session_count": 0,
+  "last_seen_ip": "127.0.0.1",
+  "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+  "unsubscribed_from_emails": false,
+  "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
+  "company_ids": [
+
+  ]
+}

data/spec/integration/fixtures/v1-users-impression.json

@@ -0,0 +1,3 @@
+{
+  "unread_messages": 1
+}

data/spec/integration/fixtures/v1-users-message_thread.json

@@ -0,0 +1,44 @@
+{
+  "created_at": 1385114541,
+  "updated_at": 1385028141,
+  "read": true,
+  "created_by_user": true,
+  "thread_id": 5591,
+  "message_id": 5591,
+  "message_type": "conversation",
+  "interrupt": true,
+  "messages": [
+    {
+      "created_at": 1385114541,
+      "url": null,
+      "html": "<p>Hey Intercom, What is up?</p>\n\n<p></p>",
+      "subject": "",
+      "from": {
+        "email": "bob@example.com",
+        "user_id": "456",
+        "name": "Bob",
+        "is_admin": false,
+        "avatar": {
+        }
+      }
+    },
+    {
+      "created_at": 1384941741,
+      "url": null,
+      "html": "<p>Not much, you?\n</p>"
+    },
+    {
+      "created_at": 1385028141,
+      "url": null,
+      "html": "<p>Not much either :(</p>\n\n<p></p>",
+      "from": {
+        "email": "bob@example.com",
+        "user_id": "123",
+        "name": "Bob",
+        "is_admin": false,
+        "avatar": {
+        }
+      }
+    }
+  ]
+}

data/spec/integration/fixtures/v1-users-message_threads.json

@@ -0,0 +1,46 @@
+[
+  {
+    "created_at": 1385114400,
+    "updated_at": 1385028000,
+    "read": true,
+    "created_by_user": true,
+    "thread_id": 5591,
+    "message_id": 5591,
+    "message_type": "conversation",
+    "interrupt": true,
+    "messages": [
+      {
+        "created_at": 1385114400,
+        "url": null,
+        "html": "<p>Hey Intercom, What is up?</p>\n\n<p></p>",
+        "subject": "",
+        "from": {
+          "email": "somebody@example.com",
+          "user_id": "123",
+          "name": "Somebody",
+          "is_admin": false,
+          "avatar": {
+          }
+        }
+      },
+      {
+        "created_at": 1384941600,
+        "url": null,
+        "html": "<p>Not much, you?\n</p>"
+      },
+      {
+        "created_at": 1385028000,
+        "url": null,
+        "html": "<p>Not much either :(</p>\n\n<p></p>",
+        "from": {
+          "email": "somebody@example.com",
+          "user_id": "123",
+          "name": "Somebody",
+          "is_admin": false,
+          "avatar": {
+          }
+        }
+      }
+    ]
+  }
+]

data/spec/integration/fixtures/v1-users-note.json

@@ -0,0 +1,49 @@
+{
+  "html": "<p>This is a note</p>",
+  "created_at": null,
+  "user": {
+    "intercom_id": "528f2cbb1b393a6e470000e6",
+    "email": "somebody@example.com",
+    "user_id": "123",
+    "name": "Somebody",
+    "created_at": 1270000000,
+    "last_impression_at": 1300000000,
+    "custom_data": {
+      "app_name": "Genesis",
+      "monthly_spend": 155.5,
+      "team_mates": 7
+    },
+    "social_profiles": [
+      {
+        "type": "twitter",
+        "url": "http://twitter.com/abc",
+        "username": "abc"
+      },
+      {
+        "type": "facebook",
+        "url": "http://facebook.com/vanity",
+        "username": "vanity",
+        "id": "13241141441141413"
+      }
+    ],
+    "location_data": {
+      "city_name": "Santiago",
+      "continent_code": "SA",
+      "country_name": "Chile",
+      "latitude": -33.44999999999999,
+      "longitude": -70.6667,
+      "postal_code": "",
+      "region_name": "12",
+      "timezone": "Chile/Continental",
+      "country_code": "CHL"
+    },
+    "session_count": 0,
+    "last_seen_ip": "127.0.0.1",
+    "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+    "unsubscribed_from_emails": false,
+    "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
+    "company_ids": [
+
+    ]
+  }
+}

data/spec/integration/fixtures/v1-users.json

@@ -0,0 +1,144 @@
+{
+  "users": [
+    {
+      "intercom_id": "528f27c330972d783600006d",
+      "email": "first.user@example.com",
+      "user_id": "123",
+      "name": "First User",
+      "created_at": 1270000000,
+      "last_impression_at": 1300000000,
+      "custom_data": {
+        "app_name": "Genesis",
+        "monthly_spend": 155.5,
+        "team_mates": 7
+      },
+      "social_profiles": [
+        {
+          "type": "twitter",
+          "url": "http://twitter.com/abc",
+          "username": "abc"
+        },
+        {
+          "type": "facebook",
+          "url": "http://facebook.com/vanity",
+          "username": "vanity",
+          "id": "13241141441141413"
+        }
+      ],
+      "location_data": {
+        "city_name": "Santiago",
+        "continent_code": "SA",
+        "country_name": "Chile",
+        "latitude": -33.44999999999999,
+        "longitude": -70.6667,
+        "postal_code": "",
+        "region_name": "12",
+        "timezone": "Chile/Continental",
+        "country_code": "CHL"
+      },
+      "session_count": 0,
+      "last_seen_ip": "127.0.0.1",
+      "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+      "unsubscribed_from_emails": false,
+      "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
+      "company_ids": [
+
+      ]
+    },
+    {
+      "intercom_id": "528f27c330972d7836000070",
+      "email": "second.user@example.com",
+      "user_id": "123",
+      "name": "Second User",
+      "created_at": 1270000000,
+      "last_impression_at": 1300000000,
+      "custom_data": {
+        "app_name": "Genesis",
+        "monthly_spend": 155.5,
+        "team_mates": 7
+      },
+      "social_profiles": [
+        {
+          "type": "twitter",
+          "url": "http://twitter.com/abc",
+          "username": "abc"
+        },
+        {
+          "type": "facebook",
+          "url": "http://facebook.com/vanity",
+          "username": "vanity",
+          "id": "13241141441141413"
+        }
+      ],
+      "location_data": {
+        "city_name": "Santiago",
+        "continent_code": "SA",
+        "country_name": "Chile",
+        "latitude": -33.44999999999999,
+        "longitude": -70.6667,
+        "postal_code": "",
+        "region_name": "12",
+        "timezone": "Chile/Continental",
+        "country_code": "CHL"
+      },
+      "session_count": 0,
+      "last_seen_ip": "127.0.0.1",
+      "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+      "unsubscribed_from_emails": false,
+      "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
+      "company_ids": [
+
+      ]
+    },
+    {
+      "intercom_id": "528f27c330972d7836000073",
+      "email": "third.user@example.com",
+      "user_id": "123",
+      "name": "Third User",
+      "created_at": 1270000000,
+      "last_impression_at": 1300000000,
+      "custom_data": {
+        "app_name": "Genesis",
+        "monthly_spend": 155.5,
+        "team_mates": 7
+      },
+      "social_profiles": [
+        {
+          "type": "twitter",
+          "url": "http://twitter.com/abc",
+          "username": "abc"
+        },
+        {
+          "type": "facebook",
+          "url": "http://facebook.com/vanity",
+          "username": "vanity",
+          "id": "13241141441141413"
+        }
+      ],
+      "location_data": {
+        "city_name": "Santiago",
+        "continent_code": "SA",
+        "country_name": "Chile",
+        "latitude": -33.44999999999999,
+        "longitude": -70.6667,
+        "postal_code": "",
+        "region_name": "12",
+        "timezone": "Chile/Continental",
+        "country_code": "CHL"
+      },
+      "session_count": 0,
+      "last_seen_ip": "127.0.0.1",
+      "last_seen_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.56 Safari/535.11",
+      "unsubscribed_from_emails": false,
+      "avatar_url": "https://graph.facebook.com/13241141441141413/picture?width=24&height=24",
+      "company_ids": [
+
+      ]
+    }
+  ],
+  "total_count": 3,
+  "page": 1,
+  "next_page": null,
+  "previous_page": null,
+  "total_pages": 1
+}

data/spec/integration/intercom_api_integration_spec.rb

@@ -3,35 +3,46 @@ require 'fakeweb'
 
 describe "api.intercom.io dummy data requests" do
   before :each do
-    Intercom.app_id = "dummy-app-id"
-    Intercom.api_key = "dummy-secret-key"
-    Intercom.endpoint = "https://api.intercom.io"
+    Intercom.app_id = "some-app-id"
+    Intercom.api_key = "some-secret-key"
+    Intercom.endpoint = "https://intercom.example.com"
+    FakeWeb.clean_registry
+  end
+
+  def fixture(name)
+    File.read(File.expand_path("../fixtures/#{name}.json", __FILE__))
   end
 
   it "should get all user" do
+    FakeWeb.register_uri(:get, %r|v1/users|, :body => fixture('v1-users'))
     Intercom::User.all.count.must_be :>, 0
   end
 
   it "should get a user" do
+    FakeWeb.register_uri(:get, %r(v1/users\?email=), :body => fixture('v1-user'))
     user = Intercom::User.find(:email => "somebody@example.com")
     user.name.must_equal "Somebody"
   end
 
   it "not found... " do
+    FakeWeb.register_uri(:get, %r(v1/users\?email=not-found), :status => [404, "Not Found"])
     proc { Intercom::User.find(:email => "not-found@example.com") }.must_raise Intercom::ResourceNotFound
   end
 
   it "server error" do
+    FakeWeb.register_uri(:get, %r(v1/users\?email=server-error), :status => [500, "Oh Noes"])
     proc { Intercom::User.find(:email => "server-error@example.com") }.must_raise Intercom::ServerError
   end
 
   it "authentication failure with bad api key" do
+    FakeWeb.register_uri(:get, %r(v1/users\?email=authentication-error), :status => [401, "Authentication Error"])
     Intercom.app_id = "bad-app-id"
     Intercom.api_key = "bad-secret-key"
-    proc { Intercom::User.find(:email => "not-found@example.com") }.must_raise Intercom::AuthenticationError
+    proc { Intercom::User.find(:email => "authentication-error@example.com") }.must_raise Intercom::AuthenticationError
   end
 
   it "should find_all messages for a user" do
+    FakeWeb.register_uri(:get, %r(v1/users/message_threads\?email=somebody), :body => fixture('v1-users-message_threads'))
     message_thread = Intercom::MessageThread.find_all(:email => "somebody@example.com").first
     %w(thread_id read messages created_at updated_at created_by_user).each do |expected|
       message_thread.send(expected).wont_be_nil
@@ -39,23 +50,30 @@ describe "api.intercom.io dummy data requests" do
   end
 
   it "should mark message_thread as read" do
+    FakeWeb.register_uri(:get, %r(v1/users/message_threads\?email=somebody), :body => fixture('v1-users-message_threads'))
+    FakeWeb.register_uri(:put, %r(v1/users/message_threads), :body => fixture('v1-users-message_thread'))
     message_thread = Intercom::MessageThread.find_all(:email => "somebody@example.com").first
     message_thread.mark_as_read!
   end
 
   it "should create some impression" do
+    FakeWeb.register_uri(:post, %r(v1/users/impressions), :body => fixture('v1-users-impression'))
     impression = Intercom::Impression.create(:email => 'somebody@example.com')
     impression.unread_messages.must_be :>, 0
     impression.email.must_equal 'somebody@example.com'
   end
 
   it "should create some notes" do
+    FakeWeb.register_uri(:post, %r(v1/users/notes), :body => fixture('v1-users-note'))
     note = Intercom::Note.create(:body => "This is a note", :email => "somebody@example.com")
     note.html.must_equal "<p>This is a note</p>"
     note.user.email.must_equal "somebody@example.com"
   end
 
+
   it "should failover to good endpoint when first one is un-reachable" do
+    FakeWeb.allow_net_connect = %r(127.0.0.7)
+    FakeWeb.register_uri(:get, %r(api.intercom.io/v1/users), :body => fixture('v1-user'))
     Intercom.endpoints = unshuffleable_array(["http://127.0.0.7", "https://api.intercom.io"])
     user = Intercom::User.find(:email => "somebody@example.com")
     user.name.must_equal "Somebody"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 0.1.17
+  version: 0.1.19
 platform: ruby
 authors:
 - Ben McRedmond
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-18 00:00:00.000000000 Z
+date: 2014-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -70,6 +70,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'Intercom (https://www.intercom.io) is a customer relationship management
   and messaging tool for web app owners. This library wraps the api provided by Intercom.
   See http://docs.intercom.io/api for more details. '
@@ -107,6 +121,12 @@ files:
 - lib/intercom/user_collection_proxy.rb
 - lib/intercom/user_resource.rb
 - lib/intercom/version.rb
+- spec/integration/fixtures/v1-user.json
+- spec/integration/fixtures/v1-users-impression.json
+- spec/integration/fixtures/v1-users-message_thread.json
+- spec/integration/fixtures/v1-users-message_threads.json
+- spec/integration/fixtures/v1-users-note.json
+- spec/integration/fixtures/v1-users.json
 - spec/integration/intercom_api_integration_spec.rb
 - spec/spec_helper.rb
 - spec/unit/intercom/flat_store_spec.rb
@@ -143,6 +163,12 @@ signing_key:
 specification_version: 4
 summary: Ruby bindings for the Intercom API
 test_files:
+- spec/integration/fixtures/v1-user.json
+- spec/integration/fixtures/v1-users-impression.json
+- spec/integration/fixtures/v1-users-message_thread.json
+- spec/integration/fixtures/v1-users-message_threads.json
+- spec/integration/fixtures/v1-users-note.json
+- spec/integration/fixtures/v1-users.json
 - spec/integration/intercom_api_integration_spec.rb
 - spec/spec_helper.rb
 - spec/unit/intercom/flat_store_spec.rb