intercom 3.4.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d99183b501bb44dbe266b53e79f3f87c19598ec3
-  data.tar.gz: 60219b646fe7651c872bb0defc9e519538d76278
+  metadata.gz: af771d03313306122d7cd15732e481d1be985ea2
+  data.tar.gz: 5868caffd6bb8f2f66a674e6610b7e2278a13882
 SHA512:
-  metadata.gz: 75cf2e79bd16fbecd583c1870b88cb6434c2626049b005616b22c9702b8b55dca4eccf32dfcf080fa466b32081b6f14ae4f88156d43af865728ecbd33062ff8f
-  data.tar.gz: 6e70470e54a9b0c82e91ff6a598e49ace938ea7504aec800ebb0bf81cf8b710aa495d915b176d862290cf703371f2724c8a1ac967a8bf0a48755470181bde009
+  metadata.gz: 46b5dec841b7297280ddfddcb79400fc606e73c27324177bbc6f7fee6614851e06e409273b95c271773eec588ddd5b7aca332344ae9f4bd0c793c5f7312a822a
+  data.tar.gz: c74408ea271f4ab2695d8e9cde03a5e862ad5c59993423f478ca98d05617fea3880daf97dbc583e4ca6cf69936b167085176a9543a151c12b6bd0fb3ebee3e91

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,19 @@
+Please use the following template to submit your issue. Following this template will allow us to quickly investigate and help you with your issue. Please be aware that issues which do not conform to this template may be closed.
+
+For feature requests please contact us at team@intercom.io
+
+
+## Version info
+  - intercom-ruby version:
+  - Ruby version:
+
+## Expected behavior
+
+## Actual behavior
+
+## Steps to reproduce
+ 1. 
+ 2. 
+ 3. 
+
+## Logs

data/README.md

@@ -22,7 +22,7 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 Using bundler:
 
-    gem 'intercom', "~> 3.4.0"
+    gem 'intercom', "~> 3.5.0"
 
 ## Basic Usage
 
@@ -191,7 +191,7 @@ intercom.conversations.reply(:id => conversation.id, :type => 'user', :email =>
 # Admin (identified by id) replies with a comment
 intercom.conversations.reply(:id => conversation.id, :type => 'admin', :admin_id => '123', :message_type => 'comment', :body => 'bar')
 # User (identified by email) replies with a comment and attachment
-intercom.conversations.reply(:id => conversation.id, :type => 'user', :email => 'joe@example.com', :message_type => 'comment', :body => 'foo', :attachment => ['http://www.example.com/attachment.jpg'])
+intercom.conversations.reply(:id => conversation.id, :type => 'user', :email => 'joe@example.com', :message_type => 'comment', :body => 'foo', :attachment_urls => ['http://www.example.com/attachment.jpg'])
 
 # Open
 intercom.conversations.open(id: conversation.id, admin_id: '123')
@@ -439,7 +439,7 @@ intercom.jobs.errors(id: 'job_abcd1234')
 
 There are different styles for error handling - some people prefer exceptions; some prefer nil and check; some prefer error objects/codes. Balancing these preferences alongside our wish to provide an idiomatic gem has brought us to use the current mechanism of throwing specific exceptions. Our approach in the client is to propagate errors and signal our failure loudly so that erroneous data does not get propagated through our customers' systems - in other words, if you see a `Intercom::ServiceUnavailableError` you know where the problem is.
 
-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 its `http_code` method.
+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 its `http_code` method.
 
 The list of different error subclasses are listed below. As they all inherit off Intercom::IntercomError you can choose to rescue Intercom::IntercomError or
 else rescue the more specific error subclass.

data/lib/intercom.rb

@@ -12,6 +12,7 @@ require 'intercom/service/subscription'
 require 'intercom/service/segment'
 require 'intercom/service/tag'
 require 'intercom/service/user'
+require 'intercom/service/visitor'
 require 'intercom/options'
 require 'intercom/client'
 require "intercom/contact"
@@ -30,6 +31,7 @@ require "intercom/request"
 require "intercom/subscription"
 require "intercom/utils"
 require "intercom/errors"
+require "intercom/visitor"
 require "json"
 
 ##

data/lib/intercom/api_operations/convert.rb

@@ -3,16 +3,33 @@ require 'intercom/traits/api_resource'
 module Intercom
   module ApiOperations
     module Convert
-      def convert(contact, user)
-        Intercom::User.new.from_response(
-          @client.post(
-            "/contacts/convert",
-            {
-              contact: { user_id: contact.user_id },
-              user: identity_hash(user)
-            }
+      def convert(contact, user = false)
+        if contact.class == Intercom::Visitor
+          visitor = contact
+          req = {
+            visitor: { user_id: visitor.user_id },
+          }
+          if user
+            req[:user] = identity_hash(user)
+            req[:type] = 'user'
+          else
+            req[:type] = 'lead'
+          end
+          Intercom::User.new.from_response(
+            @client.post(
+              "/visitors/convert", req
+            )
           )
-        )
+        else
+          Intercom::User.new.from_response(
+            @client.post(
+              "/contacts/convert", {
+                contact: { user_id: contact.user_id },
+                user: identity_hash(user)
+              }
+            )
+          )
+        end
       end
     end
   end

data/lib/intercom/client.rb

@@ -76,6 +76,10 @@ module Intercom
       Intercom::Service::User.new(self)
     end
 
+    def visitors
+      Intercom::Service::Visitor.new(self)
+    end
+
     def jobs
       Intercom::Service::Job.new(self)
     end

data/lib/intercom/errors.rb

@@ -14,7 +14,7 @@ module Intercom
   # Check that you have set <b>Intercom.app_id=</b> and <b>Intercom.app_api_key=</b> correctly.
   class AuthenticationError < IntercomError; end
 
-  # Raised when something does wrong on within the Intercom API service.
+  # Raised when something goes wrong on within the Intercom API service.
   class ServerError < IntercomError; end
 
   # Raised when we have bad gateway errors.
@@ -29,21 +29,21 @@ module Intercom
   # Raised when requesting resources on behalf of a user that doesn't exist in your application on Intercom.
   class ResourceNotFound < IntercomError; end
 
-  # Raised when the request has a bad syntax
+  # Raised when the request has bad syntax
   class BadRequestError < IntercomError; end
 
-  # Raised when you have exceed the API rate limit
+  # Raised when you have exceeded the API rate limit
   class RateLimitExceeded < IntercomError; end
 
   # Raised when the request throws an error not accounted for
   class UnexpectedError < IntercomError; end
-  
+
   # Raised when multiple users match the query (typically duplicate email addresses)
   class MultipleMatchingUsersError < IntercomError; end
 
   # Raised when you try to call a non-setter method that does not exist on an object
   class Intercom::AttributeNotSetError < IntercomError ; end
-  
+
   # Raised when unexpected nil returned from server
   class Intercom::HttpError < IntercomError ; end
 
@@ -51,7 +51,7 @@ module Intercom
   # Non-public errors (internal to the gem)
   #
 
-  # Base class exception from which all public Intercom exceptions will be derived
+  # Base class exception from which all private Intercom exceptions will be derived
   class IntercomInternalError < StandardError; end
 
   # Raised when we attempt to handle a method missing but are unsuccessful

data/lib/intercom/request.rb

@@ -105,7 +105,7 @@ module Intercom
 
     def decode(content_encoding, body)
       return body if (!body) || body.empty? || content_encoding != 'gzip'
-      Zlib::GzipReader.new(StringIO.new(body)).read
+      Zlib::GzipReader.new(StringIO.new(body)).read.force_encoding("utf-8")
     end
 
     def raise_errors_on_failure(res)

data/lib/intercom/service/tag.rb

@@ -1,7 +1,6 @@
 require 'intercom/service/base_service'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/list'
-require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 
 module Intercom
@@ -9,7 +8,6 @@ module Intercom
     class Tag < BaseService
       include ApiOperations::Save
       include ApiOperations::List
-      include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Delete
 

data/lib/intercom/service/visitor.rb

@@ -0,0 +1,26 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/load'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/save'
+require 'intercom/api_operations/convert'
+require 'intercom/api_operations/delete'
+
+module Intercom
+  module Service
+    class Visitor < BaseService
+      include ApiOperations::Load
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::FindAll
+      include ApiOperations::Save
+      include ApiOperations::Convert
+      include ApiOperations::Delete
+
+      def collection_class
+        Intercom::Visitor
+      end
+    end
+  end
+end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.4.0"
+  VERSION = "3.5.1"
 end

data/lib/intercom/visitor.rb

@@ -0,0 +1,14 @@
+require 'intercom/traits/incrementable_attributes'
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Visitor
+    include Traits::IncrementableAttributes
+    include Traits::ApiResource
+
+    def identity_vars ; [:id, :email, :user_id] ; end
+    def flat_store_attributes ; [:custom_attributes] ; end
+    def update_verb ; 'put' ; end
+
+  end
+end

data/spec/unit/intercom/tag_spec.rb

@@ -3,12 +3,6 @@ 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
-    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
     client.expects(:post).with("/tags", {'name' => "Test Tag"}).returns(test_tag)
     tag = client.tags.create(:name => "Test Tag")

data/spec/unit/intercom/visitors_spec.rb

@@ -0,0 +1,61 @@
+require "spec_helper"
+
+describe "Intercom::Visitors" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it 'should be listable' do
+    proxy = client.visitors.all
+    proxy.resource_name.must_equal 'visitors'
+    proxy.finder_url.must_equal '/visitors'
+    proxy.resource_class.must_equal Intercom::Visitor
+  end
+
+  it 'can update a visitor with an id' do
+    visitor = Intercom::Visitor.new(:id => "de45ae78gae1289cb")
+    client.expects(:put).with("/visitors/de45ae78gae1289cb", {'custom_attributes' => {}})
+    client.visitors.save(visitor)
+  end
+
+  describe 'converting' do
+    let(:visitor) { Intercom::Visitor.from_api(user_id: 'visitor_id') }
+    let(:user) { Intercom::User.from_api(id: 'user_id') }
+
+    it 'visitor to user' do
+      client.expects(:post).with(
+        "/visitors/convert",
+        {
+          visitor: { user_id: visitor.user_id },
+          user: { 'id' => user.id },
+          type:'user'
+        }
+      ).returns(test_user)
+
+      client.visitors.convert(visitor, user)
+    end
+
+    it 'visitor to lead' do
+      client.expects(:post).with(
+        "/visitors/convert",
+        {
+          visitor: { user_id: visitor.user_id },
+          type:'lead'
+        }
+      ).returns(test_user)
+
+      client.visitors.convert(visitor)
+    end
+  end
+
+  it "returns a ClientCollectionProxy for all without making any requests" do
+    client.expects(:execute_request).never
+    all = client.visitors.all
+    all.must_be_instance_of(Intercom::ClientCollectionProxy)
+  end
+
+  it "deletes a visitor" do
+    visitor = Intercom::Visitor.new("id" => "1")
+    client.expects(:delete).with("/visitors/1", {}).returns(visitor)
+    client.visitors.delete(visitor)
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-11 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -117,6 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile
@@ -173,6 +174,7 @@ files:
 - lib/intercom/service/subscription.rb
 - lib/intercom/service/tag.rb
 - lib/intercom/service/user.rb
+- lib/intercom/service/visitor.rb
 - lib/intercom/subscription.rb
 - lib/intercom/tag.rb
 - lib/intercom/traits/api_resource.rb
@@ -181,6 +183,7 @@ files:
 - lib/intercom/user.rb
 - lib/intercom/utils.rb
 - lib/intercom/version.rb
+- lib/intercom/visitor.rb
 - spec/spec_helper.rb
 - spec/unit/intercom/admin_spec.rb
 - spec/unit/intercom/client_collection_proxy_spec.rb
@@ -200,6 +203,7 @@ files:
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
+- spec/unit/intercom/visitors_spec.rb
 - spec/unit/intercom_spec.rb
 homepage: https://www.intercom.io
 licenses:
@@ -221,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.2.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
@@ -245,5 +249,6 @@ test_files:
 - spec/unit/intercom/tag_spec.rb
 - spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
+- spec/unit/intercom/visitors_spec.rb
 - spec/unit/intercom_spec.rb
 has_rdoc: