ruby_hubspot_api 0.1.2.1 → 0.2.1

data/lib/hubspot/resource.rb

@@ -1,23 +1,70 @@
 # frozen_string_literal: true
 
 require_relative './api_client'
+require_relative './paged_collection'
+require_relative './paged_batch'
 
 module Hubspot
   # rubocop:disable Metrics/ClassLength
-  # Hubspot::Resource class
+
+  # HubSpot Resource Base Class
+  # This class provides common functionality for interacting with HubSpot API resources such as Contacts, Companies, etc
+  #
+  # It supports common operations like finding, creating, updating, and deleting resources, as well as batch operations.
+  #
+  # This class is meant to be inherited by specific resources like `Hubspot::Contact`.
+  #
+  # You can access the properties of a resource instance by calling the property name as method
+  #
+  # Example Usage:
+  #   Hubspot::Contact.find(1)
+  #   contact.name # 'Luke'
+  #
+  #   company = Hubspot::Company.create(name: "Acme Corp")
+  #   company.id.nil? # false
+  #
   class Resource < ApiClient
     METADATA_FIELDS = %w[createdate hs_object_id lastmodifieddate].freeze
 
-    # Allow read/write access to properties and metadata
-    attr_accessor :id, :properties, :changes, :metadata
+    # Allow read/write access to id, properties, changes and metadata
+
+    # the id of the object in hubspot
+    attr_accessor :id
+
+    # the properties as if read from the api
+    attr_accessor :properties
+
+    # track any changes made to properties before saving etc
+    attr_accessor :changes
+
+    # any other data sent from the api about the resource
+    attr_accessor :metadata
 
     class << self
       # Find a resource by ID and return an instance of the class
+      #
+      # id - [Integer] The ID (or hs_object_id) of the resource to fetch.
+      #
+      # Example:
+      #   contact = Hubspot::Contact.find(1)
+      #
+      # Returns An instance of the resource.
       def find(id)
         response = get("/crm/v3/objects/#{resource_name}/#{id}")
         instantiate_from_response(response)
       end
 
+      # Finds a resource by a given property and value.
+      #
+      # property - The property to search by (e.g., "email").
+      # value - The value of the property to match.
+      # properties - Optional list of properties to return.
+      #
+      # Example:
+      #   properties = %w[firstname lastname email last_contacted]
+      #   contact = Hubspot::Contact.find_by("email", "john@example.com", properties)
+      #
+      # Returns An instance of the resource.
       def find_by(property, value, properties = nil)
         params = { idProperty: property }
         params[:properties] = properties if properties.is_a?(Array)
@@ -25,12 +72,28 @@ module Hubspot
         instantiate_from_response(response)
       end
 
-      # Create a new resource
+      # Creates a new resource with the given parameters.
+      #
+      # params - The properties to create the resource with.
+      #
+      # Example:
+      #   contact = Hubspot::Contact.create(name: "John Doe", email: "john@example.com")
+      #
+      # Returns [Resource] The newly created resource.
       def create(params)
         response = post("/crm/v3/objects/#{resource_name}", body: { properties: params }.to_json)
         instantiate_from_response(response)
       end
 
+      # Updates an existing resource by ID.
+      #
+      # id - The ID of the resource to update.
+      # params - The properties to update.
+      #
+      # Example:
+      #   contact.update(1, name: "Jane Doe")
+      #
+      # Returns True if the update was successful, false if not
       def update(id, params)
         response = patch("/crm/v3/objects/#{resource_name}/#{id}", body: { properties: params }.to_json)
         raise Hubspot.error_from_response(response) unless response.success?
@@ -38,6 +101,14 @@ module Hubspot
         true
       end
 
+      # Deletes a resource by ID.
+      #
+      # id - The ID of the resource to delete.
+      #
+      # Example:
+      #   Hubspot::Contact.archive(1)
+      #
+      # Returns True if the deletion was successful, false if not
       def archive(id)
         response = delete("/crm/v3/objects/#{resource_name}/#{id}")
         raise Hubspot.error_from_response(response) unless response.success?
@@ -45,6 +116,14 @@ module Hubspot
         true
       end
 
+      # Lists all resources with optional filters and pagination.
+      #
+      # params - Optional parameters to filter or paginate the results.
+      #
+      # Example:
+      #   contacts = Hubspot::Contact.list(limit: 100)
+      #
+      # Returns [PagedCollection] A collection of resources.
       def list(params = {})
         PagedCollection.new(
           url: "/crm/v3/objects/#{resource_name}",
@@ -53,7 +132,45 @@ module Hubspot
         )
       end
 
-      # Get the complete list of fields (properties) for the object
+      # Performs a batch read operation to retrieve multiple resources by their IDs.
+      #
+      # object_ids  - A list of resource IDs to fetch.
+      #
+      # id_property - The property to use for identifying resources (default: 'id').
+      #
+      #
+      # Example:
+      #   Hubspot::Contact.batch_read([1, 2, 3])
+      #
+      # Returns [PagedBatch] A paged batch of resources (call .each_page to cycle through pages from the API)
+      def batch_read(object_ids = [], id_property: 'id')
+        params = id_property == 'id' ? {} : { idProperty: id_property }
+
+        PagedBatch.new(
+          url: "/crm/v3/objects/#{resource_name}/batch/read",
+          params: params,
+          object_ids: object_ids,
+          resource_class: self
+        )
+      end
+
+      # Performs a batch read operation to retrieve multiple resources by their IDs
+      # until there are none left
+      #
+      # object_ids - A list of resource IDs to fetch. [Array<Integer>]
+      # id_property - The property to use for identifying resources (default: 'id').
+      #
+      # Example:
+      #   Hubspot::Contact.batch_read([1, 2, 3])
+      #
+      # Returns [Hubspot::Batch] A batch of resources that can be operated on further
+      def batch_read_all(object_ids = [], id_property: 'id')
+        Hubspot::Batch.read(self, object_ids, id_property: id_property)
+      end
+
+      # Retrieve the complete list of properties for this resource class
+      #
+      # Returns [Array<Hubspot::Property>] An array of hubspot properties
       def properties
         @properties ||= begin
           response = get("/crm/v3/properties/#{resource_name}")
@@ -61,10 +178,34 @@ module Hubspot
         end
       end
 
+      # Retrieve the complete list of user defined properties for this resource class
+      #
+      # Returns [Array<Hubspot::Property>] An array of hubspot properties
       def custom_properties
         properties.reject { |property| property['hubspotDefined'] }
       end
 
+      # Retrieve the complete list of updatable properties for this resource class
+      #
+      # Returns [Array<Hubspot::Property>] An array of updateable hubspot properties
+      def updatable_properties
+        properties.reject(&:read_only?)
+      end
+
+      # Retrieve the complete list of read-only properties for this resource class
+      #
+      # Returns [Array<Hubspot::Property>] An array of read-only hubspot properties
+      def read_only_properties
+        properties.select(&:read_only)
+      end
+
+      # Retrieve information about a specific property
+      #
+      # Example:
+      #   property = Hubspot::Contact.property('industry_sector')
+      #   values_for_select = property.options.each_with_object({}) { |prop, ps| ps[prop['value']] = prop['label'] }
+      #
+      # Returns [Array<Hubspot::Property>] An array of hubspot properties
       def property(property_name)
         properties.detect { |prop| prop.name == property_name }
       end
@@ -81,6 +222,45 @@ module Hubspot
       }.freeze
 
       # rubocop:disable Metrics/MethodLength
+
+      # Search for resources using a flexible query format and optional properties.
+      #
+      # This method allows searching for resources by passing a query in the form of a string (for full-text search)
+      # or a hash with special suffixes on the keys to define different comparison operators.
+      # You can also specify which properties to return and the number of results per page.
+      #
+      # Available suffixes for query keys (when using a hash):
+      #   - `_contains`: Matches values that contain the given string.
+      #   - `_gt`: Greater than comparison.
+      #   - `_lt`: Less than comparison.
+      #   - `_gte`: Greater than or equal to comparison.
+      #   - `_lte`: Less than or equal to comparison.
+      #   - `_neq`: Not equal to comparison.
+      #   - `_in`: Matches any of the values in the given array.
+      #
+      # If no suffix is provided, the default comparison is equality (`EQ`).
+      #
+      # query - [String, Hash] The query for searching. This can be either:
+      #   - A String: for full-text search.
+      #   - A Hash: where each key represents a property and may have suffixes for the comparison
+      #     (e.g., `{ email_contains: 'example.org', age_gt: 30 }`).
+      # properties - An optional array of property names to return in the search results. [Array<String>]
+      #   If not specified or empty, HubSpot will return the default set of properties.
+      # page_size - The number of results to return per page (default is 10 for contacts and 100 for everything else).
+      #
+      # Example Usage:
+      #   # Full-text search for 'example.org':
+      #   contacts = Hubspot::Contact.search(query: "example.org",
+      #                                      properties: ["email", "firstname", "lastname"], page_size: 50)
+      #
+      #   # Search for contacts whose email contains 'example.org' and are older than 30:
+      #   contacts = Hubspot::Contact.search(
+      #     query: { email_contains: 'example.org', age_gt: 30 },
+      #     properties: ["email", "firstname", "lastname"],
+      #     page_size: 50
+      #   )
+      #
+      # Returns [PagedCollection] A paged collection of results that can be iterated over.
       def search(query:, properties: [], page_size: 100)
         search_body = {}
 
@@ -111,8 +291,6 @@ module Hubspot
 
       # rubocop:enable Metrics/MethodLength
 
-      private
-
       # Define the resource name based on the class
       def resource_name
         name = self.name.split('::').last.downcase
@@ -123,6 +301,8 @@ module Hubspot
         end
       end
 
+      private
+
       # Instantiate a single resource object from the response
       def instantiate_from_response(response)
         data = handle_response(response)
@@ -160,20 +340,51 @@ module Hubspot
     end
 
     # rubocop:disable Ling/MissingSuper
+
+    # Public: Initialize a resouce
+    #
+    # data - [2D Hash, nested Hash] data to initialise the resourse This can be either:
+    #   - A Simple 2D Hash, key value pairs of property => value (for the create option)
+    #   - A structured hash consisting of { id: <hs_object_id>, properties: {}, ... }
+    #     This is the same structure as per the API, and can be rebuilt if you store the id
+    #     of the object against your own data
+    #
+    # Example:
+    #   contact = Hubspot::Contact.new(firstname: 'Luke', lastname: 'Skywalker', email: 'luke@jedi.org')
+    #   contact.persisted? # false
+    #   contact.save # creates the record in Hubspot
+    #   contact.persisted? # true
+    #   puts "Contact saved with hubspot id #{contact.id}"
+    #
+    #   existing_contact = Hubspot::Contact.new(id: hubspot_id, properties: contact.to_hubspot_properties)
     def initialize(data = {})
+      data.transform_keys!(&:to_s)
       @id = extract_id(data)
       @properties = {}
       @metadata = {}
-
       if @id
         initialize_from_api(data)
       else
         initialize_new_object(data)
       end
     end
+
     # rubocop:enable Ling/MissingSuper
 
-    # Instance methods for update (or save)
+    # Determine the state of the object
+    #
+    # Returns Boolean
+    def changes?
+      !@changes.empty?
+    end
+
+    # Create or Update the resource.
+    # If the resource was already persisted (e.g. it was retrieved from the API)
+    # it will be updated using values from @changes
+    #
+    # If the resource is new (no id) it will be created
+    #
+    # Returns Boolean
     def save
       if persisted?
         self.class.update(@id, @changes).tap do |result|
@@ -187,11 +398,22 @@ module Hubspot
       end
     end
 
+    # If the resource exists in Hubspot
+    #
+    # Returns Boolean
     def persisted?
       @id ? true : false
     end
 
     # Update the resource
+    #
+    # params - hash of properties to update in key value pairs
+    #
+    # Example:
+    #   contact = Hubspot::Contact.find(hubspot_contact_id)
+    #   contact.update(status: 'gold customer', last_contacted_at: Time.now.utc.iso8601)
+    #
+    # Returns Boolean
     def update(params)
       raise 'Not able to update as not persisted' unless persisted?
 
@@ -202,13 +424,27 @@ module Hubspot
       save
     end
 
+    # Archive the object in Hubspot
+    #
+    # Example:
+    #   company = Hubspot::Company.find(hubspot_company_id)
+    #   company.delete
+    #
     def delete
       self.class.archive(id)
     end
     alias archive delete
 
+    def resource_name
+      self.class.resource_name
+    end
+
     # rubocop:disable Metrics/MethodLength
-    # Handle dynamic getter and setter methods with method_missing
+
+    # getter: Check the properties and changes hashes to see if the method
+    # being called is a key, and return the corresponding value
+    # setter: If the method ends in "=" persist the value in the changes hash
+    # (when it is different from the corresponding value in properties if set)
     def method_missing(method, *args)
       method_name = method.to_s
 
@@ -232,19 +468,16 @@ module Hubspot
       end
 
       # Fallback if the method or attribute is not found
-      # :nocov:
       super
-      # :nocov:
     end
+
     # rubocop:enable Metrics/MethodLength
 
-    # Ensure respond_to_missing? is properly overridden
-    # :nocov:
+    # Ensure respond_to_missing? handles existing keys in the properties anc changes hashes
     def respond_to_missing?(method_name, include_private = false)
       property_name = method_name.to_s.chomp('=')
       @properties.key?(property_name) || @changes.key?(property_name) || super
     end
-    # :nocov:
 
     private
 

data/lib/hubspot/version.rb

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

data/lib/hubspot.rb

@@ -19,6 +19,7 @@ module Hubspot
     def configure
       yield(config) if block_given?
       set_client_headers if config.access_token
+      set_request_timeouts
     end
 
     def configured?
@@ -31,5 +32,18 @@ module Hubspot
     def set_client_headers
       Hubspot::ApiClient.headers 'Authorization' => "Bearer #{config.access_token}"
     end
+
+    def set_request_timeouts
+      config.timeout && Hubspot::ApiClient.default_timeout(config.timeout)
+      timeouts = %i[open_timeout read_timeout]
+      timeouts << :write_timeout if RUBY_VERSION >= '2.6'
+
+      timeouts.each do |t|
+        timeout = config.send(t)
+        next unless timeout
+
+        Hubspot::ApiClient.send(t, timeout)
+      end
+    end
   end
 end

data/lib/ruby_hubspot_api.rb

@@ -20,4 +20,7 @@ require_relative 'hubspot/company'
 require_relative 'hubspot/user'
 
 # Load other components
+require_relative 'hubspot/batch'
 require_relative 'hubspot/paged_collection'
+
+require_relative 'support/patches'

data/lib/support/patches.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# simplest monkey patch, honest ;)
+class Object
+  # Only define blank? if it's not already defined
+  unless method_defined?(:blank?)
+    def blank?
+      respond_to?(:empty?) ? empty? : !self
+    end
+  end
+end

data/ruby_hubspot_api.gemspec

@@ -40,12 +40,14 @@ Gem::Specification.new do |spec|
   # Define development dependencies
   spec.add_development_dependency 'rake', '>= 11.0', '< 14.0'
 
-  spec.add_development_dependency 'bundler', '>= 2.0'
+  spec.add_development_dependency 'bundler', '>= 2.0', '< 2.4.0'
+  spec.add_development_dependency 'codecov'
   spec.add_development_dependency 'dotenv', '>= 2.0'
   spec.add_development_dependency 'pry', '>= 0.1'
   spec.add_development_dependency 'pry-byebug', '>= 3.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
-  spec.add_development_dependency 'simplecov', '>= 0.22', '< 1.0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-lcov'
   spec.add_development_dependency 'vcr', '>= 6.0'
   spec.add_development_dependency 'webmock', '>= 3.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_hubspot_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Simon Brook
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-25 00:00:00.000000000 Z
+date: 2024-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -37,6 +37,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -44,6 +47,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -106,20 +126,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.22'
-    - - "<"
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -176,10 +204,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".env.sample"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -190,16 +218,19 @@ files:
 - bin/setup
 - lib/hubspot.rb
 - lib/hubspot/api_client.rb
+- lib/hubspot/batch.rb
 - lib/hubspot/company.rb
 - lib/hubspot/config.rb
 - lib/hubspot/contact.rb
 - lib/hubspot/exceptions.rb
+- lib/hubspot/paged_batch.rb
 - lib/hubspot/paged_collection.rb
 - lib/hubspot/property.rb
 - lib/hubspot/resource.rb
 - lib/hubspot/user.rb
 - lib/hubspot/version.rb
 - lib/ruby_hubspot_api.rb
+- lib/support/patches.rb
 - ruby_hubspot_api.gemspec
 homepage: https://github.com/sensadrome/ruby_hubspot_api
 licenses:

data/.ruby-version

@@ -1 +0,0 @@
-2.5.3