hubspot-api-client 3.1.1 → 6.0.0

data/sample-apps/webhooks-contacts-app/app/controllers/events_controller.rb

@@ -2,9 +2,14 @@ class EventsController < ApplicationController
   MAX_BATCH_SIZE = 100
 
   before_action :authorize
-  before_action :contacts, only: %i[index]
 
   def index
+    @events = Event.all
+    contact_id_batches = @events.map(&:object_id).uniq.each_slice(MAX_BATCH_SIZE).to_a
+    @contacts = contact_id_batches.each_with_object({}) do |batch, memo|
+      batch = Services::Hubspot::Contacts::GetBatch.new(batch).call
+      batch.each { |contact| memo[contact[:id]] = { name: contact[:name] } }
+    end
   end
 
   def not_shown_count
@@ -20,14 +25,7 @@ class EventsController < ApplicationController
       session['tokens'] = Token.instance.attributes
     end
 
-    session['tokens'] = Services::Authorization::Tokens::Refresh.new(tokens: session['tokens'], request: request).call
-    Services::Authorization::AuthorizeHubspot.new(tokens: session['tokens']).call
-  end
-
-  def contacts
-    contact_id_batches = Event.all.map(&:object_id).uniq.each_slice(MAX_BATCH_SIZE).to_a
-    @contacts = contact_id_batches.each_with_object([]) do |batch, memo|
-      memo.concat Services::Hubspot::Contacts::GetBatch.new(batch).call
-    end
+    session['tokens'] = Services::Hubspot::Authorization::Tokens::Refresh.new(tokens: session['tokens'], request: request).call
+    Services::Hubspot::Authorization::Authorize.new(tokens: session['tokens']).call
   end
 end

data/sample-apps/webhooks-contacts-app/app/controllers/home_controller.rb

@@ -0,0 +1,44 @@
+class HomeController < ApplicationController
+  before_action :authorize
+
+  def index
+    @target_url = url_for(controller: :webhooks, action: :callback, only_path: false, protocol: 'https')
+  end
+
+  def start
+    ::Hubspot.configure do |config|
+      config.api_key = { 'hapikey' => ENV['HUBSPOT_DEVELOPER_API_KEY'] }
+    end
+
+    app_id = ENV['HUBSPOT_APPLICATION_ID']
+    Services::Hubspot::Webhooks::PauseActiveSubscriptions.new(app_id: app_id).call
+
+    target_url = url_for(controller: :webhooks, action: :callback, only_path: false, protocol: 'https')
+    Services::Hubspot::Webhooks::ConfigureTargetUrl.new(app_id: app_id, target_url: target_url).call
+
+    subscriptions = [
+      {"event_type": "contact.propertyChange", "property_name": "firstname"},
+      {"event_type": "contact.creation"},
+      {"event_type": "contact.deletion"},
+    ]
+
+    subscriptions.each do |subscription|
+      Services::Hubspot::Webhooks::CreateOrActivateSubscription.new(app_id: app_id, **subscription).call
+    end
+
+    redirect_to controller: :events, action: :index
+  end
+
+  private
+
+  def authorize
+    unless authorized?
+      redirect_to login_path and return unless Token.any?
+
+      session['tokens'] = Token.instance.attributes
+    end
+
+    session['tokens'] = Services::Hubspot::Authorization::Tokens::Refresh.new(tokens: session['tokens'], request: request).call
+    Services::Hubspot::Authorization::Authorize.new(tokens: session['tokens']).call
+  end
+end

data/sample-apps/webhooks-contacts-app/app/controllers/oauth/authorization_controller.rb

@@ -1,19 +1,19 @@
 module Oauth
   class AuthorizationController < ApplicationController
     def authorize
-      url = Services::Authorization::GetAuthorizationUri.new(request: request).call
+      url = Services::Hubspot::Authorization::GetAuthorizationUri.new(request: request).call
       redirect_to url
     end
 
     def callback
-      tokens = Services::Authorization::Tokens::Generate.new(
+      session[:tokens] = Services::Hubspot::Authorization::Tokens::Generate.new(
         code: params[:code],
         request: request
       ).call
-      Token.instance.update!(tokens)
-      session['tokens'] = tokens
-      Services::Authorization::AuthorizeHubspot.new(tokens: tokens).call
-      redirect_to '/events'
+      Services::Hubspot::Authorization::Authorize.new(tokens: session[:tokens]).call
+      redirect_to '/'
     end
+
+    def login;end
   end
 end

data/sample-apps/webhooks-contacts-app/app/controllers/webhooks_controller.rb

@@ -3,7 +3,7 @@ class WebhooksController < ApplicationController
 
   def callback
     webhooks = JSON.parse(request.raw_post)
-    webhooks.each { |webhook| Services::Hubspot::Webhooks::Handle.new(webhook).call }
+    webhooks.each { |webhook| Services::Hubspot::Webhooks::Handle.new(webhook: webhook, request: request).call }
     render json: {}
   end
 end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/authorize.rb

@@ -0,0 +1,17 @@
+module Services
+  module Hubspot
+    module Authorization
+      class Authorize
+        def initialize(tokens:)
+          @tokens = tokens
+        end
+
+        def call
+          ::Hubspot.configure do |config|
+            config.access_token = @tokens[:access_token]
+          end
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/get_authorization_uri.rb

@@ -0,0 +1,35 @@
+module Services
+  module Hubspot
+    module Authorization
+      class GetAuthorizationUri
+        CALLBACK_PATH = '/oauth/callback'.freeze
+
+        def initialize(request:)
+          @request = request
+        end
+
+        def call
+          check_presence_of_credentials
+
+          ::Hubspot::OAuthHelper.authorize_url(
+            client_id: ENV['HUBSPOT_CLIENT_ID'],
+            redirect_uri: redirect_uri,
+            scope: %w[contacts]
+          )
+        end
+
+        private
+
+        def redirect_uri
+          @request.protocol + @request.host_with_port + CALLBACK_PATH
+        end
+
+        def check_presence_of_credentials
+          return if ENV['HUBSPOT_CLIENT_ID'].present?
+
+          raise(ExceptionHandler::HubspotError.new, 'Please specify HUBSPOT_CLIENT_ID in .env')
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/base.rb

@@ -0,0 +1,21 @@
+module Services
+  module Hubspot
+    module Authorization
+      module Tokens
+        class Base
+          CALLBACK_PATH = '/oauth/callback'.freeze
+
+          def expires_at(expires_in)
+            Time.current + (expires_in * 0.95).round
+          end
+
+          private
+
+          def redirect_uri
+            @request.protocol + @request.host_with_port + CALLBACK_PATH
+          end
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/generate.rb

@@ -0,0 +1,28 @@
+module Services
+  module Hubspot
+    module Authorization
+      module Tokens
+        class Generate < Tokens::Base
+          def initialize(code:, request:)
+            @code = code
+            @request = request
+          end
+
+          def call
+            default_api = ::Hubspot::OAuth::DefaultApi.new
+            tokens = default_api.create_token(
+              grant_type: :authorization_code,
+              code: @code,
+              redirect_uri: redirect_uri,
+              client_id: ENV['HUBSPOT_CLIENT_ID'],
+              client_secret: ENV['HUBSPOT_CLIENT_SECRET'],
+              return_type: 'Object'
+            )
+            tokens[:expires_at] = expires_at(tokens[:expires_in])
+            tokens
+          end
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/authorization/tokens/refresh.rb

@@ -0,0 +1,35 @@
+module Services
+  module Hubspot
+    module Authorization
+      module Tokens
+        class Refresh < Tokens::Base
+          def initialize(tokens:, request:)
+            @tokens = tokens
+            @request = request
+          end
+
+          def call
+            @tokens = refresh_tokens if Time.current > @tokens[:expires_at]
+            @tokens
+          end
+
+          private
+
+          def refresh_tokens
+            default_api = ::Hubspot::OAuth::DefaultApi.new
+            tokens = default_api.create_token(
+              grant_type: :refresh_token,
+              refresh_token: @tokens[:refresh_token],
+              redirect_uri: redirect_uri,
+              client_id: ENV['HUBSPOT_CLIENT_ID'],
+              client_secret: ENV['HUBSPOT_CLIENT_SECRET'],
+              return_type: 'Object'
+            )
+            tokens[:expires_at] = expires_at(tokens[:expires_in])
+            tokens
+          end
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/configure_target_url.rb

@@ -0,0 +1,25 @@
+module Services
+  module Hubspot
+    module Webhooks
+      class ConfigureTargetUrl
+        def initialize(app_id:, target_url:)
+          @app_id = app_id
+          @target_url = target_url
+        end
+
+        def call
+          ::Hubspot::Webhooks::SettingsApi.new.configure(
+            @app_id,
+            settings_change_request(@target_url)
+          )
+        end
+
+        private
+
+        def settings_change_request(target_url)
+          ::Hubspot::Webhooks::SettingsChangeRequest.new(target_url: target_url)
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/create_or_activate_subscription.rb

@@ -0,0 +1,44 @@
+module Services
+  module Hubspot
+    module Webhooks
+      class CreateOrActivateSubscription
+        def initialize(app_id:, event_type:, property_name: nil)
+          @app_id = app_id
+          @event_type = event_type
+          @property_name = property_name
+        end
+
+        def call
+          begin
+            request = subscription_create_request(event_type: @event_type, property_name: @property_name)
+            ::Hubspot::Webhooks::SubscriptionsApi.new.create(
+              @app_id,
+              request
+            )
+          rescue => e
+            existing_subscription_id = JSON.parse(JSON.parse(e.response_body)['context']['subscriptionIds'][0])[0]
+            ::Hubspot::Webhooks::SubscriptionsApi.new.update(
+              existing_subscription_id,
+              @app_id,
+              subscription_patch_request: subscription_patch_request
+            )
+          end
+        end
+
+        private
+
+        def subscription_create_request(event_type:, property_name:)
+          ::Hubspot::Webhooks::SubscriptionCreateRequest.new(
+            active: true,
+            event_type: event_type,
+            property_name: property_name,
+         )
+        end
+
+        def subscription_patch_request
+          ::Hubspot::Webhooks::SubscriptionPatchRequest.new(enabled: true)
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/handle.rb

@@ -2,11 +2,13 @@ module Services
   module Hubspot
     module Webhooks
       class Handle
-        def initialize(webhook)
+        def initialize(webhook:, request:)
           @webhook = webhook
+          @request = request
         end
 
         def call
+          validate_signature
           create_event
         end
 
@@ -28,6 +30,16 @@ module Services
           end
           event.save!
         end
+
+        def validate_signature
+          ::Hubspot::Helpers::WebhooksHelper.validate_signature(
+            signature: @request.headers['X-HubSpot-Signature'],
+            signature_version: @request.headers['X-HubSpot-Signature-Version'],
+            http_uri: @request.base_url,
+            request_body: @request.raw_post,
+            client_secret: ENV["HUBSPOT_CLIENT_SECRET"]
+          )
+        end
       end
     end
   end

data/sample-apps/webhooks-contacts-app/app/lib/services/hubspot/webhooks/pause_active_subscriptions.rb

@@ -0,0 +1,39 @@
+module Services
+  module Hubspot
+    module Webhooks
+      class PauseActiveSubscriptions
+        def initialize(app_id:)
+          @app_id = app_id
+        end
+
+        def call
+          return false if active_subscriptions.empty?
+
+          inputs = active_subscriptions.map do |subscription|
+            ::Hubspot::Webhooks::SubscriptionBatchUpdateRequest.new(
+              id: subscription.id,
+              active: false
+            )
+          end
+
+          batch_input_subscription_batch_update_request =
+            ::Hubspot::Webhooks::BatchInputSubscriptionBatchUpdateRequest.new(inputs: inputs)
+
+          ::Hubspot::Webhooks::SubscriptionsApi.new.update_batch(
+            @app_id,
+            batch_input_subscription_batch_update_request
+          )
+        end
+
+        private
+
+        def active_subscriptions
+          return @active_subscriptions if @active_subscriptions.present?
+
+          subscriptions = ::Hubspot::Webhooks::SubscriptionsApi.new.get_all(@app_id).results
+          @active_subscriptions = subscriptions.filter(&:active)
+        end
+      end
+    end
+  end
+end

data/sample-apps/webhooks-contacts-app/app/models/event.rb

@@ -1,2 +1,5 @@
 class Event < ApplicationRecord
+  def occured_at
+    Time.at(self[:occured_at].to_i / 1000)
+  end
 end

data/sample-apps/webhooks-contacts-app/app/views/events/index.html.erb

@@ -9,26 +9,24 @@
           <tr>
             <th>Contact ID</th>
             <th>Contact Name</th>
-            <th>Event type</th>
+            <th>Event</th>
+            <th>Occurred At</th>
           </tr>
         </thead>
         <tbody>
-          <% @contacts.each do |contact| %>
+          <% @events.each do |event| %>
             <tr>
-              <td><%= contact[:id] %></td>
-              <td><%= contact[:name] %></td>
+              <td><%= event.object_id %></td>
               <td>
-              <% contact[:events].map do |event| %>
-                <span class="event <%= event.event_type %>">
-                  <%= event.event_type %>
-                  <% if event.property_name.present? %>
-                    <span><%= event.property_name %></span>
-                  <% end %>
-                  <% if event.property_value.present? %>
-                    <span><%= event.property_value %></span>
-                  <% end %>
-                </span>
-              <% end %>
+                <% if @contacts.keys.include? event.object_id %>
+                  <%= @contacts[event.object_id][:name] %>
+                <% end %>
+              </td>
+              <td>
+                <span class="event <%= event.event_type.split('.')[0] %>"><%= event.event_type %></span>
+              </td>
+              <td>
+                <%= event.occured_at %>
               </td>
             </tr>
           <% end %>
@@ -38,4 +36,4 @@
         <h3 id="empty-message">Webhooks haven't been received yet.</h3>
       <% end %>
   <% end %>
-</div>
+</div>