hubspot-api-client 1.0.1 → 2.0.0

data/sample-apps/rate-limits-redis-sample-app/README.md

@@ -0,0 +1,35 @@
+# HubSpot Ruby Rate Limits Redis Sample App
+
+This is a sample app for the [hubspot-ruby SDK](../../../../). Currently, this app focuses on demonstrating the mechanism of avoiding of rate limits. It will be useful for you if you don't want to reach rate limit (429 http error).
+
+Please see the documentation on [Creating an app in HubSpot](https://developers.hubspot.com/docs-beta/creating-an-app)
+
+### HubSpot Public API endpoints used in this application
+
+  - [Contacts](https://developers.hubspot.com/docs-beta/crm/contacts)
+  - [OAuth](https://developers.hubspot.com/docs-beta/working-with-oauth)
+
+### Setup App
+
+Make sure you have [Docker Compose](https://docs.docker.com/compose/) installed.
+
+### Configure
+
+1. Copy .env.template to .env
+2. Specify authorization data in .env:
+    - Paste HUBSPOT_CLIENT_ID and HUBSPOT_CLIENT_SECRET for OAuth
+
+### Running
+
+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
+```
+You should now be able to navigate to [http://localhost:3000](http://localhost:3000).
+Firstly you will need to authorize via OAuth there.
+Then you can to go to the terminal window and execute the comand that displayed on root page.
+The app logs the results of the execution in the original terminal window where you started docker-compose
+
+Please note this app starts a few workers in order to test rate limit.
+

data/sample-apps/rate-limits-redis-sample-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/rate-limits-redis-sample-app/app/assets/config/manifest.js

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

data/sample-apps/rate-limits-redis-sample-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/rate-limits-redis-sample-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/rate-limits-redis-sample-app/app/assets/stylesheets/application.css

@@ -0,0 +1,90 @@
+/*
+ * 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
+}
+
+.error-wrapper .result {
+  color: white;
+  background-color: red;
+}
+
+pre {
+  line-height: 0.7;
+}
+
+pre p {
+  margin: 0;
+  margin-left: 5px;
+}
+
+#rake-task {
+  position: relative;
+  margin-bottom: 10px;
+  background-color: #f4f5f6;
+}
+
+
+.is-copy {
+  background-color: green;
+  color: #fff;
+}

data/sample-apps/rate-limits-redis-sample-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/rate-limits-redis-sample-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/rate-limits-redis-sample-app/app/controllers/home_controller.rb

@@ -0,0 +1,15 @@
+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::Authorization::Tokens::Refresh.new(tokens: session['tokens'], request: request).call
+    Services::Authorization::AuthorizeHubspot.new(tokens: session['tokens']).call
+  end
+end

data/sample-apps/rate-limits-redis-sample-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 '/'
+    end
+
+    def login;end
+  end
+end

data/sample-apps/rate-limits-redis-sample-app/app/helpers/application_helper.rb

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

data/sample-apps/rate-limits-redis-sample-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/rate-limits-redis-sample-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/rate-limits-redis-sample-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/rate-limits-redis-sample-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
+          tokens_api = ::Hubspot::OAuth::TokensApi.new
+          tokens = tokens_api.post_oauth_v1_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/rate-limits-redis-sample-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
+          tokens_api = ::Hubspot::OAuth::TokensApi.new
+          tokens = tokens_api.post_oauth_v1_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/rate-limits-redis-sample-app/app/lib/services/hubspot/contacts/archive_batch.rb

@@ -0,0 +1,29 @@
+module Services
+  module Hubspot
+    module Contacts
+      class ArchiveBatch
+        def initialize(ids, access_token)
+          @ids = ids
+          @access_token = access_token
+        end
+
+        def call
+          ids_object = ::Hubspot::Crm::Contacts::BatchInputSimplePublicObjectId.new(
+            inputs: @ids
+          )
+          batch_api.archive_batch(body: ids_object , auth_names: 'oauth2')
+        end
+
+        private
+
+        def batch_api
+          config = ::Hubspot::Crm::Contacts::Configuration.new do |config|
+            config.access_token = @access_token
+          end
+          api_client = ::Hubspot::Crm::Contacts::ApiClient.new(config)
+          ::Hubspot::Crm::Contacts::BatchApi.new(api_client)
+        end
+      end
+    end
+  end
+end

data/sample-apps/rate-limits-redis-sample-app/app/lib/services/hubspot/contacts/create_batch.rb

@@ -0,0 +1,37 @@
+module Services
+  module Hubspot
+    module Contacts
+      class CreateBatch
+        def initialize(emails, access_token)
+          @emails = emails
+          @access_token = access_token
+        end
+
+        def call
+          contacts_object = ::Hubspot::Crm::Contacts::BatchInputSimplePublicObjectInput.new(
+            inputs: contacts
+          )
+          batch_api.create_batch(body: contacts_object, auth_names: 'oauth2')
+        end
+
+        private
+
+        def contacts
+          @emails.map do |email|
+            ::Hubspot::Crm::Contacts::SimplePublicObjectInput.new(
+              properties: { email: email }
+            )
+          end
+        end
+
+        def batch_api
+          config = ::Hubspot::Crm::Contacts::Configuration.new do |config|
+            config.access_token = @access_token
+          end
+          api_client = ::Hubspot::Crm::Contacts::ApiClient.new(config)
+          ::Hubspot::Crm::Contacts::BatchApi.new(api_client)
+        end
+      end
+    end
+  end
+end