intercom 3.0.0b1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b15f68c468eb6d078694a471e95551e20e709b0e
-  data.tar.gz: 36819fd55b2cf627ec08006431cc64bb23094fe3
+  metadata.gz: bf276d9bcb6ec4c0a10de9e8f8ed2b665b37e88f
+  data.tar.gz: a72b07089606ba2f439acf3de33b702795669c1c
 SHA512:
-  metadata.gz: 0603c5eaad0d8bd02c285cad70cfd0356492bad00d4119d10ed317aeb2817d7c5466aad6796481e9a4fc07133e07928263cd39f22381faca31857afd089e056f
-  data.tar.gz: d7aec86d14f294f9bfa1b1537c4079cd93e775d6abb54a982c0e7ea0415f22f439eae50dc546d7af2a1c36bb98a79829b323907c4c6de31e49e40a41e46daedc
+  metadata.gz: 9fa345d1fb399d0b1c96da4e135cb751bc3138d2dd9e306541e9f606939d61aaafb259640a205f2ea7c16fa95725be3c19cb536d6f734b9afb7ccf891cb0ac98
+  data.tar.gz: 604e7edbfc96a8023591ced851914cc8c890845358b921b9db2a3db620150e61724a489418e666baaf200559ab4b1563a946b2ee7403e445dfed0229c0da0124

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.0.0b1"
+    gem 'intercom', "~> 3.0.0"
 
 ## Basic Usage
 
@@ -32,7 +32,7 @@ Using bundler:
 intercom = Intercom::Client.new(app_id: 'my_app_id', api_key: 'my_api_key')
 ```
 
-You can get your `app_id` from the URL when you're logged into Intercom (it's the alphanumeric just after `/apps/`) and your API key from the API keys integration settings page (under your app settings - integrations in Intercom). 
+You can get your `app_id` from the URL when you're logged into Intercom (it's the alphanumeric just after `/apps/`) and your API key from the API keys integration settings page (under your app settings - integrations in Intercom).
 
 ### Resources
 
@@ -41,6 +41,7 @@ Resources this API supports:
     https://api.intercom.io/users
     https://api.intercom.io/contacts
     https://api.intercom.io/companies
+    https://api.intercom.io/counts
     https://api.intercom.io/tags
     https://api.intercom.io/notes
     https://api.intercom.io/segments
@@ -111,7 +112,7 @@ intercom.companies.users(company.id)
 # Tag users
 tag = intercom.tags.tag(name: 'blue', users: [{email: "test1@example.com"}])
 # Untag users
-intercom.tags.untag_users('blue',  users: [{user_id: "42ea2f1b93891f6a99000427"}])
+intercom.tags.untag(name: 'blue',  users: [{user_id: "42ea2f1b93891f6a99000427"}])
 # Iterate over all tags
 intercom.tags.all.each {|tag| "#{tag.id} - #{tag.name}" }
 intercom.tags.all.map {|tag| tag.name }
@@ -313,6 +314,16 @@ contacts = intercom.contacts.find_all(email: "some_contact@example.com")
 intercom.contacts.convert(contact, user)
 ```
 
+### Counts
+
+```ruby
+# App-wide counts
+intercom.counts.for_app
+
+# Users in segment counts
+intercom.counts.for_type(type: 'user', count: 'segment')
+```
+
 ### Subscriptions
 
 Subscribe to events in Intercom to receive webhooks.

data/lib/intercom.rb

@@ -3,6 +3,7 @@ require 'intercom/service/admin'
 require 'intercom/service/company'
 require 'intercom/service/contact'
 require 'intercom/service/conversation'
+require 'intercom/service/count'
 require 'intercom/service/event'
 require 'intercom/service/message'
 require 'intercom/service/note'
@@ -13,6 +14,7 @@ require 'intercom/service/user'
 require 'intercom/options'
 require 'intercom/client'
 require "intercom/contact"
+require "intercom/count"
 require "intercom/user"
 require "intercom/company"
 require "intercom/note"

data/lib/intercom/client.rb

@@ -36,6 +36,10 @@ module Intercom
       Intercom::Service::Conversation.new(self)
     end
 
+    def counts
+      Intercom::Service::Counts.new(self)
+    end
+
     def events
       Intercom::Service::Event.new(self)
     end

data/lib/intercom/count.rb

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

data/lib/intercom/service/count.rb

@@ -0,0 +1,22 @@
+require 'intercom/service/base_service'
+require 'intercom/api_operations/find'
+
+module Intercom
+  module Service
+    class Counts < BaseService
+      include ApiOperations::Find
+
+      def collection_class
+        Intercom::Count
+      end
+
+      def for_app
+        find({})
+      end
+
+      def for_type(type:, count: nil)
+        find(type: type, count: count)
+      end
+    end
+  end
+end

data/lib/intercom/version.rb

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

data/spec/spec_helper.rb

@@ -405,6 +405,49 @@ def test_subscription
         "notes"=>[]}}
 end
 
+def test_app_count
+  {
+    "type" => "count.hash",
+    "company" => {
+      "count" => 8
+    },
+    "segment" => {
+      "count" => 47
+    },
+    "tag" => {
+      "count" => 341
+    },
+    "user" => {
+      "count" => 12239
+    }
+  }
+end
+
+def test_segment_count
+  {
+    "type" => "count",
+    "user" => {
+      "segment" => [
+        {
+          "Active" => 1
+        },
+        {
+          "New" => 0
+        },
+        {
+          "VIP" => 0
+        },
+        {
+          "Slipping Away" => 0
+        },
+        {
+          "segment 1" => 1
+        }
+      ]
+    }
+  }
+end
+
 def error_on_modify_frozen
   RUBY_VERSION =~ /1.8/ ? TypeError : RuntimeError
 end

data/spec/unit/intercom/count_spec.rb

@@ -0,0 +1,17 @@
+require "spec_helper"
+
+describe "Intercom::Count" do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it 'should get app wide counts' do
+    client.expects(:get).with("/counts", {}).returns(test_app_count)
+    counts = client.counts.for_app
+    counts.tag['count'].must_equal(341)
+  end
+
+  it 'should get type counts' do
+    client.expects(:get).with("/counts", {type: 'user', count: 'segment'}).returns(test_segment_count)
+    counts = client.counts.for_type(type: 'user', count: 'segment')
+    counts.user['segment'][4]["segment 1"].must_equal(1)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.0.0b1
+  version: 3.0.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -127,6 +127,7 @@ files:
 - 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/segments.rb
@@ -146,6 +147,7 @@ files:
 - lib/intercom/service/company.rb
 - lib/intercom/service/contact.rb
 - lib/intercom/service/conversation.rb
+- lib/intercom/service/count.rb
 - lib/intercom/service/event.rb
 - lib/intercom/service/message.rb
 - lib/intercom/service/note.rb
@@ -168,6 +170,7 @@ files:
 - spec/unit/intercom/company_spec.rb
 - spec/unit/intercom/contact_spec.rb
 - spec/unit/intercom/conversation_spec.rb
+- spec/unit/intercom/count_spec.rb
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb
@@ -194,9 +197,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: intercom
 rubygems_version: 2.2.2
@@ -211,6 +214,7 @@ test_files:
 - spec/unit/intercom/company_spec.rb
 - spec/unit/intercom/contact_spec.rb
 - spec/unit/intercom/conversation_spec.rb
+- spec/unit/intercom/count_spec.rb
 - spec/unit/intercom/event_spec.rb
 - spec/unit/intercom/lib/flat_store_spec.rb
 - spec/unit/intercom/message_spec.rb