hubspot-api-ruby 0.8.0 → 0.10.0

data/spec/lib/hubspot/company_spec.rb

@@ -1,16 +1,4 @@
 RSpec.describe Hubspot::Company do
-  # let(:example_company_hash) do
-  #   VCR.use_cassette("company_example") do
-  #     HTTParty.get("https://api.hubapi.com/companies/v2/companies/21827084?hapikey=demo").parsed_response
-  #   end
-  # end
-  # let(:company_with_contacts_hash) do
-  #   VCR.use_cassette("company_with_contacts") do
-  #     HTTParty.get("https://api.hubapi.com/companies/v2/companies/115200636?hapikey=demo").parsed_response
-  #   end
-  # end
-
-  before{ Hubspot.configure(hapikey: "demo") }
 
   it_behaves_like "a saveable resource", :company do
     def set_property(company)
@@ -42,7 +30,7 @@ RSpec.describe Hubspot::Company do
       it 'raises an error' do
         expect {
           subject
-        }.to raise_error(Hubspot::RequestError, /resource not found/)
+        }.to raise_error(Hubspot::NotFoundError, /resource not found/)
       end
     end
   end
@@ -175,7 +163,7 @@ RSpec.describe Hubspot::Company do
 
         expect {
           described_class.find subject.id
-        }.to raise_error(Hubspot::RequestError)
+        }.to raise_error(Hubspot::NotFoundError)
       end
     end
   end
@@ -279,13 +267,11 @@ RSpec.describe Hubspot::Company do
       subject { described_class.add_contact company.id, contact.id }
 
       it 'returns success' do
-        expect(subject).to be_truthy
+        expect(subject).to be true
       end
 
       it 'adds the contact to the company' do
-        expect {
-          subject
-        }.to change { company.contact_ids }.by([contact.id])
+        expect { subject }.to change { company.contact_ids }.by([contact.id])
       end
     end
 
@@ -294,12 +280,10 @@ RSpec.describe Hubspot::Company do
 
       let(:company) { create :company }
 
-      subject { described_class.add_contact company.id, 1 }
+      subject { described_class.add_contact company.id, 1234 }
 
-      it 'raises an error' do
-        expect {
-          subject
-        }.to raise_error(Hubspot::RequestError, /Contact with the vid/)
+      it 'returns false' do
+        expect(subject).to eq(false)
       end
     end
 
@@ -309,32 +293,30 @@ RSpec.describe Hubspot::Company do
       subject { described_class.add_contact 1, 1 }
 
       it 'raises an error' do
-        expect {
-          subject
-        }.to raise_error(Hubspot::RequestError, /company with the ID/)
+        expect(subject).to eq(false)
       end
     end
   end
 
   describe '.remove_contact' do
     context 'with a valid company ID and contact ID' do
-      cassette allow_playback_repeats: true
+      cassette
 
-      let!(:company) { create :company }
-      let!(:contact) { create :contact, associatedCompanyId: company.id }
+      let(:company) { create :company }
+      let(:contact) { create :contact }
 
+      before { described_class.add_contact(company.id, contact.id) }
       subject { described_class.remove_contact company.id, contact.id }
 
       it 'returns success' do
-        expect(subject).to be_truthy
+        expect(subject).to be true
       end
 
-      # Testing this turns out to be hard since using associatedCompanyId doesn't immediately add
-      # the contact to the company but triggers some background job to perform the update. Since
-      # we're testing the gem interface and not the API (that's Hubspot's job) this should be OK to
-      # leave out.
-      #
-      # it 'removes the contact from the company'
+      it 'removes the contact from the company' do
+        expect(company.contact_ids.resources).to eq [contact.id]
+        subject
+        expect(company.contact_ids.resources).to eq []
+      end
     end
   end
 end

data/spec/lib/hubspot/config_spec.rb

@@ -1,26 +1,23 @@
 describe Hubspot::Config do
   describe ".configure" do
-    it "sets the hapikey config" do
-      hapikey = "demo"
+    it "sets the access token config" do
+      access_token = "foobar"
 
-      config = Hubspot::Config.configure(hapikey: hapikey)
+      config = Hubspot::Config.configure(access_token: access_token)
 
-      expect(config.hapikey).to eq(hapikey)
+      expect(config.access_token).to eq(access_token)
     end
 
     it "changes the base_url" do
       base_url = "https://api.hubapi.com/v2"
 
-      config = Hubspot::Config.configure(
-        hapikey: "123abc",
-        base_url: base_url
-      )
+      config = Hubspot::Config.configure(base_url: base_url, access_token: 'foobar')
 
       expect(config.base_url).to eq(base_url)
     end
 
     it "sets a default value for base_url" do
-      config = Hubspot::Config.configure(hapikey: "123abc")
+      config = Hubspot::Config.configure(access_token: 'foobar')
 
       expect(config.base_url).to eq("https://api.hubapi.com")
     end
@@ -29,7 +26,7 @@ describe Hubspot::Config do
       portal_id = "62515"
 
       config = Hubspot::Config.configure(
-        hapikey: "123abc",
+        access_token: 'foobar',
         portal_id: portal_id
       )
 
@@ -50,15 +47,28 @@ describe Hubspot::Config do
         })
       }.to raise_error(Hubspot::ConfigurationError)
     end
+
+    context 'hapikey deprecation' do
+      it "sets the hapikey config and sends a deprecation warning" do
+        previous, $stderr = $stderr, StringIO.new
+
+        hapikey = 'demo'
+        config = Hubspot::Config.configure(hapikey: hapikey)
+        expect(config.hapikey).to eq(hapikey)
+        expect($stderr.string).to include 'please use access_token instead.'
+      ensure
+        $stderr = previous
+      end
+    end
   end
 
   describe ".reset!" do
     it "resets the config values" do
-      Hubspot::Config.configure(hapikey: "123abc", portal_id: "456def")
+      Hubspot::Config.configure(access_token: "123abc", portal_id: "456def")
 
       Hubspot::Config.reset!
 
-      expect(Hubspot::Config.hapikey).to be nil
+      expect(Hubspot::Config.access_token).to be nil
       expect(Hubspot::Config.portal_id).to be nil
     end
   end
@@ -66,7 +76,7 @@ describe Hubspot::Config do
   describe ".ensure!" do
     context "when a specified parameter is missing" do
       it "raises an error" do
-        Hubspot::Config.configure(hapikey: "123abc")
+        Hubspot::Config.configure(access_token: "123abc")
 
         expect {
           Hubspot::Config.ensure!(:portal_id)
@@ -76,7 +86,7 @@ describe Hubspot::Config do
 
     context "when all specified parameters are present" do
       it "does not raise an error" do
-        Hubspot::Config.configure(hapikey: "123abc", portal_id: "456def")
+        Hubspot::Config.configure(access_token: "123abc", portal_id: "456def")
 
         expect {
           Hubspot::Config.ensure!(:portal_id)

data/spec/lib/hubspot/connection_spec.rb

@@ -1,18 +1,12 @@
 describe Hubspot::Connection do
-  before do
-    Hubspot.configure hapikey: 'fake'
-  end
-
   describe ".get_json" do
     it "returns the parsed response from the GET request" do
       path = "/some/path"
       body = { key: "value" }
 
-      stub_request(:get, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 200, body: JSON.generate(body))
+      stub_request(:get, "https://api.hubapi.com/some/path").to_return(status: 200, body: JSON.generate(body))
 
       result = Hubspot::Connection.get_json(path, {})
-
       expect(result).to eq({ "key" => "value" })
     end
   end
@@ -22,11 +16,9 @@ describe Hubspot::Connection do
       path = "/some/path"
       body = { id: 1, name: "ABC" }
 
-      stub_request(:post, "https://api.hubapi.com/some/path?hapikey=fake&name=ABC").
-        to_return(status: 200, body: JSON.generate(body))
+      stub_request(:post, "https://api.hubapi.com/some/path?name=ABC").to_return(status: 200, body: JSON.generate(body))
 
       result = Hubspot::Connection.post_json(path, params: { name: "ABC" })
-
       expect(result).to eq({ "id" => 1, "name" => "ABC" })
     end
   end
@@ -35,11 +27,9 @@ describe Hubspot::Connection do
     it "returns the response from the DELETE request" do
       path = "/some/path"
 
-      stub_request(:delete, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 204, body: JSON.generate({}))
+      stub_request(:delete, "https://api.hubapi.com/some/path").to_return(status: 204, body: JSON.generate({}))
 
       result = Hubspot::Connection.delete_json(path, {})
-
       expect(result.code).to eq(204)
     end
   end
@@ -49,20 +39,18 @@ describe Hubspot::Connection do
       path = "/some/path"
       update_options = { params: {}, body: {} }
 
-      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 200, body: JSON.generate(vid: 123))
+      stub_request(:put, "https://api.hubapi.com/some/path").to_return(status: 200, body: JSON.generate(vid: 123))
 
       response = Hubspot::Connection.put_json(path, update_options)
 
       assert_requested(
         :put,
-        "https://api.hubapi.com/some/path?hapikey=fake",
+        "https://api.hubapi.com/some/path",
          {
            body: "{}",
            headers: { "Content-Type" => "application/json" },
          }
       )
-
       expect(response).to eq({ "vid" => 123 })
     end
 
@@ -72,13 +60,13 @@ describe Hubspot::Connection do
 
       logger = stub_logger
 
-      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 200, body: JSON.generate("response body"))
+      stub_request(:put, "https://api.hubapi.com/some/path").to_return(status: 200,
+                                                                       body: JSON.generate("response body"))
 
       Hubspot::Connection.put_json(path, update_options)
 
       expect(logger).to have_received(:info).with(<<~MSG)
-        Hubspot: https://api.hubapi.com/some/path?hapikey=fake.
+        Hubspot: https://api.hubapi.com/some/path.
         Body: {}.
         Response: 200 "response body"
       MSG
@@ -88,8 +76,7 @@ describe Hubspot::Connection do
       path = "/some/path"
       update_options = { params: {}, body: {} }
 
-      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
-        to_return(status: 401)
+      stub_request(:put, "https://api.hubapi.com/some/path").to_return(status: 401)
 
       expect {
         Hubspot::Connection.put_json(path, update_options)
@@ -99,80 +86,85 @@ describe Hubspot::Connection do
 
   context 'private methods' do
     describe ".generate_url" do
-      let(:path){ "/test/:email/profile" }
-      let(:params){{email: "test"}}
-      let(:options){{}}
-      subject{ Hubspot::Connection.send(:generate_url, path, params, options) }
-      before{ Hubspot.configure(hapikey: "demo", portal_id: "62515") }
+      let(:path) { "/test/:email/profile" }
+      let(:params) { { email: "test" } }
+      let(:options) { {} }
+      subject { Hubspot::Connection.send(:generate_url, path, params, options) }
 
       it "doesn't modify params" do
-        expect{ subject }.to_not change{params}
+        expect { subject }.to_not change{params}
       end
 
       context "with a portal_id param" do
-        let(:path){ "/test/:portal_id/profile" }
-        let(:params){{}}
-        it{ should == "https://api.hubapi.com/test/62515/profile?hapikey=demo" }
+        let(:path) { "/test/:portal_id/profile" }
+        let(:params) { {} }
+
+        before do
+          Hubspot.configure(access_token: ENV.fetch("HUBSPOT_ACCESS_TOKEN"), portal_id: ENV.fetch("HUBSPOT_PORTAL_ID"))
+        end
+
+        it { should == "https://api.hubapi.com/test/#{ENV.fetch('HUBSPOT_PORTAL_ID')}/profile" }
       end
 
       context "when configure hasn't been called" do
-        before{ Hubspot::Config.reset! }
+        before { Hubspot::Config.reset! }
         it "raises a config exception" do
-          expect{ subject }.to raise_error Hubspot::ConfigurationError
+          expect { subject }.to raise_error Hubspot::ConfigurationError
         end
       end
 
       context "with interpolations but no params" do
-        let(:params){{}}
+        let(:params) { {} }
+
         it "raises an interpolation exception" do
           expect{ subject }.to raise_error Hubspot::MissingInterpolation
         end
       end
 
       context "with an interpolated param" do
-        let(:params){ {email: "email@address.com"} }
-        it{ should == "https://api.hubapi.com/test/email%40address.com/profile?hapikey=demo" }
+        let(:params) { { email: "email@address.com" } }
+        it { should == "https://api.hubapi.com/test/email%40address.com/profile" }
       end
 
       context "with multiple interpolated params" do
-        let(:path){ "/test/:email/:id/profile" }
-        let(:params){{email: "email@address.com", id: 1234}}
-        it{ should == "https://api.hubapi.com/test/email%40address.com/1234/profile?hapikey=demo" }
+        let(:path) { "/test/:email/:id/profile" }
+        let(:params) { { email: "email@address.com", id: 1234 } }
+        it { should == "https://api.hubapi.com/test/email%40address.com/1234/profile" }
       end
 
       context "with query params" do
-        let(:params){{email: "email@address.com", id: 1234}}
-        it{ should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&hapikey=demo" }
+        let(:params) { { email: "email@address.com", id: 1234 } }
+        it { should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234" }
 
         context "containing a time" do
           let(:start_time) { Time.now }
-          let(:params){{email: "email@address.com", id: 1234, start: start_time}}
-          it{ should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&start=#{start_time.to_i * 1000}&hapikey=demo" }
+          let(:params) { { email: "email@address.com", id: 1234, start: start_time } }
+          it { should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&start=#{start_time.to_i * 1000}" }
         end
 
         context "containing a range" do
           let(:start_time) { Time.now }
           let(:end_time) { Time.now + 1.year }
-          let(:params){{email: "email@address.com", id: 1234, created__range: start_time..end_time }}
-          it{ should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&created__range=#{start_time.to_i * 1000}&created__range=#{end_time.to_i * 1000}&hapikey=demo" }
+          let(:params) { { email: "email@address.com", id: 1234, created__range: start_time..end_time  } }
+          it { should == "https://api.hubapi.com/test/email%40address.com/profile?id=1234&created__range=#{start_time.to_i * 1000}&created__range=#{end_time.to_i * 1000}" }
         end
 
         context "containing an array of strings" do
-          let(:path){ "/test/emails" }
-          let(:params){{batch_email: %w(email1@example.com email2@example.com)}}
-          it{ should == "https://api.hubapi.com/test/emails?email=email1%40example.com&email=email2%40example.com&hapikey=demo" }
+          let(:path) { "/test/emails" }
+          let(:params) { { batch_email: %w(email1@example.com email2@example.com) } }
+          it { should == "https://api.hubapi.com/test/emails?email=email1%40example.com&email=email2%40example.com" }
         end
       end
 
       context "with options" do
-        let(:options){ {base_url: "https://cool.com", hapikey: false} }
-        it{ should == "https://cool.com/test/test/profile"}
+        let(:options) { { base_url: "https://cool.com", access_token: false } }
+        it { should == "https://cool.com/test/test/profile" }
       end
 
       context "passing Array as parameters for batch mode, key is prefixed with batch_" do
         let(:path) { Hubspot::ContactList::LIST_BATCH_PATH }
         let(:params) { { batch_list_id: [1,2,3] } }
-        it{ should == "https://api.hubapi.com/contacts/v1/lists/batch?listId=1&listId=2&listId=3&hapikey=demo" }
+        it { should == "https://api.hubapi.com/contacts/v1/lists/batch?listId=1&listId=2&listId=3" }
       end
     end
   end
@@ -191,10 +183,7 @@ describe Hubspot::EventConnection do
     let(:headers) { nil }
 
     subject { described_class.trigger(path, options) }
-    before do
-      Hubspot.configure(hapikey: 'demo', portal_id: '62515')
-      allow(described_class).to receive(:get).and_return(true)
-    end
+    before { allow(described_class).to receive(:get).and_return(true) }
 
     it 'calls get with a custom url' do
       subject