Merge pull request #160 from intercom/jo/counts-api

counts api

Author: josler

README.md

@@ -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
@@ -313,6 +314,16 @@ contacts = intercom.contacts.find_all(email: "[email protected]")
 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.

lib/intercom.rb

@@ -3,6 +3,7 @@
 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/options'
 require 'intercom/client'
 require "intercom/contact"
+require "intercom/count"
 require "intercom/user"
 require "intercom/company"
 require "intercom/note"

lib/intercom/client.rb

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

lib/intercom/count.rb

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

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

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

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