hubspot-api-client 7.1.0 → 8.0.0

data/sample-apps/timeline-events-app/Gemfile

@@ -0,0 +1,33 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '2.6.3'
+
+gem 'rails', '~> 5.2.3'
+gem 'sqlite3'
+gem 'puma', '~> 4.3'
+gem 'sass-rails', '~> 5.0'
+gem 'uglifier', '>= 1.3.0'
+gem 'jbuilder', '~> 2.5'
+gem 'csv'
+
+gem 'hubspot-api-client', path: '../../'
+
+group :development, :test do
+  gem 'dotenv-rails', require: 'dotenv/rails-now'
+  gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  gem 'rspec-rails', '~> 3.5'
+  gem 'capybara'
+  gem 'capybara-mechanize', '~> 1.11'
+  gem 'selenium-webdriver', '3.4.3'
+  gem 'geckodriver-helper'
+  gem 'pry'
+  gem 'pry-byebug'
+end
+
+group :development do
+  gem 'web-console', '>= 3.3.0'
+  gem 'listen', '>= 3.0.5', '< 3.2'
+end
+
+gem 'tzinfo-data', platforms: [:mingw, :mswin, :x64_mingw, :jruby]

data/sample-apps/timeline-events-app/Gemfile.lock

@@ -0,0 +1,271 @@
+PATH
+  remote: ../..
+  specs:
+    hubspot-api-client (7.3.0)
+      faraday (>= 0.14.0)
+      json (~> 2.1, >= 2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    archive-zip (0.12.0)
+      io-like (~> 0.3.0)
+    arel (9.0.0)
+    bindex (0.8.1)
+    builder (3.2.3)
+    byebug (11.0.1)
+    capybara (3.29.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
+    capybara-mechanize (1.11.0)
+      capybara (>= 2.4.4, < 4)
+      mechanize (~> 2.7.0)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    connection_pool (2.2.2)
+    crass (1.0.5)
+    csv (3.1.2)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.7.5)
+    dotenv-rails (2.7.5)
+      dotenv (= 2.7.5)
+      railties (>= 3.2, < 6.1)
+    erubi (1.9.0)
+    execjs (2.7.0)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.11.1)
+    geckodriver-helper (0.24.0)
+      archive-zip (~> 0.7)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.7.0)
+      concurrent-ruby (~> 1.0)
+    io-like (0.3.0)
+    jbuilder (2.9.1)
+      activesupport (>= 4.2.0)
+    json (2.3.1)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    loofah (2.3.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    mechanize (2.7.6)
+      domain_name (~> 0.5, >= 0.5.1)
+      http-cookie (~> 1.0)
+      mime-types (>= 1.17.2)
+      net-http-digest_auth (~> 1.1, >= 1.1.1)
+      net-http-persistent (>= 2.5.2)
+      nokogiri (~> 1.6)
+      ntlm-http (~> 0.1, >= 0.1.1)
+      webrobots (>= 0.0.9, < 0.2)
+    method_source (0.9.2)
+    mime-types (3.3)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    mimemagic (0.3.3)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.13.0)
+    multipart-post (2.1.1)
+    net-http-digest_auth (1.4.1)
+    net-http-persistent (3.1.0)
+      connection_pool (~> 2.2)
+    nio4r (2.5.2)
+    nokogiri (1.10.5)
+      mini_portile2 (~> 2.4.0)
+    ntlm-http (0.1.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.1)
+    puma (4.3.1)
+      nio4r (~> 2.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rake (13.0.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    regexp_parser (1.6.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    ruby_dep (1.5.0)
+    rubyzip (1.3.0)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+    sass-rails (5.1.0)
+      railties (>= 5.2.0)
+      sass (~> 3.1)
+      sprockets (>= 2.8, < 4.0)
+      sprockets-rails (>= 2.0, < 4.0)
+      tilt (>= 1.1, < 3)
+    selenium-webdriver (3.4.3)
+      childprocess (~> 0.5)
+      rubyzip (~> 1.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    uglifier (4.2.0)
+      execjs (>= 0.3.0, < 3)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    web-console (3.7.0)
+      actionview (>= 5.0)
+      activemodel (>= 5.0)
+      bindex (>= 0.4.0)
+      railties (>= 5.0)
+    webrobots (0.1.2)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  capybara
+  capybara-mechanize (~> 1.11)
+  csv
+  dotenv-rails
+  geckodriver-helper
+  hubspot-api-client!
+  jbuilder (~> 2.5)
+  listen (>= 3.0.5, < 3.2)
+  pry
+  pry-byebug
+  puma (~> 4.3)
+  rails (~> 5.2.3)
+  rspec-rails (~> 3.5)
+  sass-rails (~> 5.0)
+  selenium-webdriver (= 3.4.3)
+  sqlite3
+  tzinfo-data
+  uglifier (>= 1.3.0)
+  web-console (>= 3.3.0)
+
+RUBY VERSION
+   ruby 2.6.3p62
+
+BUNDLED WITH
+   1.17.3

data/sample-apps/timeline-events-app/README.md

@@ -0,0 +1,30 @@
+# HubSpot-ruby sample app
+
+# HubSpot-ruby timeline-events sample app
+
+This is a sample app for the [hubspot-ruby SDK](../../../../../). Currently, this app focuses on demonstrating the functionality of [Timeline Events API](https://developers.hubspot.com/docs-beta/crm/timeline) endpoints and their related actions.
+
+Please see the documentation on [Creating an app in HubSpot](https://developers.hubspot.com/docs-beta/creating-an-app)
+### HubSpot Public API links used in this application
+
+  - [Search for contacts](https://developers.hubspot.com/docs-beta/crm/contacts)
+  - [Create event template](https://developers.hubspot.com/docs-beta/crm/timeline)
+  - [Create timeline event](https://developers.hubspot.com/docs-beta/crm/timeline)
+
+
+### 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 web```
+You should now be able to navigate to [http://localhost:3000](http://localhost:3000) and use the application.

data/sample-apps/timeline-events-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/timeline-events-app/app/assets/config/manifest.js

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

data/sample-apps/timeline-events-app/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// 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 activestorage
+//= require_tree .

data/sample-apps/timeline-events-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/timeline-events-app/app/assets/stylesheets/application.css

@@ -0,0 +1,171 @@
+/*
+ * 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;
+}
+
+input[type=datetime-local] {
+  width: 100%;
+  height: 3.8rem;
+  padding: .6rem 1.0rem;
+}
+
+h3.alert-success {
+  text-align: center;
+}
+
+.delete-button {
+  margin-bottom: 0;
+  float: right;
+  margin-right: 20px;
+}
+
+.delete-button input {
+  margin-bottom: 0;
+}
+
+pre {
+  line-height: 0.7;
+}
+
+pre p {
+  margin: 0;
+  margin-left: 5px;
+}
+
+.alert {
+  padding: 20px;
+  background-color: #f7786f;
+  color: white;
+  margin-bottom: 15px;
+}
+
+.closebtn {
+  margin-left: 15px;
+  color: white;
+  font-weight: bold;
+  float: right;
+  font-size: 22px;
+  line-height: 20px;
+  cursor: pointer;
+  transition: 0.3s;
+}
+
+.closebtn:hover {
+  color: black;
+}
+
+.template-form {
+  padding: 0 15%;
+}
+
+.textarea {
+  height: 150px;
+}
+
+.form-groups {
+  width: 580px;
+}
+
+#event_template_email, #event_template_header_template,
+#event_template_detail_template, #event_template_target_record_type {
+  background-color: #f5f8fa;
+}
+
+.textarea:focus, #event_template_email:focus {
+  border-color: rgba(0,208,228,.5);
+  box-shadow: 0 0 4px 1px rgba(0,208,228,.3),0 0 0 1px #00d0e4;
+}
+
+.textarea::placeholder, #event_template_email::placeholder {
+  opacity: 1;
+  font-family: Helvetica, Arial, sans-serif;
+  font-weight: 400;
+  color: #7c98b6;
+}
+
+.contacts-iframe {
+  height: 700px;
+  width: 100%;
+  position:relative;
+}
+
+.contacts-iframe iframe {
+  border: none;
+  position:absolute;
+  width:1080px;
+  height:900px;
+}
+
+pre {
+  border-left: 0.3rem solid #ff7a59;
+}
+
+input[type=submit] {
+  background-color: #ff7a59;
+  border-color: #ff7a59;
+}

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