hubspot-api-client 3.3.0 → 7.1.0

data/sample-apps/search-result-paging-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/search-result-paging-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: 'home/index'
+    end
+  end
+end

data/sample-apps/search-result-paging-app/app/controllers/home_controller.rb

@@ -0,0 +1,14 @@
+class HomeController < ApplicationController
+  before_action :authorize
+
+  def index;end
+
+  private
+
+  def authorize
+    redirect_to login_path and return if session['tokens'].blank?
+
+    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/search-result-paging-app/app/controllers/oauth/authorization_controller.rb

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

data/sample-apps/search-result-paging-app/app/helpers/application_helper.rb

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

data/sample-apps/search-result-paging-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/search-result-paging-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/search-result-paging-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/search-result-paging-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/search-result-paging-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/search-result-paging-app/app/lib/services/hubspot/contacts/get_page.rb

@@ -0,0 +1,26 @@
+module Services
+  module Hubspot
+    module Contacts
+      class GetPage
+        def initialize(limit: 10)
+          @limit = limit
+        end
+
+        def call
+          basic_api = ::Hubspot::Crm::Contacts::BasicApi.new
+          results = basic_api.get_page(auth_names: 'oauth2', limit: @limit).results
+          results = add_fullnames(results)
+        end
+
+        private
+
+        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/search-result-paging-app/app/lib/services/hubspot/contacts/search.rb

@@ -0,0 +1,35 @@
+module Services
+  module Hubspot
+    module Contacts
+      class Search
+        def initialize(after:, limit:, search_query:, search_api: nil)
+          @after = after
+          @limit = limit
+          @search_query = search_query
+          @search_api = search_api.nil? ? ::Hubspot::Crm::Contacts::SearchApi.new : search_api
+        end
+
+        def call
+          @search_api.do_search(body: search_request, auth_names: 'oauth2').results
+        end
+
+        private
+
+        def search_request
+          filter = ::Hubspot::Crm::Contacts::Filter.new(
+            property_name: 'hs_object_id',
+            operator: 'GT',
+            value: @after
+          )
+          filter_group = ::Hubspot::Crm::Contacts::FilterGroup.new(filters: [filter])
+          ::Hubspot::Crm::Contacts::PublicObjectSearchRequest.new(
+            query: @search_query,
+            limit: @limit,
+            filter_groups: [filter_group],
+            sorts: [{'propertyName' => 'hs_object_id', 'direction' => 'ASCENDING'}]
+          )
+        end
+      end
+    end
+  end
+end

data/sample-apps/search-result-paging-app/app/lib/services/hubspot/properties/create.rb

@@ -0,0 +1,23 @@
+module Services
+  module Hubspot
+    module Properties
+      class Create
+        def initialize(params)
+          @params = params
+        end
+
+        def call
+          core_api = ::Hubspot::Crm::Properties::CoreApi.new
+          params = { auth_names: 'oauth2', body: property_create }
+          core_api.create('contact',params)
+        end
+
+        private
+
+        def property_create
+          @property_create ||= ::Hubspot::Crm::Properties::PropertyCreate.new(@params)
+        end
+      end
+    end
+  end
+end

data/sample-apps/search-result-paging-app/app/lib/services/hubspot/properties/destroy.rb

@@ -0,0 +1,16 @@
+module Services
+  module Hubspot
+    module Properties
+      class Destroy
+        def initialize(name)
+          @name = name
+        end
+
+        def call
+          core_api = ::Hubspot::Crm::Properties::CoreApi.new
+          core_api.archive('contact', @name, auth_names: 'oauth2')
+        end
+      end
+    end
+  end
+end

data/sample-apps/search-result-paging-app/app/models/application_record.rb

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

data/sample-apps/search-result-paging-app/app/views/home/index.html.erb

@@ -0,0 +1,13 @@
+<div class='container'>
+  <% if @error.present? %>
+    <h3><%= @error.message %></h3>
+  <% else %>
+    <h3>In order to continue run rake task in console</h3>
+
+    <div id="rake-task">
+      <%= "docker-compose run web rake contacts:search access_token=#{session[:tokens][:access_token]}" %>
+    </div>
+
+    <button class="clipboard-btn" type="button" data-clipboard-target="#rake-task">Copy to clipboard</button>
+  <% end %>
+</div>

data/sample-apps/search-result-paging-app/app/views/layouts/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>HubSpot Ruby Search sample 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/search-result-paging-app/app/views/oauth/authorization/login.html.erb

@@ -0,0 +1,15 @@
+<div class="container">
+  <pre>
+    // app/lib/services/authorization/get_authorization_uri.rb - Generate URL for OAuth
+
+    ::Hubspot::OAuthHelper.authorize_url(
+      client_id: 'client_id',
+      redirect_uri: redirect_uri,
+      scope: %w[contacts]
+    )
+  </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/search-result-paging-app/app/views/shared/_header.html.erb

@@ -0,0 +1,18 @@
+<nav class="navigation">
+  <div class="container">
+    <a class="navigation-title" href="/">
+      <h3 class="title">HubSpot Ruby Search Sample App</h3>
+    </a>
+    <ul class="navigation-list float-right">
+      <li class="navigation-item">
+        <a id="contacts-list" class="navigation-link" href="/contacts">Contacts</a>
+      </li>
+      <li class="navigation-item">
+        <a id="properties-list" class="navigation-link" href="/properties">Properties</a>
+      </li>
+      <li class="navigation-item">
+        <a class="navigation-link" href="/oauth">OAuth2</a>
+      </li>
+    </ul>
+  </div>
+</nav>

data/sample-apps/search-result-paging-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/search-result-paging-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/search-result-paging-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/search-result-paging-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