ruby_hubspot_api 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 62b690c7e426369cd5979c4f6b5b0cec8b5a7620
-  data.tar.gz: 26047bb4aa34d3a91bf6c1aff80b6e3775220f4f
+SHA256:
+  metadata.gz: 85164b2e72737294737730eea14e12955d3f143f5fadc6a586523b002b1d82fa
+  data.tar.gz: 4240f83a2b75521845a0db28a6f7eac72b12542cd0c8c0bd1504f4a5c36c3c00
 SHA512:
-  metadata.gz: a6512174b13fa2ef07740690864c79a6c3593c908c1fed37170ef35bf08ca7ae5ceb9a3e53fe12d53079eb4e4bb47a58801430103b96c9a7b78dfd67eaaabaa5
-  data.tar.gz: 6ea719cb62b217fdbbdb2009d64215369608ba8d3423b59245472fb64fcd957174c5cc28a0cbcbd1f5eaf904260d19e1989da528df913292c139b5f4d893110e
+  metadata.gz: d74e992af58345457232d6617c6133e1874a85f98925606a954c86c0a766c198bd5e7d0643e5417d8a21ea195f1aba9d823147123c9cf8d631ac9514a4ed268c
+  data.tar.gz: 32be447b0f03a5d86c340f00d1639d61a839c040fbe96789bdaeb7869403fadaf04843167a497e99b6223b0cca4c7e00c62d04ac8554d6ec618db6861cc969f8

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_hubspot_api (0.3.1)
+    ruby_hubspot_api (0.3.2)
       httparty (>= 0.1, < 1.0)
 
 GEM
@@ -17,15 +17,17 @@ GEM
     crack (1.0.0)
       bigdecimal
       rexml
+    csv (3.3.0)
     diff-lcs (1.5.1)
     docile (1.3.5)
     dotenv (2.8.1)
     hashdiff (1.1.1)
-    httparty (0.21.0)
+    httparty (0.22.0)
+      csv
       mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
     method_source (1.1.0)
-    mini_mime (1.1.2)
+    mini_mime (1.1.5)
     multi_xml (0.6.0)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -80,4 +82,4 @@ DEPENDENCIES
   webmock (>= 3.0)
 
 BUNDLED WITH
-   2.2.34
+   2.3.27

data/README.md

@@ -310,6 +310,21 @@ companies.each do |company|
 end
 ```
 
+#### Getting the total number of records
+
+Having created a search collection you can retrieve the total number of matching records from Hubspot by calling .total on the collection. This will make a single request to the api to retrieve the number of matching records
+
+```ruby
+contacts_collection = Hubspot::Contact.search(query: { lead_status: 'cold' } )
+
+if contacts_collection.total > 200
+  puts "Contacts will be processed overnight"
+  # schedule_processing_job
+else
+  puts "Found #{contacts_collection.total} contacts. Processing...."
+  process_contacts(contacts_collection)
+```
+
 #### Specifying Properties in Search
 
 When performing a search, you can also specify which properties to return.

data/lib/hubspot/exceptions.rb

@@ -7,7 +7,9 @@ module Hubspot
     attr_accessor :response
 
     def initialize(response, message = nil)
-      message = response.parsed_response['message'] if !message && response.respond_to?(:parsed_response)
+      if !message && response.respond_to?(:parsed_response)
+        message = response.parsed_response['message']
+      end
       message += "\n" if message
       me = super("#{message}Response body: #{response.body}",)
       me.response = response
@@ -20,6 +22,7 @@ module Hubspot
   class NotConfiguredError < StandardError; end
   class ArgumentError < StandardError; end
   class NothingToDoError < StandardError; end
+  class NotImplementedError < StandardError; end
 
   class << self
     def error_from_response(response)

data/lib/hubspot/paged_collection.rb

@@ -11,17 +11,24 @@ module Hubspot
 
     MAX_LIMIT = 100 # HubSpot max items per page
 
+    # rubocop:disable Lint/MissingSuper
     def initialize(url:, params: {}, resource_class: nil, method: :get)
       @url = url
       @params = params
       @resource_class = resource_class
       @method = method.to_sym
     end
+    # rubocop:enable Lint/MissingSuper
+
+    def total
+      @total ||= determine_total
+    end
 
     def each_page
       offset = nil
       loop do
         response = fetch_page(offset)
+        @total = response['total'] if response['total']
         mapped_results = process_results(response)
         yield mapped_results unless mapped_results.empty?
         offset = response.dig('paging', 'next', 'after')
@@ -38,10 +45,12 @@ module Hubspot
     end
 
     # Override Enumerable's first method so as not to have to call each (via all)
+    # rubocop:disable Metrics/MethodLength
     def first(limit = 1)
       resources = []
       remaining = limit
 
+      original_limit = @params.delete(:limit)
       # Modify @params directly to set the limit
       @params[:limit] = [remaining, MAX_LIMIT].min
 
@@ -52,8 +61,10 @@ module Hubspot
         break if remaining <= 0
       end
 
+      @params[:limit] = original_limit
       limit == 1 ? resources.first : resources.first(limit)
     end
+    # rubocop:enable Metrics/MethodLength
 
     def each(&block)
       each_page do |page|
@@ -63,6 +74,33 @@ module Hubspot
 
     private
 
+    def determine_total
+      # We only get a response['total'] for the search endpoint
+      raise NotImplementedError, 'Total only available for search requests' unless search_request?
+
+      # if we don't already know the total we will make a single request and minimise the response
+      # size by asking for just one property and one record.
+
+      # store the current properties
+      original_properties = @params.delete(:properties)
+
+      # just request hs_object_id
+      @params[:properties] = ['hs_object_id']
+
+      # dummy request. @total will be set during the each_page evaluation
+      _first_page = first
+
+      # restore the original properties
+      @params[:properties] = original_properties
+
+      # return the now set total
+      @total
+    end
+
+    def search_request?
+      @url.include?('/search')
+    end
+
     def fetch_page(offset)
       params_with_offset = @params.dup
       params_with_offset.merge!(after: offset) if offset

data/lib/hubspot/resource.rb

@@ -314,13 +314,8 @@ module Hubspot
           method: :post
         )
       end
-
       # rubocop:enable Metrics/MethodLength
 
-      # The root of the api call. Mostly this will be "crm"
-      # but you can override this to account for a different
-      # object hierarchy
-
       # Define the resource name based on the class
       def resource_name
         name = self.name.split('::').last.downcase
@@ -339,6 +334,9 @@ module Hubspot
 
       private
 
+      # The root of the api call. Mostly this will be "crm"
+      # but you can override this to account for a different
+      # object hierarchy
       def api_root
         '/crm/v3/objects'
       end

data/lib/hubspot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hubspot
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_hubspot_api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Simon Brook
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-16 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -239,7 +239,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/sensadrome/ruby_hubspot_api
   changelog_uri: https://github.com/sensadrome/ruby_hubspot_api/blob/main/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -254,9 +254,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: ruby_hubspot_api is an ORM-like wrapper for the Hubspot API
 test_files: []