hubspot-api-client 3.3.0 → 4.0.0

data/sample-apps/search-result-paging-app/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/sample-apps/search-result-paging-app/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css

data/sample-apps/search-result-paging-app/app/assets/javascripts/application.js

@@ -0,0 +1,25 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
+// vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require jquery
+//= require activestorage
+//= require clipboard
+//= require_tree .
+
+$(document).ready(function(){
+  var clipboard = new Clipboard('.clipboard-btn');
+  clipboard.on('success', function(e) {
+    $(e.trigger).text('Copied!');
+    $(e.trigger).addClass('is-copy');
+  });
+});

data/sample-apps/search-result-paging-app/app/assets/javascripts/cable.js

@@ -0,0 +1,13 @@
+// Action Cable provides the framework to deal with WebSockets in Rails.
+// You can generate new channels where WebSocket features live using the `rails generate channel` command.
+//
+//= require action_cable
+//= require_self
+//= require_tree ./channels
+
+(function() {
+  this.App || (this.App = {});
+
+  App.cable = ActionCable.createConsumer();
+
+}).call(this);

data/sample-apps/search-result-paging-app/app/assets/stylesheets/application.css

@@ -0,0 +1,77 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, or any plugin's
+ * vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */
+
+ .wrapper .container {
+  padding-bottom: 2rem;
+  padding-top: 2rem;
+}
+
+.navigation {
+  background: #f4f5f6;
+  border-bottom: .1rem solid #d1d1d1;
+  display: block;
+  height: 5.2rem;
+  left: 0;
+  max-width: 100%;
+  width: 100%;
+}
+
+.navigation .container {
+  padding-bottom: 0;
+  padding-top: 0
+}
+
+.navigation .navigation-list {
+  list-style: none;
+  margin-bottom: 0;
+}
+
+.navigation .navigation-item {
+  float: left;
+  margin-bottom: 0;
+  margin-left: 2.5rem;
+  position: relative
+}
+
+.navigation .navigation-title, .navigation .title {
+  color: #606c76;
+  position: relative
+}
+
+.navigation .navigation-link, .navigation .navigation-title, .navigation .title {
+  display: inline;
+  font-size: 1.6rem;
+  line-height: 5.2rem;
+  padding: 0;
+  text-decoration: none
+}
+
+.navigation .navigation-link.active {
+  color: #606c76
+}
+
+pre {
+  padding-left: 1rem;
+}
+
+.authorize-button {
+  justify-content: center;
+}
+
+.text-center {
+  text-align: center;
+}
+

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