ruby_hubspot_api 0.2 → 0.2.1.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 67b58c873d1e9277df15b213a804afe47189c888aab565963950bf9992050e07
-  data.tar.gz: 62028c4b6b0a2ac9a9a29e88cf4762cbbdb909942415d1bc2bf02e3838b405eb
+SHA1:
+  metadata.gz: 2ca83fa3cba8c574d585b31a359da74678d405d2
+  data.tar.gz: 151f119e552b17faff4d921cda1ceec62a3fc045
 SHA512:
-  metadata.gz: 98ec373c58ef3aa92eb963d2ab567bd41204bd1c80552e0abacf4cadc1a6860d5b227dde78f5fbfe8b6d3cdff65536390116f468492c6f639e87c1a83f4e60ff
-  data.tar.gz: 5bea871875782b5fd35ff62de85c11da16f7e763a88972ac3d6cbca3e6b700eca589eed7933058434d9c6574079b71fd5e2d0aabc8fcc3be288dd27d5a9ae405
+  metadata.gz: e2e95c0a9ef1b69ff862c7843bbb100b23d57fe29cfea0d2042a7593dc3760307d48027fc0b54a6ae05bd39c4721db7603e04a7b16a5ec51b50a1becc436fdc1
+  data.tar.gz: 9dd953ca1946b3f9c3f1d0616f377a330f7e894f6a0f1a1aa6e98fde137015b6c39148dec58437c5cf027d89b9e096dbeb36b144a368ed8f1e61aa2a673305d7

data/.github/workflows/ruby.yml

@@ -0,0 +1,47 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - name: Run tests
+      run: HUBSPOT_LOG_LEVEL=FATAL bundle exec rspec
+
+    - name: Upload coverage to Codecov
+      run: bash <(curl -s https://codecov.io/bash)
+      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 }}

data/.gitignore

@@ -6,3 +6,4 @@
 # rspec failure tracking
 .rspec_status
 .pry_history
+.ruby-version

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_hubspot_api (0.1.2.1)
+    ruby_hubspot_api (0.2.1)
       httparty (>= 0.1, < 1.0)
 
 GEM
@@ -9,14 +9,16 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    bigdecimal (3.1.8)
+    bigdecimal (3.0.2)
     byebug (11.1.3)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
     crack (1.0.0)
       bigdecimal
       rexml
     diff-lcs (1.5.1)
-    docile (1.4.1)
+    docile (1.3.5)
     dotenv (2.8.1)
     hashdiff (1.1.1)
     httparty (0.21.0)
@@ -25,15 +27,15 @@ GEM
     method_source (1.1.0)
     mini_mime (1.1.2)
     multi_xml (0.6.0)
-    pry (0.13.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.9.0)
+    pry-byebug (3.8.0)
       byebug (~> 11.0)
-      pry (~> 0.13.0)
+      pry (~> 0.10)
     public_suffix (4.0.7)
     rake (13.2.1)
-    rexml (3.3.7)
+    rexml (3.2.5)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -47,32 +49,35 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    simplecov (0.22.0)
+    simplecov (0.18.5)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
     simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
+    simplecov-lcov (0.8.0)
     vcr (6.0.0)
-    webmock (3.23.1)
+    webmock (3.18.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-18
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (>= 2.0)
+  bundler (>= 2.0, < 2.4.0)
+  codecov
   dotenv (>= 2.0)
   pry (>= 0.1)
   pry-byebug (>= 3.0)
   rake (>= 11.0, < 14.0)
   rspec (>= 3.0)
   ruby_hubspot_api!
-  simplecov (>= 0.22, < 1.0)
+  simplecov
+  simplecov-lcov
   vcr (>= 6.0)
   webmock (>= 3.0)
 
 BUNDLED WITH
-   2.3.26
+   2.2.34

data/README.md

@@ -1,5 +1,7 @@
 # Ruby HubSpot API Gem
 
+[![codecov](https://codecov.io/gh/sensadrome/ruby_hubspot_api/branch/main/graph/badge.svg)](https://codecov.io/gh/sensadrome/ruby_hubspot_api) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/504ca01245ee4928b6ed0b13801259e7)](https://app.codacy.com/gh/sensadrome/ruby_hubspot_api/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+
 This gem was largely inspired by [hubspot-api-ruby](https://github.com/captaincontrat/hubspot-api-ruby) which, in turn, was inspired by the [hubspot-ruby](https://github.com/HubspotCommunity/hubspot-ruby) community gem. I wanted to use version 3 of the api and simplify some parts of the interface
 
 The Ruby HubSpot API gem is a starting point for building an ORM-like interface to HubSpot's API.
@@ -30,19 +32,54 @@ To authenticate API requests, you need a HubSpot access token. First you will ne
 
 You can configure the gem by adding this code to your initializer (for Rails) or to your startup configuration (in any other environment):
 
+##### Minimum configuration
+
 ```ruby
 Hubspot.configure do |config|
   config.access_token = 'your_access_token'
 end
 ```
 
+##### Full possible configuration
+
+```ruby
+Hubspot.configure do |config|
+  config.access_token = 'your_access_token'
+  config.portal_id = 'your_portal_id'
+  config.client_secret = 'your_client_secret'
+  config.logger = Rails.logger
+  config.log_level = 'info' # debug,info,warn,error,fatal
+  config.timeout = 10 # seconds to timeout all api requests
+  config.open_timeout = 5 # open_timeout seconds
+  config.read_timeout = 5 # read_timeout seconds
+  config.write_timeout = 5 # swrite_timeout econds (ruby >= 2.6)
+end
+```
+
 This configuration ensures that your API requests are authenticated using your HubSpot access token.
 
-## Working with Objects
+## Working with Resources
+
+This gem allows you to interact with Hubspot resources such as contacts and companies. You can perform operations on individual resources (e.g., creating or updating records) as well as on collections (e.g., listing or searching).
+
+__please note__
+
+> In the Hubspot API contacts, companies etc are referred to as "Objects" (e.g. CRM > Objects > Contacts) so when we use the word "Object" (with a capital O) we will be referring to an object in Hubspot
 
-_(N.B when referring to the resources in the api we will refer to them as Objects as per the Hubspot nomenclature)_
+> In this gem we use the term Resource so as not to accidentally overload Object! When we use the term "Resource" we should be referring to the ruby ORM base class and when we say "resource" we should be referring to an instance of this class (or a class that inherits it)
 
-This gem allows you to interact with HubSpot objects such as contacts and companies. You can perform operations on individual instances (e.g., creating or updating records) as well as on collections (e.g., listing or searching).
+### Hubspot::Resource class
+
+This is the base ORM class for all Hubspot CRM objects. You should not operate on this class but with the following classes each of which inherits from Hubspot::Resource
+
+```ruby
+Hubspot::Contact  # crm > contacts
+Hubspot::Company  # crm > companies
+Hubspot::User     # hubspot users (also referred to as 'owners')
+Hubspot::Owner    # alias of Hubspot::User if you prefer to use it
+```
+ 
+however you can [add custom objects of your own](#user-content-custom-resources) based on your own custom defined Objects in Hubspot
 
 ### Creating and Saving an Object
 
@@ -178,12 +215,12 @@ This will automatically set the limits and handle paging for the most efficient
 
 By default Hubspot will only send back the [default hubspot properties](https://knowledge.hubspot.com/properties/hubspots-default-contact-properties)
 
-You can pass an array of properties to be return as follows:
+You can pass an array of properties to be returned as follows:
 
 Example:
 
 ```ruby
-# Search for contacts with email containing "hubspot.com" and only return specific properties
+# Get the full list of contacts and only return specific properties
 contacts = Hubspot::Contact.list(
   properties: ['firstname', 'lastname', 'email', 'mobile', 'custom_property_1']
 )
@@ -327,7 +364,9 @@ batch.each_page do |contacts|
 end
 ```
 
-Finally there is another helper method on re
+Finally there is another helper method `batch_read_all` on any Hubspot::Resource class (Hubspot::Contact, Hubspot::Company, Hubspot::User etc) which will read all of the resources and return a HubSpot::Batch (with all of the resources). 
+
+You can then update the resources and call `update` on the batch.... see below
 
 #### Batch Update
 
@@ -348,13 +387,12 @@ batch.update
 
 Example using a batch
 ```ruby
-contact_ids = my_contacts.collect(&:hubspot_id).compact
-batch = Hubspot::contacts.batch_read(contact_ids)
+user_ids = my_selected_users.collect(&:hubspot_id).compact
+batch = Hubspot::User.batch_read(user_ids)
 
-batch.resources.each do |hubspot_contact|
-  my_contact = my_contacts.find { |c| c.hubspot_id == hubspot_contact.id }
-  # some logic or method to set any new/changed properties on hubspot_contact
-  update_hubspot_contact_from_local(hubspot_contact, my_contact)
+batch.resources.each do |hubspot_user|
+  # some logic or method to set any new/changed properties on hubspot_user
+  hubspot_user.sales_total = fetch_sales_total(user.email)
 end
 
 # now we have a batch with changed resources we can update the batch
@@ -404,6 +442,31 @@ else
 end
 ```
 
+## Custom Resources
+
+If you have defined custom objects you can easily add them by creating a class that inherits from `Hubspot::Resource`
+
+```ruby
+# lib/hubspot/projects.rb
+
+require 'ruby_hubspot_api' # if not required by bundler already...
+
+module Hubspot
+  class Project < Resource
+    
+    # resource_name (part of the url in the api) will default
+    # to a simple plural of the class name - in this case 'projects'
+    # if the url for your custom object is different you can override it
+
+    def resource_name
+      'company_projects'
+    end
+  end
+end
+
+projects = Hubspot::Projects.search(query: { status_in: ['upcoming', 'active', 'overrun'] }).all
+
+```
 
 ## Contributing
 

data/lib/hubspot/api_client.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# HubSpot API Client
+# Handles all HTTP interactions with the HubSpot API. It manages GET, POST, PATCH, and DELETE requests.
 module Hubspot
   # All interations with the Hubspot API happen here...
   class ApiClient

data/lib/hubspot/config.rb

@@ -15,6 +15,11 @@ module Hubspot
       apply_log_level
     end
 
+    # Apply the log level to the logger
+    def apply_log_level
+      @logger.level = @log_level
+    end
+
     private
 
     # Initialize the default logger
@@ -43,11 +48,6 @@ module Hubspot
     end
     # rubocop:enable Metrics/MethodLength
 
-    # Apply the log level to the logger
-    def apply_log_level
-      @logger.level = @log_level
-    end
-
     # Set the default log level based on environment
     def default_log_level
       if defined?(Rails) && Rails.env.test?

data/lib/hubspot/property.rb

@@ -11,5 +11,9 @@ module Hubspot
       "#<#{self.class} #{formatted_attrs}>"
     end
     # :nocov:
+
+    def read_only?
+      modificationMetadata['readOnlyValue'] == true
+    end
   end
 end

data/lib/hubspot/resource.rb

@@ -82,6 +82,14 @@ module Hubspot
         properties.reject { |property| property['hubspotDefined'] }
       end
 
+      def updatable_properties
+        properties.reject(&:read_only?)
+      end
+
+      def read_only_properties
+        properties.select(&:read_only?)
+      end
+
       def property(property_name)
         properties.detect { |prop| prop.name == property_name }
       end

data/lib/hubspot/version.rb

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

data/lib/hubspot.rb

@@ -20,6 +20,7 @@ module Hubspot
       yield(config) if block_given?
       set_client_headers if config.access_token
       set_request_timeouts
+      config.apply_log_level
     end
 
     def configured?

data/lib/support/patches.rb

@@ -9,3 +9,30 @@ class Object
     end
   end
 end
+
+# At some point this will seem like a bad idea ;)
+
+# :nocov:
+if RUBY_VERSION < '2.5.0'
+  class Hash
+    # Non-mutating version (returns a new hash with transformed keys)
+    def transform_keys
+      return enum_for(:transform_keys) unless block_given?
+      result = {}
+      each_key do |key|
+        result[yield(key)] = self[key]
+      end
+      result
+    end
+
+    # Mutating version (modifies the hash in place)
+    def transform_keys!
+      return enum_for(:transform_keys!) unless block_given?
+      keys.each do |key|
+        self[yield(key)] = delete(key)
+      end
+      self
+    end
+  end
+end
+# :nocov:end

data/ruby_hubspot_api.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/sensadrome/ruby_hubspot_api'
   spec.license = 'MIT'
 
-  spec.required_ruby_version = '>= 2.5'
+  spec.required_ruby_version = '>= 2.4'
 
   # Prevent pushing this gem to RubyGems.org.
   # To allow pushes either set the 'allowed_push_host'
@@ -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.2'
+  version: 0.2.1.pre.1
 platform: ruby
 authors:
 - Simon Brook
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-29 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
@@ -218,14 +246,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
+rubyforge_project: 
+rubygems_version: 2.6.14.4
 signing_key: 
 specification_version: 4
 summary: ruby_hubspot_api is an ORM-like wrapper for the Hubspot API

data/.ruby-version

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