intercom 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5ef9d6fa028f29130786bb4e260112ddbbce668
-  data.tar.gz: 23112e23cdf9f44f20d4a55d20bf7070aae80385
+  metadata.gz: 3ecabc64ed0e6223bb4b5af895a49b6dee13fdb5
+  data.tar.gz: 98f56f0bd24d589be44195af2d8470b469adfdd2
 SHA512:
-  metadata.gz: 3e1c851b4481a5a17faf27240766e94b0b92060d0758e079a7f04cac11a9eb1725710b3744149d263737903f0c805d8cdf405d95d7bab8e36106ebe25e814672
-  data.tar.gz: ab37cc7e537610f7fb6748dab499b975a1926043aac9ba313c15a7f097db5aec8ecf6611458675bf7aa716527903d55cb5534227a1e2afd97d9f5bc6c0e49df7
+  metadata.gz: ab1db67838ece4aeb6456060bd27b68b7a3762b1840dd5bed9cbeddab2c542eb1dbed37c78a2a0ffd2245601d896a19aac1974b5e79739b0809e3e729bbfc015
+  data.tar.gz: 74252ee9ad4f610e86d5c37fda98e36911211ba353a14c212347a5d5bf0e54c08999239c21638e59c5f44726242ad9f8b9555875f828459ce2bd7b6f6c563156

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.2.0"
+    gem 'intercom', "~> 3.3.0"
 
 ## Basic Usage
 
@@ -49,6 +49,8 @@ Resources this API supports:
     https://api.intercom.io/conversations
     https://api.intercom.io/messages
     https://api.intercom.io/subscriptions
+    https://api.intercom.io/jobs
+    https://api.intercom.io/bulk
 
 ### Examples
 
@@ -75,6 +77,14 @@ intercom.users.save(user)
 # Iterate over all users
 intercom.users.all.each {|user| puts %Q(#{user.email} - #{user.custom_attributes["average_monthly_spend"]}) }
 intercom.users.all.map {|user| user.email }
+
+#Bulk operations.
+# Submit bulk job, to create users
+intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@example.com"}, {user_id: 25, email: "bob@example.com"}])
+# Submit bulk job, to delete users
+intercom.users.submit_bulk_job(delete_items: [{user_id: 25, email: "alice@example.com"}, {user_id: 25, email: "bob@example.com"}])
+# Submit bulk job, to add items to existing job
+intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@example.com"}], delete_items: [{user_id: 25, email: "bob@example.com"}], job_id:'job_abcd1234')
 ```
 
 #### Admins
@@ -286,6 +296,8 @@ intercom.events.create(
     "found_date" => 12909364407
   }
 )
+
+
 ```
 
 Metadata Objects support a few simple types that Intercom can present on your behalf
@@ -316,6 +328,54 @@ The metadata key values in the example are treated as follows-
 
 *NB:* This version of the gem reserves the field name `type` in Event data.
 
+Bulk operations. 
+```ruby
+# Submit bulk job, to create events
+intercom.events.submit_bulk_job(create_items: [
+  {
+    event_name: "ordered-item",
+    created_at: 1438944980,
+    user_id: "314159",
+    metadata: {
+      order_date: 1438944980,
+      stripe_invoice: "inv_3434343434"
+    }
+  },
+  {
+    event_name: "invited-friend",
+    created_at: 1438944979,
+    user_id: "314159",
+    metadata: {
+      invitee_email: "pi@example.org",
+      invite_code: "ADDAFRIEND"
+    }
+  }
+])
+
+
+# Submit bulk job, to add items to existing job
+intercom.events.submit_bulk_job(create_items: [
+  {
+    event_name: "ordered-item",
+    created_at: 1438944980,
+    user_id: "314159",
+    metadata: {
+      order_date: 1438944980,
+      stripe_invoice: "inv_3434343434"
+    }
+  },
+  {
+    event_name: "invited-friend",
+    created_at: 1438944979,
+    user_id: "314159",
+    metadata: {
+      invitee_email: "pi@example.org",
+      invite_code: "ADDAFRIEND"
+    }
+  }
+], job_id:'job_abcd1234')
+```
+
 ### Contacts
 
 `Contacts` represent logged out users of your application.
@@ -362,8 +422,20 @@ intercom.subscriptions.find(:id => "nsub_123456789")
 # list subscriptions
 intercom.subscriptions.all
 ```
+### Bulk jobs
+
+```ruby
+# fetch a job
+intercom.jobs.find(id: 'job_abcd1234')
+
+# fetch a job's error feed
+intercom.jobs.errors(id: 'job_abcd1234')
+```
 
 ### Errors
+
+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.
 
 The list of different error subclasses are listed below. As they all inherit off Intercom::IntercomError you can choose to rescue Intercom::IntercomError or

data/changes.txt

@@ -1,3 +1,6 @@
+3.3.0
+ - Add Bulk API support
+
 3.2.0
  - Add attachment support for conversations
  - Fix puts'ing api resources

data/lib/intercom.rb

@@ -7,6 +7,7 @@ require 'intercom/service/count'
 require 'intercom/service/event'
 require 'intercom/service/message'
 require 'intercom/service/note'
+require 'intercom/service/job'
 require 'intercom/service/subscription'
 require 'intercom/service/segment'
 require 'intercom/service/tag'
@@ -18,6 +19,7 @@ require "intercom/count"
 require "intercom/user"
 require "intercom/company"
 require "intercom/note"
+require "intercom/job"
 require "intercom/tag"
 require "intercom/segment"
 require "intercom/event"

data/lib/intercom/api_operations/bulk/load_error_feed.rb

@@ -0,0 +1,13 @@
+module Intercom
+  module ApiOperations
+    module Bulk
+      module LoadErrorFeed
+        def errors(params)
+          response = @client.get("/jobs/#{params.fetch(:id)}/error", {})
+          raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
+          from_api(response)
+        end
+      end
+    end
+  end
+end

data/lib/intercom/api_operations/bulk/submit.rb

@@ -0,0 +1,35 @@
+module Intercom
+  module ApiOperations
+    module Bulk
+      module Submit
+        def submit_bulk_job(params)
+          raise(ArgumentError, "events do not support bulk delete operations") if collection_class == Intercom::Event && !params.fetch(:delete_items, []).empty?
+          data_type = Utils.resource_class_to_singular_name(collection_class)
+          collection_name = Utils.resource_class_to_collection_name(collection_class)
+          create_items = params.fetch(:create_items, []).map { |item| item_for_api("post", data_type, item) }
+          delete_items = params.fetch(:delete_items, []).map { |item| item_for_api("delete", data_type, item) }
+          existing_job_id = params.fetch(:job_id, '')
+
+          bulk_request = {
+            items: create_items + delete_items
+          }
+          bulk_request[:job] = { id: existing_job_id } unless existing_job_id.empty?
+
+          response = @client.post("/bulk/#{collection_name}", bulk_request)
+          raise Intercom::HttpError.new('Http Error - No response entity returned') unless response
+          Intercom::Job.new.from_response(response)
+        end
+
+        private
+
+        def item_for_api(method, data_type, item)
+          {
+            method: method,
+            data_type: data_type,
+            data: item
+          }
+        end
+      end
+    end
+  end
+end

data/lib/intercom/client.rb

@@ -68,6 +68,10 @@ module Intercom
       Intercom::Service::User.new(self)
     end
 
+    def jobs
+      Intercom::Service::Job.new(self)
+    end
+
     def get(path, params)
       execute_request Intercom::Request.get(path, params)
     end

data/lib/intercom/job.rb

@@ -0,0 +1,7 @@
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class Job
+    include Traits::ApiResource
+  end
+end

data/lib/intercom/lib/dynamic_accessors_on_method_missing.rb

@@ -45,8 +45,8 @@ module Intercom
       end
 
       def trying_to_access_print_method?
-         [:to_ary, :to_s].include? method_sym
-       end
+        [:to_ary, :to_s].include? method_sym
+      end
 
       def attribute_not_set_error_message
         "'#{method_string}' called on #{klass} but it has not been set an " +

data/lib/intercom/service/event.rb

@@ -1,10 +1,12 @@
 require 'intercom/service/base_service'
 require 'intercom/api_operations/save'
+require 'intercom/api_operations/bulk/submit'
 
 module Intercom
   module Service
     class Event < BaseService
       include ApiOperations::Save
+      include ApiOperations::Bulk::Submit
 
       def collection_class
         Intercom::Event

data/lib/intercom/service/job.rb

@@ -0,0 +1,24 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/find'
+require 'intercom/api_operations/load'
+require 'intercom/api_operations/save'
+require 'intercom/api_operations/bulk/load_error_feed'
+
+module Intercom
+  module Service
+    class Job < BaseService
+      include ApiOperations::Save
+      include ApiOperations::List
+      include ApiOperations::FindAll
+      include ApiOperations::Find
+      include ApiOperations::Load
+      include ApiOperations::Bulk::LoadErrorFeed
+
+      def collection_class
+        Intercom::Job
+      end
+    end
+  end
+end

data/lib/intercom/service/user.rb

@@ -5,6 +5,7 @@ require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
 require 'intercom/api_operations/delete'
+require 'intercom/api_operations/bulk/submit'
 require 'intercom/extended_api_operations/tags'
 require 'intercom/extended_api_operations/segments'
 
@@ -17,6 +18,7 @@ module Intercom
       include ApiOperations::FindAll
       include ApiOperations::Save
       include ApiOperations::Delete
+      include ApiOperations::Bulk::Submit
       include ExtendedApiOperations::Tags
       include ExtendedApiOperations::Segments
 

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.2.0"
+  VERSION = "3.3.0"
 end

data/spec/unit/intercom/event_spec.rb

@@ -23,4 +23,105 @@ describe "Intercom::Event" do
     client.events.create(:event_name => "sale of item", :email => 'joe@example.com')
   end
 
+  describe 'bulk operations' do
+    let (:job) {
+      {
+        "app_id"=>"app_id",
+        "id"=>"super_awesome_job",
+        "created_at"=>1446033421,
+        "completed_at"=>1446048736,
+        "closing_at"=>1446034321,
+        "updated_at"=>1446048736,
+        "name"=>"api_bulk_job",
+        "state"=>"completed",
+        "links"=>
+          {
+            "error"=>"https://api.intercom.io/jobs/super_awesome_job/error",
+            "self"=>"https://api.intercom.io/jobs/super_awesome_job"
+          },
+        "tasks"=>
+          [
+            {
+              "id"=>"super_awesome_task",
+              "item_count"=>2,
+              "created_at"=>1446033421,
+              "started_at"=>1446033709,
+              "completed_at"=>1446033709,
+              "state"=>"completed"
+            }
+          ]
+        }
+    }
+    let(:bulk_request) {
+       {
+        items: [
+          {
+            method: "post",
+            data_type: "event",
+            data:{
+              event_name: "ordered-item",
+              created_at: 1438944980,
+              user_id: "314159",
+              metadata: {
+                order_date: 1438944980,
+                stripe_invoice: "inv_3434343434"
+              }
+            }
+          },
+          {
+            method: "post",
+            data_type: "event",
+            data:{
+              event_name: "invited-friend",
+              created_at: 1438944979,
+              user_id: "314159",
+              metadata: {
+                invitee_email: "pi@example.org",
+                invite_code: "ADDAFRIEND"
+              }
+            }
+          }
+        ]
+      }
+    }
+    let(:events) {
+      [
+        {
+          event_name: "ordered-item",
+          created_at: 1438944980,
+          user_id: "314159",
+          metadata: {
+            order_date: 1438944980,
+            stripe_invoice: "inv_3434343434"
+          }
+        },
+        {
+          event_name: "invited-friend",
+          created_at: 1438944979,
+          user_id: "314159",
+          metadata: {
+            invitee_email: "pi@example.org",
+            invite_code: "ADDAFRIEND"
+          }
+        }
+      ]
+    }
+
+    it "submits a bulk job" do
+      client.expects(:post).with("/bulk/events", bulk_request).returns(job)
+      client.events.submit_bulk_job(create_items: events)
+    end
+
+    it "adds events to an existing bulk job" do
+      bulk_request[:job] = {id: 'super_awesome_job'}
+      client.expects(:post).with("/bulk/events", bulk_request).returns(job)
+      client.events.submit_bulk_job(create_items: events, job_id: 'super_awesome_job')
+    end
+
+    it "does not submit delete jobs" do
+      lambda { client.events.submit_bulk_job(delete_items: events) }.must_raise ArgumentError
+    end
+
+  end
+
 end

data/spec/unit/intercom/job_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe "jobs" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+  let (:job) {
+    {
+      "app_id"=>"app_id",
+      "id"=>"super_awesome_job",
+      "created_at"=>1446033421,
+      "completed_at"=>1446048736,
+      "closing_at"=>1446034321,
+      "updated_at"=>1446048736,
+      "name"=>"api_bulk_job",
+      "state"=>"completed",
+      "links"=>
+        {
+          "error"=>"https://api.intercom.io/jobs/super_awesome_job/error",
+          "self"=>"https://api.intercom.io/jobs/super_awesome_job"
+        },
+      "tasks"=>
+        [
+          {
+            "id"=>"super_awesome_task",
+            "item_count"=>2,
+            "created_at"=>1446033421,
+            "started_at"=>1446033709,
+            "completed_at"=>1446033709,
+            "state"=>"completed"
+          }
+        ]
+      }
+  }
+  let (:error_feed) {
+    {
+      "app_id"=>"app_id",
+      "job_id"=>"super_awesome_job",
+      "pages"=>{},
+      "items"=>[]
+    }
+  }
+
+  it 'gets a job' do
+    client.expects(:get).with("/jobs/super_awesome_job", {}).returns(job)
+    client.jobs.find(id: 'super_awesome_job')
+  end
+
+  it 'gets a job\'s error feed' do
+    client.expects(:get).with("/jobs/super_awesome_job/error", {}).returns(error_feed)
+    client.jobs.errors(id: 'super_awesome_job')
+  end
+end

data/spec/unit/intercom/user_spec.rb

@@ -242,4 +242,85 @@ describe "Intercom::User" do
     p user
   end
 
+  describe 'bulk operations' do
+    let (:job) {
+      {
+        "app_id"=>"app_id",
+        "id"=>"super_awesome_job",
+        "created_at"=>1446033421,
+        "completed_at"=>1446048736,
+        "closing_at"=>1446034321,
+        "updated_at"=>1446048736,
+        "name"=>"api_bulk_job",
+        "state"=>"completed",
+        "links"=>
+          {
+            "error"=>"https://api.intercom.io/jobs/super_awesome_job/error",
+            "self"=>"https://api.intercom.io/jobs/super_awesome_job"
+          },
+        "tasks"=>
+          [
+            {
+              "id"=>"super_awesome_task",
+              "item_count"=>2,
+              "created_at"=>1446033421,
+              "started_at"=>1446033709,
+              "completed_at"=>1446033709,
+              "state"=>"completed"
+            }
+          ]
+        }
+    }
+    let(:bulk_request) {
+       {
+        items: [
+          {
+            method: "post",
+            data_type: "user",
+            data:{
+              user_id: 25,
+              email: "alice@example.com"
+            }
+          },
+          {
+            method: "delete",
+            data_type: "user",
+            data:{
+              user_id: 26,
+              email: "bob@example.com"
+            }
+          }
+        ]
+      }
+    }
+    let(:users_to_create) {
+      [
+        {
+          user_id: 25,
+          email: "alice@example.com"
+        }
+      ]
+    }
+    let(:users_to_delete) {
+      [
+        {
+          user_id: 26,
+          email: "bob@example.com"
+        }
+      ]
+    }
+
+    it "submits a bulk job" do
+      client.expects(:post).with("/bulk/users", bulk_request).returns(job)
+      client.users.submit_bulk_job(create_items: users_to_create, delete_items: users_to_delete)
+    end
+
+    it "adds users to an existing bulk job" do
+      bulk_request[:job] = {id: 'super_awesome_job'}
+      client.expects(:post).with("/bulk/users", bulk_request).returns(job)
+      client.users.submit_bulk_job(create_items: users_to_create, delete_items: users_to_delete, job_id: 'super_awesome_job')
+    end
+
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -129,6 +129,8 @@ files:
 - lib/ext/sliceable_hash.rb
 - lib/intercom.rb
 - lib/intercom/admin.rb
+- lib/intercom/api_operations/bulk/load_error_feed.rb
+- lib/intercom/api_operations/bulk/submit.rb
 - lib/intercom/api_operations/convert.rb
 - lib/intercom/api_operations/delete.rb
 - lib/intercom/api_operations/find.rb
@@ -147,6 +149,7 @@ files:
 - lib/intercom/extended_api_operations/segments.rb
 - lib/intercom/extended_api_operations/tags.rb
 - lib/intercom/extended_api_operations/users.rb
+- lib/intercom/job.rb
 - lib/intercom/lib/dynamic_accessors.rb
 - lib/intercom/lib/dynamic_accessors_on_method_missing.rb
 - lib/intercom/lib/flat_store.rb
@@ -163,6 +166,7 @@ files:
 - lib/intercom/service/conversation.rb
 - lib/intercom/service/count.rb
 - lib/intercom/service/event.rb
+- lib/intercom/service/job.rb
 - lib/intercom/service/message.rb
 - lib/intercom/service/note.rb
 - lib/intercom/service/segment.rb
@@ -186,6 +190,7 @@ files:
 - spec/unit/intercom/conversation_spec.rb
 - spec/unit/intercom/count_spec.rb
 - spec/unit/intercom/event_spec.rb
+- spec/unit/intercom/job_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
@@ -216,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
@@ -230,6 +235,7 @@ test_files:
 - spec/unit/intercom/conversation_spec.rb
 - spec/unit/intercom/count_spec.rb
 - spec/unit/intercom/event_spec.rb
+- spec/unit/intercom/job_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
@@ -240,4 +246,3 @@ test_files:
 - spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
 - spec/unit/intercom_spec.rb
-has_rdoc: