hubspot-api-ruby 0.8.0

data/spec/lib/hubspot/form_spec.rb

@@ -0,0 +1,189 @@
+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') do
+      HTTParty.get("https://api.hubapi.com#{Hubspot::Form::FORMS_PATH}/#{guid}/?hapikey=demo").parsed_response
+    end
+  end
+
+  describe '#initialize' do
+    subject { Hubspot::Form.new(example_form_hash) }
+
+    it { should be_an_instance_of Hubspot::Form }
+    its(:guid) { should be_a(String) }
+    its(:properties) { should be_a(Hash) }
+  end
+
+  before { Hubspot.configure(hapikey: 'demo', portal_id: '62515') }
+
+  describe '.all' do
+    cassette 'find_all_forms'
+
+    it 'returns all forms' do
+      forms = Hubspot::Form.all
+      expect(forms.count).to be > 20
+
+      form = forms.first
+      expect(form).to be_a(Hubspot::Form)
+    end
+  end
+
+  describe '.find' do
+    cassette 'form_find'
+    subject { Hubspot::Form.find(guid) }
+
+    context 'when the form is found' do
+      it { should be_an_instance_of Hubspot::Form }
+      its(:fields) { should_not be_empty }
+    end
+
+    context 'when the form is not found' do
+      it 'raises an error' do
+        expect { Hubspot::Form.find(-1) }.to raise_error(Hubspot::RequestError)
+      end
+    end
+  end
+
+  describe '.create' do
+    subject { Hubspot::Form.create!(params) }
+
+    context 'with all required parameters' do
+      cassette 'create_form'
+
+      let(:params) do
+        {
+          name: "Demo Form #{Time.now.to_i}",
+          action: '',
+          method: 'POST',
+          cssClass: 'hs-form stacked',
+          redirect: '',
+          submitText: 'Sign Up',
+          followUpId: '',
+          leadNurturingCampaignId: '',
+          notifyRecipients: '',
+          embeddedCode: ''
+        }
+      end
+      it { should be_an_instance_of Hubspot::Form }
+      its(:guid) { should be_a(String) }
+    end
+
+    context 'without all required parameters' do
+      cassette 'fail_to_create_form'
+
+      it 'raises an error' do
+        expect { Hubspot::Form.create!({}) }.to raise_error(Hubspot::RequestError)
+      end
+    end
+  end
+
+  describe '#fields' do
+    context 'returning all the fields' do
+      cassette 'fields_among_form'
+
+      let(:form) { Hubspot::Form.new(example_form_hash) }
+
+      it 'returns by default the fields property if present' do
+        fields = form.fields
+        fields.should_not be_empty
+      end
+
+      it 'updates the fields property and returns it' do
+        fields = form.fields(bypass_cache: true)
+        fields.should_not be_empty
+      end
+    end
+
+    context 'returning an uniq field' do
+      cassette 'field_among_form'
+
+      let(:form) { Hubspot::Form.new(example_form_hash) }
+      let(:field_name) { form.fields.first['name'] }
+
+      it 'returns by default the field if present as a property' do
+        field = form.fields(only: field_name)
+        expect(field).to be_a(Hash)
+        expect(field['name']).to be == field_name
+      end
+
+      it 'makes an API request if specified' do
+        field = form.fields(only: field_name, bypass_cache: true)
+        expect(field).to be_a(Hash)
+        expect(field['name']).to be == field_name
+      end
+    end
+  end
+
+  describe '#submit' do
+    cassette 'form_submit_data'
+
+    let(:form) { Hubspot::Form.find('561d9ce9-bb4c-45b4-8e32-21cdeaa3a7f0') }
+
+    context 'with a valid portal id' do
+      before do
+        Hubspot.configure(hapikey: 'demo', portal_id: '62515')
+      end
+
+      it 'returns true if the form submission is successful' do
+        params = {}
+        result = form.submit(params)
+        result.should be true
+      end
+    end
+
+    context 'with an invalid portal id' do
+      before do
+        Hubspot.configure(hapikey: 'demo', portal_id: 'xxxx')
+      end
+
+      it 'returns false in case of errors' do
+        params = { unknown_field: :bogus_value }
+        result = form.submit(params)
+        result.should be false
+      end
+    end
+
+    context 'when initializing Hubspot::Form directly' do
+      let(:form) { Hubspot::Form.new('guid' => '561d9ce9-bb4c-45b4-8e32-21cdeaa3a7f0') }
+
+      before { Hubspot.configure(hapikey: 'demo', portal_id: '62515') }
+
+      it 'returns true if the form submission is successful' do
+        params = {}
+        result = form.submit(params)
+        result.should be true
+      end
+    end
+  end
+
+  describe '#update!' do
+    cassette 'form_update'
+
+    new_name = 'updated form name 1424709912'
+    redirect = 'http://hubspot.com'
+
+    let(:form) { Hubspot::Form.find('561d9ce9-bb4c-45b4-8e32-21cdeaa3a7f0') }
+    let(:params) { { name: new_name, redirect: redirect } }
+    subject { form.update!(params) }
+
+    it { should be_an_instance_of Hubspot::Form }
+    it 'updates properties' do
+      subject.properties['name'].should be == new_name
+      subject.properties['redirect'].should be == redirect
+    end
+  end
+
+  describe '#destroy!' do
+    cassette 'form_destroy'
+
+    # NOTE: form previous created via the create! method
+    let(:form) { Hubspot::Form.find('beb92950-ca65-4daf-87ae-a42c054e429f') }
+    subject { form.destroy! }
+    it { should be true }
+
+    it 'should be destroyed' do
+      subject
+      form.destroyed?.should be true
+    end
+  end
+end

data/spec/lib/hubspot/owner_spec.rb

@@ -0,0 +1,56 @@
+describe Hubspot::Owner do
+  let(:example_owners) do
+    VCR.use_cassette('owner_example') do
+      HTTParty.get('https://api.hubapi.com/owners/v2/owners?hapikey=demo&portalId=62515').parsed_response
+    end
+  end
+
+  before { Hubspot.configure(hapikey: 'demo') }
+
+  describe '.all' do
+    cassette 'owner_all'
+
+    it 'should find all owners' do
+      owners = Hubspot::Owner.all
+
+      expect(owners.blank?).to be false
+      compare_owners(owners, example_owners)
+    end
+  end
+
+  describe '.find_by_email' do
+    cassette 'owner_find_by_email'
+
+    let(:sample) { example_owners.first }
+    let(:email) { sample['email'] }
+
+    it 'should find a user via their email address' do
+      owner = Hubspot::Owner.find_by_email(email)
+      sample.map do |key, val|
+        expect(owner[key]).to eq(val)
+      end
+    end
+  end
+
+  describe '.find_by_emails' do
+    cassette 'owner_find_by_emails'
+
+    let(:samples) { example_owners[0..[example_owners.count, 3].min] }
+    let(:emails) { samples.map { |s| s['email'] } }
+
+    it 'should find users via their email address' do
+      owners = Hubspot::Owner.find_by_emails(emails)
+      compare_owners(owners, samples)
+    end
+  end
+end
+
+def compare_owners(owners, examples)
+  owners.each do |owner|
+    example = examples.detect { |o| o['email'] == owner.email }
+    expect(example.blank?).to be false
+    example.each do |key, val|
+      expect(owner[key]).to eq(val)
+    end
+  end
+end

data/spec/lib/hubspot/properties_spec.rb

@@ -0,0 +1,45 @@
+module Hubspot
+  describe Properties do
+    let(:params) { { 'name'                          => 'amount_of_new_money_lined_up',
+                     'label'                         => 'New Money Lined Up (Over $50K or Under $50K)',
+                     'description'                   => '',
+                     'groupName'                     => 'onboarding_questionnaire',
+                     'type'                          => 'enumeration',
+                     'fieldType'                     => 'select',
+                     'options'                       => [{ 'description' => '', 'value' => 'option0', 'readOnly' => false, 'label' => 'Under $50K', 'displayOrder' => 0, 'hidden' => false, 'doubleData' => 0.0 },
+                                                         { 'description' => '', 'value' => 'option1', 'readOnly' => false, 'label' => '$50K and above', 'displayOrder' => 1, 'hidden' => false, 'doubleData' => 0.0 },
+                                                         { 'description' => nil, 'value' => 'option2', 'readOnly' => nil, 'label' => 'Not applicable', 'displayOrder' => 2, 'hidden' => false, 'doubleData' => nil }],
+                     'formField'                     => true,
+                     'displayOrder'                  => 0,
+                     'readOnlyDefinition'            => false,
+                     'hidden'                        => false,
+                     'mutableDefinitionNotDeletable' => false,
+                     'displayMode'                   => 'current_value',
+                     'deleted'                       => false,
+                     'createdUserId'                 => 2334900,
+                     'calculated'                    => false,
+                     'readOnlyValue'                 => false,
+                     'externalOptions'               => false,
+                     'updatedUserId'                 => 2225340 } }
+    let(:valid_params) { { 'name'         => 'amount_of_new_money_lined_up',
+                           'groupName'    => 'onboarding_questionnaire',
+                           'description'  => '',
+                           'fieldType'    => 'select',
+                           'formField'    => true,
+                           'type'         => 'enumeration',
+                           'displayOrder' => 0,
+                           'label'        => 'New Money Lined Up (Over $50K or Under $50K)',
+                           'options'      => [{ 'description' => '', 'value' => 'option0', 'label' => 'Under $50K', 'hidden' => false, 'displayOrder' => 0 },
+                                              { 'description' => '', 'value' => 'option1', 'label' => '$50K and above', 'hidden' => false, 'displayOrder' => 1 },
+                                              { 'description' => nil, 'value' => 'option2', 'label' => 'Not applicable', 'hidden' => false, 'displayOrder' => 2 }]
+    } }
+
+    context '.valid_params' do
+      it 'should strip out extra keys and their values' do
+        result = Hubspot::Properties.valid_params(params)
+        expect(Properties.same?(result, valid_params))
+      end
+    end
+
+  end
+end

data/spec/lib/hubspot/resource_spec.rb

@@ -0,0 +1,54 @@
+
+RSpec.describe Hubspot::Resource do
+  describe '#new' do
+    context 'when specifying an ID' do
+      let(:id) { 1 }
+      subject { described_class.new(id) }
+
+      it 'sets the id property' do
+        expect(subject.id).to eq id
+      end
+
+      it "isn't persisted" do
+        pending "rework of pending flag"
+        expect(subject).not_to be_persisted
+      end
+
+      it 'has no changes' do
+        expect(subject).not_to be_changed
+      end
+    end
+
+    context 'when specifying properties' do
+      let(:name) { Faker::Company.name }
+      let(:properties) { { name: name } }
+      subject { described_class.new properties }
+
+      it 'has no id' do
+        expect(subject.id).to be_nil
+      end
+
+      it 'has the property set' do
+        expect(subject[:name]).to eq name
+        expect(subject["name"]).to eq name
+        expect(subject.name).to eq name
+      end
+
+      it 'has changes' do
+        expect(subject.changes).not_to be_empty
+      end
+    end
+
+    context 'with no arguments' do
+      subject { described_class.new }
+
+      it 'has no id' do
+        expect(subject.id).to be_nil
+      end
+
+      it 'has no changes' do
+        expect(subject).not_to be_changed
+      end
+    end
+  end
+end

data/spec/lib/hubspot/topic_spec.rb

@@ -0,0 +1,23 @@
+describe Hubspot::Topic do
+  before do
+    Hubspot.configure(hapikey: "demo")
+  end
+
+  describe ".list" do
+    cassette "topics_list"
+    let(:topics) { Hubspot::Topic.list }
+
+    it "should have a list of topics" do
+      topics.count.should be(3)
+    end
+  end
+
+  describe ".find_by_topic_id" do
+    cassette "topics_list"
+
+    it "should find a specific topic" do
+      topic = Hubspot::Topic.find_by_topic_id(349001328)
+      topic['id'].should eq(349001328)
+    end
+  end
+end

data/spec/lib/hubspot/utils_spec.rb

@@ -0,0 +1,164 @@
+describe Hubspot::Utils do
+  describe ".properties_to_hash" do
+    let(:properties) do
+      {
+        "email"     => { "value" => "email@address.com" },
+        "firstname" => { "value" => "Bob" },
+        "lastname"  => { "value" => "Smith" }
+      }
+    end
+    subject { Hubspot::Utils.properties_to_hash(properties) }
+    its(["email"]) { should == "email@address.com" }
+    its(["firstname"]) { should == "Bob" }
+    its(["lastname"]) { should == "Smith" }
+  end
+
+  describe ".hash_to_properties" do
+    let(:hash) do
+      {
+        "email"     => "email@address.com",
+        "firstname" => "Bob",
+        "lastname"  => "Smith"
+      }
+    end
+    subject { Hubspot::Utils.hash_to_properties(hash) }
+    it { should be_an_instance_of Array }
+    its(:length) { should == 3 }
+    it { should include({ "property" => "email", "value" => "email@address.com" }) }
+    it { should include({ "property" => "firstname", "value" => "Bob" }) }
+    it { should include({ "property" => "lastname", "value" => "Smith" }) }
+  end
+
+  describe '.compare_property_lists for ContactProperties' do
+    let(:example_groups) do
+      VCR.use_cassette('contact_properties/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('contact_properties/properties_example') do
+        HTTParty.get('https://api.hubapi.com/contacts/v2/properties?hapikey=demo').parsed_response
+      end
+    end
+
+    let(:source) { { 'groups' => example_groups, 'properties' => example_properties } }
+    let!(:target) { Marshal.load(Marshal.dump(source)) }
+
+    context 'with no changes' do
+      it 'should report no changes' do
+        skip, new_groups, new_props, update_props = Hubspot::Utils.compare_property_lists(Hubspot::ContactProperties, source, target)
+        expect(skip.count).to be > 0
+        expect(new_groups.count).to be(0)
+        expect(new_props.count).to be(0)
+        expect(update_props.count).to be(0)
+      end
+    end
+
+    context 'with changes' do
+      let(:description) { "#{source['properties'][0]['description']}_XXX" }
+
+      count = 0
+
+      it 'should report the changes' do
+        10.times do |i|
+          if !source['properties'][i]['readOnlyDefinition']
+            source['properties'][i]['description']   = description
+            source['properties'][i]['createdUserId'] = 2500
+            count                                    += 1
+          end
+        end
+
+        skip, new_groups, new_props, update_props = Hubspot::Utils.compare_property_lists(Hubspot::ContactProperties, source, target)
+        expect(skip.count).to be > 0
+        expect(new_groups.count).to be(0)
+        expect(new_props.count).to be(0)
+        expect(update_props.count).to be(count)
+      end
+    end
+  end
+
+  describe '.compare_property_lists for DealProperties' do
+    let(:example_groups) 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') do
+        HTTParty.get('https://api.hubapi.com/deals/v1/properties?hapikey=demo').parsed_response
+      end
+    end
+
+    let(:source) { { 'groups' => example_groups, 'properties' => example_properties } }
+    let!(:target) { Marshal.load(Marshal.dump(source)) }
+
+    context 'with no changes' do
+      it 'should report no changes' do
+        skip, new_groups, new_props, update_props = Hubspot::Utils.compare_property_lists(Hubspot::DealProperties, source, target)
+        expect(skip.count).to be > 0
+        expect(new_groups.count).to be(0)
+        expect(new_props.count).to be(0)
+        expect(update_props.count).to be(0)
+      end
+    end
+
+    context 'with changes' do
+      let(:description) { "#{source['properties'][0]['description']}_XXX" }
+
+      count = 0
+
+      it 'should report the changes' do
+        10.times do |i|
+          if !source['properties'][i]['readOnlyDefinition']
+            source['properties'][i]['description']   = description
+            source['properties'][i]['createdUserId'] = 2500
+            count                                    += 1
+          end
+        end
+
+        skip, new_groups, new_props, update_props = Hubspot::Utils.compare_property_lists(Hubspot::DealProperties, source, target)
+        expect(skip.count).to be > 0
+        expect(new_groups.count).to be(0)
+        expect(new_props.count).to be(0)
+        expect(update_props.count).to be(count)
+      end
+    end
+  end
+
+  describe ".dump_properties" do
+    it "prints a deprecation warning" do
+      VCR.use_cassette("dump_deal_properties_and_groups") do
+        api_key = "demo"
+
+        output = capture_stderr do
+          Hubspot::Utils.dump_properties(Hubspot::DealProperties, api_key)
+        end
+
+        expected_warning = "Hubspot::Utils.dump_properties is deprecated"
+        expect(output).to include(expected_warning)
+      end
+    end
+  end
+
+  describe ".restore_properties" do
+    it "prints a deprecation warning" do
+      VCR.use_cassette("restore_deal_properties_and_groups") do
+        api_key = "demo"
+        properties = {"groups" => {}, "properties" => {}}
+
+        output = capture_stderr do
+          Hubspot::Utils.restore_properties(
+            Hubspot::DealProperties,
+            api_key,
+            properties
+          )
+        end
+
+        expected_warning = "Hubspot::Utils.restore_properties is deprecated"
+        expect(output).to include(expected_warning)
+      end
+    end
+  end
+end