ruby_hubspot_api 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 52c9ee03d417a29792dbd370399982a03662cb621c0ab3e5ec0a2abd7de89ac5
-  data.tar.gz: aae2926993d4b6dcf78b8e728c031631225f667c882f0b6d0710601ff62c0772
+SHA1:
+  metadata.gz: 62b690c7e426369cd5979c4f6b5b0cec8b5a7620
+  data.tar.gz: 26047bb4aa34d3a91bf6c1aff80b6e3775220f4f
 SHA512:
-  metadata.gz: 6d2c9d82565c619a189bfc0780c914bb1b10cf769eb94b66e1e702fa5268fedadf7e3b9a188f6a1b0caa67c1b2d432e8f6401ffb890ca01efc768abc16ae3d3a
-  data.tar.gz: e66a9d5daa8373529a3a2ee07c474d288d94327fc40d83ed08e050e1dbb83c8f89217c95083035396f212ed78b97348f1a9437889d2719cd9dbf49d4624cbce3
+  metadata.gz: a6512174b13fa2ef07740690864c79a6c3593c908c1fed37170ef35bf08ca7ae5ceb9a3e53fe12d53079eb4e4bb47a58801430103b96c9a7b78dfd67eaaabaa5
+  data.tar.gz: 6ea719cb62b217fdbbdb2009d64215369608ba8d3423b59245472fb64fcd957174c5cc28a0cbcbd1f5eaf904260d19e1989da528df913292c139b5f4d893110e

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,89 +1,139 @@
-## v.0.2.0
 
-- Get the development dependencies right!
-- Bump the version again
-- describe find_by method
-- update lock
-- batch  :sparkle: upsert spec
-- Borrowing Object#blank? method cos it actually really helps...
-- batch implemntation
-- logger.debug the post body and response body
-- Adds a changes? Method on resource
-- Adds instance method resource_name on resource
-- Ensure keys are stringified
-- Add all end points to the batch spec
-- Adds create and archive methods to batches
-- Tidy up resource code
-- Cover the previously nocov'd code
-- Add api client logging spec
-- add configurable timeouts to requests
-- Move rate limit handling to the client
-- Simplify mocked responses in batch spec
-- Adds PagedBatch as pager for batch/read request
+## v0.3.0
+
+- update gem version in lock file
+- bump version
+- use safe navigation for extracting id
+- make erb explicitly determined by the file exension (.json.erb)
+- check the env vars before sanitising
+- Finish specs
+- Sanitize web mock output
+- Tests the method missing setter for resource
+- find_by_token method - uses v1 API
+- Contact find_by_token spec
+- Allow ERB in json fixtures
+- No cov for inspect
+- Ensure properties are passed as named argument
+- Update batch spec to check resource_matcher works
+- Drop cadacy for now
+- Ignore gem files
+- Dynamically add a method to batch to allow "resources" to be referred to as the resource_name
+- Adds validation for resource matcher
+- Bump the version
+- Update batch spec
+- Clear up processing results
+- Fix find resources
+- Update the hierarchy to allow more flexibility
+- Tidy comments
+- Adds  :sparkle: attributes method to a resource
+- Improve logic of resource matching
+- Update user model to force specific properties to be retrieved
+- Add some handling of required properties
+- Tidy up somer doc comments
+- adjust some rubocop settings
+- Yep. Back ported to 2.4
+- Tidy up documentation of resource
+- Ensure we always apply the right log_level
+- Adding Codacy badge
+- try to upload the coverage results to codacy too
+- Only apply lcov formatter if running on github
+- Add property check to the contact spec
+- Add read-only properties to resource class
+- Adding lcov format
+- Using earlier bundler
+- adding codecov
+- determine if a Hubspot property is read_only (or by negation updatable)
+- test on ruby 3.0 too
+- ignore ruby version file
+- Use ERB in VCR tests so as to be independent of the env vars
+- try calling rspec directly
+- add ruby 2.5 and reduce log output
+- add plaatforms to Gemfile.lock
+- fix the github workflow properly
+- fix the github workflow
+- Create ruby.yml
+- More usage clarification
+- Clarify usage
+
+## v0.2.0
+
+- bump version
 - Update the Readme to add Batch operations
-- #5 batch_updating
+- Adds PagedBatch as pager for batch/read request
+- Simplify mocked responses in batch spec
+- Move rate limit handling to the client
+- add configurable timeouts to requests
+- Add api client logging spec
+- Cover the previously nocov'd code
+- Tidy up resource code
+- Adds create and archive methods to batches
+- Add all end points to the batch spec
+- Ensure keys are stringified
+- Adds instance method resource_name on resource
+- Adds a changes? Method on resource
+- logger.debug the post body and response body
+- batch implemntation
+- Borrowing Object#blank? method cos it actually really helps...
+- batch  :sparkle: upsert spec
+- update lock
+- describe find_by method
+- Bump the version again
+- Get the development dependencies right!
 
 ## v0.1.2
 
-- initial setup
-- Setup the configuration block
-- Adds spec for config
-- Set the auth headers when access_token configured
-- Version spec
-- don't test for client id
-- Load api client and add exception handler
-- Initial bases class Resource for api crud
-- Contact class with spec
-- Cassettes for contact spec
-- company model and spec with cassettes
-- Adds PagedCollection for paged results (list / search)
-- Adds Hubspot configuration to tests
-- Update required files
-- Adds list method to return PagedCollection
-- Add interface for search
-- VCR configuration
-- Contact/search cassette
-- Sample ENV file for developers
-- console with configuration if env vars set
-- Readme file
-- MIT license
-- allow connections if vcr_record_mode is on
-- Fix rubocop config
-- Update Readme
-- Log api requests and add interface to set logging
-- Update exception handing logic and add more exception classes
-- Test all parts of the config code
-- Adds user model (aliased to Owner) and specs
-- Add a configured? method to Hubspot module
-- Adds a dummy Hubspot::Property class
-- Update Paged request handling based on method
-- Adds a find_by mechanism for resources
-- Use the Hubspot::Property class to return properties for a given resource object
-- Update the specs for 100% coverage
-- Update the sample .env file
-- Reorder and clarify Readme
-- When we use limit(1) we should only return the object not an array
-- Test that we only get the properties we ask for or the defaults
-- 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
+- Sure the search param is values where passing an array
+- Fix the Readme
 
 ## v0.1.1
 
-- Fix the Readme
-- Sure the search param is values where passing an array
-- update changelog and Gemfile.lock
 - bump version
+- Fix dependencies
+- adds the version numbers to the gemspec
 
 ## v0.1.0
 
-- adds the version numbers to the gemspec
-- Fix dependencies
-- bump version
+- Update the changeling and link in gem spec
+- Improve the intialiser
+- Flatten the properties array into a comma separated list
+- Test that we only get the properties we ask for or the defaults
+- When we use limit(1) we should only return the object not an array
+- Reorder and clarify Readme
+- Update the sample .env file
+- Update the specs for 100% coverage
+- Use the Hubspot::Property class to return properties for a given resource object
+- Adds a find_by mechanism for resources
+- Update Paged request handling based on method
+- Adds a dummy Hubspot::Property class
+- Add a configured? method to Hubspot module
+- Adds user model (aliased to Owner) and specs
+- Test all parts of the config code
+- Update exception handing logic and add more exception classes
+- Log api requests and add interface to set logging
+- Update Readme
+- Fix rubocop config
+- allow connections if vcr_record_mode is on
+- MIT license
+- Readme file
+- console with configuration if env vars set
+- Sample ENV file for developers
+- Contact/search cassette
+- VCR configuration
+- Add interface for search
+- Adds list method to return PagedCollection
+- Update required files
+- Adds Hubspot configuration to tests
+- Adds PagedCollection for paged results (list / search)
+- company model and spec with cassettes
+- Cassettes for contact spec
+- Contact class with spec
+- Initial bases class Resource for api crud
+- Load api client and add exception handler
+- don't test for client id
+- Version spec
+- Set the auth headers when access_token configured
+- Adds spec for config
+- Setup the configuration block
+

data/Gemfile.lock

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

data/README.md

@@ -120,7 +120,7 @@ puts "Contact: #{contact.firstname} #{contact.lastname}"
 
 ### Updating an Existing Object
 
-To update an existing object, you can either modify the object and call `save`, or use the `update` method specifying the properties you want to update. You can test whether or not the object will need to upload changes to the api by using the changes? method
+To update an existing object, you can either modify the object and call `save`, or use the `update` method specifying the properties you want to update. You can test whether or not the object will need to upload changes to the api by using the changes? method. If you don't want to check for changes? you can use the method `save!` on the resource which will raise a Hubspot::NothingToDoError if there are no changes.
 
 Example using `save`:
 
@@ -136,6 +136,22 @@ contact.save # true
 contact.changes? # false
 ```
 
+Example using `save!`:
+
+```ruby
+contact = Hubspot::Contact.find(1)
+
+MyDecorator.new(contact).apply_changes!
+
+begin
+  contact.save!
+rescue Hubspot::NothingToDoError = _
+  puts "Nothing changed, cancelled api call"
+rescue Hubspot::RequestError => e
+  puts "API Error: #{e.message}"
+end
+```
+
 Example using `update`:
 
 ```ruby
@@ -274,6 +290,26 @@ end
 - **lte**: Less than or equal to.
 - **IN**: Matches any of the values in an array.
 
+#### Searching for empty values (NOT_HAS_PROPERTY)
+
+Any empty value in your search will be matched using the correect filter in Hubspot
+
+```ruby
+# Search for companies with no value for a given field
+companies = Hubspot::Company.search(query: { client_category: nil }, properties: %w[name number_of_employees])
+# Request body: {"filterGroups":[{"filters":[{"propertyName":"client_category","operator":"NOT_HAS_PROPERTY"}]}]
+
+puts "Searching for uncategorised customers"
+puts ""
+
+companies.each do |company|
+  category = company_category_by_size(company.number_of_employees)
+  company.update(client_category: category)
+
+  puts "  Found: #{company.name} (size #{company.number_of_employees}) - filed under #{category}"
+end
+```
+
 #### Specifying Properties in Search
 
 When performing a search, you can also specify which properties to return.

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/exceptions.rb

@@ -19,6 +19,7 @@ module Hubspot
   class RateLimitExceededError < RequestError; end
   class NotConfiguredError < StandardError; end
   class ArgumentError < StandardError; end
+  class NothingToDoError < StandardError; end
 
   class << self
     def error_from_response(response)

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/paged_collection.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'json'
 require_relative './api_client'
 require_relative './exceptions'
 

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
@@ -261,6 +263,8 @@ module Hubspot
       #
       # If no suffix is provided, the default comparison is equality (`EQ`).
       #
+      # If no value is provided, or is empty the NOT_HAS_PROPERTY operator will be used
+      #
       # 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
@@ -354,9 +358,9 @@ module Hubspot
         filter_groups = [{ filters: [] }]
 
         filters.each do |key, value|
-          filter = extract_property_and_operator(key)
+          filter = extract_property_and_operator(key, value)
           value_key = value.is_a?(Array) ? :values : :value
-          filter[value_key] = value
+          filter[value_key] = value unless value.blank?
           filter_groups.first[:filters] << filter
         end
 
@@ -364,7 +368,9 @@ module Hubspot
       end
 
       # Extract property name and operator from the key
-      def extract_property_and_operator(key)
+      def extract_property_and_operator(key, value)
+        return { propertyName: key.to_s, operator: 'NOT_HAS_PROPERTY' } if value.blank?
+
         OPERATOR_MAP.each do |suffix, hubspot_operator|
           if key.to_s.end_with?(suffix)
             return {
@@ -392,8 +398,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 +420,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
@@ -447,6 +458,12 @@ module Hubspot
       end
     end
 
+    def save!
+      raise NothingToDoError, 'Nothing to save' unless changes?
+
+      save
+    end
+
     # If the resource exists in Hubspot
     #
     # Returns Boolean
@@ -520,15 +537,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 +557,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
+          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
-          @properties[key] = value
+          @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,15 +628,12 @@ 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)
       @id = created_resource.id
+      @properties.merge!(@changes)
+      @changes = {}
       @id ? true : false
     end
   end

data/lib/hubspot/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hubspot
-  VERSION = '0.2.2'
+  VERSION = '0.3.1'
 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.1
 platform: ruby
 authors:
 - Simon Brook
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-03 00:00:00.000000000 Z
+date: 2024-10-16 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