hubspot-ruby 0.1.8 → 0.2.0

data/spec/lib/tasks/properties_spec.rb

@@ -0,0 +1,90 @@
+require 'rake'
+require 'stringio'
+
+describe 'properties rake tasks', live: true do
+  before :all do
+    Rake.application.rake_require 'tasks/properties'
+  end
+
+  context 'Contact Properties' do
+    let(:file) { '/tmp/contact-demo-props.json' }
+    let(:hapikey) { 'demo' }
+
+    describe 'hubspot:dump_properties' do
+      let :run_rake_task do
+        Rake::Task['hubspot:dump_properties'].reenable
+        Rake.application.invoke_task "hubspot:dump_properties[contact,#{file},#{hapikey}]"
+      end
+
+      it 'saves the properties to a file' do
+        run_rake_task
+
+        props = JSON.parse(File.read(file))
+        expect(props.count).to be > 0
+        expect(props['groups'].count).to be > 0
+        expect(props['properties'].count).to be > 0
+      end
+    end
+
+    describe 'hubspot:restore_properties' do
+      let :run_rake_task do
+        Rake::Task['hubspot:restore_properties'].reenable
+        Rake.application.invoke_task "hubspot:restore_properties[contact,#{file},#{hapikey}]"
+      end
+
+      it 'should not need to make any changes' do
+        results = capture_stdout { run_rake_task }
+        expect(results.include?('Created: ')).to be_false
+        expect(results.include?('Updated: ')).to be_false
+      end
+    end
+
+  end
+
+  context 'Deal Properties' do
+    let(:file) { '/tmp/deal-demo-props.json' }
+    let(:hapikey) { 'demo' }
+
+    describe 'hubspot:dump_properties' do
+      let :run_rake_task do
+        Rake::Task['hubspot:dump_properties'].reenable
+        Rake.application.invoke_task "hubspot:dump_properties[deal,#{file},#{hapikey}]"
+      end
+
+      it 'saves the properties to a file' do
+        pending 'Hubspot disabled this call using the demo hapikey'
+
+        run_rake_task
+
+        props = JSON.parse(File.read(file))
+        expect(props.count).to be > 0
+        expect(props['groups'].count).to be > 0
+        expect(props['properties'].count).to be > 0
+      end
+    end
+
+    describe 'hubspot:restore_properties' do
+      let :run_rake_task do
+        Rake::Task['hubspot:restore_properties'].reenable
+        Rake.application.invoke_task "hubspot:restore_properties[deal,#{file},#{hapikey}]"
+      end
+
+      it 'should not need to make any changes' do
+        pending 'Hubspot disabled this call using the demo hapikey'
+
+        results = capture_stdout { run_rake_task }
+        expect(results.include?('Created: ')).to be_false
+        expect(results.include?('Updated: ')).to be_false
+      end
+    end
+
+  end
+
+  def capture_stdout
+    previous, $stdout = $stdout, StringIO.new
+    yield
+    $stdout.string
+  ensure
+    $stdout = previous
+  end
+end

data/spec/live/companies_integration_spec.rb

@@ -0,0 +1,23 @@
+describe "Companies API Live test", live: true do
+  # Let's try to hit all the API endpoints at least once
+
+  before do
+    Hubspot.configure hapikey: "demo"
+  end
+
+  it 'find, update and destroy a company' do
+    companies = Hubspot::Company.find_by_domain("create-delete-test.com")
+    companies.first.destroy! if companies.any?
+
+    company = Hubspot::Company.create!("Create Delete Test", domain: "create-delete-test.com")
+    expect(company).to be_present
+
+    company.update! name: "Create Delete Test 2"
+    company = Hubspot::Company.find_by_id(company.vid)
+
+    expect(company["name"]).to eql "Create Delete Test 2"
+
+    expect(company.destroy!).to be_true
+    expect(Hubspot::Company.find_by_domain("create-delete-test.com")).to eq []
+  end
+end

data/spec/live/companies_properties_integration_spec.rb

@@ -0,0 +1,120 @@
+describe 'Company Properties API Live test', live: true do
+  # Let's try to hit all the API endpoints at least once
+
+  before do
+    Hubspot.configure hapikey: "demo"
+  end
+
+  it 'should return a list of properties' do
+    result = Hubspot::CompanyProperties.all
+
+    expect(result.count).to be > 0
+  end
+
+  it 'should return a list of properties for the specified groups' do
+    group_names = %w(companyinformation)
+
+    result = Hubspot::CompanyProperties.all({}, { include: group_names })
+    expect(result.count).to be > 0
+    result.each do |entry|
+      expect(group_names.include?(entry['groupName']))
+    end
+  end
+
+  it 'should return a list of properties except for the specified groups' do
+    group_names = %w(companyinformation)
+
+    result = Hubspot::CompanyProperties.all({}, { exclude: group_names })
+    expect(result.count).to be > 0
+    result.each do |entry|
+      expect(group_names.include?(entry['groupName'])).to be_false
+    end
+  end
+
+  it 'should return a list of groups' do
+    result = Hubspot::CompanyProperties.groups
+
+    expect(result.count).to be > 0
+    expect(result[0].slice(*%w(name displayName displayOrder)).count).to eq(3)
+  end
+
+  it 'should return  list of groups and their properties' do
+    result = Hubspot::CompanyProperties.groups({ includeProperties: true })
+
+    expect(result.count).to be > 0
+    expect(result[0].slice(*%w(name displayName displayOrder properties)).count).to eq(4)
+  end
+
+  it 'should return only the requested groups' do
+    group_names = %w(companyinformation )
+    result      = Hubspot::CompanyProperties.groups({}, { include: group_names })
+
+    expect(result.count).to eq(group_names.count)
+    result.each do |entry|
+      expect(group_names.include?(entry['name']))
+    end
+  end
+
+  it 'should filter out the excluded groups' do
+    group_names = %w(companyinformation )
+    result      = Hubspot::CompanyProperties.groups({}, { exclude: group_names })
+
+    result.each do |entry|
+      expect(group_names.include?(entry['name'])).to be_false
+    end
+  end
+
+  describe 'should create, update, and delete properties' do
+    let(:data) {
+      { 'name'        => 'testfield909',
+        'label'       => 'A test property',
+        'description' => 'This is a test property',
+        'groupName'   => 'companyinformation',
+        'type'        => 'string',
+        'fieldType'   => 'text',
+        'formField'   => false }
+    }
+
+    it 'should create a new property' do
+      response = Hubspot::CompanyProperties.create!(data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should update an existing property' do
+      data['label'] = 'An updated test property'
+
+      response = Hubspot::CompanyProperties.update!(data['name'], data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should delete an existing property' do
+      response = Hubspot::CompanyProperties.delete!(data['name'])
+      expect(response).to be nil
+    end
+  end
+
+  describe 'should create, update, and delete property groups' do
+    let(:data) {
+      { 'name'         => 'testgroup99',
+        'displayName'  => 'Test Group 99'
+      }
+    }
+
+    it 'should create a new property group' do
+      response = Hubspot::CompanyProperties.create_group!(data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should update an existing property group' do
+      data['displayName'] = 'Test Group 99 Modified'
+
+      response = Hubspot::CompanyProperties.update_group!(data['name'], data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should delete an existing property group' do
+      response = Hubspot::CompanyProperties.delete_group!(data['name'])
+      expect(response).to be nil
+    end
+  end
+end

data/spec/live/contacts_integration_spec.rb

@@ -21,4 +21,4 @@ describe "Contacts API Live test", live: true do
     expect(contact.destroy!).to be_true
     expect(Hubspot::Contact.find_by_email("create_delete_test@hsgemtest.com")).to be_nil
   end
-end
+end

data/spec/live/contacts_properties_integration_spec.rb

@@ -0,0 +1,120 @@
+describe 'Contact Properties API Live test', live: true do
+  # Let's try to hit all the API endpoints at least once
+
+  before do
+    Hubspot.configure hapikey: "demo"
+  end
+
+  it 'should return a list of properties' do
+    result = Hubspot::ContactProperties.all
+
+    expect(result.count).to be > 0
+  end
+
+  it 'should return a list of properties for the specified groups' do
+    group_names = %w(contactinformation salesforceinformation)
+
+    result = Hubspot::ContactProperties.all({}, { include: group_names })
+    expect(result.count).to be > 0
+    result.each do |entry|
+      expect(group_names.include?(entry['groupName']))
+    end
+  end
+
+  it 'should return a list of properties except for the specified groups' do
+    group_names = %w(contactinformation salesforceinformation)
+
+    result = Hubspot::ContactProperties.all({}, { exclude: group_names })
+    expect(result.count).to be > 0
+    result.each do |entry|
+      expect(group_names.include?(entry['groupName'])).to be_false
+    end
+  end
+
+  it 'should return a list of groups' do
+    result = Hubspot::ContactProperties.groups
+
+    expect(result.count).to be > 0
+    expect(result[0].slice(*%w(name displayName displayOrder)).count).to eq(3)
+  end
+
+  it 'should return  list of groups and their properties' do
+    result = Hubspot::ContactProperties.groups({ includeProperties: true })
+
+    expect(result.count).to be > 0
+    expect(result[0].slice(*%w(name displayName displayOrder properties)).count).to eq(4)
+  end
+
+  it 'should return only the requested groups' do
+    group_names = %w(contactinformation salesforceinformation)
+    result      = Hubspot::ContactProperties.groups({}, { include: group_names })
+
+    expect(result.count).to eq(group_names.count)
+    result.each do |entry|
+      expect(group_names.include?(entry['name']))
+    end
+  end
+
+  it 'should filter out the excluded groups' do
+    group_names = %w(contactinformation salesforceinformation)
+    result      = Hubspot::ContactProperties.groups({}, { exclude: group_names })
+
+    result.each do |entry|
+      expect(group_names.include?(entry['name'])).to be_false
+    end
+  end
+
+  describe 'should create, update, and delete properties' do
+    let(:data) {
+      { 'name'        => 'testfield909',
+        'label'       => 'A test property',
+        'description' => 'This is a test property',
+        'groupName'   => 'contactinformation',
+        'type'        => 'string',
+        'fieldType'   => 'text',
+        'formField'   => false }
+    }
+
+    it 'should create a new property' do
+      response = Hubspot::ContactProperties.create!(data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should update an existing property' do
+      data['label'] = 'An updated test property'
+
+      response = Hubspot::ContactProperties.update!(data['name'], data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should delete an existing property' do
+      response = Hubspot::ContactProperties.delete!(data['name'])
+      expect(response).to be nil
+    end
+  end
+
+  describe 'should create, update, and delete property groups' do
+    let(:data) {
+      { 'name'         => 'testgroup99',
+        'displayName'  => 'Test Group 99'
+      }
+    }
+
+    it 'should create a new property group' do
+      response = Hubspot::ContactProperties.create_group!(data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should update an existing property group' do
+      data['displayName'] = 'Test Group 99 Modified'
+
+      response = Hubspot::ContactProperties.update_group!(data['name'], data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should delete an existing property group' do
+      response = Hubspot::ContactProperties.delete_group!(data['name'])
+      expect(response).to be nil
+    end
+  end
+end

data/spec/live/deal_properties_integration_spec.rb

@@ -0,0 +1,123 @@
+describe 'Deal Properties API Live test', live: true do
+  # Let's try to hit all the API endpoints at least once
+
+  before do
+    Hubspot.configure hapikey: 'demo'
+  end
+
+  it 'should return a list of properties' do
+    pending 'Broken by Hubspot'
+    result = Hubspot::DealProperties.all
+
+    expect(result.count).to be > 0
+  end
+
+  it 'should return a list of properties for the specified groups' do
+    pending 'Broken by Hubspot'
+    group_names = %w(dealinformation)
+
+    result = Hubspot::DealProperties.all({}, { include: group_names })
+    expect(result.count).to be > 0
+    result.each do |entry|
+      expect(group_names.include?(entry['groupName']))
+    end
+  end
+
+  it 'should return a list of properties except for the specified groups' do
+    pending 'Broken by Hubspot'
+    group_names = %w(dealinformation)
+
+    result = Hubspot::DealProperties.all({}, { exclude: group_names })
+    expect(result.count).to be > 0
+    result.each do |entry|
+      expect(group_names.include?(entry['groupName'])).to be_false
+    end
+  end
+
+  it 'should return a list of groups' do
+    result = Hubspot::DealProperties.groups
+
+    expect(result.count).to be > 0
+    expect(result[0].keys).to eql(%w(name displayName displayOrder hubspotDefined))
+  end
+
+  it 'should return  list of groups and their properties' do
+    result = Hubspot::DealProperties.groups({ includeProperties: true })
+
+    expect(result.count).to be > 0
+    expect(result[0].keys).to eql(%w(name displayName displayOrder hubspotDefined properties))
+  end
+
+  it 'should return only the requested groups' do
+    group_names = %w(dealinformation)
+    result      = Hubspot::DealProperties.groups({}, { include: group_names })
+
+    expect(result.count).to eq(group_names.count)
+    result.each do |entry|
+      expect(group_names.include?(entry['name']))
+    end
+  end
+
+  it 'should filter out the excluded groups' do
+    group_names = %w(dealinformation)
+    result      = Hubspot::DealProperties.groups({}, { exclude: group_names })
+
+    result.each do |entry|
+      expect(group_names.include?(entry['name'])).to be_false
+    end
+  end
+
+  describe 'should create, update, and delete properties' do
+    let(:data) {
+      { 'name'        => 'testfield909',
+        'label'       => 'A test property',
+        'description' => 'This is a test property',
+        'groupName'   => 'dealinformation',
+        'type'        => 'string',
+        'fieldType'   => 'text',
+        'formField'   => false }
+    }
+
+    it 'should create a new property' do
+      response = Hubspot::DealProperties.create!(data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should update an existing property' do
+      data['label'] = 'An updated test property'
+
+      response = Hubspot::DealProperties.update!(data['name'], data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should delete an existing property' do
+      response = Hubspot::DealProperties.delete!(data['name'])
+      expect(response).to be nil
+    end
+  end
+
+  describe 'should create, update, and delete property groups' do
+    let(:data) {
+      { 'name'         => 'testgroup99',
+        'displayName'  => 'Test Group 99'
+      }
+    }
+
+    it 'should create a new property group' do
+      response = Hubspot::DealProperties.create_group!(data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should update an existing property group' do
+      data['displayName'] = 'Test Group 99 Modified'
+
+      response = Hubspot::DealProperties.update_group!(data['name'], data)
+      data.map { |key, val| expect(response[key]).to eql(val) }
+    end
+
+    it 'should delete an existing property group' do
+      response = Hubspot::DealProperties.delete_group!(data['name'])
+      expect(response).to be nil
+    end
+  end
+end