intercom 2.5.4 → 3.0.0b1

data/lib/intercom/subscription.rb

@@ -1,15 +1,7 @@
-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/tag.rb

@@ -1,23 +1,7 @@
-require 'intercom/api_operations/count'
-require 'intercom/api_operations/save'
-require 'intercom/api_operations/list'
-require 'intercom/api_operations/find'
-require 'intercom/api_operations/find_all'
 require 'intercom/traits/api_resource'
-require 'intercom/traits/generic_handler_binding'
-require 'intercom/generic_handlers/tag'
-require 'intercom/generic_handlers/tag_find_all'
 
 module Intercom
   class Tag
-    include ApiOperations::Count
-    include ApiOperations::Save
-    include ApiOperations::List
-    include ApiOperations::Find
-    include ApiOperations::FindAll
     include Traits::ApiResource
-    include Traits::GenericHandlerBinding
-    include GenericHandlers::Tag
-    include GenericHandlers::TagFindAll
   end
 end

data/lib/intercom/user.rb

@@ -1,24 +1,8 @@
-require 'intercom/api_operations/count'
-require 'intercom/api_operations/list'
-require 'intercom/api_operations/load'
-require 'intercom/api_operations/find'
-require 'intercom/api_operations/find_all'
-require 'intercom/api_operations/save'
-require 'intercom/api_operations/delete'
-require 'intercom/extended_api_operations/tags'
 require 'intercom/traits/incrementable_attributes'
 require 'intercom/traits/api_resource'
 
 module Intercom
   class User
-    include ApiOperations::Count
-    include ApiOperations::List
-    include ApiOperations::Load
-    include ApiOperations::Find
-    include ApiOperations::FindAll
-    include ApiOperations::Save
-    include ApiOperations::Delete
-    include ExtendedApiOperations::Tags
     include Traits::IncrementableAttributes
     include Traits::ApiResource
 

data/lib/intercom/utils.rb

@@ -45,7 +45,6 @@ module Intercom
       end
 
       def define_lightweight_class(class_name)
-        #File.open('./intercom_ruby_dynamically_defined_classes.log', 'a') {|f| f.puts("Dynamically defining the class Intercom::#{class_name}") } #HACK
         new_class_definition = Class.new(Object) do
           include Traits::ApiResource
         end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "2.5.4"
+  VERSION = "3.0.0b1"
 end

data/spec/spec_helper.rb

@@ -57,6 +57,45 @@ def test_user(email="bob@example.com")
   }
 end
 
+def test_admin_list
+  {
+    "type" => "admin.list",
+    "admins" => [
+      {
+        "type" => "admin",
+        "id" => "1234",
+        "name" => "Hoban Washburne",
+        "email" => "wash@serenity.io"
+      }
+    ]
+  }
+end
+
+def test_company
+  {
+    "type" => "company",
+    "id" => "531ee472cce572a6ec000006",
+    "name" => "Blue Sun",
+    "plan" => {
+      "type" =>"plan",
+      "id" =>"1",
+      "name" =>"Paid"
+    },
+    "company_id" => "6",
+    "remote_created_at" => 1394531169,
+    "created_at" => 1394533506,
+    "updated_at" => 1396874658,
+    "last_request_at" => 1396874658,
+    "monthly_spend" => 49,
+    "session_count" => 26,
+    "user_count" => 10,
+    "custom_attributes" => {
+      "paid_subscriber"  => true,
+      "team_mates" => 0
+    }
+  }
+end
+
 def test_messages
   [test_message, test_message]
 end
@@ -122,6 +161,84 @@ def page_of_users(include_next_link= false)
   }
 end
 
+def test_conversation
+  {
+    "type" => "conversation",
+    "id" => "147",
+    "created_at" => 1400850973,
+    "updated_at" => 1400857494,
+    "conversation_message" => {
+      "type" => "conversation_message",
+      "subject" => "",
+      "body" => "<p>Hi Alice,</p>\n\n<p>We noticed you using our Product, do you have any questions?</p> \n<p>- Jane</p>",
+      "author" => {
+        "type" => "admin",
+        "id" => "25"
+      },
+      "attachments" => [
+        {
+          "name" => "signature",
+          "url" => "http =>//someurl.com/signature.jpg"
+        }
+      ]
+    },
+    "user" => {
+      "type" => "user",
+      "id" => "536e564f316c83104c000020"
+    },
+    "assignee" => {
+      "type" => "admin",
+      "id" => "25"
+    },
+    "open" => true,
+    "read" => true,
+    "conversation_parts" => {
+      "type" => "conversation_part.list",
+      "conversation_parts" => [
+      ]
+    }
+  }
+end
+
+def segment
+  {
+    "type" => "segment",
+    "id" => "5310d8e7598c9a0b24000002",
+    "name" => "Active",
+    "created_at" => 1393613031,
+    "updated_at" => 1393613031
+  }
+end
+
+def segment_list
+  {
+    "type" => "segment.list",
+    "segments" => [
+      {
+        "created_at" => 1393613031,
+        "id" => "5310d8e7598c9a0b24000002",
+        "name" => "Active",
+        "type" => "segment",
+        "updated_at" => 1393613031
+      },
+      {
+        "created_at" => 1393613030,
+        "id" => "5310d8e6598c9a0b24000001",
+        "name" => "New",
+        "type" => "segment",
+        "updated_at" => 1393613030
+      },
+      {
+        "created_at" => 1393613031,
+        "id" => "5310d8e7598c9a0b24000003",
+        "name" => "Slipping Away",
+        "type" => "segment",
+        "updated_at" => 1393613031
+      }
+    ]
+  }
+end
+
 def test_tag
   {
     "id" => "4f73428b5e4dfc000b000112",

data/spec/unit/intercom/admin_spec.rb

@@ -1,9 +1,16 @@
 require "spec_helper"
 
 describe "Intercom::Admin" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   it "returns a CollectionProxy for all without making any requests" do
-    Intercom.expects(:execute_request).never
-    all = Intercom::Admin.all
-    all.must_be_instance_of(Intercom::CollectionProxy)
+    client.expects(:execute_request).never
+    all = client.admins.all
+    all.must_be_instance_of(Intercom::ClientCollectionProxy)
+  end
+
+  it 'gets an admin list' do
+    client.expects(:get).with("/admins", {}).returns(test_admin_list)
+    client.admins.all.each { |a| }
   end
-end
+end

data/spec/unit/intercom/client_collection_proxy_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Intercom::ClientCollectionProxy do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it "stops iterating if no next link" do
+    client.expects(:get).with("/users", {}).returns(page_of_users(false))
+    emails = []
+    client.users.all.each { |user| emails << user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+  it "keeps iterating if next link" do
+    client.expects(:get).with("/users", {}).returns(page_of_users(true))
+    client.expects(:get).with('https://api.intercom.io/users?per_page=50&page=2', {}).returns(page_of_users(false))
+    emails = []
+    client.users.all.each { |user| emails << user.email }
+  end
+
+  it "supports indexed array access" do
+    client.expects(:get).with("/users", {}).returns(page_of_users(false))
+    client.users.all[0].email.must_equal 'user1@example.com'
+  end
+
+  it "supports map" do
+    client.expects(:get).with("/users", {}).returns(page_of_users(false))
+    emails = client.users.all.map { |user| user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+  it "supports querying" do
+    client.expects(:get).with("/users", {:tag_name => 'Taggart J'}).returns(page_of_users(false))
+    client.users.find_all(:tag_name => 'Taggart J').map(&:email).must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+end

data/spec/unit/intercom/client_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module Intercom
+  describe Client do
+    let(:app_id) { 'myappid' }
+    let(:api_key) { 'myapikey' }
+    let(:client) { Client.new(app_id: app_id, api_key: api_key) }
+
+    it 'should set the base url' do
+      client.base_url.must_equal('https://api.intercom.io')
+    end
+
+    it 'should be able to change the base url' do
+      prev = client.options(Intercom::Client.set_base_url('https://mymockintercom.io'))
+      client.base_url.must_equal('https://mymockintercom.io')
+      client.options(prev)
+      client.base_url.must_equal('https://api.intercom.io')
+    end
+
+  end
+end

data/spec/unit/intercom/company_spec.rb

@@ -1,23 +1,36 @@
 require 'spec_helper'
 
 describe Intercom::Company do
-  
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   describe 'when no response raises error' do
     it 'on find' do
-      Intercom.expects(:get).with("/companies", {:company_id => '4'}).returns(nil)
-      proc {Intercom::Company.find(:company_id => '4')}.must_raise Intercom::HttpError
+      client.expects(:get).with("/companies", {:company_id => '4'}).returns(nil)
+      proc {client.companies.find(:company_id => '4')}.must_raise Intercom::HttpError
     end
-    
+
     it 'on find_all' do
-      Intercom.expects(:get).with("/companies", {}).returns(nil)
-      proc {Intercom::Company.all.each {|company| }}.must_raise Intercom::HttpError
+      client.expects(:get).with("/companies", {}).returns(nil)
+      proc {client.companies.all.each {|company| }}.must_raise Intercom::HttpError
     end
-    
+
     it 'on load' do
-      Intercom.expects(:get).with("/companies", {:company_id => '4'}).returns({'type' =>'user', 'id' =>'aaaaaaaaaaaaaaaaaaaaaaaa', 'company_id' => '4', 'name' => 'MyCo'})
-      company = Intercom::Company.find(:company_id => '4')
-      Intercom.expects(:get).with('/companies/aaaaaaaaaaaaaaaaaaaaaaaa', {}).returns(nil)
-      proc {company.load}.must_raise Intercom::HttpError
+      client.expects(:get).with("/companies", {:company_id => '4'}).returns({'type' =>'user', 'id' =>'aaaaaaaaaaaaaaaaaaaaaaaa', 'company_id' => '4', 'name' => 'MyCo'})
+      company = client.companies.find(:company_id => '4')
+      client.expects(:get).with('/companies/aaaaaaaaaaaaaaaaaaaaaaaa', {}).returns(nil)
+      proc {client.companies.load(company)}.must_raise Intercom::HttpError
+    end
+  end
+
+  it 'gets users in a company' do
+    client.expects(:get).with("/companies/abc123/users", {}).returns(page_of_users(false))
+    client.companies.users('abc123').each do |u|
     end
   end
+
+  it 'finds a company' do
+    client.expects(:get).with("/companies/531ee472cce572a6ec000006", {}).returns(test_company)
+    company = client.companies.find(id: '531ee472cce572a6ec000006')
+    company.name.must_equal("Blue Sun")
+  end
 end

data/spec/unit/intercom/contact_spec.rb

@@ -1,9 +1,11 @@
 require "spec_helper"
 
 describe "Intercom::Contact" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   it 'should not throw ArgumentErrors when there are no parameters' do
-    Intercom.expects(:post)
-    Intercom::Contact.create
+    client.expects(:post)
+    client.contacts.create
   end
 
   describe 'converting' do
@@ -11,15 +13,15 @@ describe "Intercom::Contact" do
     let(:user) { Intercom::User.from_api(id: 'user_id') }
 
     it do
-      Intercom.expects(:post).with(
+      client.expects(:post).with(
         "/contacts/convert",
         {
           contact: { user_id: contact.user_id },
-          user: user.identity_hash
+          user: { 'id' => user.id }
         }
       ).returns(test_user)
 
-      contact.convert(user)
+      client.contacts.convert(contact, user)
     end
   end
 end

data/spec/unit/intercom/conversation_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "Intercom::Conversation" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it "gets a conversation" do
+    client.expects(:get).with("/conversations/147", {}).returns(test_conversation)
+    client.conversations.find(:id => "147")
+  end
+
+  it 'marks a conversation as read' do
+    client.expects(:put).with('/conversations/147', { read: true })
+    client.conversations.mark_read('147')
+  end
+
+  it 'replies to a conversation' do
+    client.expects(:post).with('/conversations/147/reply', { type: 'user', body: 'Thanks again', message_type: 'comment', user_id: 'ac4', conversation_id: '147' }).returns(test_conversation)
+    client.conversations.reply(id: '147', type: 'user', body: 'Thanks again', message_type: 'comment', user_id: 'ac4')
+  end
+
+  # it "creates a subscription" do
+  #   client.expects(:post).with("/subscriptions", {'url' => "http://example.com", 'topics' => ["user.created"]}).returns(test_subscription)
+  #   subscription = client.subscriptions.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

data/spec/unit/intercom/event_spec.rb

@@ -4,11 +4,12 @@ describe "Intercom::Event" do
 
   let(:user) {Intercom::User.new("email" => "jim@example.com", :user_id => "12345", :created_at => Time.now, :name => "Jim Bob")}
   let(:created_time) {Time.now - 300}
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
 
   it "creates an event with metadata" do
-    Intercom.expects(:post).with('/events', {'event_name' => 'Eventful 1', 'created_at' => created_time.to_i, 'email' => 'joe@example.com', 'metadata' => {'invitee_email' => 'pi@example.org', :invite_code => 'ADDAFRIEND', 'found_date' => 12909364407}}).returns(:status => 202)
+    client.expects(:post).with('/events', {'event_name' => 'Eventful 1', 'created_at' => created_time.to_i, 'email' => 'joe@example.com', 'metadata' => {'invitee_email' => 'pi@example.org', :invite_code => 'ADDAFRIEND', 'found_date' => 12909364407}}).returns(:status => 202)
 
-    Intercom::Event.create(:event_name => "Eventful 1", :created_at => created_time,
+    client.events.create(:event_name => "Eventful 1", :created_at => created_time,
                                    :email => 'joe@example.com',
                                    :metadata => {
                                      "invitee_email" => "pi@example.org",
@@ -18,8 +19,8 @@ describe "Intercom::Event" do
   end
 
   it "creates an event without metadata" do
-    Intercom.expects(:post).with('/events', {'event_name' => 'sale of item', 'email' => 'joe@example.com'})
-    Intercom::Event.create(:event_name => "sale of item", :email => 'joe@example.com')
+    client.expects(:post).with('/events', {'event_name' => 'sale of item', 'email' => 'joe@example.com'})
+    client.events.create(:event_name => "sale of item", :email => 'joe@example.com')
   end
- 
+
 end

data/spec/unit/intercom/message_spec.rb

@@ -3,19 +3,20 @@ 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")}
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
 
   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")
+    client.expects(:post).with('/messages', {'from' => { :type => 'user', :email => 'jim@example.com'}, 'body' => 'halp'}).returns(:status => 200)
+    client.messages.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")
+    client.expects(:post).with('/messages', {'from' => { 'type' => 'user', 'email' => 'jim@example.com'}, 'body' => 'halp'}).returns(:status => 200)
+    client.messages.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')
+    client.expects(:post).with('/messages', {'from' => { 'type' => "admin", 'id' => "1234" }, 'to' => { 'type' => 'user', 'id' => '5678' }, 'body' => 'halp', 'message_type' => 'inapp'}).returns(:status => 200)
+    client.messages.create('from' => { 'type' => "admin", 'id' => "1234" }, :to => { 'type' => 'user', 'id' => '5678' }, 'body' => "halp", 'message_type' => 'inapp')
   end
 end