hubspot_client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5904fbc990f2c806e61e911eba497a18c8d5edd447bf037e7645b67c996316e
-  data.tar.gz: 37c4de7c938ae280b5c33f184eb2bdc8c4c86aab769aeed3c55223f64a66cf26
+  metadata.gz: d32c26caa7aef52958e69b0e2d39e817a3f7bc3040588047cf87a971e368624c
+  data.tar.gz: d9eb9948cefd4c32be3dd6a063a066f19585a787460eb1497bf440c798f35297
 SHA512:
-  metadata.gz: 285786683544164c349a56e2dbfc14ffdaff18f073aaf6e409daa0dc5c12a892f5ffffc0e7607b31f0ae8a85a77e542d25edd69576411f61f6cb18033a510d9e
-  data.tar.gz: 13a19aa59a459dfa3b50e3a2314e89f9d611fea3a2a56d862c1490c893d46f5f59bb3af313e917e3cb2b8999fac6afd6a5da7aef8619a0f432987f505b568127
+  metadata.gz: 3ce85e31052c0fa66eab3902c9a97b11a3644549a54d7bdcd177c85f6efbcfb2713301c919ce32b4ad3b7feecd382d5ddc40c847fb74f201c1512cedfb6228b4
+  data.tar.gz: 9de133859142bd82180e74193a659998d8cd97044ff86ed69e9e7dbc64fb19ccaaa1c4d09d644fbc041705edffc76bdc4e51941cda3d592181c975afa26c0f60

data/.gitignore

@@ -1,4 +1,5 @@
 .env
+.env.hubspot-dev
 .idea/
 .ruby-version
 coverage/*

data/CHANGELOG.md

@@ -1,14 +1,28 @@
-## 0.3.0
+## 0.3.1 (2023-07-05)
+
+### Features
+* add missing context and legalConsentOptions to submission client
+
+### Breaking Changes
+None
+
+## 0.3.0 (2023-07-03)
 
 ### Features
 * add client form, to get all forms
 * add client submission, to submit forms
 
+### Breaking Changes
+None
+
 ## 0.2.1 (2022-12-07)
 
 ### Patch
 * only update writeable properties
 
+### Breaking Changes
+None
+
 ## 0.2.0 (2022-12-02)
 
 ### Features

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot_client (0.3.0)
+    hubspot_client (0.3.1)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -137,13 +137,32 @@ The `fields` parameter is a list of objects with the following properties:
 ```ruby
 [
   {
-    "objectTypeId": '0-1',
+    "objectTypeId": '0-1', # Optional
     "name": 'email',
     "value": 'darth_garllon@example.com'
   }
 ]
 ```
 
+the `context` parameter is a hash of the following attributes:
+```ruby
+{
+  "pageUri": 'https://example.com',
+  "pageName": 'Example page'
+}
+```
+
+The `leagalConsentOptions` parameter is a hash of the following attributes:
+```ruby
+{
+    consent: {
+      consentToProcess: true,
+      text: "I agree to allow #{company_name} to store and process my personal data.",
+      communications: []
+    }
+}
+```
+
 ## Development
 
 After checking out the repo, run

data/bin/console

@@ -6,7 +6,15 @@ require 'hubspot_client'
 require 'dotenv'
 require 'pry'
 
-Dotenv.load
+def load_environment_variables
+  env_file = ENV['ENV_FILE'] || '.env'
+  raise "#{env_file} not found" unless File.exist?(env_file)
+
+  puts "Loading `#{env_file}` file"
+  Dotenv.load(env_file)
+end
+
+load_environment_variables
 
 HubspotClient.configure do |config|
   config.access_token = ENV['ACCESS_TOKEN']

data/lib/hubspot_client/client/submission.rb

@@ -8,10 +8,28 @@ module HubspotClient
 
       BASE_PATH_V3 = '/submissions/v3/integration/secure/submit'
 
-      def initialize(portal_id:, form_guid:, fields: [])
-        @portal_id = portal_id
-        @form_guid = form_guid
-        @fields    = fields
+      # EXAMPLES:
+      # fields: [{name: 'email', value: 'darth_garllon@example.com'}]
+      #
+      # context: {
+      #   pageUri: "https://example.com",
+      #   pageName: "Example page"
+      # }
+      #
+      # legal_consent_options: {
+      #   consent: {
+      #     consentToProcess: true,
+      #     text: "I agree to allow #{company_name} to store and process my personal data.",
+      #     communications: []
+      #   }
+      # }
+
+      def initialize(portal_id:, form_guid:, fields: [], context: {}, legal_consent_options: {})
+        @portal_id             = portal_id
+        @form_guid             = form_guid
+        @fields                = fields
+        @context               = context
+        @legal_consent_options = legal_consent_options
       end
 
       def submit
@@ -23,7 +41,9 @@ module HubspotClient
 
       def body
         {
-          "fields": @fields
+          fields: @fields,
+          context: @context,
+          legalConsentOptions: @legal_consent_options
         }
       end
 

data/lib/hubspot_client/model/company.rb

@@ -19,7 +19,7 @@ module HubspotClient
 
       def update(new_properties = {})
         assign_attributes(new_properties)
-        response = Client::Company.new.update(hs_object_id, to_h)
+        response = Client::Company.new.update(hs_object_id, to_h.slice(*writable_properties))
 
         return true if response.code == 200
 
@@ -40,6 +40,12 @@ module HubspotClient
           self[attribute] = value
         end
       end
+
+      private
+
+      def writable_properties
+        HubspotClient::Model::Property.writable_property_names_for('companies')
+      end
     end
   end
 end

data/lib/hubspot_client/model/contact.rb

@@ -25,7 +25,7 @@ module HubspotClient
 
       def update(new_properties = {})
         assign_attributes(new_properties)
-        response = Client::Contact.new.update(hs_object_id, to_h)
+        response = Client::Contact.new.update(hs_object_id, to_h.slice(*writable_properties))
 
         return true if response.code == 200
 
@@ -70,6 +70,12 @@ module HubspotClient
           self[attribute] = value
         end
       end
+
+      private
+
+      def writable_properties
+        HubspotClient::Model::Property.writable_property_names_for('contacts')
+      end
     end
   end
 end

data/lib/hubspot_client/model/property.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module HubspotClient
+  module Model
+    class Property
+      def self.all_for(object_type)
+        HubspotClient::Client::Properties.new.for(object_type)
+      end
+
+      def self.writable_property_names_for(object_type)
+        readonly_properties = all_for(object_type)['results'].reject do |property|
+          property['modificationMetadata']['readOnlyValue'] == true
+        end
+
+        readonly_properties.map { |property| property['name'].to_sym }
+      end
+    end
+  end
+end

data/lib/hubspot_client/version.rb

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

data/lib/hubspot_client.rb

@@ -12,6 +12,7 @@ require 'hubspot_client/configuration'
 require 'hubspot_client/model/communication_preference'
 require 'hubspot_client/model/company'
 require 'hubspot_client/model/contact'
+require 'hubspot_client/model/property'
 require 'hubspot_client/version'
 
 module HubspotClient

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hubspot_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Garllon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-03 00:00:00.000000000 Z
+date: 2023-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -186,6 +186,7 @@ files:
 - lib/hubspot_client/model/communication_preference.rb
 - lib/hubspot_client/model/company.rb
 - lib/hubspot_client/model/contact.rb
+- lib/hubspot_client/model/property.rb
 - lib/hubspot_client/version.rb
 homepage: https://github.com/Farbfox/hubspot_client/blob/main/README.md
 licenses: