intercom 2.5.4 → 3.0.0b1

data/spec/unit/intercom/note_spec.rb

@@ -1,12 +1,19 @@
 require "spec_helper"
 
 describe "notes" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   it "creates a note" do
-    Intercom.expects(:post).with("/notes", {"body" => "Note to leave on user"}).returns({"body" => "<p>Note to leave on user</p>", "created_at" => 1234567890})
-    note = Intercom::Note.create("body" => "Note to leave on user")
+    client.expects(:post).with("/notes", {"body" => "Note to leave on user"}).returns({"body" => "<p>Note to leave on user</p>", "created_at" => 1234567890})
+    note = client.notes.create("body" => "Note to leave on user")
     note.body.must_equal "<p>Note to leave on user</p>"
   end
 
+  it 'gets a note' do
+    client.expects(:get).with("/notes/123", {}).returns({"id" => "123", "body" => "<p>Note to leave on user</p>", "created_at" => 1234567890})
+    client.notes.find(id: '123')
+  end
+
   it "sets/gets allowed keys" do
     params = {"body" => "Note body", "email" => "me@example.com", :user_id => "abc123"}
     note = Intercom::Note.new(params)

data/spec/unit/intercom/segment_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe "Intercom::Segment" do
+
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it 'lists segments' do
+    client.expects(:get).with('/segments', {}).returns(segment_list)
+    segments = client.segments.all.to_a
+    segments[0].name.must_equal('Active')
+  end
+end

data/spec/unit/intercom/subscription_spec.rb

@@ -1,18 +1,20 @@
 require 'spec_helper'
 
 describe "Intercom::Subscription" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   it "gets a subscription" do
-    Intercom.expects(:get).with("/subscriptions/nsub_123456789", {}).returns(test_subscription)
-    subscription = Intercom::Subscription.find(:id => "nsub_123456789")
+    client.expects(:get).with("/subscriptions/nsub_123456789", {}).returns(test_subscription)
+    subscription = client.subscriptions.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"])
+    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
+end

data/spec/unit/intercom/tag_spec.rb

@@ -1,23 +1,29 @@
 require 'spec_helper'
 
 describe "Intercom::Tag" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   it "gets a tag" do
-    Intercom.expects(:get).with("/tags", {:name => "Test Tag"}).returns(test_tag)
-    tag = Intercom::Tag.find(:name => "Test Tag")
+    client.expects(:get).with("/tags", {:name => "Test Tag"}).returns(test_tag)
+    tag = client.tags.find(:name => "Test Tag")
     tag.name.must_equal "Test Tag"
   end
 
   it "creates a tag" do
-    Intercom.expects(:post).with("/tags", {'name' => "Test Tag"}).returns(test_tag)
-    tag = Intercom::Tag.create(:name => "Test Tag")
+    client.expects(:post).with("/tags", {'name' => "Test Tag"}).returns(test_tag)
+    tag = client.tags.create(:name => "Test Tag")
     tag.name.must_equal "Test Tag"
   end
 
   it "tags users" do
-    Intercom.expects(:post).with("/tags", {'name' => "Test Tag", 'user_ids' => ["abc123", "def456"], 'tag_or_untag' => "tag"}).returns(test_tag)
-    tag = Intercom::Tag.create(:name => "Test Tag", :user_ids => ["abc123", "def456"], :tag_or_untag => "tag")
+    client.expects(:post).with("/tags", {'name' => "Test Tag", 'users' => [ { user_id: 'abc123' }, { user_id: 'def456' } ], 'tag_or_untag' => 'tag'}).returns(test_tag)
+    tag = client.tags.tag(:name => "Test Tag", :users => [ { user_id: "abc123" }, { user_id: "def456" } ] )
     tag.name.must_equal "Test Tag"
     tag.tagged_user_count.must_equal 2
   end
 
-end
+  it 'untags users' do
+    client.expects(:post).with("/tags", {'name' => "Test Tag", 'users' => [ { user_id: 'abc123' }, { user_id: 'def456' } ], 'tag_or_untag' => 'untag'}).returns(test_tag)
+    client.tags.untag(:name => "Test Tag", :users => [ { user_id: "abc123" }, { user_id: "def456" } ])
+  end
+end

data/spec/unit/intercom/user_spec.rb

@@ -1,6 +1,8 @@
 require "spec_helper"
 
 describe "Intercom::User" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
   it "to_hash'es itself" do
     created_at = Time.now
     user = Intercom::User.new(:email => "jim@example.com", :user_id => "12345", :created_at => created_at, :name => "Jim Bob")
@@ -77,10 +79,10 @@ describe "Intercom::User" do
     user.unsubscribed_from_emails.must_equal true
     user.user_agent_data.must_equal "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"
   end
-  
+
   it 'allows update_last_request_at' do
-    Intercom.expects(:post).with("/users", {"user_id" => "1224242", 'update_last_request_at' => true, "custom_attributes" => {}}).returns({"user_id" => "i-1224242", "last_request_at" => 1414509439})
-    Intercom::User.create(user_id:'1224242', update_last_request_at:true)
+    client.expects(:post).with("/users", {"user_id" => "1224242", 'update_last_request_at' => true, "custom_attributes" => {}}).returns({"user_id" => "i-1224242", "last_request_at" => 1414509439})
+    client.users.create(user_id: '1224242', update_last_request_at: true)
   end
 
   it "allows easy setting of custom data" do
@@ -104,7 +106,7 @@ describe "Intercom::User" do
 
   it "rejects nested data structures in custom_attributes" do
     user = Intercom::User.new()
-    
+
     proc { user.custom_attributes["thing"] = [1] }.must_raise(ArgumentError)
     proc { user.custom_attributes["thing"] = {1 => 2} }.must_raise(ArgumentError)
     proc { user.custom_attributes["thing"] = {1 => {2 => 3}} }.must_raise(ArgumentError)
@@ -147,58 +149,68 @@ describe "Intercom::User" do
   end
 
   it "fetches a user" do
-    Intercom.expects(:get).with("/users", {"email" => "bo@example.com"}).returns(test_user)
-    user = Intercom::User.find("email" => "bo@example.com")
+    client.expects(:get).with("/users", {"email" => "bo@example.com"}).returns(test_user)
+    user = client.users.find("email" => "bo@example.com")
     user.email.must_equal "bob@example.com"
     user.name.must_equal "Joe Schmoe"
     user.session_count.must_equal 123
   end
 
+  it 'gets users by tag' do
+    client.expects(:get).with("/users?tag_id=124", {}).returns(page_of_users(false))
+    client.users.by_tag(124).each { |t| }
+  end
+
+  it 'gets users by segment' do
+    client.expects(:get).with("/users?segment_id=124", {}).returns(page_of_users(false))
+    client.users.by_segment(124).each { |t| }
+  end
+
   it "saves a user (always sends custom_attributes)" do
     user = Intercom::User.new("email" => "jo@example.com", :user_id => "i-1224242")
-    Intercom.expects(:post).with("/users", {"email" => "jo@example.com", "user_id" => "i-1224242", "custom_attributes" => {}}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
-    user.save
+    client.expects(:post).with("/users", {"email" => "jo@example.com", "user_id" => "i-1224242", "custom_attributes" => {}}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
+    client.users.save(user)
   end
 
   it "saves a user with a company" do
     user = Intercom::User.new("email" => "jo@example.com", :user_id => "i-1224242", :company => {'company_id' => 6, 'name' => "Intercom"})
-    Intercom.expects(:post).with("/users", {'custom_attributes' => {}, "user_id" => "i-1224242", "email" => "jo@example.com", "company" => {"company_id" => 6, "name" => "Intercom"}}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
-    user.save
+    client.expects(:post).with("/users", {'custom_attributes' => {}, "user_id" => "i-1224242", "email" => "jo@example.com", "company" => {"company_id" => 6, "name" => "Intercom"}}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
+    client.users.save(user)
   end
 
   it "saves a user with a companies" do
     user = Intercom::User.new("email" => "jo@example.com", :user_id => "i-1224242", :companies => [{'company_id' => 6, 'name' => "Intercom"}])
-    Intercom.expects(:post).with("/users", {'custom_attributes' => {}, "email" => "jo@example.com", "user_id" => "i-1224242", "companies" => [{"company_id" => 6, "name" => "Intercom"}]}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
-    user.save
+    client.expects(:post).with("/users", {'custom_attributes' => {}, "email" => "jo@example.com", "user_id" => "i-1224242", "companies" => [{"company_id" => 6, "name" => "Intercom"}]}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
+    client.users.save(user)
   end
-  
+
   it 'can save a user with a nil email' do
     user = Intercom::User.new("email" => nil, :user_id => "i-1224242", :companies => [{'company_id' => 6, 'name' => "Intercom"}])
-    Intercom.expects(:post).with("/users", {'custom_attributes' => {}, "email" => nil, "user_id" => "i-1224242", "companies" => [{"company_id" => 6, "name" => "Intercom"}]}).returns({"email" => nil, "user_id" => "i-1224242"})
-    user.save
+    client.expects(:post).with("/users", {'custom_attributes' => {}, "email" => nil, "user_id" => "i-1224242", "companies" => [{"company_id" => 6, "name" => "Intercom"}]}).returns({"email" => nil, "user_id" => "i-1224242"})
+    client.users.save(user)
   end
 
   it "deletes a user" do
     user = Intercom::User.new("id" => "1")
-    Intercom.expects(:delete).with("/users/1", {}).returns(user)
-    user.delete
+    client.expects(:delete).with("/users/1", {}).returns(user)
+    client.users.delete(user)
   end
 
-  it "can use User.create for convenience" do
-    Intercom.expects(:post).with("/users", {'custom_attributes' => {}, "email" => "jo@example.com", "user_id" => "i-1224242"}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
-    user = Intercom::User.create("email" => "jo@example.com", :user_id => "i-1224242")
+  it "can use client.users.create for convenience" do
+    client.expects(:post).with("/users", {'custom_attributes' => {}, "email" => "jo@example.com", "user_id" => "i-1224242"}).returns({"email" => "jo@example.com", "user_id" => "i-1224242"})
+    user = client.users.create("email" => "jo@example.com", :user_id => "i-1224242")
     user.email.must_equal "jo@example.com"
   end
 
-  it "updates the @user with attributes as set by the server" do
-    Intercom.expects(:post).with("/users", {"email" => "jo@example.com", "user_id" => "i-1224242", 'custom_attributes' => {}}).returns({"email" => "jo@example.com", "user_id" => "i-1224242", "session_count" => 4})
-    user = Intercom::User.create("email" => "jo@example.com", :user_id => "i-1224242")
+  it "updates the user with attributes as set by the server" do
+    client.expects(:post).with("/users", {"email" => "jo@example.com", "user_id" => "i-1224242", 'custom_attributes' => {}}).returns({"email" => "jo@example.com", "user_id" => "i-1224242", "session_count" => 4})
+    user = client.users.create("email" => "jo@example.com", :user_id => "i-1224242")
     user.session_count.must_equal 4
   end
 
   it "allows setting dates to nil without converting them to 0" do
-    Intercom.expects(:post).with("/users", {"email" => "jo@example.com", 'custom_attributes' => {}, "remote_created_at" => nil}).returns({"email" => "jo@example.com"})
-    user = Intercom::User.create("email" => "jo@example.com", "remote_created_at" => nil)
+    client.expects(:post).with("/users", {"email" => "jo@example.com", 'custom_attributes' => {}, "remote_created_at" => nil}).returns({"email" => "jo@example.com"})
+    user = client.users.create("email" => "jo@example.com", "remote_created_at" => nil)
     user.remote_created_at.must_equal nil
   end
 
@@ -217,14 +229,10 @@ describe "Intercom::User" do
     user.new_param.must_equal "some value"
   end
 
-  it "returns a CollectionProxy for all without making any requests" do
-    Intercom.expects(:execute_request).never
-    all = Intercom::User.all
-    all.must_be_instance_of(Intercom::CollectionProxy)
+  it "returns a ClientCollectionProxy for all without making any requests" do
+    client.expects(:execute_request).never
+    all = client.users.all
+    all.must_be_instance_of(Intercom::ClientCollectionProxy)
   end
 
-  it "returns the total number of users" do
-    Intercom::Count.expects(:user_count).returns('count_info')
-    Intercom::User.count
-  end  
 end

data/spec/unit/intercom_spec.rb

@@ -4,87 +4,4 @@ describe Intercom do
   it "has a version number" do
     Intercom::VERSION.must_match(/\d+\.\d+\.\d+/)
   end
-
-  describe "API" do
-    before do
-      Intercom.app_id = "abc123"
-      Intercom.app_api_key = "super-secret-key"
-    end
-
-    it "raises ArgumentError if no app_id or app_api_key specified" do
-      Intercom.app_id = nil
-      Intercom.app_api_key = nil
-      proc { Intercom.target_base_url }.must_raise ArgumentError, "You must set both Intercom.app_id and Intercom.app_api_key to use this client. See https://github.com/intercom/intercom-ruby for usage examples."
-    end
-    
-    it 'raises an Intercom::MultipleMatchingUsers error when receiving a conflict' do
-      multiple_matching_error = { 'type' => 'error.list', 'errors' => [{ 'code' => 'conflict', 'message' => 'Multiple existing users match this email address - must be more specific using user_id' }]}
-      proc {Intercom::Request.new('/users', :get).raise_application_errors_on_failure(multiple_matching_error, 400)}.must_raise(Intercom::MultipleMatchingUsersError)
-    end
-
-    it "returns the app_id and app_api_key previously set" do
-      Intercom.app_id.must_equal "abc123"
-      Intercom.app_api_key.must_equal "super-secret-key"
-    end
-
-    it "defaults to https to api.intercom.io" do
-      Intercom.target_base_url.must_equal "https://abc123:super-secret-key@api.intercom.io"
-    end
-
-    it "raises ResourceNotFound if get a 404" do
-
-    end
-
-    describe "overriding protocol/hostname" do
-      before do
-        @protocol = Intercom.protocol
-        @hostname = Intercom.hostname
-        Intercom.endpoints = nil
-      end
-
-      after do
-        Intercom.protocol = @protocol
-        Intercom.hostname = @hostname
-        Intercom.endpoints = ["https://api.intercom.io"]
-      end
-
-      it "allows overriding of the endpoint and protocol" do
-        Intercom.protocol = "http"
-        Intercom.hostname = "localhost:3000"
-        Intercom.target_base_url.must_equal "http://abc123:super-secret-key@localhost:3000"
-      end
-
-      it "prefers endpoints" do
-        Intercom.endpoint = "https://localhost:7654"
-        Intercom.target_base_url.must_equal "https://abc123:super-secret-key@localhost:7654"
-        Intercom.endpoints = unshuffleable_array(["http://example.com","https://localhost:7654"])
-        Intercom.target_base_url.must_equal "http://abc123:super-secret-key@example.com"
-      end
-
-      it "has endpoints" do
-        Intercom.endpoints.must_equal ["https://api.intercom.io"]
-        Intercom.endpoints = ["http://example.com","https://localhost:7654"]
-        Intercom.endpoints.must_equal ["http://example.com","https://localhost:7654"]
-      end
-
-      it "should randomize endpoints if last checked endpoint is > 5 minutes ago" do
-        Intercom.instance_variable_set(:@current_endpoint, "http://start")
-        Intercom.instance_variable_set(:@endpoints, ["http://alternative"])
-        Intercom.instance_variable_set(:@endpoint_randomized_at, Time.now - 120)
-        Intercom.current_endpoint.must_equal "http://start"
-        Intercom.instance_variable_set(:@endpoint_randomized_at, Time.now - 360)
-        Intercom.current_endpoint.must_equal "http://alternative"
-        Intercom.instance_variable_get(:@endpoint_randomized_at).to_i.must_be_close_to Time.now.to_i
-      end
-    end
-  end
-
-
-  it "checks for email or user id" do
-    proc { Intercom.check_required_params("else") }.must_raise ArgumentError, "Expected params Hash, got String"
-    proc { Intercom.check_required_params(:something => "else") }.must_raise ArgumentError, "Either email or user_id must be specified"
-    Intercom.check_required_params(:email => "bob@example.com", :something => "else")
-    Intercom.check_required_params("email" => "bob@example.com", :something => "else")
-    Intercom.check_required_params(:user_id => "123")
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 3.0.0b1
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -116,56 +116,64 @@ files:
 - lib/intercom.rb
 - lib/intercom/admin.rb
 - lib/intercom/api_operations/convert.rb
-- lib/intercom/api_operations/count.rb
 - lib/intercom/api_operations/delete.rb
 - lib/intercom/api_operations/find.rb
 - lib/intercom/api_operations/find_all.rb
 - lib/intercom/api_operations/list.rb
 - lib/intercom/api_operations/load.rb
 - lib/intercom/api_operations/save.rb
-- lib/intercom/collection_proxy.rb
+- lib/intercom/client.rb
+- lib/intercom/client_collection_proxy.rb
 - lib/intercom/company.rb
 - lib/intercom/contact.rb
 - lib/intercom/conversation.rb
-- lib/intercom/count.rb
 - lib/intercom/errors.rb
 - lib/intercom/event.rb
-- lib/intercom/extended_api_operations/reply.rb
+- lib/intercom/extended_api_operations/segments.rb
 - lib/intercom/extended_api_operations/tags.rb
 - lib/intercom/extended_api_operations/users.rb
-- lib/intercom/generic_handlers/base_handler.rb
-- lib/intercom/generic_handlers/count.rb
-- lib/intercom/generic_handlers/tag.rb
-- lib/intercom/generic_handlers/tag_find_all.rb
 - lib/intercom/lib/dynamic_accessors.rb
 - lib/intercom/lib/dynamic_accessors_on_method_missing.rb
 - lib/intercom/lib/flat_store.rb
 - lib/intercom/lib/typed_json_deserializer.rb
 - lib/intercom/message.rb
 - lib/intercom/note.rb
-- lib/intercom/notification.rb
+- lib/intercom/options.rb
 - lib/intercom/request.rb
 - lib/intercom/segment.rb
+- lib/intercom/service/admin.rb
+- lib/intercom/service/base_service.rb
+- lib/intercom/service/company.rb
+- lib/intercom/service/contact.rb
+- lib/intercom/service/conversation.rb
+- lib/intercom/service/event.rb
+- lib/intercom/service/message.rb
+- lib/intercom/service/note.rb
+- lib/intercom/service/segment.rb
+- lib/intercom/service/subscription.rb
+- lib/intercom/service/tag.rb
+- lib/intercom/service/user.rb
 - lib/intercom/subscription.rb
 - lib/intercom/tag.rb
 - lib/intercom/traits/api_resource.rb
 - lib/intercom/traits/dirty_tracking.rb
-- lib/intercom/traits/generic_handler_binding.rb
 - lib/intercom/traits/incrementable_attributes.rb
 - lib/intercom/user.rb
 - lib/intercom/utils.rb
 - lib/intercom/version.rb
 - spec/spec_helper.rb
 - spec/unit/intercom/admin_spec.rb
-- spec/unit/intercom/collection_proxy_spec.rb
+- spec/unit/intercom/client_collection_proxy_spec.rb
+- spec/unit/intercom/client_spec.rb
 - spec/unit/intercom/company_spec.rb
 - spec/unit/intercom/contact_spec.rb
+- spec/unit/intercom/conversation_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/request_spec.rb
+- spec/unit/intercom/segment_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb
@@ -183,30 +191,32 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.2.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
 test_files:
 - spec/spec_helper.rb
 - spec/unit/intercom/admin_spec.rb
-- spec/unit/intercom/collection_proxy_spec.rb
+- spec/unit/intercom/client_collection_proxy_spec.rb
+- spec/unit/intercom/client_spec.rb
 - spec/unit/intercom/company_spec.rb
 - spec/unit/intercom/contact_spec.rb
+- spec/unit/intercom/conversation_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/request_spec.rb
+- spec/unit/intercom/segment_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb