RubyGems - hubspot-api-client - Versions diffs - 3.1.0.pre.beta → 5.0.0 - Mend

hubspot-api-client 3.1.0.pre.beta → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (241) hide show

data/sample-apps/search-result-paging-app/config/routes.rb ADDED

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  get '/oauth', to: 'oauth/authorization#authorize'
+  get '/oauth/callback', to: 'oauth/authorization#callback'
+  get '/login', to: 'oauth/authorization#login'
+  get '/', to: 'home#index'
+  root to: 'home#index'
+end

data/sample-apps/search-result-paging-app/config/spring.rb ADDED

@@ -0,0 +1,6 @@
+%w[
+  .ruby-version
+  .rbenv-vars
+  tmp/restart.txt
+  tmp/caching-dev.txt
+].each { |path| Spring.watch(path) }

data/sample-apps/search-result-paging-app/db/seeds.rb ADDED

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rails db:seed command (or created alongside the database with db:setup).
+#
+# Examples:
+#
+#   movies = Movie.create([{ name: 'Star Wars' }, { name: 'Lord of the Rings' }])
+#   Character.create(name: 'Luke', movie: movies.first)

data/sample-apps/search-result-paging-app/docker-compose.yml ADDED

@@ -0,0 +1,11 @@
+version: '3'
+services:
+  web:
+    build:
+      context: ../../
+      dockerfile: ./sample-apps/search-result-paging-app/Dockerfile
+    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
+    volumes:
+      - .:/search-result-paging-app
+    ports:
+      - "3000:3000"

data/sample-apps/search-result-paging-app/docker-entrypoint.sh ADDED

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+# Remove a potentially pre-existing server.pid for Rails.
+rm -f /myapp/tmp/pids/server.pid
+# Then exec the container's main process (what's set as CMD in the Dockerfile).
+exec "$@"

data/sample-apps/search-result-paging-app/lib/assets/.keep ADDED

File without changes

data/sample-apps/search-result-paging-app/lib/tasks/.keep ADDED

File without changes

data/sample-apps/search-result-paging-app/lib/tasks/search_contacts.rake ADDED

@@ -0,0 +1,36 @@
+namespace :contacts do
+  desc "Test searching mechanism"
+  task search: :environment do
+    def iterate_via_search_results(search_query:, process_contact_function:)
+      config = ::Hubspot::Crm::Contacts::Configuration.new do |config|
+        config.access_token = ENV['access_token']
+      end
+      api_client = ::Hubspot::Crm::Contacts::ApiClient.new(config)
+      search_api = ::Hubspot::Crm::Contacts::SearchApi.new(api_client)
+      after = 0
+      loop do
+        contacts = Services::Hubspot::Contacts::Search.new(
+          search_query: search_query,
+          after: after,
+          limit: ENV['SEARCH_BATCH_SIZE'],
+          search_api: search_api
+        ).call
+        break if contacts.count == 0
+        contacts.each { |contact|  process_contact_function.call(contact) }
+        after = contacts.last.id
+      end
+    end
+    Rails.logger = Logger.new(STDOUT)
+    iterate_via_search_results(
+      search_query: ENV['SEARCH_QUERY'],
+      process_contact_function: lambda { |contact| Rails.logger.info("Processing contact_id = #{contact.id}") }
+    )
+  end
+end

data/sample-apps/search-result-paging-app/log/.keep ADDED

File without changes

data/sample-apps/search-result-paging-app/package.json ADDED

@@ -0,0 +1,5 @@
+{
+  "name": "search-result-paging-app",
+  "private": true,
+  "dependencies": {}
+}

data/sample-apps/search-result-paging-app/public/404.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <div>
+      <h1>The page you were looking for doesn't exist.</h1>
+      <p>You may have mistyped the address or the page may have moved.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/sample-apps/search-result-paging-app/public/422.html ADDED

@@ -0,0 +1,67 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <div>
+      <h1>The change you wanted was rejected.</h1>
+      <p>Maybe you tried to change something you didn't have access to.</p>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/sample-apps/search-result-paging-app/public/500.html ADDED

@@ -0,0 +1,66 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <style>
+  .rails-default-error-page {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+    margin: 0;
+  }
+  .rails-default-error-page div.dialog {
+    width: 95%;
+    max-width: 33em;
+    margin: 4em auto 0;
+  }
+  .rails-default-error-page div.dialog > div {
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 12% 0;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  .rails-default-error-page h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  .rails-default-error-page div.dialog > p {
+    margin: 0 0 1em;
+    padding: 1em;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body class="rails-default-error-page">
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <div>
+      <h1>We're sorry, but something went wrong.</h1>
+    </div>
+    <p>If you are the application owner check the logs for more information.</p>
+  </div>
+</body>
+</html>

data/sample-apps/search-result-paging-app/public/apple-touch-icon-precomposed.png ADDED

File without changes

data/sample-apps/search-result-paging-app/public/apple-touch-icon.png ADDED

File without changes

data/sample-apps/search-result-paging-app/public/favicon.ico ADDED

File without changes

data/sample-apps/search-result-paging-app/public/robots.txt ADDED

	@@ -0,0 +1 @@
1	+ # See http://www.robotstxt.org/robotstxt.html for documentation on how to use the robots.txt file

data/sample-apps/search-result-paging-app/tmp/.keep ADDED

File without changes

data/sample-apps/webhooks-contacts-app/.env.template CHANGED

@@ -1,2 +1,4 @@
-HUBSPOT_API_KEY=demo
+HUBSPOT_APPLICATION_ID=
+HUBSPOT_CLIENT_ID=
 HUBSPOT_CLIENT_SECRET=
+HUBSPOT_DEVELOPER_API_KEY=

data/sample-apps/webhooks-contacts-app/Gemfile.lock CHANGED

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: ../..
   specs:
-    hubspot-api-client (1.0.0)
+    hubspot-api-client (3.2.0)
       faraday (>= 0.14.0)
       json (~> 2.1, >= 2.1.0)

data/sample-apps/webhooks-contacts-app/README.md CHANGED

@@ -1,16 +1,29 @@
-# HubSpot-ruby sample Webhooks Tutorial app
+# HubSpot-ruby sample Webhooks app
-This is a sample app for the [hubspot-ruby SDK](../../../../)
+This is a sample app for the [hubspot-ruby SDK](../../../..).
 Currently, this app focuses on demonstrating the functionality of [Webhooks API](https://developers.hubspot.com/docs-beta/crm/extensions), contact creation/deletion in particular.
-Please see the documentation on [How do I create an app in HubSpot?](https://developers.hubspot.com/docs/faq/how-do-i-create-an-app-in-hubspot)
+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
-  - [Initiate an Integration with OAuth 2.0](https://developers.hubspot.com/docs/methods/oauth2/initiate-oauth-integration)
-  - [Get OAuth 2.0 Access Token and Refresh Tokens](https://developers.hubspot.com/docs/methods/oauth2/get-access-and-refresh-tokens)
-  - [Refresh OAuth 2.0 Access Token](https://developers.hubspot.com/docs/methods/oauth2/refresh-access-token)
   - [Read a batch of contact objects by ID](https://developers.hubspot.com/docs-beta/crm/contacts)
+### Note on the Data Base
+This application uses MySQL database to store the events coming from Webhooks. There is a single events table:
+```
+create table if not exists events
+(
+    id              INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    event_type      VARCHAR(255),
+    object_id       int             default null,
+    event_id        bigint          default null,
+    occurred_at     bigint          default null,
+    property_name   varchar(255)    default null,
+    property_value  varchar(255)    default null,
+    created_at      datetime        default CURRENT_TIMESTAMP
+);
+```
+Please note that event_id sent by HubSpot needs to be stored as int
 ### Setup App
@@ -19,19 +32,15 @@ Make sure you have [Docker Compose](https://docs.docker.com/compose/) and [Ngrok
 ### Configure
 1. Copy .env.template to .env
-2. Paste your HUBSPOT_CLIENT_ID and HUBSPOT_CLIENT_SECRET
+2. Paste your HUBSPOT_CLIENT_ID, HUBSPOT_CLIENT_SECRET, HUBSPOT_APPLICATION_ID and HUBSPOT_DEVELOPER_API_KEY
 ### Running
-The best way to run this project (with the least configuration), is using docker compose. Change to the webroot and start it
+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
 ```
-In another terminal, run:
-```bash
-docker-compose run web rake db:create db:migrate
-```
 Copy Ngrok url from console. Now you should now be able to navigate to that url and use the application.
@@ -40,12 +49,6 @@ Copy Ngrok url from console. Now you should now be able to navigate to that url
 If you are using Ngrok free plan and testing the application with large amount of import/deletions of Contacts you are likely to see Ngrok "Too Many Connections" error.
 This is caused by a large amount of weebhooks events being sent to Ngrok tunnel. To avoid it you can deploy sample applications on your server w/o Ngrok or upgrade to Ngrok Enterprise version
-### Configure webhooks
-Required webhooks url should look like https://***.ngrok.io/webhooks/callback
-Following [Webhooks Setup](https://developers.hubspot.com/docs/methods/webhooks/webhooks-overview) guide please note:
-- Every time the app is restarted you should update the webhooks url
-- The app supports `contact.creation` and `contact.deletion` subscription types only
-- Subscription are paused by default. You need to activate them manually after creating
+### HubSpot Signature
+To help improve security, HubSpot webhooks are sent with signature so you can verify that it came from HubSpot. This sample application shows how to do that verification. You can read more about validation in general here: https://developers.hubspot.com/docs/api/webhooks/validating-requests.
+The source code for validating webhooks is at [hubspot\utils\webhooks](../../hubspot/utils/webhooks.py) and [an usage example](./src/routes/webhooks.py).

data/sample-apps/webhooks-contacts-app/app/assets/stylesheets/application.css CHANGED

@@ -63,57 +63,8 @@
   color: #606c76
 }
-.company-new-button {
-  margin: 2rem;
-  margin-left: 0;
-}
-.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;
-}
-company a {
-  color: #4e585f;
-  text-decoration: none;
-}
-.company a:hover {
-   text-decoration: none;
-   cursor: pointer;
-}
-.company .company-info {
-  display: block;
-}
-pre {
-  line-height: 0.7;
-}
-pre p {
-  margin: 0;
-  margin-left: 5px;
+.hidden {
+  display: none;
 }
 .event.deletion {
@@ -131,10 +82,11 @@ pre p {
   color: #ffffff;
 }
-.event.propertyChange span:first-child {
-  background-color: #08080885;
+.authorize-button {
+  justify-content: center;
 }
-.hidden {
-  display: none;
+.text-center {
+  text-align: center;
 }