hubspot-api-ruby 0.8.0

data/spec/lib/tasks/hubspot_spec.rb

@@ -0,0 +1,119 @@
+require "rake"
+require "stringio"
+require "tempfile"
+
+RSpec.describe "hubspot rake tasks", type: :rake do
+  let(:hapikey) { "demo" }
+
+  describe "hubspot:dump_properties" do
+    it "writes the class properties and groups to the given file" do
+      VCR.use_cassette("dump_contact_properties_and_groups") do
+        file = Tempfile.new
+
+        invoke_rake_task("hubspot:dump_properties", ["contact", file, hapikey])
+
+        result = JSON.parse(File.read(file))
+
+        expect(result.count).to be > 0
+        expect(result['groups'].count).to be > 0
+        expect(result['properties'].count).to be > 0
+      end
+    end
+
+    it "prints a deprecation warning" do
+      VCR.use_cassette("dump_contact_properties_and_groups") do
+        file = Tempfile.new ""
+
+        output = capture_stderr do
+          invoke_rake_task("hubspot:dump_properties", ["contact", file, hapikey])
+        end
+
+        expect(output).to include("hubspot:dump_properties is deprecated")
+      end
+    end
+
+    context "given an unknown class" do
+      it "raises an error" do
+        file = Tempfile.new
+
+        expected_error_msg = ':kind must be either "contact" or "deal"'
+
+        expect do
+          invoke_rake_task(
+            "hubspot:dump_properties",
+            ["unknown_class", file, hapikey]
+          )
+        end.to raise_error(ArgumentError, expected_error_msg)
+      end
+    end
+  end
+
+  describe "hubspot:restore_properties" do
+    context "when the class properties match the existing properties" do
+      it "should not need to make any changes" do
+        VCR.use_cassette("restore_contact_properties_and_groups") do
+          file = build_file_with_matching_properties("contact")
+
+          results = capture_stdout do
+            invoke_rake_task(
+              "hubspot:restore_properties",
+              ["contact", file, hapikey]
+            )
+          end
+
+          expect(results).not_to include("Created: ")
+          expect(results).not_to include("Updated: ")
+        end
+      end
+    end
+
+    it "prints a deprecation warning" do
+      VCR.use_cassette("restore_contact_properties_and_groups") do
+        file = build_file_with_matching_properties("contact")
+
+        output = capture_stderr do
+          invoke_rake_task(
+            "hubspot:restore_properties",
+            ["contact", file, hapikey]
+          )
+        end
+
+        expect(output).to include("hubspot:restore_properties is deprecated")
+      end
+    end
+
+    context "when a file is not provided" do
+      it "raises an error" do
+        missing_file = ""
+        expected_error_msg = ":file is a required parameter"
+
+        expect do
+          invoke_rake_task(
+            "hubspot:restore_properties",
+            ["contact", missing_file, hapikey]
+          )
+        end.to raise_error(ArgumentError, expected_error_msg)
+      end
+    end
+
+    context "given an unknown class" do
+      it "raises an error" do
+        file = Tempfile.new
+        expected_error_msg = ':kind must be either "contact" or "deal"'
+
+        expect do
+          invoke_rake_task(
+            "hubspot:restore_properties",
+            ["unknown_class", file, hapikey]
+          )
+        end.to raise_error(ArgumentError, expected_error_msg)
+      end
+    end
+  end
+
+  def build_file_with_matching_properties(klass)
+    file = Tempfile.new
+    invoke_rake_task("hubspot:dump_properties", ["contact", file, hapikey])
+    file
+  end
+end

data/spec/shared_examples/saveable_resource.rb

@@ -0,0 +1,45 @@
+RSpec.shared_examples_for "a saveable resource" do |factory_name|
+  describe '#save' do
+    context 'with a new resource' do
+      cassette
+      let(:resource) { build factory_name }
+      subject { resource.save }
+
+      it 'succeeds' do
+        expect(subject).to be_truthy
+      end
+
+      it 'sets the ID' do
+        expect {
+          subject
+        }.to change { resource.id }.from(nil)
+      end
+
+      it 'clears the changes' do
+        expect {
+          subject
+        }.to change { resource.changed? }.from(true).to(false)
+      end
+    end
+
+    context 'with an existing resource' do
+      cassette
+      let(:resource) { create factory_name }
+      subject { resource.save }
+
+      before(:each) do
+        set_property(resource)
+      end
+
+      it 'succeeds' do
+        expect(subject).to be_truthy
+      end
+
+      it 'clears the changes' do
+        expect {
+          subject
+        }.to change { resource.changed? }.from(true).to(false)
+      end
+    end
+  end
+end

data/spec/shared_examples/updateable_resource.rb

@@ -0,0 +1,87 @@
+RSpec.shared_examples_for "an updateable resource" do |factory_name|
+  describe '.update' do
+    context 'with an existing resource' do
+      cassette
+      let(:resource) { create factory_name }
+      subject { described_class.update(resource.id, changed_properties) }
+
+      it 'succeeds' do
+        expect(subject).to be_truthy
+      end
+    end
+
+    context 'with an invalid resource' do
+      cassette
+      subject { described_class.update(0, changed_properties) }
+
+      it 'fails' do
+        expect(subject).to be_falsey
+      end
+    end
+  end
+
+  describe '.update!' do
+    context 'with an existing resource' do
+      cassette
+      let(:resource) { create factory_name }
+      subject { described_class.update!(resource.id, changed_properties) }
+
+      it 'succeeds' do
+        expect(subject).to be_truthy
+      end
+    end
+
+    context 'with an invalid resource' do
+      cassette
+      subject { described_class.update!(0, changed_properties) }
+
+      it 'fails with an error' do
+        expect {
+          subject
+        }.to raise_error Hubspot::RequestError
+      end
+    end
+  end
+
+  describe '#update' do
+    context 'with no changes' do
+      cassette
+      let(:resource) { create factory_name }
+      subject { resource.update(changed_properties) }
+
+      it 'succeeds' do
+        expect(subject).to be_truthy
+      end
+
+      it 'updates the properties' do
+        subject
+        changed_properties.each do |property, value|
+          expect(resource.send(property.to_sym)).to eq value
+        end
+      end
+    end
+
+    context 'with overlapping changes' do
+      cassette
+      let(:resource) { create factory_name}
+      subject { resource.update(changed_properties) }
+
+      before(:each) do
+        overlapping_properties.each do |property, value|
+          resource.send("#{property}=".to_sym, value)
+        end
+      end
+
+      it 'succeeds' do
+        expect(subject).to be_truthy
+      end
+
+      it 'merges and updates the properties' do
+        subject
+        overlapping_properties.merge(changed_properties).each do |property, value|
+          expect(resource.send(property.to_sym)).to eq value
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+RSPEC_ROOT = File.dirname(__FILE__)
+GEM_ROOT = File.expand_path("..", RSPEC_ROOT)
+
+require 'simplecov'
+SimpleCov.root GEM_ROOT
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/.bundle/"
+end
+
+require 'dotenv/load'
+require 'rspec'
+require 'rspec/its'
+require 'webmock/rspec'
+require 'factory_bot'
+require 'faker'
+require 'byebug'
+require 'hubspot-api-ruby'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{RSPEC_ROOT}/support/**/*.rb"].each {|f| require f}
+
+# Require shared examples
+Dir["#{RSPEC_ROOT}/shared_examples/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.after(:each) do
+    Hubspot::Config.reset!
+  end
+
+  config.filter_run_when_matching :focus
+
+  # Setup FactoryBot
+  config.include FactoryBot::Syntax::Methods
+  config.before(:suite) do
+    FactoryBot.find_definitions
+  end
+
+  config.extend CassetteHelper
+  config.extend TestsHelper
+end

data/spec/support/capture_output.rb

@@ -0,0 +1,21 @@
+module CaptureOutput
+  def capture_stderr
+    previous, $stderr = $stderr, StringIO.new
+    yield
+    $stderr.string
+  ensure
+    $stderr = previous
+  end
+
+  def capture_stdout
+    previous, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = previous
+  end
+end
+
+RSpec.configure do |config|
+  config.include CaptureOutput
+end

data/spec/support/cassette_helper.rb

@@ -0,0 +1,19 @@
+module CassetteHelper
+  def self.extended(base)
+    base.around do |spec|
+      VCR.insert_cassette(_cassette, _cassette_options) if defined?(_cassette) && _cassette
+      spec.run
+      VCR.eject_cassette if defined?(_cassette) && _cassette
+    end
+  end
+
+  def cassette(*args)
+    options = args.extract_options!
+
+    let(:_cassette) do |example|
+      args.first || example.full_description
+    end
+
+    let(:_cassette_options) { options }
+  end
+end

data/spec/support/hubspot_api_helpers.rb

@@ -0,0 +1,13 @@
+module HubspotApiHelpers
+  def hubspot_api_url(path)
+    URI.join(Hubspot::Config.base_url, path)
+  end
+
+  def assert_hubspot_api_request(method, path, options = {})
+    assert_requested(method, /#{hubspot_api_url(path)}/, options)
+  end
+end
+
+RSpec.configure do |c|
+  c.include HubspotApiHelpers
+end

data/spec/support/rake.rb

@@ -0,0 +1,46 @@
+require "rake"
+
+module RakeHelpers
+  def invoke_rake_task(name, args = [])
+    RakeTask.new(name).invoke(*args)
+  end
+end
+
+class RakeTask
+  def initialize(name)
+    @task_name = name
+    prep_environment
+  end
+
+  delegate :invoke, to: :task
+
+  private
+
+  attr_reader :task_name
+
+  def prep_environment
+    Rake.application = rake
+    Rake.load_rakefile(full_task_path)
+    Rake::Task.define_task(:environment)
+  end
+
+  def full_task_path
+    "#{root_path}/lib/tasks/#{task_name.split(':').first}.rake"
+  end
+
+  def root_path
+    File.expand_path('../..', __dir__)
+  end
+
+  def task
+    rake[task_name]
+  end
+
+  def rake
+    @_rake ||= Rake::Application.new
+  end
+end
+
+RSpec.configure do |config|
+  config.include RakeHelpers, type: :rake
+end

data/spec/support/tests_helper.rb

@@ -0,0 +1,17 @@
+module TestsHelper
+  def expect_count_and_offset(&block)
+    it 'returns only the number of objects specified by count' do
+      result = block.call(count: 2)
+      expect(result.size).to eql 2
+
+      result = block.call(count: 4)
+      expect(result.size).to eql 4
+    end
+
+    it 'returns objects by a specified offset' do
+      non_offset_objects = block.call(count: 2)
+      objects_with_offset = block.call(count: 2, offset: 2)
+      expect(non_offset_objects).to_not eql objects_with_offset
+    end
+  end
+end

data/spec/support/vcr.rb

@@ -0,0 +1,16 @@
+require "vcr"
+
+def vcr_record_mode
+  if ENV["VCR_RECORD"] == "1"
+    :new_episodes
+  else
+    :none
+  end
+end
+
+VCR.configure do |c|
+  c.cassette_library_dir = "#{RSPEC_ROOT}/fixtures/vcr_cassettes"
+  c.hook_into :webmock
+  c.default_cassette_options = { record: vcr_record_mode }
+  c.filter_sensitive_data("<HAPI_KEY>") { ENV.fetch("HUBSPOT_HAPI_KEY", "demo") }
+end

metadata

@@ -0,0 +1,369 @@
+--- !ruby/object:Gem::Specification
+name: hubspot-api-ruby
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Jonathan
+- Juliette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: hubspot-api-ruby is a wrapper for the HubSpot REST API
+email:
+- jonathan@hoggo.com
+- juliette@hoggo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- RELEASING.md
+- Rakefile
+- hubspot-api-ruby.gemspec
+- lib/hubspot-api-ruby.rb
+- lib/hubspot/blog.rb
+- lib/hubspot/collection.rb
+- lib/hubspot/company.rb
+- lib/hubspot/company_properties.rb
+- lib/hubspot/config.rb
+- lib/hubspot/connection.rb
+- lib/hubspot/contact.rb
+- lib/hubspot/contact_list.rb
+- lib/hubspot/contact_properties.rb
+- lib/hubspot/deal.rb
+- lib/hubspot/deal_pipeline.rb
+- lib/hubspot/deal_properties.rb
+- lib/hubspot/deprecator.rb
+- lib/hubspot/engagement.rb
+- lib/hubspot/event.rb
+- lib/hubspot/exceptions.rb
+- lib/hubspot/file.rb
+- lib/hubspot/form.rb
+- lib/hubspot/oauth.rb
+- lib/hubspot/owner.rb
+- lib/hubspot/paged_collection.rb
+- lib/hubspot/properties.rb
+- lib/hubspot/railtie.rb
+- lib/hubspot/resource.rb
+- lib/hubspot/subscription.rb
+- lib/hubspot/topic.rb
+- lib/hubspot/utils.rb
+- lib/tasks/hubspot.rake
+- spec/factories/companies.rb
+- spec/factories/contacts.rb
+- spec/lib/hubspot-ruby_spec.rb
+- spec/lib/hubspot/blog_spec.rb
+- spec/lib/hubspot/company_properties_spec.rb
+- spec/lib/hubspot/company_spec.rb
+- spec/lib/hubspot/config_spec.rb
+- spec/lib/hubspot/connection_spec.rb
+- spec/lib/hubspot/contact_list_spec.rb
+- spec/lib/hubspot/contact_properties_spec.rb
+- spec/lib/hubspot/contact_spec.rb
+- spec/lib/hubspot/deal_pipeline_spec.rb
+- spec/lib/hubspot/deal_properties_spec.rb
+- spec/lib/hubspot/deal_spec.rb
+- spec/lib/hubspot/deprecator_spec.rb
+- spec/lib/hubspot/engagement_spec.rb
+- spec/lib/hubspot/event_spec.rb
+- spec/lib/hubspot/file_spec.rb
+- spec/lib/hubspot/form_spec.rb
+- spec/lib/hubspot/owner_spec.rb
+- spec/lib/hubspot/properties_spec.rb
+- spec/lib/hubspot/resource_spec.rb
+- spec/lib/hubspot/topic_spec.rb
+- spec/lib/hubspot/utils_spec.rb
+- spec/lib/tasks/hubspot_spec.rb
+- spec/shared_examples/saveable_resource.rb
+- spec/shared_examples/updateable_resource.rb
+- spec/spec_helper.rb
+- spec/support/capture_output.rb
+- spec/support/cassette_helper.rb
+- spec/support/hubspot_api_helpers.rb
+- spec/support/rake.rb
+- spec/support/tests_helper.rb
+- spec/support/vcr.rb
+homepage: http://github.com/lounna-sas/hubspot-api-ruby
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/lounna-sas/hubspot-api-ruby/blob/master/History.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: hubspot-api-ruby is a wrapper for the HubSpot REST API
+test_files: []