Merge pull request #593 from intercom/seanhealy/opedSubscription

Add opted out and in subscription types

Author: SeanHealy33

README.md

@@ -165,6 +165,16 @@ contact.remove_company(id: company.id)
 
 # List companies for a contact
 contact.companies.each {|c| p c.name}
+
+# attach a subscription_types on a contact
+contact.create_subscription_types(id: '1')
+
+# List subscription_types for a contact
+contact.subscription_types.each {|n| p n.body}
+
+# Remove subscription_types
+contact.remove_subscription_type({ "id": subscription.id })
+
 ```
 
 #### Visitors
@@ -596,6 +606,19 @@ intercom.subscriptions.delete(subscription)
 intercom.subscriptions.all
 ```
 
+
+#### Subscription Types
+
+Subscribe to events in Intercom to receive webhooks.
+
+```ruby
+
+# fetch a subscription
+intercom.subscription_types.find(id: "1")
+
+intercom.subscription_types.all
+```
+
 #### Articles
 
 ```ruby

lib/intercom.rb

@@ -12,6 +12,7 @@
 require 'intercom/service/message'
 require 'intercom/service/note'
 require 'intercom/service/job'
+require 'intercom/service/subscription_type'
 require 'intercom/service/subscription'
 require 'intercom/service/segment'
 require 'intercom/service/section'
@@ -44,6 +45,7 @@
 require 'intercom/article'
 require 'intercom/request'
 require 'intercom/subscription'
+require 'intercom/subscription_type'
 require 'intercom/team'
 require 'intercom/errors'
 require 'intercom/visitor'

lib/intercom/api_operations/nested_resource.rb

@@ -13,9 +13,7 @@ def nested_resource_methods(resource,
           raise ArgumentError, 'operations array required' if operations.nil?
 
           resource_url_method = :"#{resource_plural}_url"
-
           resource_name = Utils.resource_class_to_collection_name(self)
-
           define_method(resource_url_method.to_sym) do |id, nested_id = nil|
             url = "/#{resource_name}/#{id}/#{path}"
             url += "/#{nested_id}" unless nested_id.nil?

lib/intercom/client.rb

@@ -84,6 +84,10 @@ def subscriptions
       Intercom::Service::Subscription.new(self)
     end
 
+    def subscription_types
+      Intercom::Service::SubscriptionType.new(self)
+    end
+
     def segments
       Intercom::Service::Segment.new(self)
     end

lib/intercom/contact.rb

@@ -12,6 +12,7 @@ class Contact
 
     nested_resource_methods :tag, operations: %i[add delete list]
     nested_resource_methods :note, operations: %i[create list]
+    nested_resource_methods :subscription_type, operations: %i[create delete list]
     nested_resource_methods :company, operations: %i[add delete list]
     nested_resource_methods :segment, operations: %i[list]
 

lib/intercom/service/subscription_type.rb

@@ -0,0 +1,18 @@
+require 'intercom/api_operations/list'
+require 'intercom/api_operations/find_all'
+require 'intercom/api_operations/find'
+
+module Intercom
+  module Service
+    class SubscriptionType < BaseService
+      include ApiOperations::List
+      include ApiOperations::Find
+      include ApiOperations::FindAll
+      include ApiOperations::Delete
+
+      def collection_class
+        Intercom::SubscriptionType
+      end
+    end
+  end
+end

lib/intercom/subscription_type.rb

@@ -0,0 +1,12 @@
+
+require 'intercom/traits/api_resource'
+
+module Intercom
+  class SubscriptionType
+    include Traits::ApiResource
+
+    def self.collection_proxy_class
+      Intercom::BaseCollectionProxy
+    end
+  end
+end

lib/intercom/utils.rb

@@ -25,6 +25,10 @@ def constantize(camel_cased_word)
         constant
       end
 
+      def camelize(snake_cased_word)
+        snake_cased_word.split(/_/).map(&:capitalize).join
+      end
+
       def resource_class_to_singular_name(resource_class)
         resource_name = resource_class.to_s.split('::')[-1]
         resource_name = maybe_underscore_name(resource_name)
@@ -40,7 +44,7 @@ def resource_class_to_collection_name(resource_class)
       end
 
       def constantize_resource_name(resource_name)
-        class_name = Utils.singularize(resource_name.capitalize)
+        class_name = camelize Utils.singularize(resource_name.capitalize)
         define_lightweight_class(class_name) unless Intercom.const_defined?(class_name, false)
         namespaced_class_name = "Intercom::#{class_name}"
         constantize namespaced_class_name

spec/unit/intercom/contact_spec.rb

@@ -282,6 +282,7 @@
     let(:contact) { Intercom::Contact.new(id: '1', client: client) }
     let(:contact_no_tags) { Intercom::Contact.new(id: '2', client: client, tags: []) }
     let(:company) { Intercom::Company.new(id: '1') }
+    let(:subscription) { Intercom::Subscription.new(id: '1', client: client) }
     let(:tag) { Intercom::Tag.new(id: '1') }
     let(:note) { Intercom::Note.new(body: "<p>Text for the note</p>") }
 
@@ -344,6 +345,11 @@
       contact.add_tag({ "id": tag.id })
     end
 
+    it 'removes a subscription to a contact' do
+      client.expects(:delete).with("/contacts/1/subscription_types/#{subscription.id}", "id": subscription.id).returns(subscription.to_hash)
+      contact.remove_subscription_type({ "id": subscription.id })
+    end
+
     it 'removes a tag from a contact' do
       client.expects(:delete).with("/contacts/1/tags/#{tag.id}", "id": tag.id ).returns(tag.to_hash)
       contact.remove_tag({ "id": tag.id })
@@ -393,6 +399,11 @@
         contact.create_note({body: note.body})
       end
 
+      it 'adds a subscription to a contact' do
+        client.expects(:post).with('/contacts/1/subscription_types', "id": subscription.id).returns(subscription.to_hash)
+        contact.create_subscription_type({ "id": subscription.id })
+      end
+
       it 'adds a tag to a contact' do
         client.expects(:post).with('/contacts/1/tags', "id": tag.id).returns(tag.to_hash)
         contact.add_tag({ "id": tag.id })