hubspot-api-ruby 0.8.0

data/spec/lib/hubspot/company_spec.rb

@@ -0,0 +1,340 @@
+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)
+      company.name = "Foobar"
+    end
+  end
+
+  it_behaves_like "an updateable resource", :company do
+    let(:changed_properties) { { name: "Foobar" } }
+    let(:overlapping_properties) { { name: "My Corp", description: "My Corporation" } }
+  end
+
+  describe '.find' do
+    context 'with a valid ID' do
+      cassette
+      let(:company) { create :company }
+      subject { described_class.find company.id }
+
+      it 'finds the company' do
+        expect(subject).to be_a(described_class)
+        expect(subject.id).to eq(company.id)
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      subject { described_class.find 0 }
+
+      it 'raises an error' do
+        expect {
+          subject
+        }.to raise_error(Hubspot::RequestError, /resource not found/)
+      end
+    end
+  end
+
+  describe '.create' do
+    context 'with no properties' do
+      cassette
+      subject { described_class.create }
+
+      it 'creates a new company' do
+        expect(subject).to be_a(described_class)
+        expect(subject.id).not_to be_nil
+      end
+    end
+
+    context 'with properties' do
+      cassette
+
+      let(:name) { "Foo Bar Inc." }
+      let(:properties) { { name: name } }
+      subject { described_class.create properties }
+
+      it 'creates a new company' do
+        expect(subject).to be_a(described_class)
+        expect(subject.id).not_to be_nil
+      end
+
+      it 'has the property set' do
+        expect(subject.name).to eq name
+      end
+
+      it 'is persisted' do
+        expect(subject).to be_persisted
+      end
+    end
+  end
+
+  describe '.new' do
+    context 'with no properties' do
+      it 'returns a company' do
+        expect(subject).to be_a(described_class)
+      end
+
+      it 'has no changes' do
+        expect(subject.changes).to be_empty
+      end
+
+      it 'is not persisted' do
+        expect(subject).not_to be_persisted
+      end
+    end
+
+    context 'with properties' do
+      subject { described_class.new name: Faker::Company.name }
+
+      it 'has changes' do
+        expect(subject.changed?).to be_truthy
+      end
+
+      it 'is not persisted' do
+        expect(subject).not_to be_persisted
+      end
+    end
+
+    context 'with an ID property' do
+      subject { described_class.new id: 1 }
+
+      it 'has changes' do
+        pending "tracking ID property changes"
+        expect(subject.changed?).to be_truthy
+      end
+
+      it 'is not persisted' do
+        pending "persisted flag rework"
+        expect(subject).not_to be_persisted
+      end
+    end
+  end
+
+  describe '#reload' do
+    context 'with a valid ID' do
+      cassette
+
+      let(:company) { create :company }
+      subject { inst = described_class.new(company.id); inst.reload }
+
+      it 'loads the company details' do
+        expect(subject.id).to eq(company.id)
+        expect(subject.name).to eq(company.name)
+      end
+    end
+
+    context 'without an ID' do
+      cassette
+
+      it 'raises an error' do
+        expect {
+          subject.reload
+        }.to raise_error(Hubspot::InvalidParams)
+      end
+    end
+  end
+
+  describe '#delete' do
+    context 'when not persisted' do
+      cassette
+
+      subject { build :company }
+
+      it 'raises an error' do
+        expect {
+          subject.delete
+        }.to raise_error(Hubspot::InvalidParams)
+      end
+    end
+
+    context 'when persisted' do
+      cassette
+
+      subject { create :company }
+
+      it 'sets the deleted flag' do
+        expect {
+          subject.delete
+        }.to change { subject.deleted? }.from(false).to(true)
+      end
+
+      it 'deletes the resource' do
+        subject.delete
+
+        expect {
+          described_class.find subject.id
+        }.to raise_error(Hubspot::RequestError)
+      end
+    end
+  end
+
+  describe '.all' do
+    context 'with no options' do
+      cassette
+
+      subject { described_class.all }
+
+      it 'returns a collection' do
+        expect(subject).to be_a(Hubspot::PagedCollection)
+        expect(subject.first).to be_a(Hubspot::Company)
+      end
+
+      it 'has an offset' do
+        expect(subject.next_offset).not_to be_blank
+      end
+
+      it 'identifies if there are more resources' do
+        expect(subject.more?).not_to be_nil
+      end
+    end
+
+    context 'with an offset' do
+      cassette
+
+      let!(:company) { create :company }
+      subject { described_class.all offset: company.id }
+
+      it 'returns a collection' do
+        expect(subject).to be_a(Hubspot::PagedCollection)
+      end
+
+      it 'has an offset' do
+        expect(subject.next_offset).not_to be_blank
+      end
+
+      it 'identifies if there are more resources' do
+        expect(subject.more?).not_to be_nil
+      end
+    end
+
+    context 'with a limit' do
+      cassette
+
+      let(:limit) { 1 }
+      subject { described_class.all limit: limit }
+
+      it 'returns a collection' do
+        expect(subject).to be_a(Hubspot::PagedCollection)
+        expect(subject.first).to be_a(Hubspot::Company)
+      end
+
+      it 'respects the limit' do
+        expect(subject.size).to eq(limit)
+      end
+    end
+  end
+
+  describe '.search_domain' do
+    cassette
+
+    let!(:company) { create :company }
+
+    subject { described_class.search_domain company.domain }
+
+    it 'returns a collection' do
+      expect(subject).to be_a(Hubspot::PagedCollection)
+      expect(subject.first).to be_a(Hubspot::Company)
+    end
+  end
+
+  describe '.recently_created' do
+    cassette
+
+    subject { described_class.recently_created }
+
+    it 'returns a collection' do
+      expect(subject).to be_a(Hubspot::PagedCollection)
+    end
+  end
+
+  describe '.recently_modified' do
+    cassette
+
+    subject { described_class.recently_modified }
+
+    it 'returns a collection' do
+      expect(subject).to be_a(Hubspot::PagedCollection)
+    end
+  end
+
+  describe '.add_contact' do
+    context 'with a valid company ID and contact ID' do
+      cassette
+
+      let(:company) { create :company }
+      let(:contact) { create :contact }
+
+      subject { described_class.add_contact company.id, contact.id }
+
+      it 'returns success' do
+        expect(subject).to be_truthy
+      end
+
+      it 'adds the contact to the company' do
+        expect {
+          subject
+        }.to change { company.contact_ids }.by([contact.id])
+      end
+    end
+
+    context 'with a valid company ID and invalid contact ID' do
+      cassette
+
+      let(:company) { create :company }
+
+      subject { described_class.add_contact company.id, 1 }
+
+      it 'raises an error' do
+        expect {
+          subject
+        }.to raise_error(Hubspot::RequestError, /Contact with the vid/)
+      end
+    end
+
+    context 'with an invalid company ID' do
+      cassette
+
+      subject { described_class.add_contact 1, 1 }
+
+      it 'raises an error' do
+        expect {
+          subject
+        }.to raise_error(Hubspot::RequestError, /company with the ID/)
+      end
+    end
+  end
+
+  describe '.remove_contact' do
+    context 'with a valid company ID and contact ID' do
+      cassette allow_playback_repeats: true
+
+      let!(:company) { create :company }
+      let!(:contact) { create :contact, associatedCompanyId: company.id }
+
+      subject { described_class.remove_contact company.id, contact.id }
+
+      it 'returns success' do
+        expect(subject).to be_truthy
+      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'
+    end
+  end
+end

data/spec/lib/hubspot/config_spec.rb

@@ -0,0 +1,87 @@
+describe Hubspot::Config do
+  describe ".configure" do
+    it "sets the hapikey config" do
+      hapikey = "demo"
+
+      config = Hubspot::Config.configure(hapikey: hapikey)
+
+      expect(config.hapikey).to eq(hapikey)
+    end
+
+    it "changes the base_url" do
+      base_url = "https://api.hubapi.com/v2"
+
+      config = Hubspot::Config.configure(
+        hapikey: "123abc",
+        base_url: base_url
+      )
+
+      expect(config.base_url).to eq(base_url)
+    end
+
+    it "sets a default value for base_url" do
+      config = Hubspot::Config.configure(hapikey: "123abc")
+
+      expect(config.base_url).to eq("https://api.hubapi.com")
+    end
+
+    it "sets a value for portal_id" do
+      portal_id = "62515"
+
+      config = Hubspot::Config.configure(
+        hapikey: "123abc",
+        portal_id: portal_id
+      )
+
+      expect(config.portal_id).to eq(portal_id)
+    end
+
+    it "raises when an authentication approach is not provided" do
+      expect {
+        Hubspot::Config.configure({})
+      }.to raise_error(Hubspot::ConfigurationError)
+    end
+
+    it "raises when two authentication approaches are provided" do
+      expect {
+        Hubspot::Config.configure({
+          hapikey: "123abc",
+          access_token: "456def",
+        })
+      }.to raise_error(Hubspot::ConfigurationError)
+    end
+  end
+
+  describe ".reset!" do
+    it "resets the config values" do
+      Hubspot::Config.configure(hapikey: "123abc", portal_id: "456def")
+
+      Hubspot::Config.reset!
+
+      expect(Hubspot::Config.hapikey).to be nil
+      expect(Hubspot::Config.portal_id).to be nil
+    end
+  end
+
+  describe ".ensure!" do
+    context "when a specified parameter is missing" do
+      it "raises an error" do
+        Hubspot::Config.configure(hapikey: "123abc")
+
+        expect {
+          Hubspot::Config.ensure!(:portal_id)
+        }.to raise_error(Hubspot::ConfigurationError)
+      end
+    end
+
+    context "when all specified parameters are present" do
+      it "does not raise an error" do
+        Hubspot::Config.configure(hapikey: "123abc", portal_id: "456def")
+
+        expect {
+          Hubspot::Config.ensure!(:portal_id)
+        }.not_to raise_error
+      end
+    end
+  end
+end

data/spec/lib/hubspot/connection_spec.rb

@@ -0,0 +1,214 @@
+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))
+
+      result = Hubspot::Connection.get_json(path, {})
+
+      expect(result).to eq({ "key" => "value" })
+    end
+  end
+
+  describe ".post_json" do
+    it "returns the parsed response from the POST request" 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))
+
+      result = Hubspot::Connection.post_json(path, params: { name: "ABC" })
+
+      expect(result).to eq({ "id" => 1, "name" => "ABC" })
+    end
+  end
+
+  describe ".delete_json" 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({}))
+
+      result = Hubspot::Connection.delete_json(path, {})
+
+      expect(result.code).to eq(204)
+    end
+  end
+
+  describe ".put_json" do
+    it "issues a PUT request and returns the parsed body" 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))
+
+      response = Hubspot::Connection.put_json(path, update_options)
+
+      assert_requested(
+        :put,
+        "https://api.hubapi.com/some/path?hapikey=fake",
+         {
+           body: "{}",
+           headers: { "Content-Type" => "application/json" },
+         }
+      )
+
+      expect(response).to eq({ "vid" => 123 })
+    end
+
+    it "logs information about the request and response" do
+      path = "/some/path"
+      update_options = { params: {}, body: {} }
+
+      logger = stub_logger
+
+      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
+        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.
+        Body: {}.
+        Response: 200 "response body"
+      MSG
+    end
+
+    it "raises when the request fails" do
+      path = "/some/path"
+      update_options = { params: {}, body: {} }
+
+      stub_request(:put, "https://api.hubapi.com/some/path?hapikey=fake").
+        to_return(status: 401)
+
+      expect {
+        Hubspot::Connection.put_json(path, update_options)
+      }.to raise_error(Hubspot::RequestError)
+    end
+  end
+
+  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") }
+
+      it "doesn't modify params" do
+        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" }
+      end
+
+      context "when configure hasn't been called" do
+        before{ Hubspot::Config.reset! }
+        it "raises a config exception" do
+          expect{ subject }.to raise_error Hubspot::ConfigurationError
+        end
+      end
+
+      context "with interpolations but no params" do
+        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" }
+      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" }
+      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" }
+
+        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" }
+        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" }
+        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" }
+        end
+      end
+
+      context "with options" do
+        let(:options){ {base_url: "https://cool.com", hapikey: 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" }
+      end
+    end
+  end
+
+  def stub_logger
+    instance_double(Logger, info: true).tap do |logger|
+      allow(Hubspot::Config).to receive(:logger).and_return(logger)
+    end
+  end
+end
+
+describe Hubspot::EventConnection do
+  describe '.trigger' do
+    let(:path) { '/path' }
+    let(:options) { { params: {} } }
+    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
+
+    it 'calls get with a custom url' do
+      subject
+      expect(described_class).to have_received(:get).with('https://track.hubspot.com/path', body: nil, headers: nil)
+    end
+
+    context 'with more options' do
+      let(:headers) { { 'User-Agent' => 'something' } }
+      let(:options) { { params: {}, headers: headers } }
+
+      it 'supports headers' do
+        subject
+        expect(described_class).to have_received(:get).with('https://track.hubspot.com/path', body: nil, headers: headers)
+      end
+    end
+  end
+end