hubspot-api-client 7.1.1 → 9.0.0

data/sample-apps/timeline-events-app/app/controllers/application_controller.rb

@@ -0,0 +1,12 @@
+class ApplicationController < ActionController::Base
+  include ExceptionHandler
+
+  before_action :check_env_variables
+
+  private
+
+  def check_env_variables
+    missing_vars = %w[HUBSPOT_CLIENT_ID HUBSPOT_CLIENT_SECRET].select { |var| ENV[var].blank? }
+    raise(ExceptionHandler::HubspotError.new, "Please specify #{missing_vars.join(', ')} in .env") if missing_vars.present?
+  end
+end

data/sample-apps/timeline-events-app/app/controllers/concerns/exception_handler.rb

@@ -0,0 +1,12 @@
+module ExceptionHandler
+  extend ActiveSupport::Concern
+
+  class HubspotError < StandardError; end
+
+  included do
+    rescue_from HubspotError do |error|
+      @error = error
+      render template: 'timeline_events/index'
+    end
+  end
+end

data/sample-apps/timeline-events-app/app/controllers/oauth/authorization_controller.rb

@@ -0,0 +1,19 @@
+module Oauth
+  class AuthorizationController < ApplicationController
+    def authorize
+      url = Services::Authorization::GetAuthorizationUri.new(request: request).call
+      redirect_to url
+    end
+
+    def callback
+      session[:tokens] = Services::Authorization::Tokens::Generate.new(
+        code: params[:code],
+        request: request
+      ).call
+      Services::Authorization::AuthorizeHubspot.new(tokens: session[:tokens]).call
+      redirect_to root_path
+    end
+
+    def login;end
+  end
+end

data/sample-apps/timeline-events-app/app/controllers/timeline_events_controller.rb

@@ -0,0 +1,37 @@
+class TimelineEventsController < ApplicationController
+  before_action :authorize
+
+  def index
+    return unless params[:contact_id]
+
+    @contacts_url = 'https://app.hubspot.com/contacts/' + ENV['HUBSPOT_PORTAL_ID'] +
+                    '/contact/' + params[:contact_id]
+  end
+
+  def create
+    if email_valid?
+      template = Services::Hubspot::Timeline::CreateTemplate.new(template_params).call
+      event = Services::Hubspot::Timeline::CreateEvent.new(template_params[:email], template.id).call
+      redirect_to root_path(contact_id: event.object_id)
+    else
+      redirect_to root_path, flash: { error: "Error: we can't find this email in your contacts list." }
+    end
+  end
+
+  private
+
+  def email_valid?
+    Services::Hubspot::Contacts::Search.new(email: template_params[:email]).call.present?
+  end
+
+  def template_params
+    params.require(:event_template).permit(:email, :target_record_type, :header_template, :detail_template)
+  end
+
+  def authorize
+    redirect_to login_path and return if session['tokens'].blank?
+
+    session['tokens'] = Services::Authorization::Tokens::Refresh.new(tokens: session['tokens'], request: request).call
+    Services::Authorization::AuthorizeHubspot.new(tokens: session['tokens']).call
+  end
+end

data/sample-apps/timeline-events-app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/sample-apps/timeline-events-app/app/lib/services/authorization/authorize_hubspot.rb

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

data/sample-apps/timeline-events-app/app/lib/services/authorization/get_authorization_uri.rb

@@ -0,0 +1,33 @@
+module Services
+  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

data/sample-apps/timeline-events-app/app/lib/services/authorization/tokens/base.rb

@@ -0,0 +1,19 @@
+module Services
+  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

data/sample-apps/timeline-events-app/app/lib/services/authorization/tokens/generate.rb

@@ -0,0 +1,26 @@
+module Services
+  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

data/sample-apps/timeline-events-app/app/lib/services/authorization/tokens/refresh.rb

@@ -0,0 +1,33 @@
+module Services
+  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

data/sample-apps/timeline-events-app/app/lib/services/hubspot/contacts/search.rb

@@ -0,0 +1,37 @@
+module Services
+  module Hubspot
+    module Contacts
+      class Search
+        def initialize(email:)
+          @email = email
+        end
+
+        def call
+          search_api = ::Hubspot::Crm::Contacts::SearchApi.new
+          results = search_api.do_search(search_request, auth_names: 'oauth2').results
+          results = add_fullnames(results)
+          results
+        end
+
+        private
+
+        def search_request
+          filter = ::Hubspot::Crm::Contacts::Filter.new(
+            property_name: 'email',
+            operator: 'EQ',
+            value: @email
+          )
+          filter_group = ::Hubspot::Crm::Contacts::FilterGroup.new(filters: [filter])
+          ::Hubspot::Crm::Contacts::PublicObjectSearchRequest.new(filter_groups: [filter_group])
+        end
+
+        def add_fullnames(contacts)
+          contacts.each do |contact|
+            fullname = [contact.properties['firstname'], contact.properties['lastname']].reject(&:empty?).join(' ')
+            contact.properties['fullname'] = fullname
+          end
+        end
+      end
+    end
+  end
+end

data/sample-apps/timeline-events-app/app/lib/services/hubspot/timeline/create_event.rb

@@ -0,0 +1,20 @@
+module Services
+  module Hubspot
+    module Timeline
+      class CreateEvent
+        def initialize(email, template_id)
+          @email = email
+          @template_id = template_id
+        end
+
+        def call
+          timeline_event = ::Hubspot::Crm::Timeline::TimelineEvent.new(
+            email: @email,
+            event_template_id: @template_id
+          )
+          ::Hubspot::Crm::Timeline::EventsApi.new.create(timeline_event: timeline_event)
+        end
+      end
+    end
+  end
+end

data/sample-apps/timeline-events-app/app/lib/services/hubspot/timeline/create_template.rb

@@ -0,0 +1,39 @@
+module Services
+  module Hubspot
+    module Timeline
+      class CreateTemplate
+        def initialize(template_params)
+          @template_params = template_params
+        end
+
+        def call
+          api_client = api_client_with_hapikey
+          create_api = ::Hubspot::Crm::Timeline::TemplatesApi.new(api_client)
+          create_api.create(
+            ENV['HUBSPOT_APPLICATION_ID'],
+            timeline_event_template_create_request: template_create_request,
+            auth_names: 'hapikey'
+          )
+        end
+
+        private
+
+        def template_create_request
+          ::Hubspot::Crm::Timeline::TimelineEventTemplateCreateRequest.new(
+            object_type: @template_params[:target_record_type],
+            name: 'Test event template name',
+            header_template: @template_params[:header_template],
+            detail_template: @template_params[:detail_template]
+          )
+        end
+
+        def api_client_with_hapikey
+          config = ::Hubspot::Crm::Timeline::Configuration.new do |config|
+            config.api_key = { 'hapikey' => ENV['HUBSPOT_DEVELOPER_API_KEY'] }
+          end
+          ::Hubspot::Crm::Timeline::ApiClient.new(config)
+        end
+      end
+    end
+  end
+end

data/sample-apps/timeline-events-app/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/sample-apps/timeline-events-app/app/views/layouts/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>HubSpot Ruby sample timeline events app</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Roboto:300,300italic,700,700italic">
+    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/normalize/5.0.0/normalize.css">
+    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/milligram/1.3.0/milligram.css">
+
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
+
+  <body>
+    <%= render partial: "shared/header"%>
+    <div class="wrapper">
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/sample-apps/timeline-events-app/app/views/oauth/authorization/login.html.erb

@@ -0,0 +1,15 @@
+<div class="container">
+  <pre>
+    <p>// app/lib/services/authorization/get_authorization_uri.rb - Generate URL for OAuth</p>
+
+    <p>::Hubspot::OAuthHelper.authorize_url(</p>
+    <p>  client_id: 'client_id',</p>
+    <p>  redirect_uri: redirect_uri,</p>
+    <p>  scope: %w[contacts]</p>
+    <p>)</p>
+  </pre>
+  <h3 class="text-center">In order to continue please authorize via OAuth</h3>
+  <div class="row authorize-button">
+      <a class="button" href="/oauth">Authorize</a>
+  </div>
+</div>

data/sample-apps/timeline-events-app/app/views/shared/_header.html.erb

@@ -0,0 +1,12 @@
+<nav class="navigation">
+  <div class="container">
+    <a class="navigation-title" href="/">
+      <h3 class="title">HubSpot Ruby Sample Timeline Events App</h3>
+    </a>
+    <ul class="navigation-list float-right">
+      <li class="navigation-item">
+        <a class="navigation-link" href="/oauth">OAuth2</a>
+      </li>
+    </ul>
+  </div>
+</nav>

data/sample-apps/timeline-events-app/app/views/timeline_events/index.html.erb

@@ -0,0 +1,53 @@
+<div class='container'>
+  <% if flash[:error] %>
+    <div class='alert'>
+      <span class='closebtn' onclick="this.parentElement.style.display='none';">&times;</span>
+      <%= flash[:error] %>
+    </div>
+  <% end %>
+
+  <div class='template-form'>
+    <h3>Create New Event Template:</h3>
+
+    <%= form_for :event_template, url: create_path do |form| %>
+
+      <div class='form-groups'>
+        <%= form.label :target_record_type, 'Target record type:' %>
+        <%= form.select :target_record_type, ['Contact'], {}, disabled: true %>
+        <%= form.hidden_field :target_record_type, value: 'contacts' %>
+
+        <%= form.label :header_template, 'Header template:' %>
+        <%= form.text_area :header_template, placeholder: 'Set a header tempalte for this event', class: 'textarea' %>
+
+        <%= form.label :detail_template, 'Details template:' %>
+        <%= form.text_area :detail_template, placeholder: 'Set a details template for this event', class: 'textarea' %>
+
+        <%= form.label :email, 'Email of the contact on whose timeline you want to render the event:' %>
+        <%= form.email_field :email, required: true, placeholder: 'Email' %>
+      </div>
+
+      <pre>
+        <h4> What will happen if you press the button:</h4>
+        <p> 1) New event template will be created</p>
+        <p> 2) Object timeline will be populated with a new event (specified above)</p>
+      </pre>
+
+      <%= form.submit 'Render Timeline Event' %>
+    <% end  %>
+  </div>
+
+  <% if @contacts_url %>
+    <h3>The result of creating timeline event:</h3>
+    <pre>
+      <p>In order to see your newly created timeline events:</p>
+
+      <p> 1) Click on the "Filter activity".</p>
+      <p> 2) Find and choose your app in "Integrations" section.</p>
+      <p> 3) After that you will be able to see the list of your events.</p>
+    </pre>
+
+    <div class='contacts-iframe'>
+      <iframe src= <%= @contacts_url %> ></iframe>
+    </div>
+  <% end %>
+</div>

data/sample-apps/timeline-events-app/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+load Gem.bin_path('bundler', 'bundle')