hubspot-ruby 0.5.0 → 0.6.0

data/spec/lib/hubspot/contact_spec.rb

@@ -1,6 +1,6 @@
-describe Hubspot::Contact do
+RSpec.describe Hubspot::Contact do
   let(:example_contact_hash) do
-    VCR.use_cassette('contact_example', record: :none) do
+    VCR.use_cassette('contact_example') do
       HTTParty.get('https://api.hubapi.com/contacts/v1/contact/email/testingapis@hubspot.com/profile?hapikey=demo').parsed_response
     end
   end
@@ -52,34 +52,52 @@ describe Hubspot::Contact do
   end
 
   describe '.createOrUpdate' do
-    cassette 'contact_create_or_update'
-    let(:params){{}}
-    subject{ Hubspot::Contact.createOrUpdate(email, params) }
-    context 'with a new email' do
-      let(:email){ "newcontact#{Time.now.to_i}@hsgem.com" }
-      it{ should be_an_instance_of Hubspot::Contact }
-      its(:email){ should match /newcontact.*@hsgem.com/ } # Due to VCR the email may not match exactly
+    context "when the contact already exists" do
+      it "updates the contact" do
+        VCR.use_cassette("contacts/update_contact") do
+          existing_contact = Hubspot::Contact.create!("contact@example.com")
+          email = existing_contact.email
+          new_email = "new_email@example.com"
+          params = { email: new_email }
 
-      context 'and some params' do
-        cassette 'contact_create_or_update_with_params'
-        let(:email){ "newcontact_x_#{Time.now.to_i}@hsgem.com" }
-        let(:params){ {firstname: 'Hugh', lastname: 'Jackman' } }
-        its(['firstname']){ should == 'Hugh'}
-        its(['lastname']){ should == 'Jackman'}
+          contact = Hubspot::Contact.createOrUpdate(email, params)
+
+          assert_requested :post, hubspot_api_url("/contacts/v1/contact/createOrUpdate/email/#{email}?hapikey=demo")
+          expect(contact).to be_a(Hubspot::Contact)
+          expect(contact.email).to eq(new_email)
+
+          contact.destroy!
+        end
       end
     end
-    context 'with an existing email' do
-      cassette 'contact_create_or_update_existing_email'
-      let(:email){ 'testingapis@hubspot.com' }
-      let(:params){ { firstname: 'Hugh', lastname: 'Jackman, Jr.' } }
-      its(['firstname']){ should == 'Hugh'}
-      its(['lastname']){ should == 'Jackman, Jr.'}
+
+    context "when the contact does not exist" do
+      it "creates the contact" do
+        VCR.use_cassette("contacts/create_contact") do
+          email = "new_contact@example.com"
+          params = { firstname: "Leslie", lastname: "Knope" }
+
+          contact = Hubspot::Contact.createOrUpdate(email, params)
+
+          assert_requested :post, hubspot_api_url("/contacts/v1/contact/createOrUpdate/email/#{email}?hapikey=demo")
+
+          expect(contact).to be_a(Hubspot::Contact)
+          expect(contact.email).to eq(email)
+          expect(contact[:firstname]).to eq(params[:firstname])
+          expect(contact[:lastname]).to eq(params[:lastname])
+
+          contact.destroy!
+        end
+      end
     end
-    context 'with an invalid email' do
-      cassette 'contact_create_or_update_invalid_email'
-      let(:email){ 'not_an_email' }
-      it 'raises a RequestError' do
-        expect{ subject }.to raise_error Hubspot::RequestError
+
+    context "with an invalid email" do
+      it "raises an error" do
+        VCR.use_cassette("contact_create_or_update_invalid_email") do
+          expect {
+            Hubspot::Contact.createOrUpdate("not_an_email")
+          }.to raise_error(Hubspot::RequestError)
+        end
       end
     end
   end

data/spec/lib/hubspot/deal_pipeline_spec.rb

@@ -0,0 +1,85 @@
+RSpec.describe Hubspot::DealPipeline do
+  before do
+    Hubspot.configure hapikey: 'demo'
+  end
+
+  describe ".find" do
+    it "retrieves a record by id" do
+      VCR.use_cassette("find_deal_pipeline") do
+        deal_pipeline = Hubspot::DealPipeline.create!(label: "New Pipeline")
+        id = deal_pipeline.pipeline_id
+
+        result = Hubspot::DealPipeline.find(deal_pipeline.pipeline_id)
+
+        assert_requested :get, hubspot_api_url("/deals/v1/pipelines/#{id}")
+        expect(result).to be_a(Hubspot::DealPipeline)
+
+        deal_pipeline.destroy!
+      end
+    end
+  end
+
+  describe ".all" do
+    it "returns a list" do
+      VCR.use_cassette("all_deal_pipelines") do
+        deal_pipeline = Hubspot::DealPipeline.create!(label: "New Pipeline")
+
+        results = Hubspot::DealPipeline.all
+
+        assert_requested :get, hubspot_api_url("/deals/v1/pipelines")
+        expect(results).to be_kind_of(Array)
+        expect(results.first).to be_a(Hubspot::DealPipeline)
+
+        deal_pipeline.destroy!
+      end
+    end
+  end
+
+  describe ".create!" do
+    it "creates a new record" do
+      VCR.use_cassette("create_deal_pipeline") do
+        result = Hubspot::DealPipeline.create!(label: "New Pipeline")
+
+        assert_requested :post, hubspot_api_url("/deals/v1/pipelines")
+        expect(result).to be_a(Hubspot::DealPipeline)
+
+        result.destroy!
+      end
+    end
+  end
+
+  describe "#destroy!" do
+    it "deletes the record" do
+      VCR.use_cassette("delete_deal_pipeline") do
+        deal_pipeline = Hubspot::DealPipeline.create!(label: "New Pipeline")
+        id = deal_pipeline.pipeline_id
+
+        result = deal_pipeline.destroy!
+
+        assert_requested :delete, hubspot_api_url("/deals/v1/pipelines/#{id}")
+        expect(result).to be_a(HTTParty::Response)
+      end
+    end
+  end
+
+  describe "#[]" do
+    it "returns the stage at the specified index" do
+      data = {
+        "stages" => [
+          {"active": true, "label": "New Lead"},
+          {"active": true, "label": "Proposal"},
+        ],
+      }
+
+      deal_pipeline = Hubspot::DealPipeline.new(data)
+
+      result = deal_pipeline[0]
+
+      expect(result).to eq(data["stages"][0])
+    end
+  end
+
+  def hubspot_api_url(path)
+    URI.join(Hubspot::Config.base_url, path, "?hapikey=demo")
+  end
+end

data/spec/lib/hubspot/deal_properties_spec.rb

@@ -15,13 +15,13 @@ describe Hubspot::DealProperties do
   end
 
   let(:example_groups) do
-    VCR.use_cassette('deal_groups_example', record: :once) do
+    VCR.use_cassette('deal_groups_example') do
       HTTParty.get('https://api.hubapi.com/deals/v1/groups?hapikey=demo').parsed_response
     end
   end
 
   let(:example_properties) do
-    VCR.use_cassette('deal_properties_example', record: :once) do
+    VCR.use_cassette('deal_properties_example') do
       HTTParty.get('https://api.hubapi.com/deals/v1/properties?hapikey=demo').parsed_response
     end
   end

data/spec/lib/hubspot/form_spec.rb

@@ -1,7 +1,7 @@
 describe Hubspot::Form do
   let(:guid) { '78c2891f-ebdd-44c0-bd94-15c012bbbfbf' } # '561d9ce9-bb4c-45b4-8e32-21cdeaa3a7f0'
   let(:example_form_hash) do
-    VCR.use_cassette('form_example', record: :none) do
+    VCR.use_cassette('form_example') do
       HTTParty.get("https://api.hubapi.com#{Hubspot::Form::FORMS_PATH}/#{guid}/?hapikey=demo").parsed_response
     end
   end

data/spec/lib/hubspot/utils_spec.rb

@@ -31,13 +31,13 @@ describe Hubspot::Utils do
 
   describe '.compare_property_lists for ContactProperties' do
     let(:example_groups) do
-      VCR.use_cassette('groups_example', record: :once) do
+      VCR.use_cassette('groups_example') do
         HTTParty.get('https://api.hubapi.com/contacts/v2/groups?hapikey=demo').parsed_response
       end
     end
 
     let(:example_properties) do
-      VCR.use_cassette('properties_example', record: :once) do
+      VCR.use_cassette('properties_example') do
         HTTParty.get('https://api.hubapi.com/contacts/v2/properties?hapikey=demo').parsed_response
       end
     end
@@ -80,13 +80,13 @@ describe Hubspot::Utils do
 
   describe '.compare_property_lists for DealProperties' do
     let(:example_groups) do
-      VCR.use_cassette('deal_groups_example', record: :once) do
+      VCR.use_cassette('deal_groups_example') do
         HTTParty.get('https://api.hubapi.com/deals/v1/groups?hapikey=demo').parsed_response
       end
     end
 
     let(:example_properties) do
-      VCR.use_cassette('deal_properties_example', record: :once) do
+      VCR.use_cassette('deal_properties_example') do
         HTTParty.get('https://api.hubapi.com/deals/v1/properties?hapikey=demo').parsed_response
       end
     end

data/spec/lib/tasks/hubspot_spec.rb

@@ -0,0 +1,100 @@
+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
+
+    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
+
+    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
+
+  def capture_stdout
+    previous, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = previous
+  end
+end

data/spec/spec_helper.rb

@@ -13,17 +13,11 @@ end
 require 'rspec'
 require 'webmock/rspec'
 require 'hubspot-ruby'
-require 'vcr'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{RSPEC_ROOT}/support/**/*.rb"].each {|f| require f}
 
-VCR.configure do |c|
-  c.cassette_library_dir = "#{RSPEC_ROOT}/fixtures/vcr_cassettes"
-  c.hook_into :webmock
-end
-
 RSpec.configure do |config|
   config.mock_with :rr
 
@@ -31,14 +25,6 @@ RSpec.configure do |config|
     Hubspot::Config.reset!
   end
 
-  config.around(:each, live: true) do |example|
-    VCR.turn_off!
-    WebMock.disable!
-    example.run
-    WebMock.enable!
-    VCR.turn_on!
-  end
-
   config.extend CassetteHelper
   config.extend TestsHelper
 end

data/spec/support/cassette_helper.rb

@@ -1,7 +1,7 @@
 module CassetteHelper
   def self.extended(base)
     base.around do |spec|
-      VCR.insert_cassette(_cassette, record: :new_episodes) if defined?(_cassette) && _cassette
+      VCR.insert_cassette(_cassette) if defined?(_cassette) && _cassette
       spec.run
       VCR.eject_cassette if defined?(_cassette) && _cassette
     end

data/spec/support/hubspot_api_helpers.rb

@@ -0,0 +1,9 @@
+module HubspotApiHelpers
+  def hubspot_api_url(path)
+    URI.join(Hubspot::Config.base_url, path)
+  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/vcr.rb

@@ -0,0 +1,15 @@
+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 }
+end