hubspot-api-client 3.2.0 → 7.0.0

data/sample-apps/webhooks-contacts-app/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: ../..
   specs:
-    hubspot-api-client (1.0.0)
+    hubspot-api-client (3.2.0)
       faraday (>= 0.14.0)
       json (~> 2.1, >= 2.1.0)
 

data/sample-apps/webhooks-contacts-app/README.md

@@ -1,16 +1,29 @@
-# HubSpot-ruby sample Webhooks Tutorial app
+# HubSpot-ruby sample Webhooks app
 
-This is a sample app for the [hubspot-ruby SDK](../../../../)
+This is a sample app for the [hubspot-ruby SDK](../../../..).
 Currently, this app focuses on demonstrating the functionality of [Webhooks API](https://developers.hubspot.com/docs-beta/crm/extensions), contact creation/deletion in particular.
 
-Please see the documentation on [How do I create an app in HubSpot?](https://developers.hubspot.com/docs/faq/how-do-i-create-an-app-in-hubspot)
+Please see the documentation on [Creating an app in HubSpot](https://developers.hubspot.com/docs-beta/creating-an-app)
 
 ### HubSpot Public API links used in this application
 
-  - [Initiate an Integration with OAuth 2.0](https://developers.hubspot.com/docs/methods/oauth2/initiate-oauth-integration)
-  - [Get OAuth 2.0 Access Token and Refresh Tokens](https://developers.hubspot.com/docs/methods/oauth2/get-access-and-refresh-tokens)
-  - [Refresh OAuth 2.0 Access Token](https://developers.hubspot.com/docs/methods/oauth2/refresh-access-token)
   - [Read a batch of contact objects by ID](https://developers.hubspot.com/docs-beta/crm/contacts)
+### Note on the Data Base
+This application uses MySQL database to store the events coming from Webhooks. There is a single events table:
+```
+create table if not exists events
+(
+    id              INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    event_type      VARCHAR(255),
+    object_id       int             default null,
+    event_id        bigint          default null,
+    occurred_at     bigint          default null,
+    property_name   varchar(255)    default null,
+    property_value  varchar(255)    default null,
+    created_at      datetime        default CURRENT_TIMESTAMP
+);
+```
+Please note that event_id sent by HubSpot needs to be stored as int
 
 ### Setup App
 
@@ -19,19 +32,15 @@ Make sure you have [Docker Compose](https://docs.docker.com/compose/) and [Ngrok
 ### Configure
 
 1. Copy .env.template to .env
-2. Paste your HUBSPOT_CLIENT_ID and HUBSPOT_CLIENT_SECRET
+2. Paste your HUBSPOT_CLIENT_ID, HUBSPOT_CLIENT_SECRET, HUBSPOT_APPLICATION_ID and HUBSPOT_DEVELOPER_API_KEY
 
 ### Running
 
-The best way to run this project (with the least configuration), is using docker compose. Change to the webroot and start it
+The best way to run this project (with the least configuration), is using docker compose.  Change to the webroot and start it
 
 ```bash
 docker-compose up --build
 ```
-In another terminal, run:
-```bash
-docker-compose run web rake db:create db:migrate
-```
 
 Copy Ngrok url from console. Now you should now be able to navigate to that url and use the application.
 
@@ -40,12 +49,6 @@ Copy Ngrok url from console. Now you should now be able to navigate to that url
 If you are using Ngrok free plan and testing the application with large amount of import/deletions of Contacts you are likely to see Ngrok "Too Many Connections" error.
 This is caused by a large amount of weebhooks events being sent to Ngrok tunnel. To avoid it you can deploy sample applications on your server w/o Ngrok or upgrade to Ngrok Enterprise version
 
-### Configure webhooks
-
-Required webhooks url should look like https://***.ngrok.io/webhooks/callback
-
-Following [Webhooks Setup](https://developers.hubspot.com/docs/methods/webhooks/webhooks-overview) guide please note:
-
-- Every time the app is restarted you should update the webhooks url
-- The app supports `contact.creation` and `contact.deletion` subscription types only
-- Subscription are paused by default. You need to activate them manually after creating
+### HubSpot Signature
+To help improve security, HubSpot webhooks are sent with signature so you can verify that it came from HubSpot. This sample application shows how to do that verification. You can read more about validation in general here: https://developers.hubspot.com/docs/api/webhooks/validating-requests.
+The source code for validating webhooks is at [hubspot\utils\webhooks](../../hubspot/utils/webhooks.py) and [an usage example](./src/routes/webhooks.py).

data/sample-apps/webhooks-contacts-app/app/assets/stylesheets/application.css

@@ -63,57 +63,8 @@
   color: #606c76
 }
 
-.company-new-button {
-  margin: 2rem;
-  margin-left: 0;
-}
-
-.error-wrapper .result {
-  color: white;
-  background-color: red;
-}
-
-input[type=datetime-local] {
-  width: 100%;
-  height: 3.8rem;
-  padding: .6rem 1.0rem;
-}
-
-h3.alert-success {
-  text-align: center;
-}
-
-.delete-button {
-  margin-bottom: 0;
-  float: right;
-  margin-right: 20px;
-}
-
-.delete-button input {
-  margin-bottom: 0;
-}
-
-company a {
-  color: #4e585f;
-  text-decoration: none;
-}
-
-.company a:hover {
-   text-decoration: none;
-   cursor: pointer;
-}
-
-.company .company-info {
-  display: block;
-}
-
-pre {
-  line-height: 0.7;
-}
-
-pre p {
-  margin: 0;
-  margin-left: 5px;
+.hidden {
+  display: none;
 }
 
 .event.deletion {
@@ -131,10 +82,11 @@ pre p {
   color: #ffffff;
 }
 
-.event.propertyChange span:first-child {
-  background-color: #08080885;
+.authorize-button {
+  justify-content: center;
 }
 
-.hidden {
-  display: none;
+.text-center {
+  text-align: center;
 }
+

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