hubspot-api-ruby 0.8.0 → 0.10.0

data/lib/hubspot/deal.rb

@@ -12,8 +12,6 @@ module Hubspot
     DEAL_PATH = "/deals/v1/deal/:deal_id"
     RECENT_UPDATED_PATH = "/deals/v1/deal/recent/modified"
     UPDATE_DEAL_PATH = '/deals/v1/deal/:deal_id'
-    ASSOCIATE_DEAL_PATH = '/deals/v1/deal/:deal_id/associations/:OBJECTTYPE?id=:objectId'
-    ASSOCIATED_DEAL_PATH = "/deals/v1/deal/associated/:objectType/:objectId"
 
     attr_reader :properties
     attr_reader :portal_id
@@ -61,25 +59,53 @@ module Hubspot
         response.success?
       end
 
-       # Associate a deal with a contact or company
-       # {http://developers.hubspot.com/docs/methods/deals/associate_deal}
-       # Usage
-       # Hubspot::Deal.associate!(45146940, [], [52])
-       def associate!(deal_id, company_ids=[], vids=[])
-         objecttype = company_ids.any? ? 'COMPANY' : 'CONTACT'
-         object_ids = (company_ids.any? ? company_ids : vids).join('&id=')
-         Hubspot::Connection.put_json(ASSOCIATE_DEAL_PATH, params: { deal_id: deal_id, OBJECTTYPE: objecttype, objectId: object_ids}, body: {})
-       end
-
-       # Didssociate a deal with a contact or company
-       # {https://developers.hubspot.com/docs/methods/deals/delete_association}
-       # Usage
-       # Hubspot::Deal.dissociate!(45146940, [], [52])
-       def dissociate!(deal_id, company_ids=[], vids=[])
-         objecttype = company_ids.any? ? 'COMPANY' : 'CONTACT'
-         object_ids = (company_ids.any? ? company_ids : vids).join('&id=')
-         Hubspot::Connection.delete_json(ASSOCIATE_DEAL_PATH, { deal_id: deal_id, OBJECTTYPE: objecttype, objectId: object_ids })
-       end
+      # Associate a deal with a contact or company
+      # {http://developers.hubspot.com/docs/methods/deals/associate_deal}
+      # Usage
+      # Hubspot::Deal.associate!(45146940, [32], [52])
+      def associate!(deal_id, company_ids=[], vids=[])
+        company_associations = associations = company_ids.map do |id|
+          { from_id: deal_id, to_id: id }
+        end
+
+        contact_associations = vids.map do |id|
+          { from_id: deal_id, to_id: id}
+        end
+
+        results = []
+        if company_associations.any?
+          results << HubSpot::Association.batch_create("Deal", "Company", company_associations)
+        end
+        if contact_associations.any?
+          results << HubSpot::Association.batch_create("Deal", "Contact", contact_associations)
+        end
+
+        results.all?
+      end
+
+      # Didssociate a deal with a contact or company
+      # {https://developers.hubspot.com/docs/methods/deals/delete_association}
+      # Usage
+      # Hubspot::Deal.dissociate!(45146940, [32], [52])
+      def dissociate!(deal_id, company_ids=[], vids=[])
+        company_associations = company_ids.map do |id|
+          { from_id: deal_id, to_id: id }
+        end
+
+        contact_associations = vids.map do |id|
+          { from_id: deal_id, to_id: id }
+        end
+
+        results = []
+        if company_associations.any?
+          results << HubSpot::Association.batch_delete("Deal", "Company", company_associations)
+        end
+        if contact_associations.any?
+          results << HubSpot::Association.batch_delete("Deal", "Contact", contact_associations)
+        end
+
+        results.all?
+      end
 
       def find(deal_id)
         response = Hubspot::Connection.get_json(DEAL_PATH, { deal_id: deal_id })
@@ -125,20 +151,15 @@ module Hubspot
       end
 
       # Find all deals associated to a contact or company
-      # {http://developers.hubspot.com/docs/methods/deals/get-associated-deals}
       # @param object [Hubspot::Contact || Hubspot::Company] a contact or company
       # @return [Array] Array of Hubspot::Deal records
       def find_by_association(object)
-        path = ASSOCIATED_DEAL_PATH
-        objectType =  case object
-                      when Hubspot::Company then :company
-                      when Hubspot::Contact then :contact
-                      else raise(Hubspot::InvalidParams, "Instance type not supported")
-                      end
-
-        params = { objectType: objectType, objectId: object.id }
-        response = Hubspot::Connection.get_json(path, params)
-        response["results"].map { |deal_id| find(deal_id) }
+        to_object_type = case object
+                     when Hubspot::Company then "Company"
+                     when Hubspot::Contact then "Contact"
+                     else raise(Hubspot::InvalidParams, 'Instance type not supported')
+                     end
+        Hubspot::Association.all(to_object_type, object.id, "Deal")
       end
     end
 

data/lib/hubspot/engagement.rb

@@ -21,7 +21,6 @@ module Hubspot
     attr_reader :metadata
 
     def initialize(response_hash)
-
       @engagement = response_hash["engagement"]
       @associations = response_hash["associations"]
       @attachments = response_hash["attachments"]

data/lib/hubspot/exceptions.rb

@@ -10,6 +10,8 @@ module Hubspot
     end
   end
 
+  class NotFoundError < RequestError; end
+
   class ConfigurationError < StandardError; end
   class MissingInterpolation < StandardError; end
   class ContactExistsError < RequestError; end

data/lib/hubspot/file.rb

@@ -10,7 +10,7 @@ module Hubspot
   #
   class File
     GET_FILE_PATH    = "/filemanager/api/v2/files/:file_id"
-    DELETE_FILE_PATH = "/filemanager/api/v2/files/:file_id/full-delete" 
+    DELETE_FILE_PATH = "/filemanager/api/v2/files/:file_id/full-delete"
     LIST_FILE_PATH   = "/filemanager/api/v2/files"
 
     attr_reader :id
@@ -24,7 +24,7 @@ module Hubspot
     class << self
       def find_by_id(file_id)
         response = Hubspot::Connection.get_json(GET_FILE_PATH, { file_id: file_id })
-	new(response)
+        new(response)
       end
     end
 

data/lib/hubspot/meeting.rb

@@ -0,0 +1,44 @@
+require 'hubspot/utils'
+
+module Hubspot
+  class Meeting
+    #
+    # HubSpot Meeting API
+    #
+    # {https://developers.hubspot.com/docs/api/crm/meetings}
+    #
+    CREATE_MEETING_PATH    = '/crm/v3/objects/meetings'
+    MEETING_PATH           = '/crm/v3/objects/meetings/:meeting_id'
+    ASSOCIATE_MEETING_PATH = '/crm/v3/objects/meetings/:meeting_id/associations/Contact/:contact_id/meeting_event_to_contact'
+
+    class << self
+      def create!(owner_id, meeting_title, meeting_body, start_date_time, end_date_time)
+        body = {
+          properties: {
+            hs_timestamp: DateTime.now.strftime('%Q'),
+            hubspot_owner_id: owner_id,
+            hs_meeting_title: meeting_title,
+            hs_meeting_body: meeting_body,
+            hs_meeting_start_time: start_date_time.is_a?(DateTime) ? start_date_time.strftime('%Q') : start_date_time,
+            hs_meeting_end_time: end_date_time.is_a?(DateTime) ? end_date_time.strftime('%Q') : end_date_time,
+            hs_meeting_outcome: 'SCHEDULED'
+          }
+        }
+        response = Hubspot::Connection.post_json(CREATE_MEETING_PATH, params: {}, body: body)
+        HashWithIndifferentAccess.new(response)
+      end
+
+      def destroy!(meeting_id)
+        Hubspot::Connection.delete_json(MEETING_PATH, {meeting_id: meeting_id})
+      end
+
+      def associate!(meeting_id, contact_id)
+        Hubspot::Connection.put_json(ASSOCIATE_MEETING_PATH,
+                                     params: {
+                                       meeting_id: meeting_id,
+                                       contact_id: contact_id
+                                     })
+      end
+    end
+  end
+end

data/lib/hubspot/properties.rb

@@ -97,7 +97,7 @@ module Hubspot
 
       def valid_group_params(params)
         return {} if params.blank?
-        result = params.slice(*PROPERTY_SPECS[:group_field_names])
+        result = params.with_indifferent_access.slice(*PROPERTY_SPECS[:group_field_names])
         result['properties'] = valid_property_params(result['properties']) unless result['properties'].blank?
         result
       end

data/lib/hubspot/railtie.rb

@@ -2,9 +2,5 @@ require 'hubspot-api-ruby'
 require 'rails'
 module Hubspot
   class Railtie < Rails::Railtie
-    rake_tasks do
-      spec = Gem::Specification.find_by_name('hubspot-api-ruby')
-      load "#{spec.gem_dir}/lib/tasks/hubspot.rake"
-    end
   end
 end

data/lib/hubspot/resource.rb

@@ -98,7 +98,7 @@ module Hubspot
     end
 
     def [](name)
-      @changes[name] || @properties[name]
+      @changes[name] || @properties.dig(name, 'value')
     end
 
     def reload
@@ -238,7 +238,7 @@ module Hubspot
       singleton_class.instance_eval do
         keys.each do |k|
           # Define a getter
-          define_method(k) { @changes[k.to_sym] || @properties.dig(k, "value") }
+          define_method(k) { @changes[k.to_sym] || @properties.dig(k, 'value') }
 
           # Define a setter
           define_method("#{k}=") do |v|
@@ -257,7 +257,7 @@ module Hubspot
         # Call the new setter
         return send(method_name, arguments[0])
       elsif @properties.key?(method_name)
-        return @properties[method_name]
+        return @properties[method_name]['value']
       else
         super
       end
@@ -267,4 +267,4 @@ module Hubspot
       (@properties && @properties.key?(method_name)) || super
     end
   end
-end
+end

data/lib/hubspot/utils.rb

@@ -20,31 +20,6 @@ module Hubspot
         hash.map { |k, v| { key_name => k.to_s, "value" => v } }
       end
 
-      def dump_properties(klass, hapikey=ENV['HUBSPOT_API_KEY'], filter={})
-        Hubspot::Deprecator.build.deprecation_warning("Hubspot::Utils.dump_properties")
-
-        with_hapikey(hapikey) do
-          { 'groups'     => klass.groups({}, filter),
-            'properties' => klass.all({}, filter).select { |p| !p['hubspotDefined'] }
-          }
-        end
-      end
-
-      def restore_properties(klass, hapikey=ENV['HUPSPOT_API_KEY'], properties={}, dry_run=false)
-        Hubspot::Deprecator.build.deprecation_warning("Hubspot::Utils.restore_properties")
-
-        existing_properties                       = dump_properties(klass, hapikey)
-        skip, new_groups, new_props, update_props = compare_property_lists(klass, properties, existing_properties)
-        puts '', 'Dry Run - Changes will not be applied' if dry_run
-        puts '','Skipping'
-        skip.each { |h| puts "#{h[:reason]} - #{h[:prop]['groupName']}:#{h[:prop]['name']}" }
-        with_hapikey(hapikey) do
-          create_groups(klass, new_groups, dry_run)
-          create_properties(klass, new_props, dry_run)
-          update_properties(klass, update_props, dry_run)
-        end
-      end
-
       def create_groups(klass, groups, dry_run=false)
         puts '','Creating new groups'
         groups.each do |g|
@@ -112,11 +87,6 @@ module Hubspot
         [skip, new_groups.to_a, new_props, update_props]
       end
 
-      def with_hapikey(hapikey)
-        Hubspot.configure(hapikey: hapikey)
-        yield if block_given?
-      end
-
       private
 
       def find_by_name(name, set)

data/lib/hubspot-api-ruby.rb

@@ -14,18 +14,21 @@ require 'hubspot/contact'
 require 'hubspot/contact_properties'
 require 'hubspot/contact_list'
 require 'hubspot/event'
+require 'hubspot/custom_event'
 require 'hubspot/form'
 require 'hubspot/blog'
 require 'hubspot/topic'
 require 'hubspot/deal'
 require 'hubspot/deal_pipeline'
 require 'hubspot/deal_properties'
+require 'hubspot/association'
 require 'hubspot/deprecator'
 require 'hubspot/owner'
 require 'hubspot/engagement'
 require 'hubspot/subscription'
 require 'hubspot/oauth'
 require 'hubspot/file'
+require 'hubspot/meeting'
 
 module Hubspot
   def self.configure(config={})

data/spec/lib/hubspot/association_spec.rb

@@ -0,0 +1,165 @@
+RSpec.describe Hubspot::Association do
+  let(:portal_id) { 62515 }
+  let(:company) { create :company }
+  let(:contact) { create :contact }
+
+  describe '.create' do
+    context 'with a valid ID' do
+      cassette
+      subject { described_class.create("Company", company.id, "Contact", contact.id) }
+
+      it 'associates the resources' do
+        expect(subject).to be true
+        expect(company.contact_ids.resources).to eq [contact.id]
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      subject { described_class.create("Company", 1234, "Contact", 1234) }
+
+      it 'returns false' do
+        expect(subject).to be false
+      end
+    end
+  end
+
+  describe '.batch_create' do
+    let(:deal) { Hubspot::Deal.create!(portal_id, [], [], {}) }
+    let(:contact2) { create :contact }
+
+    subject { described_class.batch_create(*associations) }
+
+    context 'with a valid request' do
+      cassette
+      let(:associations) do
+        [
+          "Deal",
+          "Contact",
+          [
+            { from_id: deal.deal_id, to_id: contact.id},
+            { from_id: deal.deal_id, to_id: contact2.id}
+          ]
+        ]
+      end
+
+      it 'associates the resources' do
+        expect(subject).to be true
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.vids).to eq [contact.id, contact2.id]
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      let(:associations) do
+        [
+          "Deal",
+          "Contact",
+          [
+            { from_id: deal.deal_id, to_id: 1234 }
+          ]
+        ]
+      end
+
+      it 'returns false' do
+        expect(subject).to eq(false)
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.vids).to eq []
+      end
+    end
+  end
+
+  describe '.delete' do
+    subject { described_class.delete("Company", company.id, "Contact", contact_id_to_dissociate) }
+    before { described_class.create("Company", company.id, "Contact", contact.id) }
+
+    context 'with a valid ID' do
+      cassette
+      let(:contact_id_to_dissociate) { contact.id }
+
+      it 'dissociates the resources' do
+        expect(subject).to be true
+        expect(company.contact_ids.resources).to eq []
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      let(:contact_id_to_dissociate) { 1234 }
+
+      it 'does not raise an error' do
+        expect(subject).to be true
+        expect(company.contact_ids.resources).to eq [contact.id]
+      end
+    end
+  end
+
+  describe '.batch_delete' do
+    let(:company2) { create(:company) }
+    let(:deal) { Hubspot::Deal.create!(portal_id, [company.id, company2.id], [], {}) }
+
+    subject { described_class.batch_delete("Deal", "Company", associations) }
+
+    context 'with a valid request' do
+      cassette
+      let(:associations) do
+        [
+          { from_id: deal.deal_id, to_id: company.id },
+          { from_id: deal.deal_id, to_id: company2.id }
+        ]
+      end
+
+      it 'dissociates the resources' do
+        expect(subject).to be true
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.company_ids).to eq []
+      end
+    end
+
+    context 'with an invalid ID' do
+      cassette
+      let(:associations) do
+        [
+          { from_id: deal.deal_id, to_id: 1234 },
+          { from_id: deal.deal_id, to_id: company.id }
+        ]
+      end
+
+      it 'does not raise an error, removes the valid associations' do
+        expect(subject).to be true
+        find_deal = Hubspot::Deal.find(deal.deal_id)
+        expect(find_deal.company_ids).to eq [company2.id]
+      end
+    end
+  end
+
+  describe '.all' do
+    subject { described_class.all(resource_type, resource_id, to_object_type) }
+
+    context 'with valid params' do
+      cassette
+
+      let(:resource_type) { "Deal" }
+      let(:resource_id) { deal.deal_id }
+      let(:to_object_type) { "Contact" }
+      let(:deal) { Hubspot::Deal.create!(portal_id, [], contact_ids, {}) }
+      let(:contact_ids) { [contact.id, second_contact.id] }
+      let(:second_contact) { create :contact }
+
+      it 'finds the resources' do
+        expect(subject.map(&:id)).to contain_exactly(*contact_ids)
+      end
+    end
+
+    context 'with unsupported object_type' do
+      let(:resource_type) { "Contact" }
+      let(:resource_id) { 1234 }
+      let(:to_object_type) { "Foo" }
+
+      it 'raises an error' do
+        expect { subject }.to raise_error(Hubspot::InvalidParams, 'Object type not supported')
+      end
+    end
+  end
+end

data/spec/lib/hubspot/blog_spec.rb

@@ -1,14 +1,12 @@
 require 'timecop'
 
 describe Hubspot do
-  before do
-    Hubspot.configure(hapikey: "demo")
-    Timecop.freeze(Time.utc(2012, 'Oct', 10))
-  end
+  before { Timecop.freeze(Time.utc(2012, 'Oct', 10)) }
 
-  after do
-    Timecop.return
-  end
+  after { Timecop.return }
+
+  let(:last_blog_id) { Hubspot::Blog.list.last['id'] }
+  let(:last_blog_post_id) { Hubspot::Blog.list.last.posts.first['id'] }
 
   describe Hubspot::Blog do
     describe ".list" do
@@ -16,7 +14,6 @@ describe Hubspot do
         VCR.use_cassette("blog_list") do
           result = Hubspot::Blog.list
 
-          assert_requested :get, hubspot_api_url("/content/api/v2/blogs?hapikey=demo")
           expect(result).to be_kind_of(Array)
           expect(result.first).to be_a(Hubspot::Blog)
         end
@@ -26,10 +23,8 @@ describe Hubspot do
     describe ".find_by_id" do
       it "retrieves a blog by id" do
         VCR.use_cassette("blog_list") do
-          id = 351076997
-          result = Hubspot::Blog.find_by_id(id)
+          result = Hubspot::Blog.find_by_id(last_blog_id)
 
-          assert_requested :get, hubspot_api_url("/content/api/v2/blogs/#{id}?hapikey=demo")
           expect(result).to be_a(Hubspot::Blog)
         end
       end
@@ -59,26 +54,23 @@ describe Hubspot do
     describe "#posts" do
       it "returns published blog posts created in the last 2 months" do
         VCR.use_cassette("blog_posts/all_blog_posts") do
-          blog_id = 123
+          blog_id = last_blog_id
           created_gt = timestamp_in_milliseconds(Time.now - 2.months)
           blog = Hubspot::Blog.new({ "id" => blog_id })
 
           result = blog.posts
 
-          assert_requested :get, hubspot_api_url("/content/api/v2/blog-posts?content_group_id=#{blog_id}&created__gt=#{created_gt}&hapikey=demo&order_by=-created&state=PUBLISHED")
           expect(result).to be_kind_of(Array)
         end
       end
 
       it "includes given parameters in the request" do
         VCR.use_cassette("blog_posts/filter_blog_posts") do
-          blog_id = 123
           created_gt = timestamp_in_milliseconds(Time.now - 2.months)
-          blog = Hubspot::Blog.new({ "id" => 123 })
+          blog = Hubspot::Blog.new({ "id" => last_blog_id })
 
           result = blog.posts({ state: "DRAFT" })
 
-          assert_requested :get, hubspot_api_url("/content/api/v2/blog-posts?content_group_id=#{blog_id}&created__gt=#{created_gt}&hapikey=demo&order_by=-created&state=DRAFT")
           expect(result).to be_kind_of(Array)
         end
       end
@@ -106,11 +98,8 @@ describe Hubspot do
     describe ".find_by_blog_post_id" do
       it "retrieves a blog post by id" do
         VCR.use_cassette "blog_posts" do
-          blog_post_id = 422192866
-
-          result = Hubspot::BlogPost.find_by_blog_post_id(blog_post_id)
+          result = Hubspot::BlogPost.find_by_blog_post_id(last_blog_post_id)
 
-          assert_requested :get, hubspot_api_url("/content/api/v2/blog-posts/#{blog_post_id}?hapikey=demo")
           expect(result).to be_a(Hubspot::BlogPost)
         end
       end
@@ -119,7 +108,7 @@ describe Hubspot do
     describe "#topics" do
       it "returns the list of topics" do
         VCR.use_cassette "blog_posts" do
-          blog_post = Hubspot::BlogPost.find_by_blog_post_id(422192866)
+          blog_post = Hubspot::BlogPost.find_by_blog_post_id(last_blog_post_id)
 
           topics = blog_post.topics
 

data/spec/lib/hubspot/company_properties_spec.rb

@@ -14,8 +14,6 @@ RSpec.describe Hubspot::CompanyProperties do
     end
   end
 
-  before { Hubspot.configure(hapikey: ENV.fetch("HUBSPOT_HAPI_KEY", "demo")) }
-
   describe ".all" do
     it "should return all properties" do
       VCR.use_cassette "company_properties/all_properties" do
@@ -229,7 +227,7 @@ RSpec.describe Hubspot::CompanyProperties do
           VCR.use_cassette("company_properties/delete_non_property") do
             expect {
               Hubspot::CompanyProperties.delete!("non-existent")
-            }.to raise_error(Hubspot::RequestError)
+            }.to raise_error(Hubspot::NotFoundError)
           end
         end
       end
@@ -240,17 +238,16 @@ RSpec.describe Hubspot::CompanyProperties do
     describe ".groups" do
       it "returns all groups" do
         VCR.use_cassette("company_properties/all_groups") do
-          group_name = "group_awesome"
-          Hubspot::CompanyProperties.create_group!(name: group_name)
+          group = Hubspot::CompanyProperties.create_group!(name: "group_#{SecureRandom.hex}")
 
           response = Hubspot::CompanyProperties.groups
 
           assert_hubspot_api_request(:get, "/properties/v1/companies/groups")
 
           group_names = response.map { |group| group["name"] }
-          expect(group_names).to include(group_name)
+          expect(group_names).to include(group['name'])
 
-          Hubspot::CompanyProperties.delete_group!(group_name)
+          Hubspot::CompanyProperties.delete_group!(group['name'])
         end
       end
 
@@ -358,10 +355,10 @@ RSpec.describe Hubspot::CompanyProperties do
 
         let(:sub_params) { params.select { |k, _| k != 'displayName' } }
 
-        it 'should return the valid parameters' do
-          params['name'] = 'ff_group235'
+        it 'should return the valid parameters' do |example|
+          params['name'] = "ff_group_#{SecureRandom.hex}"
           response       = Hubspot::CompanyProperties.create_group!(sub_params)
-          expect(Hubspot::CompanyProperties.same?(response, sub_params)).to be true
+          expect(Hubspot::CompanyProperties.same?(response.except("name"), sub_params.except("name"))).to be true
         end
       end
     end
@@ -402,7 +399,7 @@ RSpec.describe Hubspot::CompanyProperties do
         cassette 'company_properties/delete_non_group'
 
         it 'should raise an error' do
-          expect { Hubspot::CompanyProperties.delete_group!(name) }.to raise_error(Hubspot::RequestError)
+          expect { Hubspot::CompanyProperties.delete_group!(name) }.to raise_error(Hubspot::NotFoundError)
         end
       end
     end