hubspot-api-ruby 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8c321bf08699c556e265ef8bb24a6f66ad0993ed284a66adb4dacbcc5263748
-  data.tar.gz: 9a9fd7fccb6ac668affde2373ed824a3f5ac95fc7ed1ca6afc90e7e523dcd83e
+  metadata.gz: 4aa748bc77ade29ff96016950aa3f3d8d9bbb309167b200319798d9edf8664bc
+  data.tar.gz: f09d8a29a3dbbcaa18071670e46d4c10c6727731409bbf4a7eee5099d6fd15e2
 SHA512:
-  metadata.gz: 872f7fc25b8acfd21ca29fa0223f36506993581ced761f90838adcb5425bad857bec190f5b804f9c466f1919988d76e80b5834004228e722ca920216b2b92406
-  data.tar.gz: f9608077e1a5346205baf9216259fbfdee3e6d49f1abac18ac05e5226b3c05db86b61c0ed6d0e266510c2b9cd898e899da66e12335bdf8a4b2796677bac788ff
+  metadata.gz: ac1c6faae15a4569c92d8061a270f7b55aad7c64eaf2f16bc057b31312204164771600a5ebb511a0d7e0977123baf65b22125f69832dc6b2af63637bb4689814
+  data.tar.gz: 37b874280272f531177bf348d038b5b6e935f2a4edefeef1c1c7d4e5e68c2613047a75ea782daa412053fb8f50c312d6a27d5f264509f758cd6eb82abf1afe8d

data/README.md

@@ -1,11 +1,17 @@
 # HubSpot REST API wrappers for ruby
 
-**This is the master branch and contains unreleased and potentially breaking changes. If you are looking for the most recent stable release you want the [v0-stable branch](https://github.com/adimichele/hubspot-ruby/tree/v0-stable).**
-
 Wraps the HubSpot REST API for convenient access from ruby applications.
 
 Documentation for the HubSpot REST API can be found here: https://developers.hubspot.com/docs/endpoints
 
+## Disclaimer
+
+This gem is a fork of the unofficial [hubspot-ruby](https://github.com/HubspotCommunity/hubspot-ruby) gem which is unfortunately not maintained anymore.
+
+The API has evolved quite a bit and while this is not a drop-in replacement you should feel familiar if you come from `hubspot-ruby`.
+
+This project and the code therein was not created by and is not supported by HubSpot, Inc or any of its affiliates.
+
 ## Setup
 
     gem install hubspot-api-ruby
@@ -24,16 +30,16 @@ Authentication docs].
 Below is a complete list of configuration options with the default values:
 ```ruby
 Hubspot.configure({
-  hapikey: <HAPIKEY>,
+  access_token: <ACCESS_TOKEN>,
   base_url: "https://api.hubapi.com",
   portal_id: <PORTAL_ID>,
   logger: Logger.new(nil),
-  access_token: <ACCESS_TOKEN>,
   client_id: <CLIENT_ID>,
   client_secret: <CLIENT_SECRET>,
   redirect_uri: <REDIRECT_URI>,
   read_timeout: nil, # or :timeout to set read_timeout and open_timeout
   open_timeout: nil,
+  hapikey: <HAPIKEY>,
 })
 ```
 
@@ -44,15 +50,20 @@ environment.
 [HubSpot API Authentication Docs]: https://developers.hubspot.com/docs/methods/auth/oauth-overview
 [HubSpot Developer Tools]: https://developers.hubspot.com/docs/devtools
 
-## Authentication with an API key
+## Authentication with a private app access token
 
-To set the HubSpot API key, aka `hapikey`, run the following:
+To set the HubSpot access token, run the following:
 ```ruby
-Hubspot.configure(hapikey: "YOUR_API_KEY")
+Hubspot.configure(access_token: 'YOUR_ACCESS_TOKEN')
 ```
 
-If you have a HubSpot account, you can find your API key by logging in and
-visiting: https://app.hubspot.com/keys/get
+Note: some APIs require the portal ID to be set.
+
+```ruby
+Hubspot.configure(access_token: 'YOUR_ACCESS_TOKEN', portal_id: 'YOUR_PORTAL_ID')
+```
+
+[To learn how to create and manage private apps and access tokens, click here.](https://developers.hubspot.com/docs/api/private-apps)
 
 ## Authentication with OAuth 2.0
 
@@ -105,153 +116,25 @@ Hubspot::OAuth.refresh(refresh_token)
 
 At this time, OAuth tokens are configured globally rather than on a per-connection basis.
 
-## Usage
-
-Classes have been created that map to Hubspot resource types and attempt to abstract away as much of the API specific details as possible. These classes generally follow the [ActiveRecord](https://en.wikipedia.org/wiki/Active_record_pattern) pattern and general Ruby conventions. Anyone familiar with [Ruby On Rails](https://rubyonrails.org/) should find this API closely maps with familiar concepts.
-
-
-### Creating a new resource
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.new(name: "My Company LLC.")
-=> #<Hubspot::Company:0x000055b9219cc068 @changes={"name"=>"My Company LLC."}, @properties={}, @id=nil, @persisted=false, @deleted=false>
-
-irb(main):002:0> company.persisted?
-=> false
-
-irb(main):003:0> company.save
-=> true
-
-irb(main):004:0> company.persisted?
-=> true
-```
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.create(name: "Second Financial LLC.")
-=> #<Hubspot::Company:0x0000557ea7119fb0 @changes={}, @properties={"hs_lastmodifieddate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceId"=>nil, "versions"=>[{"name"=>"hs_lastmodifieddate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "name"=>{"value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"name", "value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "createdate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}, {"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "sourceId"=>"API", "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}}, @id=1726317857, @persisted=true, @deleted=false, @metadata={"portalId"=>62515, "companyId"=>1726317857, "isDeleted"=>false, "additionalDomains"=>[], "stateChanges"=>[], "mergeAudits"=>[]}>
-
-irb(main):002:0> company.persisted?
-=> true
-```
-
-
-### Find an existing resource
-
-**Note:** Hubspot uses a combination of different names for the "ID" property of a resource based on what type of resource it is (eg. vid for Contact). This library attempts to abstract that away and generalizes an `id` property for all resources
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.find(1726317857)
-=> #<Hubspot::Company:0x0000562e4988c9a8 @changes={}, @properties={"hs_lastmodifieddate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceId"=>nil, "versions"=>[{"name"=>"hs_lastmodifieddate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "name"=>{"value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"name", "value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "createdate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}}, @id=1726317857, @persisted=true, @deleted=false, @metadata={"portalId"=>62515, "companyId"=>1726317857, "isDeleted"=>false, "additionalDomains"=>[], "stateChanges"=>[], "mergeAudits"=>[]}>
-
-irb(main):002:0> company = Hubspot::Company.find(1)
-Traceback (most recent call last):
-        6: from ./hubspot-api-ruby/bin/console:20:in `<main>'
-        5: from (irb):2
-        4: from ./hubspot-api-ruby/lib/hubspot/resource.rb:17:in `find'
-        3: from ./hubspot-api-ruby/lib/hubspot/resource.rb:81:in `reload'
-        2: from ./hubspot-api-ruby/lib/hubspot/connection.rb:10:in `get_json'
-        1: from ./hubspot-api-ruby/lib/hubspot/connection.rb:52:in `handle_response'
-Hubspot::RequestError (Response body: {"status":"error","message":"resource not found","correlationId":"7c8ba50e-16a4-4a52-a304-ff249175a8f1","requestId":"b4898274bf8992924082b4a460b90cbe"})
-```
-
-
-### Updating resource properties
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.find(1726317857)
-=> #<Hubspot::Company:0x0000563b9f3ee230 @changes={}, @properties={"hs_lastmodifieddate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceId"=>nil, "versions"=>[{"name"=>"hs_lastmodifieddate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"CALCULATED", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "name"=>{"value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"name", "value"=>"Second Financial LLC.", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}, "createdate"=>{"value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceId"=>nil, "versions"=>[{"name"=>"createdate", "value"=>"1552234087467", "timestamp"=>1552234087467, "source"=>"API", "sourceVid"=>[], "requestId"=>"fd45773b-30d0-4d9d-b3b8-a85e01534e46"}]}}, @id=1726317857, @persisted=true, @deleted=false, @metadata={"portalId"=>62515, "companyId"=>1726317857, "isDeleted"=>false, "additionalDomains"=>[], "stateChanges"=>[], "mergeAudits"=>[]}>
-
-irb(main):002:0> company.name
-=> "Second Financial LLC."
-
-irb(main):003:0> company.name = "Third Financial LLC."
-=> "Third Financial LLC."
-
-irb(main):004:0> company.changed?
-=> true
-
-irb(main):005:0> company.changes
-=> {:name=>"Third Financial LLC."}
-
-irb(main):006:0> company.save
-=> true
-
-irb(main):007:0> company.changed?
-=> false
-
-irb(main):008:0> company.changes
-=> {}
-```
-
-**Note:** Unlike ActiveRecord in Rails, in some cases not all properties of a resource are known. If these properties are not returned by the API then they will not have a getter method defined for them until they've been set first. This may change in the future to improve the user experience and different methods are being tested.
-
-```ruby
-irb(main):001:0> company = Hubspot::Company.new
-=> #<Hubspot::Company:0x0000561d0a8bdff8 @changes={}, @properties={}, @id=nil, @persisted=false, @deleted=false>
-
-irb(main):002:0> company.name
-Traceback (most recent call last):
-        3: from ./hubspot-api-ruby/bin/console:20:in `<main>'
-        2: from (irb):2
-        1: from ./hubspot-api-ruby/lib/hubspot/resource.rb:215:in `method_missing'
-NoMethodError (undefined method `name' for #<Hubspot::Company:0x0000561d0a8bdff8>)
-
-irb(main):003:0> company.name = "Foobar"
-=> "Foobar"
-
-irb(main):004:0> company.name
-=> "Foobar"
-```
-
-### Collections
+## Authentication with an API key
 
-To make working with API endpoints that return multiple resources easier, the returned instances will be wrapped in a collection instance. Just like in Rails, the collection instance provides helper methods for limiting the number of returned resources, paging through the results, and handles passing the options each time a new API call is made. The collection exposes all Ruby Array methods so you can use things like `size()`, `first()`, `last()`, and `map()`.
+NOTE: API keys are deprecated. [Read more here](https://developers.hubspot.com/changelog/upcoming-api-key-sunset) and [find out how to migrate to private apps there](https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app).
 
+To set the HubSpot API key, aka `hapikey`, run the following:
 ```ruby
-irb(main):001:0> contacts = Hubspot::Contact.all
-=> #<Hubspot::PagedCollection:0x000055ba3c2b55d8 @limit_param="limit", @limit=25, @offset_param="offset", @offset=nil, @options={}, @fetch_proc=#<Proc:0x000055ba3c2b5538@./hubspot-api-ruby/lib/hubspot/contact.rb:18>, @resources=[...snip...], @next_offset=9242374, @has_more=true>
-
-irb(main):002:0> contacts.more?
-=> true
-
-irb(main):003:0> contacts.next_offset
-=> 9242374
-
-irb(main):004:0> contacts.size
-=> 25
-
-irb(main):005:0> contacts.first
-=> #<Hubspot::Contact:0x000055ba3c29bac0 @changes={}, @properties={"firstname"=>{"value"=>"My Street X 1551971239 => My Street X 1551971267 => My Street X 1551971279"}, "lastmodifieddate"=>{"value"=>"1551971286841"}, "company"=>{"value"=>"MadKudu"}, "lastname"=>{"value"=>"Test0830181615"}}, @id=9153674, @persisted=true, @deleted=false, @metadata={"addedAt"=>1535664601481, "vid"=>9153674, "canonical-vid"=>9153674, "merged-vids"=>[], "portal-id"=>62515, "is-contact"=>true, "profile-token"=>"AO_T-mPNHk6O7jh8u8D2IlrhZn7GO91w-weZrC93_UaJvdB0U4o6Uc_PkPJ3DOpf15sUplrxMzG9weiTTpPI05Nr04zxnaNYBVcWHOlMbVlJ2Avq1KGoCBVbIoQucOy_YmCBIfOXRtcc", "profile-url"=>"https://app.hubspot.com/contacts/62515/contact/9153674", "form-submissions"=>[], "identity-profiles"=>[{"vid"=>9153674, "saved-at-timestamp"=>1535664601272, "deleted-changed-timestamp"=>0, "identities"=>[{"type"=>"EMAIL", "value"=>"test.0830181615@test.com", "timestamp"=>1535664601151, "is-primary"=>true}, {"type"=>"LEAD_GUID", "value"=>"01a107c4-3872-44e0-ab2e-47061507ffa1", "timestamp"=>1535664601259}]}], "merge-audits"=>[]}>
-
-irb(main):006:0> contacts.next_page
-=> #<Hubspot::PagedCollection:0x000055ba3c2b55d8 @limit_param="limit", @limit=25, @offset_param="offset", @offset=9242374, @options={}, @fetch_proc=#<Proc:0x000055ba3c2b5538@./hubspot-api-ruby/lib/hubspot/contact.rb:18>, @resources=[...snip...], @next_offset=9324874, @has_more=true>
+Hubspot.configure(hapikey: "YOUR_API_KEY")
 ```
 
-For Hubspot resources that support batch updates for updating multiple resources, the collection provides an `update_all()` method:
-
-```ruby
-irb(main):001:0> companies = Hubspot::Company.all(limit: 5)
-=> #<Hubspot::PagedCollection:0x000055d5314fe0c8 @limit_param="limit", @limit=5, @offset_param="offset", @offset=nil, @options={}, @fetch_proc=#<Proc:0x000055d5314fe028@./hubspot-api-ruby/lib/hubspot/company.rb:21>, @resources=[...snip...], @next_offset=116011506, @has_more=true>
-
-irb(main):002:0> companies.size
-=> 5
-
-irb(main):003:0> companies.update_all(lifecyclestage: "opportunity")
-=> true
+If you have a HubSpot account, you can find your API key by logging in and
+visiting: https://app.hubspot.com/keys/get
 
-irb(main):004:0> companies.refresh
-=> #<Hubspot::PagedCollection:0x000055d5314fe0c8 @limit_param="limit", @limit=5, @offset_param="offset", @offset=nil, @options={}, @fetch_proc=#<Proc:0x000055d5314fe028@./hubspot-api-ruby/lib/hubspot/company.rb:21>, @resources=[...snip...], @next_offset=116011506, @has_more=true>
-```
+## Usage
 
-### Deleting a resource
+Classes have been created that map to Hubspot resource types and attempt to abstract away as much of the API specific details as possible. These classes generally follow the [ActiveRecord](https://en.wikipedia.org/wiki/Active_record_pattern) pattern and general Ruby conventions. Anyone familiar with [Ruby On Rails](https://rubyonrails.org/) should find this API closely maps with familiar concepts.
 
-```ruby
-irb(main):001:0> contact = Hubspot::Contact.find(9324874)
-=> #<Hubspot::Contact:0x000055a87c87aee0 ...snip... >
+### Example
 
-irb(main):002:0> contact.delete
-=> true
-```
+https://github.com/lounna-sas/hubspot-api-ruby/wiki
 
 ## Resource types
 
@@ -281,15 +164,18 @@ By default, the VCR recording mode is set to `:none`, which allows recorded
 requests to be re-played but raises for any new request. This prevents the test
 suite from issuing unexpected HTTP requests.
 
-To add a new test or update a VCR recording, run the test with the `VCR_RECORD`
-environment variable:
+Some requests require to be done on a live hubspot portal, you can set the `HUBSPOT_ACCESS_TOKEN` and `HUBSPOT_PORTAL_ID` environement variables, for example inside a `.env.test` file :
 
-```sh
-VCR_RECORD=1 bundle exec rspec spec
+```
+HUBSPOT_ACCESS_TOKEN=xxxx
+HUBSPOT_PORTAL_ID=yyyy
 ```
 
-[VCR]: https://github.com/vcr/vcr
+To add a new test or update a VCR recording, run the test with the `VCR_RECORD_MODE`
+environment variable, for instance:
 
-## Disclaimer
+```sh
+VCR_RECORD_MODE=new_episodes bundle exec rspec spec
+```
 
-This project and the code therein was not created by and is not supported by HubSpot, Inc or any of its affiliates.
+[VCR]: https://github.com/vcr/vcr

data/Rakefile

@@ -28,5 +28,3 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
-
-Dir.glob('lib/tasks/*.rake').each { |r| load r }

data/hubspot-api-ruby.gemspec

@@ -1,19 +1,18 @@
 Gem::Specification.new do |s|
   s.name = "hubspot-api-ruby"
-  s.version = "0.8.0"
+  s.version = "0.10.0"
   s.require_paths = ["lib"]
-  s.authors = ["Jonathan", "Juliette"]
-  s.email = ["jonathan@hoggo.com", "juliette@hoggo.com"]
+  s.authors = ["Jonathan"]
+  s.email = ["jonathan@hoggo.com"]
   s.description = "hubspot-api-ruby is a wrapper for the HubSpot REST API"
   s.licenses = ["MIT"]
   s.files = [".rspec", "Gemfile", "Guardfile", "LICENSE.txt", "README.md", "RELEASING.md", "Rakefile", "hubspot-api-ruby.gemspec"]
   s.files += Dir["lib/**/*.rb"]
-  s.files += Dir["lib/**/*.rake"]
   s.files += Dir["spec/**/*.rb"]
-  s.homepage = "http://github.com/lounna-sas/hubspot-api-ruby"
+  s.homepage = "https://github.com/captaincontrat/hubspot-api-ruby"
   s.summary = "hubspot-api-ruby is a wrapper for the HubSpot REST API"
   s.metadata = {
-    "changelog_uri" => "https://github.com/lounna-sas/hubspot-api-ruby/blob/master/History.md"
+    "changelog_uri" => "https://github.com/captaincontrat/hubspot-api-ruby/blob/master/History.md"
   }
 
   s.required_ruby_version = ">= 2.3"
@@ -23,7 +22,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "httparty", ">= 0.10"
 
   # Add development-only dependencies here
-  s.add_development_dependency("appraisal", "~> 2.2")
   s.add_development_dependency("dotenv")
   s.add_development_dependency("rake", "~> 11.0")
   s.add_development_dependency("rspec", "~> 3.8")

data/lib/hubspot/association.rb

@@ -0,0 +1,106 @@
+class Hubspot::Association
+  OBJECT_TARGET_TO_CLASS = {
+    "Contact" => Hubspot::Contact,
+    "Deal" => Hubspot::Deal,
+    "Company" => Hubspot::Company
+  }.freeze
+
+  ASSOCIATION_DEFINITIONS = {
+    "Company" => {
+      "Contact" => 2,
+      "Deal" => 6,
+      "Company" => 13
+    },
+    "Deal" => {
+      "Company" => 5,
+      "Contact" => 3
+    },
+    "Contact" => {
+      "Deal" => 4
+    }
+  }.freeze
+
+  class << self
+    def create(object_type, object_id, to_object_type, to_object_id)
+      batch_create(object_type, to_object_type, [{from_id: object_id, to_id: to_object_id}])
+    end
+
+    # Make multiple associations in a single API call
+    # {https://developers.hubspot.com/docs/api/crm/associations}
+    # usage:
+    # Hubspot::Association.batch_create("Company", "Contact", [{from_id: 1, to_id: 2}]])
+    def batch_create(from_object_type, to_object_type, associations)
+      definition_id = ASSOCIATION_DEFINITIONS.dig(from_object_type, to_object_type)
+      request = { inputs: associations.map { |assocation| build_create_association_body(assocation, definition_id) } }
+      response = Hubspot::Connection.post_json("/crm/v4/associations/#{from_object_type}/#{to_object_type}/batch/create", params: { no_parse: true }, body: request)
+      return false if response.parsed_response["errors"].present?
+
+      response.success?
+    end
+
+    def delete(object_type, object_id, to_object_type, to_object_id)
+      batch_delete(object_type, to_object_type, [{from_id: object_id, to_id: to_object_id}])
+    end
+
+    # Remove multiple associations in a single API call
+    # {https://developers.hubspot.com/docs/api/crm/associations}
+    # usage:
+    # Hubspot::Association.batch_delete("Company", "Contact", [{ from_id: 1, to_id: 2}])
+    def batch_delete(from_object_type, to_object_type, associations)
+      request = { inputs: build_delete_associations_body(associations) }
+      Hubspot::Connection.post_json("/crm/v4/associations/#{from_object_type}/#{to_object_type}/batch/archive", params: { no_parse: true }, body: request).success?
+    end
+
+    # Retrieve all associated resources given a source (object_type and object_id) and a relation type (to_object_type)
+    # {https://developers.hubspot.com/docs/api/crm/associations}
+    # Warning: it will return at most 1000 objects and make up to 1001 queries
+    # Hubspot::Association.all("Company", 42, "Contact")
+    def all(object_type, object_id, to_object_type)
+      klass = OBJECT_TARGET_TO_CLASS[to_object_type]
+      raise(Hubspot::InvalidParams, 'Object type not supported') unless klass.present?
+
+      response = Hubspot::Connection.get_json("/crm/v4/objects/#{object_type}/#{object_id}/associations/#{to_object_type}", {})
+      response['results'].map { |result| klass.find(result["toObjectId"]) }
+    end
+
+    private
+
+    def build_create_association_body(association, definition_id)
+      {
+        from: {
+          id: association[:from_id]
+        },
+        to: {
+          id: association[:to_id]
+        },
+        types: [
+          {
+            associationCategory: "HUBSPOT_DEFINED",
+            associationTypeId: definition_id
+          }
+        ]
+      }
+    end
+
+    def build_delete_associations_body(associations)
+      normalized_associations = associations.inject({}) do |memo, association|
+        memo[association[:from_id]] ||= []
+        memo[association[:from_id]] << association[:to_id]
+        memo
+      end
+
+      normalized_associations.map do |from_id, to_ids|
+        {
+          from: {
+            id: from_id
+          },
+          to: to_ids.map do |to_id|
+            {
+              id: to_id
+            }
+          end
+        }
+      end
+    end
+  end
+end

data/lib/hubspot/company.rb

@@ -2,7 +2,6 @@ class Hubspot::Company < Hubspot::Resource
   self.id_field = "companyId"
   self.property_name_field = "name"
 
-  ADD_CONTACT_PATH        = '/companies/v2/companies/:id/contacts/:contact_id'
   ALL_PATH                = '/companies/v2/companies/paged'
   BATCH_UPDATE_PATH       = '/companies/v1/batch-async/update'
   CONTACTS_PATH           = '/companies/v2/companies/:id/contacts'
@@ -12,7 +11,6 @@ class Hubspot::Company < Hubspot::Resource
   FIND_PATH               = '/companies/v2/companies/:id'
   RECENTLY_CREATED_PATH   = '/companies/v2/companies/recent/created'
   RECENTLY_MODIFIED_PATH  = '/companies/v2/companies/recent/modified'
-  REMOVE_CONTACT_PATH     = '/companies/v2/companies/:id/contacts/:contact_id'
   SEARCH_DOMAIN_PATH      = '/companies/v2/domains/:domain/companies'
   UPDATE_PATH             = '/companies/v2/companies/:id'
 
@@ -80,20 +78,11 @@ class Hubspot::Company < Hubspot::Resource
     end
 
     def add_contact(id, contact_id)
-      Hubspot::Connection.put_json(
-        ADD_CONTACT_PATH,
-        params: { id: id, contact_id: contact_id }
-      )
-      true
+      Hubspot::Association.create("Company", id, "Contact", contact_id)
     end
 
     def remove_contact(id, contact_id)
-      Hubspot::Connection.delete_json(
-        REMOVE_CONTACT_PATH,
-        { id: id, contact_id: contact_id }
-      )
-
-      true
+      Hubspot::Association.delete("Company", id, "Contact", contact_id)
     end
 
     def batch_update(companies, opts = {})

data/lib/hubspot/config.rb

@@ -5,7 +5,7 @@ module Hubspot
   class Config
     CONFIG_KEYS = [
       :hapikey, :base_url, :portal_id, :logger, :access_token, :client_id,
-      :client_secret, :redirect_uri, :read_timeout, :open_timeout
+      :client_secret, :redirect_uri, :read_timeout, :open_timeout, :custom_event_prefix
     ]
     DEFAULT_LOGGER = Logger.new(nil)
     DEFAULT_BASE_URL = "https://api.hubapi.com".freeze
@@ -15,21 +15,26 @@ module Hubspot
 
       def configure(config)
         config.stringify_keys!
-        @hapikey = config["hapikey"]
-        @base_url = config["base_url"] || DEFAULT_BASE_URL
-        @portal_id = config["portal_id"]
-        @logger = config["logger"] || DEFAULT_LOGGER
-        @access_token = config["access_token"]
-        @client_id = config["client_id"] if config["client_id"].present?
-        @client_secret = config["client_secret"] if config["client_secret"].present?
-        @redirect_uri = config["redirect_uri"] if config["redirect_uri"].present?
+        @hapikey = config['hapikey']
+        @base_url = config['base_url'] || DEFAULT_BASE_URL
+        @portal_id = config['portal_id']
+        @logger = config['logger'] || DEFAULT_LOGGER
+        @access_token = config['access_token']
+        @client_id = config['client_id'] if config['client_id'].present?
+        @client_secret = config['client_secret'] if config['client_secret'].present?
+        @redirect_uri = config['redirect_uri'] if config['redirect_uri'].present?
         @read_timeout = config['read_timeout'] || config['timeout']
         @open_timeout = config['open_timeout'] || config['timeout']
+        @custom_event_prefix = config['custom_event_prefix']
 
         unless authentication_uncertain?
           raise Hubspot::ConfigurationError.new("You must provide either an access_token or an hapikey")
         end
 
+        if hapikey.present?
+          Hubspot::Deprecator.build.deprecation_warning("hapikey", "please use access_token instead. See https://developers.hubspot.com/docs/api/migrate-an-api-key-integration-to-a-private-app")
+        end
+
         if access_token.present?
           Hubspot::Connection.headers("Authorization" => "Bearer #{access_token}")
         end

data/lib/hubspot/connection.rb

@@ -7,7 +7,7 @@ module Hubspot
         url = generate_url(path, opts)
         response = get(url, format: :json, read_timeout: read_timeout(opts), open_timeout: open_timeout(opts))
         log_request_and_response url, response
-        handle_response(response)
+        handle_response(response).parsed_response
       end
 
       def post_json(path, opts)
@@ -24,9 +24,9 @@ module Hubspot
         )
 
         log_request_and_response url, response, opts[:body]
-        raise(Hubspot::RequestError.new(response)) unless response.success?
-
-        no_parse ? response : response.parsed_response
+        handle_response(response).yield_self do |r|
+          no_parse ? r : r.parsed_response
+        end
       end
 
       def put_json(path, options)
@@ -43,17 +43,16 @@ module Hubspot
         )
 
         log_request_and_response(url, response, options[:body])
-        raise(Hubspot::RequestError.new(response)) unless response.success?
-
-        no_parse ? response : response.parsed_response
+        handle_response(response).yield_self do |r|
+          no_parse ? r : r.parsed_response
+        end
       end
 
       def delete_json(path, opts)
         url = generate_url(path, opts)
         response = delete(url, format: :json, read_timeout: read_timeout(opts), open_timeout: open_timeout(opts))
         log_request_and_response url, response, opts[:body]
-        raise(Hubspot::RequestError.new(response)) unless response.success?
-        response
+        handle_response(response)
       end
 
       protected
@@ -67,11 +66,10 @@ module Hubspot
       end
 
       def handle_response(response)
-        if response.success?
-          response.parsed_response
-        else
-          raise(Hubspot::RequestError.new(response))
-        end
+        return response if response.success?
+
+        raise(Hubspot::NotFoundError.new(response)) if response.not_found?
+        raise(Hubspot::RequestError.new(response))
       end
 
       def log_request_and_response(uri, response, body=nil)
@@ -149,4 +147,12 @@ module Hubspot
       get(url, body: opts[:body], headers: opts[:headers])
     end
   end
+
+  class CustomEventConnection < Connection
+    def self.trigger(path, opts)
+      url = generate_url(path, opts[:params], { hapikey: true })
+      headers = (opts[:headers] || {}).merge('content-type': 'application/json')
+      post(url, body: opts[:body].to_json, headers: headers)
+    end
+  end
 end

data/lib/hubspot/contact.rb

@@ -12,7 +12,6 @@ class Hubspot::Contact < Hubspot::Resource
   MERGE_PATH              = '/contacts/v1/contact/merge-vids/:id/'
   SEARCH_PATH             = '/contacts/v1/search/query'
   UPDATE_PATH             = '/contacts/v1/contact/vid/:id/profile'
-  UPDATE_PATH             = '/contacts/v1/contact/vid/:id/profile'
   BATCH_UPDATE_PATH       = '/contacts/v1/contact/batch'
 
   class << self
@@ -28,6 +27,11 @@ class Hubspot::Contact < Hubspot::Resource
       end
     end
 
+    def find_by_vid(vid)
+      response = Hubspot::Connection.get_json(FIND_PATH, id: vid)
+      from_result(response)
+    end
+    
     def find_by_email(email)
       response = Hubspot::Connection.get_json(FIND_BY_EMAIL_PATH, email: email)
       from_result(response)

data/lib/hubspot/contact_list.rb

@@ -10,7 +10,6 @@ module Hubspot
     RECENT_CONTACTS_PATH = LIST_PATH + '/contacts/recent'
     ADD_CONTACT_PATH     = LIST_PATH + '/add'
     REMOVE_CONTACT_PATH  = LIST_PATH + '/remove'
-    REFRESH_PATH         = LIST_PATH + '/refresh'
 
     class << self
       # {http://developers.hubspot.com/docs/methods/lists/create_list}
@@ -92,12 +91,6 @@ module Hubspot
       end
     end
 
-    # {http://developers.hubspot.com/docs/methods/lists/refresh_list}
-    def refresh
-      response = Hubspot::Connection.post_json(REFRESH_PATH, params: { list_id: @id, no_parse: true }, body: {})
-      response.code == 204
-    end
-
     # {http://developers.hubspot.com/docs/methods/lists/add_contact_to_list}
     def add(contacts)
       contact_ids = [contacts].flatten.uniq.compact.map(&:id)

data/lib/hubspot/custom_event.rb

@@ -0,0 +1,25 @@
+require 'hubspot/utils'
+
+module Hubspot
+  #
+  # HubSpot Custom Behavioral Events HTTP API
+  #
+  # {https://developers.hubspot.com/docs/api/analytics/events}
+  #
+  class CustomEvent
+    POST_EVENT_PATH = '/events/v3/send'
+
+    class << self
+      def trigger(event_name, email, properties, options = {})
+        options[:params] ||= {}
+        options[:body] ||= {}
+        options[:body].merge!(
+          eventName: "#{Hubspot::Config.custom_event_prefix}_#{event_name}",
+          email: email,
+          properties: properties
+        )
+        Hubspot::CustomEventConnection.trigger(POST_EVENT_PATH, options).success?
+      end
+    end
+  end
+end