hubspot-api-client 3.2.0 → 3.3.0

data/sample-apps/imports-contacts-app/README.md

@@ -0,0 +1,27 @@
+# HubSpot Ruby Imports Contacts App
+
+This is a sample app for the [hubspot-ruby SDK](../../../../). Currently, this app focuses on demonstrating the functionality of [Imports API](https://developers.hubspot.com/docs/api/crm/imports) 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 endpoints used in this application
+
+  - [Imports](https://developers.hubspot.com/docs/api/crm/imports)
+
+### Setup App
+
+Make sure you have [Docker Compose](https://docs.docker.com/compose/) installed.
+
+### Configure
+
+1. Copy .env.template to .env
+2. Paste your HUBSPOT_CLIENT_ID and HUBSPOT_CLIENT_SECRET
+
+### 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) and use the application.

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

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

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

@@ -0,0 +1,87 @@
+/*
+ * 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
+}
+
+.row.authorize-button {
+  justify-content: center;
+}
+
+.text-center {
+  text-align: center;
+}
+
+.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;
+}

data/sample-apps/imports-contacts-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/imports-contacts-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: 'imports/index'
+    end
+  end
+end

data/sample-apps/imports-contacts-app/app/controllers/imports_controller.rb

@@ -0,0 +1,24 @@
+class ImportsController < ApplicationController
+  before_action :authorize
+
+  def index
+  end
+
+  def create
+    Services::Hubspot::Imports::Create.new(uploaded_file: params[:file]).call
+    redirect_to :imports, notice: 'Import succesfully created.'
+  end
+
+  def download_example
+    send_file 'public/examples/example.csv', type: 'application/octet-stream', status: 202
+  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/imports-contacts-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 '/imports'
+    end
+
+    def login;end
+  end
+end

data/sample-apps/imports-contacts-app/app/helpers/application_helper.rb

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

data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/get_authorization_uri.rb

@@ -13,7 +13,7 @@ module Services
         ::Hubspot::OAuthHelper.authorize_url(
           client_id: ENV['HUBSPOT_CLIENT_ID'],
           redirect_uri: redirect_uri,
-          scope: %w[contacts]
+          scope: %w[crm.import]
         )
       end
 

data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/generate.rb

@@ -8,8 +8,8 @@ module Services
         end
 
         def call
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :authorization_code,
             code: @code,
             redirect_uri: redirect_uri,

data/sample-apps/{webhooks-contacts-app → imports-contacts-app}/app/lib/services/authorization/tokens/refresh.rb

@@ -3,7 +3,7 @@ module Services
     module Tokens
       class Refresh < Tokens::Base
         def initialize(tokens:, request:)
-          @tokens = tokens.with_indifferent_access
+          @tokens = tokens
           @request = request
         end
 
@@ -15,8 +15,8 @@ module Services
         private
 
         def refresh_tokens
-          tokens_api = ::Hubspot::OAuth::TokensApi.new
-          tokens = tokens_api.post_oauth_v1_token(
+          default_api = ::Hubspot::OAuth::DefaultApi.new
+          tokens = default_api.create_token(
             grant_type: :refresh_token,
             refresh_token: @tokens[:refresh_token],
             redirect_uri: redirect_uri,
@@ -25,7 +25,6 @@ module Services
             return_type: 'Object'
           )
           tokens[:expires_at] = expires_at(tokens[:expires_in])
-          Token.instance.update!(tokens)
           tokens
         end
       end

data/sample-apps/imports-contacts-app/app/lib/services/hubspot/imports/create.rb

@@ -0,0 +1,52 @@
+module Services
+  module Hubspot
+    module Imports
+      class Create
+        def initialize(uploaded_file:)
+          @file = copy_file_to_uploads(uploaded_file)
+          @filename = uploaded_file.original_filename
+        end
+
+        def call
+          core_api = ::Hubspot::Crm::Imports::CoreApi.new
+          core_api.create(import_request: import_request(@filename), files: @file, auth_names: 'oauth2')
+        end
+
+        private
+
+        def import_request(filename)
+          {
+            "name": "test_import",
+            "files": [
+              {
+                "fileName": filename,
+                "fileImportPage": {
+                  "hasHeader": true,
+                  "columnMappings": [
+                    {
+                      "columnName": "First Name",
+                      "propertyName": "firstname",
+                      "columnObjectType": "CONTACT",
+                    },
+                    {
+                      "columnName": "Email",
+                      "propertyName": "email",
+                      "columnObjectType": "CONTACT",
+                    },
+                  ]
+                }
+              }
+            ]
+          }.to_json
+        end
+
+        def copy_file_to_uploads(uploaded_file)
+          tmp = uploaded_file.tempfile
+          destiny_file = File.join('public', 'uploads', uploaded_file.original_filename)
+          FileUtils.cp tmp.path, destiny_file
+          File.open(destiny_file)
+        end
+      end
+    end
+  end
+end

data/sample-apps/imports-contacts-app/app/models/application_record.rb

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

data/sample-apps/imports-contacts-app/app/views/imports/index.html.erb

@@ -0,0 +1,70 @@
+<div class="container">
+  <% if @error.present? %>
+    <h3><%= @error.message %></h3>
+  <% else %>
+    <h3 class="text-center">Select File</h3>
+    <p>You can take an example of file <%= link_to "here", download_path, target: "_blank"%>.</p>
+    <% if flash[:notice] %>
+      <div class="notice"><%= flash[:notice] %></div>
+    <% end %>
+    <%= form_tag('/imports', method: 'post', multipart: true) do %>
+      <%= file_field_tag(:file) %>
+      <%= submit_tag("Upload") %>
+    <% end %>
+
+    <pre>
+module Services
+  module Hubspot
+    module Imports
+      class Create
+        def initialize(uploaded_file:)
+          @file = copy_file_to_uploads(uploaded_file)
+          @filename = uploaded_file.original_filename
+        end
+
+        def call
+          core_api = ::Hubspot::Crm::Imports::CoreApi.new
+          core_api.create(import_request: import_request(@filename), files: @file, auth_names: 'oauth2')
+        end
+
+        private
+
+        def import_request(filename)
+          {
+            "name": "test_import",
+            "files": [
+              {
+                "fileName": filename,
+                "fileImportPage": {
+                  "hasHeader": true,
+                  "columnMappings": [
+                    {
+                      "columnName": "First Name",
+                      "propertyName": "firstname",
+                      "columnObjectType": "CONTACT",
+                    },
+                    {
+                      "columnName": "Email",
+                      "propertyName": "email",
+                      "columnObjectType": "CONTACT",
+                    },
+                  ]
+                }
+              }
+            ]
+          }.to_json
+        end
+
+        def copy_file_to_uploads(uploaded_file)
+          tmp = uploaded_file.tempfile
+          destiny_file = File.join('public', 'uploads', uploaded_file.original_filename)
+          FileUtils.cp tmp.path, destiny_file
+          File.open(destiny_file)
+        end
+      end
+    end
+  end
+end
+    </pre>
+  <% end %>
+</div>

data/sample-apps/imports-contacts-app/app/views/layouts/application.html.erb

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>HubSpot Ruby imports contacts 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>