hubspot_v3 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 831c706b12ca929919b9521451a44350194678d709e200fa5be2344142248fbd
-  data.tar.gz: acc7373fdf69e5d5265c4b5288187920f3cddbc4fd4014be1ad846dcd331ce75
+  metadata.gz: e0d20f6a8537ba36435a57682fc297817d8172bc6918e94a114ef8d8f0e5f1cc
+  data.tar.gz: 7c2d6829f3d59310be90b89b5393318865c8723c129f27e71431f855903ceede
 SHA512:
-  metadata.gz: c44773f8b1eb6f67e7013692c0ba301ff350426c30e339ef6eb36d441d7f54176a9a5487ff3432e21bc2652758ef8a85001e96daa45a70d2b3363d7c196edc35
-  data.tar.gz: cfe059ca979b2b6153ee18c793a8fd440b714c8be7a68c8811e6ff3ce3cb77c668d61dd59d3f20c3d0370f39bac9fea816ea6c9364d5eced63f28ebb2521b1a5
+  metadata.gz: bca4bf7caba1c559c41cfeba769b2c163d80f160661b5e69064c764f88496431cdd0f0397f8571653619b09355da12b4e40502f2898190e57835641a7366b3b4
+  data.tar.gz: 53359b29589e94b29d1dde13a0d6da7c716df63c0020910c32e187a403f0812f9506db43ac58b2bb7c40382cab116a517f1cba181bcb5bbcd37633151803c51d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot_v3 (0.1.0)
+    hubspot_v3 (1.0.0)
       httparty (~> 0.2)
 
 GEM
@@ -11,9 +11,9 @@ GEM
     httparty (0.20.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
+    mime-types-data (3.2022.0105)
     multi_xml (0.6.0)
     rake (13.0.6)
     rspec (3.10.0)

data/README.md

@@ -28,9 +28,11 @@ It's possible to use our gem along with  any of these two gems.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'hubspot_v3', github: 'Pobble/hubspot_v3'
+gem 'hubspot_v3', '~> 1.0'
 ```
 
+[![Gem Version](https://badge.fury.io/rb/hubspot_v3.svg)](https://badge.fury.io/rb/hubspot_v3)
+
 And then execute:
 
     $ bundle install
@@ -321,13 +323,15 @@ require 'hubspot_v3/mock_contract'
 HubspotV3::MockContract.contacts_search_by_emails(["hello@pobble.com", "notfound@pobble.com", "info@pobble.com"])
 # [
 #   {
-#     "id" => 1589, "properties" => {
+#     "id" => 1589,
+#     "properties" => {
 #       "email"=>"hello@pobble.com",
 #       ...
 #     }
 #   },
-    {
-#    "id" => 1485, "properties" => {
+#   {
+#    "id" => 1485,
+#    "properties" => {
 #       "email"=>"info@pobble.com",
 #       ...
 #       }
@@ -338,7 +342,7 @@ HubspotV3::MockContract.contacts_search_by_emails_mapped(["hello@pobble.com", "n
 # => ["hello@pobble.com", "info@pobble.com"]
 ```
 
-`id` field of test Contact contracts is calculated as `'info@pobble.com'.bytes.sum == 1485`, create contacts will be `'info@pobble.com'.bytes.sum + 1_000_000 == 1001485`
+`id` field of test Contact contracts is calculated as `'info@pobble.com'.bytes.sum == 1485` ([source](https://github.com/Pobble/hubspot_v3/blob/master/lib/hubspot_v3/mock_contract.rb#L181)), create contacts will be `'info@pobble.com'.bytes.sum + 1_000_000 == 1001485` ([source](https://github.com/Pobble/hubspot_v3/blob/master/lib/hubspot_v3/mock_contract.rb#L29))
 
 > More info on how to use [Contract tests](https://blog.eq8.eu/article/explicit-contracts-for-rails-http-api-usecase.html)
 

data/lib/hubspot_v3/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HubspotV3
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/hubspot_v3.rb

@@ -15,6 +15,8 @@ module HubspotV3
     end
   end
 
+  HubspotRequestLimitReached = Class.new(RequestFailedError)
+
   API_URL='https://api.hubapi.com'
   CONTACTS_SEARCH='/crm/v3/objects/contacts/search'
   CONTACTS_CREATE='/crm/v3/objects/contacts/batch/create'
@@ -90,15 +92,26 @@ module HubspotV3
   end
 
   def self.post(path, bodyhash)
-    res = HTTParty.post(url(path), {
+    httparty_response = HTTParty.post(url(path), {
       body: bodyhash.to_json,
       headers: headers
     })
-    case res.code
+    case httparty_response.code
     when 200, 201
-      res.parsed_response['results']
+      httparty_response.parsed_response['results']
+    when 429
+      # Hubspot error 429 - You have reached your secondly limit.
+      raise _hubspot_request_limit_reached_error(httparty_response)
+    when 500
+      if httparty_response.parsed_response["category"] == "RATE_LIMITS"
+        # e.g.: {"status":"error","message":"You have reached your secondly limit.","category":"RATE_LIMITS"}
+        # Yes, Hubspot will sometimes give 429 or 500 when limit reached
+        raise _hubspot_request_limit_reached_error(httparty_response)
+      else
+        raise _hubspot_request_failed_error(httparty_response)
+      end
     else
-      raise HubspotV3::RequestFailedError.new("#{res.code} - #{res.parsed_response['message']}", res)
+      raise _hubspot_request_failed_error(httparty_response)
     end
   end
 
@@ -108,4 +121,16 @@ module HubspotV3
       'Authorization': "Bearer #{config.token}"
     }
   end
+
+  def self._hubspot_request_limit_reached_error(httparty_response)
+    code = httparty_response.code
+    message = httparty_response.parsed_response['message']
+    HubspotV3::HubspotRequestLimitReached.new("#{code} - #{message}", httparty_response)
+  end
+
+  def self._hubspot_request_failed_error(httparty_response)
+    code = httparty_response.code
+    message = httparty_response.parsed_response['message']
+    HubspotV3::RequestFailedError.new("#{code} - #{message}", httparty_response)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hubspot_v3
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Tomas Valent
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-28 00:00:00.000000000 Z
+date: 2022-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty