hubspot-api-client 7.1.0 → 8.0.0

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')

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

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

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+begin
+  load File.expand_path('../spring', __FILE__)
+rescue LoadError => e
+  raise unless e.message.include?('spring')
+end
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

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

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:setup'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

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

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# This file loads Spring without using Bundler, in order to be fast.
+# It gets overwritten when you run the `spring binstub` command.
+
+unless defined?(Spring)
+  require 'rubygems'
+  require 'bundler'
+
+  lockfile = Bundler::LockfileParser.new(Bundler.default_lockfile.read)
+  spring = lockfile.specs.detect { |spec| spec.name == 'spring' }
+  if spring
+    Gem.use_paths Gem.dir, Bundler.bundle_path.to_s, *Gem.path
+    gem 'spring', spring.version
+    require 'spring/binstub'
+  end
+end

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

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+include FileUtils
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+chdir APP_ROOT do
+  # This script is a way to update your development environment automatically.
+  # Add necessary update steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # Install JavaScript dependencies if using Yarn
+  # system('bin/yarn')
+
+  puts "\n== Updating database =="
+  system! 'bin/rails db:migrate'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

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

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path('..', __dir__)
+Dir.chdir(APP_ROOT) do
+  begin
+    exec "yarnpkg", *ARGV
+  rescue Errno::ENOENT
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/sample-apps/timeline-events-app/config/application.rb

@@ -0,0 +1,19 @@
+require_relative 'boot'
+
+require 'rails/all'
+
+# Require the gems listed in Gemfile, including any gems
+# you've limited to :test, :development, or :production.
+Bundler.require(*Rails.groups)
+
+module Oauth2App
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 5.2
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end

data/sample-apps/timeline-events-app/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../Gemfile', __dir__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/sample-apps/timeline-events-app/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/sample-apps/timeline-events-app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/sample-apps/timeline-events-app/config/environments/development.rb

@@ -0,0 +1,61 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options)
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/sample-apps/timeline-events-app/config/environments/production.rb

@@ -0,0 +1,94 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Store uploaded files on the local file system (see config/storage.yml for options)
+  config.active_storage.service = :local
+
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "contacts-app_#{Rails.env}"
+
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end