hubspot-api-client 11.1.0 → 15.0.0

data/lib/hubspot/discovery/oauth/client.rb

@@ -0,0 +1,23 @@
+require_relative '../base_module_client'
+
+module Hubspot
+  module Discovery
+    module OAuth
+      class Client
+        include Hubspot::Discovery::BaseModuleClient
+
+        def api_classes
+          %i[
+            access_tokens
+            refresh_tokens
+            tokens
+          ].freeze
+        end
+
+        def discovery_module_path
+          super.gsub('o_auth', 'oauth')
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/client.rb

@@ -0,0 +1,17 @@
+require_relative '../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      class Client
+        include Hubspot::Discovery::BaseModuleClient
+
+        def api_modules
+          %i[
+            users
+          ].freeze
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/users/api/roles_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      module Users
+        class RolesApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/users/api/teams_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      module Users
+        class TeamsApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/users/api/users_api.rb

@@ -0,0 +1,13 @@
+require_relative '../../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      module Users
+        class UsersApi
+          include Hubspot::Discovery::BaseApiClient
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/settings/users/client.rb

@@ -0,0 +1,21 @@
+require_relative '../../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Settings
+      module Users
+        class Client
+          include Hubspot::Discovery::BaseModuleClient
+
+          def api_classes
+            %i[
+              roles
+              teams
+              users
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/webhooks/api/settings_api.rb

@@ -0,0 +1,11 @@
+require_relative '../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Webhooks
+      class SettingsApi
+        include Hubspot::Discovery::BaseApiClient
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/webhooks/api/subscriptions_api.rb

@@ -0,0 +1,11 @@
+require_relative '../../base_api_client'
+
+module Hubspot
+  module Discovery
+    module Webhooks
+      class SubscriptionsApi
+        include Hubspot::Discovery::BaseApiClient
+      end
+    end
+  end
+end

data/lib/hubspot/discovery/webhooks/client.rb

@@ -0,0 +1,18 @@
+require_relative '../base_module_client'
+
+module Hubspot
+  module Discovery
+    module Webhooks
+      class Client
+        include Hubspot::Discovery::BaseModuleClient
+
+        def api_classes
+          %i[
+            settings
+            subscriptions
+          ].freeze
+        end
+      end
+    end
+  end
+end

data/lib/hubspot/helpers/camel_case.rb

@@ -0,0 +1,9 @@
+module Hubspot
+  module Helpers
+    class CamelCase
+      def format(string)
+        string.split('_').collect(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/hubspot/helpers/path.rb

@@ -0,0 +1,15 @@
+require_relative 'snake_case'
+
+module Hubspot
+  module Helpers
+    class Path
+      def format(module_name)
+        Hubspot::Helpers::SnakeCase.new.format(module_name.to_s)
+      end
+
+      def require_with_mapping(path)
+        require path.gsub('o_auth', 'oauth')
+      end
+    end
+  end
+end

data/lib/hubspot/helpers/snake_case.rb

@@ -0,0 +1,13 @@
+module Hubspot
+  module Helpers
+    class SnakeCase
+      def format(string)
+        string.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      end
+    end
+  end
+end

data/lib/hubspot/version.rb

@@ -1,3 +1,3 @@
  module Hubspot
-  VERSION = '11.1.0'
+  VERSION = '15.0.0'
  end

data/lib/hubspot-api-client.rb

@@ -1,60 +1,3 @@
-require 'uri'
+require_relative 'hubspot/client'
 require 'logger'
-require 'require_all'
-require_rel 'hubspot/*.rb'
-require_rel 'hubspot/helpers'
-require_rel 'hubspot'
-
-module Hubspot
-  class << self
-    CLIENTS = [
-      'Automation::Actions',
-      'Cms::AuditLogs',
-      'Cms::Blogs::Authors',
-      'Cms::Blogs::BlogPosts',
-      'Cms::Blogs::Tags',
-      'Cms::Domains',
-      'Cms::Hubdb',
-      'Cms::Performance',
-      'Cms::SiteSearch',
-      'Cms::UrlRedirects',
-      'CommunicationPreferences',
-      'Conversations::VisitorIdentification',
-      'Crm::Associations',
-      'Crm::Companies',
-      'Crm::Contacts',
-      'Crm::Deals',
-      'Crm::Extensions::Accounting',
-      'Crm::Extensions::Calling',
-      'Crm::Extensions::Cards',
-      'Crm::Extensions::Videoconferencing',
-      'Crm::Imports',
-      'Crm::LineItems',
-      'Crm::Objects',
-      'Crm::Objects::FeedbackSubmissions',
-      'Crm::Owners',
-      'Crm::Pipelines',
-      'Crm::Products',
-      'Crm::Properties',
-      'Crm::Quotes',
-      'Crm::Schemas',
-      'Crm::Tickets',
-      'Crm::Timeline',
-      'Events',
-      'Files::Files',
-      'Marketing::Transactional',
-      'OAuth',
-      'Webhooks',
-    ].freeze
-
-    def configure
-      return Configuration.default unless block_given?
-      yield(Configuration.default)
-      CLIENTS.each do |client_class_name|
-        config_class = Hubspot.const_get("#{client_class_name}::Configuration")
-        yield(config_class.default)
-      end
-      Configuration.default
-    end
-  end
-end
+require 'hubspot/version'

data/spec/discovery/automation/actions/callbacks_api_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Automation::Actions::CallbacksApi' do
+  subject(:callbacks_api) { Hubspot::Client.new(access_token: 'test').automation.actions.callbacks_api }
+  
+  it { is_expected.to respond_to(:complete) }
+  it { is_expected.to respond_to(:complete_batch) }
+end

data/spec/discovery/automation/actions/definitions_api_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Automation::Actions::DefinitionsApi' do
+  subject(:definitions_api) { Hubspot::Client.new(access_token: 'test').automation.actions.definitions_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:update) }
+end

data/spec/discovery/automation/actions/functions_api_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Automation::Actions::FunctionsApi' do
+  subject(:functions_api) { Hubspot::Client.new(access_token: 'test').automation.actions.functions_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:archive_by_function_type) }
+  it { is_expected.to respond_to(:create_or_replace) }
+  it { is_expected.to respond_to(:create_or_replace_by_function_type) }
+  it { is_expected.to respond_to(:get_by_function_type) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+end

data/spec/discovery/automation/actions/revisions_api_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Automation::Actions::RevisionsApi' do
+  subject(:revisions_api) { Hubspot::Client.new(access_token: 'test').automation.actions.revisions_api }
+  
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+end

data/spec/discovery/base_api_client_spec.rb

@@ -0,0 +1,172 @@
+require 'spec_helper'
+require 'hubspot/discovery/base_api_client'
+require 'hubspot/configuration'
+
+describe 'Hubspot::Discovery::BaseApiClient' do
+  class Hubspot::Discovery::SomeApiClass
+    include Hubspot::Discovery::BaseApiClient
+
+    def require_with_mapping(path)
+      path
+    end
+  end
+
+  class Hubspot::SomeApiClass
+    def initialize(api_client)
+    end
+
+    def get(test_id, opts = {})
+      "got test_id: #{test_id}, opts: #{opts}"
+    end
+
+    def get_with_http_info
+    end
+
+    def update(test_id, simple_public_object_input, opts = {})
+      "updated test_id: #{test_id}, name: #{simple_public_object_input.name}, email: #{simple_public_object_input.email}, opts: #{opts}"
+    end
+
+    def update_with_http_info
+    end
+
+    def raise_error
+      raise Hubspot::ApiError
+    end
+
+    def raise_error_with_http_info
+    end
+
+    def raise_error_on_third_call
+      @calls_count ||= 0
+      @calls_count += 1
+      raise Hubspot::ApiError if @calls_count < 3
+      'ok'
+    end
+
+    def raise_error_on_third_call_with_http_info
+    end
+  end
+
+  class Hubspot::ApiClient
+    def initialize(config)
+    end
+  end
+
+  class Hubspot::ApiError < ::StandardError
+    def message
+      'test error'
+    end
+
+    def code
+      429
+    end
+  end
+
+  class Hubspot::SimplePublicObjectInput
+    attr_reader :name, :email
+
+    def initialize(params)
+      @name = params[:name]
+      @email = params[:email]
+    end
+
+    def self.build_from_hash(params)
+      new(params)
+    end
+  end
+
+  subject(:client) { Hubspot::Discovery::SomeApiClass.new(access_token: 'test') }
+  let(:api) { client.api }
+  let(:body) { {name: 'test_name', email: 'test_email'} }
+  
+  it { is_expected.to respond_to(:get) }
+  it { is_expected.to respond_to(:update) }
+  it { is_expected.to respond_to(:get_with_http_info) }
+  it { is_expected.to respond_to(:update_with_http_info) }
+
+  describe '#get' do
+    subject(:get) { client.get(params) }
+
+    context 'with default params order' do
+      let(:params) { {test_id: 'test_id_value', limit: 10} }
+
+      it { is_expected.to eq('got test_id: test_id_value, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
+
+    context 'with changed params order' do
+      let(:params) { {limit: 5, test_id: 'test_id_value'} }
+
+      it { is_expected.to eq('got test_id: test_id_value, opts: {:auth_names=>"oauth2", :limit=>5}') }
+    end
+
+    context 'with error handle block' do
+      subject(:get) { client.get(params) { |e| e.message } }
+      let(:params) { {test_id: 'test_id_value', limit: 10} }
+
+      it { is_expected.to eq('got test_id: test_id_value, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
+  end
+  
+  describe '#update' do
+    subject(:update) { client.update(params) }
+
+    context 'with default params order' do
+      let(:params) { {test_id: 'test_id_value', simple_public_object_input: Hubspot::SimplePublicObjectInput.new(body), limit: 10} }
+
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
+
+    context 'with reversed params order' do
+      let(:params) { {limit: 5, simple_public_object_input: Hubspot::SimplePublicObjectInput.new(body), test_id: 'test_id_value'} }
+      
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>5}') }
+    end
+
+    context 'with shuffled params order' do
+      let(:params) { {simple_public_object_input: Hubspot::SimplePublicObjectInput.new(body), limit: 7, test_id: 'test_id_value'} }
+      
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>7}') }
+    end
+
+    context 'with body' do
+      let(:params) { {test_id: 'test_id_value', body: body, limit: 10} }
+
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
+
+    context 'with block' do
+      subject(:update) { client.update(params) { |e| e.message } }
+      let(:params) { {test_id: 'test_id_value', body: body, limit: 10} }
+
+      it { is_expected.to eq('updated test_id: test_id_value, name: test_name, email: test_email, opts: {:auth_names=>"oauth2", :limit=>10}') }
+    end
+  end
+
+  describe '#raise_error' do
+    subject(:raise_error) { client.raise_error { |e| e.message } }
+
+    it { is_expected.to eq('test error') }
+  end
+
+  describe '#raise_error_on_third_call' do
+    subject(:raise_error_on_third_call) { client.raise_error_on_third_call(retry: retry_config) }
+
+    context 'with 2 retries' do
+      let(:retry_config) { {429 => { max_retries: 2 }} }
+
+      it { is_expected.to eq('ok') }
+
+      context 'with range config' do
+        let(:retry_config) { {429..442 => { max_retries: 2 }} }
+
+        it { is_expected.to eq('ok') }
+      end
+    end
+
+    context 'with 1 retry' do
+      let(:retry_config) { {429 => { max_retries: 1 }} }
+
+      it { is_expected.to have_attributes(code: 429, message: 'test error') }
+    end
+  end
+end

data/spec/discovery/base_module_client_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'hubspot/discovery/base_module_client'
+
+describe 'Hubspot::Discovery::BaseModuleClient' do
+  class Hubspot::Discovery::TestModuleClass
+    def api_classes
+      %i[
+        settings
+        subscriptions
+      ].freeze
+    end
+
+    def api_modules
+      %i[
+        automation
+        cms
+      ].freeze
+    end
+
+    include Hubspot::Discovery::BaseModuleClient
+  end
+
+  subject(:client) { Hubspot::Discovery::TestModuleClass.new(access_token: 'test') }
+  
+  it { is_expected.to respond_to(:automation) }
+  it { is_expected.to respond_to(:cms) }
+  it { is_expected.to respond_to(:settings_api) }
+  it { is_expected.to respond_to(:subscriptions_api) }
+end

data/spec/discovery/client_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'Hubspot::Client' do
+  subject(:client) { Hubspot::Client.new(access_token: 'test') }
+  
+  it { is_expected.to respond_to(:automation) }
+  it { is_expected.to respond_to(:cms) }
+  it { is_expected.to respond_to(:communication_preferences) }
+  it { is_expected.to respond_to(:conversations) }
+  it { is_expected.to respond_to(:crm) }
+  it { is_expected.to respond_to(:events) }
+  it { is_expected.to respond_to(:files) }
+  it { is_expected.to respond_to(:marketing) }
+  it { is_expected.to respond_to(:o_auth) }
+  it { is_expected.to respond_to(:webhooks) }
+end

data/spec/discovery/cms/audit-logs/audit_logs_api_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::AuditLogs::AuditLogsApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').cms.audit_logs.audit_logs_api }
+  
+  it { is_expected.to respond_to(:get_page) }
+end

data/spec/discovery/cms/blogs/authors/blog_authors_api_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Blogs::Authors::BlogAuthorsApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').cms.blogs.authors.blog_authors_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:archive_batch) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:create_batch) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:read_batch) }
+  it { is_expected.to respond_to(:update) }
+  it { is_expected.to respond_to(:update_batch) }
+end

data/spec/discovery/cms/blogs/blog-posts/blog_posts_api_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Blogs::BlogPosts::BlogPostsApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').cms.blogs.blog_posts.blog_posts_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:archive_batch) }
+  it { is_expected.to respond_to(:clone) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:create_batch) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_draft_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:get_previous_version) }
+  it { is_expected.to respond_to(:get_previous_versions) }
+  it { is_expected.to respond_to(:push_live) }
+  it { is_expected.to respond_to(:read_batch) }
+  it { is_expected.to respond_to(:reset_draft) }
+  it { is_expected.to respond_to(:restore_previous_version) }
+  it { is_expected.to respond_to(:restore_previous_version_to_draft) }
+  it { is_expected.to respond_to(:schedule) }
+  it { is_expected.to respond_to(:update) }
+  it { is_expected.to respond_to(:update_batch) }
+  it { is_expected.to respond_to(:update_draft) }
+end

data/spec/discovery/cms/blogs/tags/blog_tags_api_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Blogs::Tags::BlogTagsApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').cms.blogs.tags.blog_tags_api }
+  
+  it { is_expected.to respond_to(:archive) }
+  it { is_expected.to respond_to(:archive_batch) }
+  it { is_expected.to respond_to(:create) }
+  it { is_expected.to respond_to(:create_batch) }
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:read_batch) }
+  it { is_expected.to respond_to(:update) }
+  it { is_expected.to respond_to(:update_batch) }
+end

data/spec/discovery/cms/domains/domains_api_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Domains::DomainsApi' do
+  subject(:domains_api) { Hubspot::Client.new(access_token: 'test').cms.domains.domains_api }
+  
+  it { is_expected.to respond_to(:get_by_id) }
+  it { is_expected.to respond_to(:get_page) }
+end

data/spec/discovery/cms/hubdb/rows_api_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Hubdb::RowsApi' do
+  subject(:rows_api) { Hubspot::Client.new(access_token: 'test').cms.hubdb.rows_api }
+  
+  it { is_expected.to respond_to(:clone_draft_table_row) }
+  it { is_expected.to respond_to(:create_table_row) }
+  it { is_expected.to respond_to(:get_draft_table_row_by_id) }
+  it { is_expected.to respond_to(:get_table_row) }
+  it { is_expected.to respond_to(:get_table_rows) }
+  it { is_expected.to respond_to(:purge_draft_table_row) }
+  it { is_expected.to respond_to(:read_draft_table_rows) }
+  it { is_expected.to respond_to(:replace_draft_table_row) }
+  it { is_expected.to respond_to(:update_draft_table_row) }
+end

data/spec/discovery/cms/hubdb/rows_batch_api_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Hubdb::RowsBatchApi' do
+  subject(:rows_batch_api) { Hubspot::Client.new(access_token: 'test').cms.hubdb.rows_batch_api }
+  
+  it { is_expected.to respond_to(:batch_clone_draft_table_rows) }
+  it { is_expected.to respond_to(:batch_create_draft_table_rows) }
+  it { is_expected.to respond_to(:batch_purge_draft_table_rows) }
+  it { is_expected.to respond_to(:batch_read_draft_table_rows) }
+  it { is_expected.to respond_to(:batch_read_table_rows) }
+  it { is_expected.to respond_to(:batch_replace_draft_table_rows) }
+  it { is_expected.to respond_to(:batch_update_draft_table_rows) }
+end

data/spec/discovery/cms/hubdb/tables_api_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Hubdb::TablesApi' do
+  subject(:tables_api) { Hubspot::Client.new(access_token: 'test').cms.hubdb.tables_api }
+  
+  it { is_expected.to respond_to(:archive_table) }
+  it { is_expected.to respond_to(:clone_draft_table) }
+  it { is_expected.to respond_to(:create_table) }
+  it { is_expected.to respond_to(:export_draft_table) }
+  it { is_expected.to respond_to(:export_table) }
+  it { is_expected.to respond_to(:get_all_draft_tables) }
+  it { is_expected.to respond_to(:get_all_tables) }
+  it { is_expected.to respond_to(:get_draft_table_details_by_id) }
+  it { is_expected.to respond_to(:get_table_details) }
+  it { is_expected.to respond_to(:import_draft_table) }
+  it { is_expected.to respond_to(:publish_draft_table) }
+  it { is_expected.to respond_to(:unpublish_table) }
+  it { is_expected.to respond_to(:reset_draft_table) }
+  it { is_expected.to respond_to(:update_draft_table) }
+end

data/spec/discovery/cms/performance/public_performance_api_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe 'Hubspot::Discovery::Cms::Performance::PublicPerformanceApi' do
+  subject(:api) { Hubspot::Client.new(access_token: 'test').cms.performance.public_performance_api }
+  
+  it { is_expected.to respond_to(:get_page) }
+  it { is_expected.to respond_to(:get_uptime) }
+end