ruby_hubspot_api 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 52c9ee03d417a29792dbd370399982a03662cb621c0ab3e5ec0a2abd7de89ac5
-  data.tar.gz: aae2926993d4b6dcf78b8e728c031631225f667c882f0b6d0710601ff62c0772
+SHA1:
+  metadata.gz: 6052dfd71294e988924beeab1b89662673ceaf93
+  data.tar.gz: 4b2e295931295d639e473a9b139df03ec7df1554
 SHA512:
-  metadata.gz: 6d2c9d82565c619a189bfc0780c914bb1b10cf769eb94b66e1e702fa5268fedadf7e3b9a188f6a1b0caa67c1b2d432e8f6401ffb890ca01efc768abc16ae3d3a
-  data.tar.gz: e66a9d5daa8373529a3a2ee07c474d288d94327fc40d83ed08e050e1dbb83c8f89217c95083035396f212ed78b97348f1a9437889d2719cd9dbf49d4624cbce3
+  metadata.gz: caee0d8350205b6bcf45bb4ed4b5421f3fdaacaff87acfcb52c4845858bbafb664f70acbca1a564a34a99a166fd1072a838702d4bf4044b076cfd0b77e87f6a7
+  data.tar.gz: 28cbb5b1ea5ebc076d7177e8f4ee35f450bbe7fbb33224a31c55f0801fc566b705cf9b65faf95453b91154675139fb33cfce557ea74e06afd001a09f710190bf

data/.github/workflows/ruby.yml

@@ -41,7 +41,7 @@ jobs:
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
-    - name: Upload coverage to Codacy
-      run: bash <(curl -Ls https://coverage.codacy.com/get.sh)
-      env:
-        CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+    # - name: Upload coverage to Codacy
+    #   run: bash <(curl -Ls https://coverage.codacy.com/get.sh)
+    #   env:
+    #     CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}

data/.gitignore

@@ -1,7 +1,7 @@
 /.bundle/
 /coverage/
 /tmp/
-
+*.gem
 .env
 # rspec failure tracking
 .rspec_status

data/CHANGELOG.md

@@ -1,4 +1,61 @@
-## v.0.2.0
+
+## v0.3.0
+
+- Clarify usage
+- More usage clarification
+- Create ruby.yml
+- fix the github workflow
+- fix the github workflow properly
+- add plaatforms to Gemfile.lock
+- add ruby 2.5 and reduce log output
+- try calling rspec directly
+- Use ERB in VCR tests so as to be independent of the env vars
+- ignore ruby version file
+- test on ruby 3.0 too
+- determine if a Hubspot property is read_only (or by negation updatable)
+- adding codecov
+- Using earlier bundler
+- Adding lcov format
+- Add read-only properties to resource class
+- Add property check to the contact spec
+- Only apply lcov formatter if running on github
+- try to upload the coverage results to codacy too
+- Adding Codacy badge
+- Ensure we always apply the right log_level
+- Tidy up documentation of resource
+- Yep. Back ported to 2.4
+- adjust some rubocop settings
+- Tidy up somer doc comments
+- Add some handling of required properties
+- Update user model to force specific properties to be retrieved
+- Improve logic of resource matching
+- Adds  :sparkle: attributes method to a resource
+- Tidy comments
+- Update the hierarchy to allow more flexibility
+- Fix find resources
+- Clear up processing results
+- Update batch spec
+- Bump the version
+- Adds validation for resource matcher
+- Dynamically add a method to batch to allow "resources" to be referred to as the resource_name
+- Ignore gem files
+- Drop cadacy for now
+- Update batch spec to check resource_matcher works
+- Ensure properties are passed as named argument
+- No cov for inspect
+- Allow ERB in json fixtures
+- Contact find_by_token spec
+- find_by_token method - uses v1 API
+- Tests the method missing setter for resource
+- Sanitize web mock output
+- Finish specs
+- check the env vars before sanitising
+- make erb explicitly determined by the file exension (.json.erb)
+- use safe navigation for extracting id
+- bump version
+- update gem version in lock file
+
+## v0.2.0
 
 - Get the development dependencies right!
 - Bump the version again
@@ -21,11 +78,23 @@
 - Simplify mocked responses in batch spec
 - Adds PagedBatch as pager for batch/read request
 - Update the Readme to add Batch operations
-- #5 batch_updating
+- bump version
 
 ## v0.1.2
 
-- initial setup
+- Fix the Readme
+- Sure the search param is values where passing an array
+- update changelog and Gemfile.lock
+- bump version
+
+## v0.1.1
+
+- adds the version numbers to the gemspec
+- Fix dependencies
+- bump version
+
+## v0.1.0
+
 - Setup the configuration block
 - Adds spec for config
 - Set the auth headers when access_token configured
@@ -67,23 +136,4 @@
 - Flatten the properties array into a comma separated list
 - Improve the intialiser
 - Update the changeling and link in gem spec
-- adds the version numbers to the gemspec
-- Fix dependencies
-- bump version
-- Fix the Readme
-- Sure the search param is values where passing an array
-- update changelog and Gemfile.lock
-- bump version
-
-## v0.1.1
-
-- Fix the Readme
-- Sure the search param is values where passing an array
-- update changelog and Gemfile.lock
-- bump version
 
-## v0.1.0
-
-- adds the version numbers to the gemspec
-- Fix dependencies
-- bump version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_hubspot_api (0.2.2)
+    ruby_hubspot_api (0.3.0)
       httparty (>= 0.1, < 1.0)
 
 GEM

data/lib/hubspot/batch.rb

@@ -31,6 +31,7 @@ module Hubspot
     CONTACT_LIMIT = 10
     DEFAULT_LIMIT = 100
 
+    # :nocov:
     def inspect
       "#<#{self.class.name} " \
       "@resource_count=#{@resources.size}, " \
@@ -38,16 +39,11 @@ module Hubspot
       "@resource_type=#{@resources.first&.resource_name}, " \
       "@responses_count=#{@responses.size}>"
     end
+    # :nocov:
 
     # rubocop:disable Lint/MissingSuper
     def initialize(resources = [], id_property: 'id', resource_matcher: nil)
-      if resource_matcher
-        unless resource_matcher.is_a?(Proc) && resource_matcher.arity == 2
-          raise ArgumentError, 'resource_matcher must be a proc that accepts exactly 2 arguments'
-        end
-
-        @resource_matcher = resource_matcher
-      end
+      validate_resource_matcher(resource_matcher)
 
       @resources = []
       @id_property = id_property # Set id_property for the batch (default: 'id')
@@ -67,11 +63,23 @@ module Hubspot
     end
 
     # Upsert method that calls save with upsert action
-    def upsert
+    def upsert(resource_matcher: nil)
+      validate_resource_matcher(resource_matcher)
+
       validate_upsert_conditions
       save(action: 'upsert')
     end
 
+    def validate_resource_matcher(resource_matcher)
+      return if resource_matcher.blank?
+
+      unless resource_matcher.is_a?(Proc) && resource_matcher.arity == 2
+        raise ArgumentError, 'resource_matcher must be a proc that accepts exactly 2 arguments'
+      end
+
+      @resource_matcher = resource_matcher
+    end
+
     # Archive method
     def archive
       save(action: 'archive')
@@ -93,15 +101,29 @@ module Hubspot
     end
 
     def add_resource(resource)
-      if @resources.any? && @resources.first.resource_name != resource.resource_name
-        raise ArgumentError, 'All resources in a batch must be of the same type'
+      if @resources.any?
+        if @resources.first.resource_name != resource.resource_name
+          raise ArgumentError, 'All resources in a batch must be of the same type'
+        end
+      else
+        add_resource_method(resource.resource_name)
       end
 
       @resources << resource
     end
 
+    def any_changes?
+      @resources.any?(&:changes?)
+    end
+
     private
 
+    def add_resource_method(resource_name)
+      self.class.class_eval do
+        alias_method resource_name.to_sym, :resources
+      end
+    end
+
     # rubocop:disable Metrics/MethodLength
     def save(action: 'update')
       @action = action
@@ -280,13 +302,15 @@ module Hubspot
     end
 
     class << self
-      def read(object_class, object_ids = [], id_property: 'id')
+      def read(object_class, object_ids = [], properties: [], id_property: 'id')
         unless object_class < Hubspot::Resource
           raise ArgumentError, 'Must be a valid Hubspot resource class'
         end
 
         # fetch all the matching resources with paging handled
-        resources = object_class.batch_read(object_ids, id_property: id_property).all
+        resources = object_class.batch_read(object_ids,
+                                            properties: properties,
+                                            id_property: id_property).all
 
         # return instance of Hubspot::Batch with the resources set
         new(resources, id_property: id_property)

data/lib/hubspot/contact.rb

@@ -2,5 +2,68 @@
 
 module Hubspot
   class Contact < Resource
+    # def required_properties
+    #   %w[email firstname lastname]
+    # end
+
+    private
+
+    def metadata_field?(key)
+      METADATA_FIELDS.include?(key) || key.start_with?('hs_')
+    end
+
+    class << self
+      # Finds a contact by the hubspotutk cookie
+      #
+      # token - the hubspot tracking token (stored from the hubspotutk cookie value)
+      # properties: - Optional list of properties to return.
+      #   Note: If properties are specified 2 calls to the api will be made because
+      #   at this time you can only search by the token using the v1 api
+      #   from which we
+      #
+      # Example:
+      #   properties = %w[firstname lastname email last_contacted]
+      #   contact = Hubspot::Contact.find_by_token(hubspotutk_cookie_value, properties)
+      #
+      # Returns An instance of the resource.
+      def find_by_token(token, properties: [])
+        all_properties = build_property_list(properties)
+        query_props = all_properties.map { |prop| "property=#{prop}" }
+        query_string = query_props.concat(['propertyMode=value_only']).join('&')
+
+        # Make the original API request, manually appending the query string
+        response = get("/contacts/v1/contact/utk/#{token}/profile?#{query_string}")
+
+        # Only modify the response if it's successful (status 200 OK)
+        if response.success?
+          # Convert the v1 response body (parsed_response) to a v3 structure
+          v3_response_hash = convert_v1_response(response.parsed_response, all_properties)
+
+          # Modify the existing response object by updating its `parsed_response`
+          response.instance_variable_set(:@parsed_response, v3_response_hash)
+        end
+
+        # Pass the (potentially modified) HTTParty response to the next step
+        instantiate_from_response(response)
+      end
+
+      private
+
+      def convert_v1_response(v1_response, property_list)
+        # Extract the `vid` as `id`
+        v3_response = {
+          'id' => v1_response['vid']
+        }
+
+        properties = property_list.each_with_object({}) do |property, hash|
+          hash[property] = v1_response.dig('properties', property, 'value')
+        end
+
+        # Build the v3 structure
+        v3_response['properties'] = properties
+
+        v3_response
+      end
+    end
   end
 end

data/lib/hubspot/form.rb

@@ -4,11 +4,13 @@ module Hubspot
   class Form < Resource
     METADATA_FIELDS = %w[createdAt updatedAt archived].freeze
 
+    # :nocov:
     def inspect
       "#<#{self.class.name} " \
       "@name=#{name}, " \
       "@fieldGroups=#{respond_to?('fieldGroups') ? fieldGroups.size : '-'}>"
     end
+    # :nocov:
 
     class << self
       def api_root
@@ -18,9 +20,9 @@ module Hubspot
 
     private
 
-    # Extract ID from data and leave as a string
-    def extract_id(data)
-      data.delete('id')
+    # dont convert (from string)
+    def extract_id(id)
+      id
     end
   end
 end

data/lib/hubspot/paged_batch.rb

@@ -10,7 +10,7 @@ module Hubspot
 
     MAX_LIMIT = 100 # HubSpot max items per page
 
-    # customised inspect
+    # :nocov:
     def inspect
       "#<#{self.class.name} " \
       "@url=#{@url.inspect}, " \
@@ -18,6 +18,7 @@ module Hubspot
       "@resource_class=#{@resource_class.inspect}, " \
       "@object_ids_count=#{@object_ids.size}>"
     end
+    # :nocov:
 
     # rubocop:disable Lint/MissingSuper
     def initialize(url:, params: {}, resource_class: nil, object_ids: [])

data/lib/hubspot/resource.rb

@@ -45,12 +45,14 @@ module Hubspot
       # 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.
+      # properties - an array of property names to fetch in the result
       #
       # Example:
       #   contact = Hubspot::Contact.find(1)
+      #   contact = Hubspot::Contact.find(1, properties: %w[email firstname lastname custom_field])
       #
       # Returns An instance of the resource.
-      def find(id, properties = nil)
+      def find(id, properties: nil)
         all_properties = build_property_list(properties)
         if all_properties.is_a?(Array) && !all_properties.empty?
           params = { query: { properties: all_properties } }
@@ -181,8 +183,8 @@ module Hubspot
       #   Hubspot::Contact.batch_read_all(hubspot_contact_ids)
       #
       # 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)
+      def batch_read_all(object_ids = [], properties: [], id_property: 'id')
+        Hubspot::Batch.read(self, object_ids, properties: properties, id_property: id_property)
       end
 
       # Retrieve the complete list of properties for this resource class
@@ -392,8 +394,13 @@ module Hubspot
 
     # 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)
+    # data - [2D Hash, nested Hash] data to initialise:
+    #   - The response from the api will be of the form:
+    #       { id: <hs_object_id>, properties: { "email": "john@example.org" ... }, ... }
+    #
+    #   - A Simple 2D Hash, key value pairs in the form:
+    #       { email: 'john@example.org', firstname: 'John', lastname: 'Smith' }
+    #
     #   - 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
@@ -409,7 +416,7 @@ module Hubspot
     #   existing_contact = Hubspot::Contact.new(id: hubspot_id, properties: contact.to_hubspot)
     def initialize(data = {})
       data.transform_keys!(&:to_s)
-      @id = extract_id(data)
+      @id = extract_id(data.delete('id'))
       @properties = {}
       @metadata = {}
       if @id
@@ -520,15 +527,8 @@ module Hubspot
       if method_name.end_with?('=')
         attribute = method_name.chomp('=')
         new_value = args.first
-
-        # Track changes only if the value has actually changed
-        if @properties[attribute] != new_value
-          @changes[attribute] = new_value
-        else
-          @changes.delete(attribute) # Remove from changes if it reverts to the original value
-        end
-
-        return new_value
+        add_accessors attribute
+        return send("#{attribute}=", new_value)
       # Handle getters
       else
         return @changes[method_name] if @changes.key?(method_name)
@@ -547,35 +547,70 @@ module Hubspot
       @properties.key?(property_name) || @changes.key?(property_name) || super
     end
 
-    private
-
-    # Extract ID from data and convert to integer
-    def extract_id(data)
-      data['id'] ? data['id'].to_i : nil
-    end
-
     # Initialize from API response, separating metadata from properties
     def initialize_from_api(data)
+      @changes = data.delete('changes')&.transform_keys!(&:to_s) || {}
+
       if data['properties']
         @metadata = data.reject { |key, _v| key == 'properties' }
         handle_properties(data['properties'])
       else
         handle_properties(data)
       end
+    end
 
-      @changes = {}
+    private
+
+    # Extract ID from data and convert to integer
+    def extract_id(id)
+      id&.to_i
     end
 
     def handle_properties(properties_data)
-      properties_data.each do |key, value|
-        if METADATA_FIELDS.include?(key)
-          @metadata[key] = value
+      properties_data.each do |attribute, value|
+        if metadata_field?(attribute)
+          @metadata[attribute.to_s] = value
         else
-          @properties[key] = value
+          add_accessors attribute.to_s
+          @properties[attribute.to_s] = value
         end
       end
     end
 
+    def add_accessors(attribute)
+      add_accessors_setter(attribute)
+      add_accessors_getter(attribute)
+    end
+
+    def add_accessors_setter(attribute)
+      # Define the setter method
+      define_singleton_method("#{attribute}=") do |new_value|
+        # Track changes only if the value has actually changed
+        if @properties[attribute] != new_value
+          @changes[attribute] = new_value
+        else
+          @changes.delete(attribute) # Remove from changes if it reverts to the original value
+        end
+
+        new_value
+      end
+    end
+
+    def add_accessors_getter(attribute)
+      # Define the getter method
+      define_singleton_method(attribute) do
+        # Return from changes if available, else return from properties
+        return @changes[attribute] if @changes.key?(attribute)
+
+        @properties[attribute] if @properties.key?(attribute)
+      end
+    end
+
+    # allows overwriting in other resource classes
+    def metadata_field?(key)
+      METADATA_FIELDS.include?(key)
+    end
+
     # Initialize a new object (no API response)
     def initialize_new_object(data)
       @properties = {}
@@ -583,11 +618,6 @@ module Hubspot
       @metadata = {}
     end
 
-    # Extract metadata from data, excluding properties
-    def extract_metadata(data)
-      data.reject { |key, _| key == 'properties' }
-    end
-
     # Create a new resource
     def create_new
       created_resource = self.class.create(@changes)

data/lib/hubspot/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_hubspot_api
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Simon Brook
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-03 00:00:00.000000000 Z
+date: 2024-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -254,7 +254,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubyforge_project: 
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: ruby_hubspot_api is an ORM-like wrapper for the Hubspot API