hubspot_client 0.1.0.beta2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bc3a880bcae828da2e0ae5b37c4027339352b7294868caeb3b87395be557897
-  data.tar.gz: 78a1a367a7a052726fa95f4d792ffdcb1d619ba58cfde4a3f3f1842277aedb41
+  metadata.gz: 29ef10cf9b14d327f1d9990684aca8cfe7c7988cbf26cb4420c20bc14c18d237
+  data.tar.gz: fded388fb01ad2b338ba0ba32631553d24e72612fa0866644c9d95725b91542d
 SHA512:
-  metadata.gz: c5d4d5cd7dae89474741e4a985452b2a7aaf15681ba97b61a4fe8ddf8a52d5ecebd0267a6c4304470e65b5a20c35cf52a46c3f4aa66cb86febe0c313d5534914
-  data.tar.gz: 965e6fbd91337cc4f22c88ed74b4ca02ffc1a5fd3dacc8dbd9b0a3efc7254c288fa06efc840827fb453372b389f9cf35fd66398c15f276e3103ec863a820a221
+  metadata.gz: e5b1458f89a50a95e1323b984329b10b47a992e05b8f1a662935ada633d019e111043de8e4ec31c453fb61f8421bca05be70c63d32629f556ac216b49e60d383
+  data.tar.gz: 512dfc4ba03b80366059709c74ea09559c5e925c339dbdc556b4a24efd0d81db9cedd99ff90c308890c5e1b7fce83c2aeb034ed1a1d69f9cf58e4565f8879774

data/.gitignore

@@ -1,2 +1,3 @@
 .env
 .idea/
+.ruby-version

data/.rubocop.yml

@@ -4,4 +4,8 @@ Layout/LineLength:
   Max: 120
 
 Style/Documentation:
-  Enabled: false
+  Enabled: false
+
+Metrics/ModuleLength:
+  Exclude:
+#    - 'spec/hubspot_client/model/contact_spec.rb'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.1.0 (2022-11-30)
+
+### Features
+* add method for contact model to set communication preferences
+* added communication preference client
+
+### Breaking Changes
+None
+
 ## 0.1.0.beta2 (2022-11-28)
 
 ### Features

data/Gemfile

@@ -2,5 +2,5 @@
 
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in graphql_connector.gemspec
+# Specify your gem's dependencies in hubspot_client.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot_client (0.1.0.beta2)
+    hubspot_client (0.2.0)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -1,7 +1,13 @@
 
 # HubspotClient
 
-An simple Hubspot Client. We only like to support the CRm features for the moment. Maybe we do more.
+A Hubspot Client. Currently we only support the following CRM Parts:
+* Contact
+* Company
+* Properties
+
+Also:
+* Communication Preferences
 
 ## Installation
 
@@ -21,7 +27,7 @@ Or install it yourself as:
 
 ## Usage
 
-You need to configure the `graphql_connector` first:
+You need to configure the `hubspot_client` first:
 ``` ruby
 HubspotClient.configure do |config|
   config.access_token = 'PRIVATE_APP_ACCESS_TOKEN'
@@ -30,9 +36,10 @@ end
 
 ## Models
 
-The idea is that the models behave like an ActiveRecord Model.
+The following models exists and should be mainly used. However you can also use the clients itself,
+if you like, but you need to understand the code by yourself.
 
-### Contact - HubspotClient::Model::Contact
+### Contact
 
 [Hubspot- API](https://developers.hubspot.com/docs/api/crm/contacts)
 
@@ -47,9 +54,8 @@ HubspotClient::Model::Contact.find(email: 'vader@example.com')
 => #<HubspotClient::Model::Contact createdate="2022-11-11T11:57:15.901Z", email="vader@example.com", firstname="Darth", hs_object_id="1337", lastmodifieddate="2022-11-17T13:31:00.526Z", lastname="Vader">
 ```
 
-#### Associate_primary_company
+#### associate_primary_company
 
-Successfull Request
 ```ruby
 hubspot_contact = HubspotClient::Model::Contact.find(hubspot_id: '1337')
 => #<HubspotClient::Model::Contact createdate="2022-11-11T11:57:15.901Z", email="vader@example.com", firstname="Darth", hs_object_id="1337", lastmodifieddate="2022-11-17T13:31:00.526Z", lastname="Vader"> 
@@ -104,7 +110,7 @@ hubspot_company.update({ name: 'Blubber' })
 
 
 
-### Subscription-Preferences
+### Communication-Preference
 
 [Hubspot- API](https://developers.hubspot.com/docs/api/marketing-api/subscriptions-preferences)
 

data/hubspot_client.gemspec

@@ -7,8 +7,8 @@ require 'hubspot_client/version'
 Gem::Specification.new do |spec|
   spec.name          = 'hubspot_client'
   spec.version       = HubspotClient::VERSION
-  spec.authors       = %w[Garllon]
-  spec.email         = ['garllon@protonmail.com']
+  spec.authors       = %w[Garllon romankonz]
+  spec.email         = %w[garllon@protonmail.com roman@konz.me]
 
   spec.summary       = 'Hubspot client'
   spec.description   = 'Hubspot client to handle CRM objects.'

data/lib/hubspot_client/client/communication_preference.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module HubspotClient
+  module Client
+    class SubscriptionNotSuccessful < ClientBaseError; end
+    class FetchDefinitionsNotSuccessful < ClientBaseError; end
+
+    class CommunicationPreference
+      include HTTParty
+      base_uri 'https://api.hubapi.com'
+
+      BASE_PATH = '/communication-preferences/v3'
+
+      def definitions
+        response = self.class.get("#{BASE_PATH}/definitions",
+                                  headers: headers)
+
+        return response if response.code == 200
+
+        raise FetchDefinitionsNotSuccessful, response
+      end
+
+      def subscribe(properties)
+        response = self.class.post("#{BASE_PATH}/subscribe",
+                                   body: properties.to_json,
+                                   headers: headers)
+
+        return response if response.code == 200
+
+        raise SubscriptionNotSuccessful, response
+      end
+
+      def headers
+        { Authorization: "Bearer #{HubspotClient.configuration.access_token}",
+          'Content-Type': 'application/json' }
+      end
+    end
+  end
+end

data/lib/hubspot_client/client/company.rb

@@ -2,9 +2,9 @@
 
 module HubspotClient
   module Client
-    class CompanyNotFound < StandardError; end
-    class CompanyNotCreated < StandardError; end
-    class CompanyNotUpdated < StandardError; end
+    class CompanyNotFound < ClientBaseError; end
+    class CompanyNotCreated < ClientBaseError; end
+    class CompanyNotUpdated < ClientBaseError; end
 
     class Company
       include HTTParty
@@ -18,7 +18,7 @@ module HubspotClient
                                   headers: headers)
         return response if response.code == 200
 
-        raise CompanyNotFound, 'Hubspot Company Not Found'
+        raise CompanyNotFound, response
       end
 
       def create(properties)
@@ -28,7 +28,7 @@ module HubspotClient
 
         return response if response.code == 201
 
-        raise CompanyNotCreated, 'Hubspot could not Create'
+        raise CompanyNotCreated, response
       end
 
       def update(hubspot_id, properties)
@@ -38,7 +38,7 @@ module HubspotClient
 
         return response if response.code == 200
 
-        raise CompanyNotUpdated, 'Hubspot could not update'
+        raise CompanyNotUpdated, response
       end
 
       private

data/lib/hubspot_client/client/contact.rb

@@ -2,10 +2,10 @@
 
 module HubspotClient
   module Client
-    class ContactNotFound < StandardError; end
-    class ContactNotCreated < StandardError; end
-    class ContactNotUpdated < StandardError; end
-    class AssociationError < StandardError; end
+    class ContactNotFound < ClientBaseError; end
+    class ContactNotCreated < ClientBaseError; end
+    class ContactNotUpdated < ClientBaseError; end
+    class AssociationError < ClientBaseError; end
 
     class Contact
       include HTTParty
@@ -32,7 +32,7 @@ module HubspotClient
 
         return response if response.code == 201
 
-        raise ContactNotCreated, 'Hubspot Contact Not created'
+        raise ContactNotCreated, response
       end
 
       def update(hubspot_id, properties)
@@ -42,7 +42,7 @@ module HubspotClient
 
         return response if response.code == 200
 
-        raise ContactNotUpdated, 'Hubspot could not update'
+        raise ContactNotUpdated, response
       end
 
       def associate_with(hubspot_id, to_object_type, to_object_type_id, association_type = '1')
@@ -60,7 +60,7 @@ module HubspotClient
         response = self.class.get(path, headers: headers)
         return response if response.code == 200
 
-        raise ContactNotFound, 'Hubspot Contact Not Found'
+        raise ContactNotFound, response
       end
 
       def find_query_params(query_params = {})

data/lib/hubspot_client/client_base_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class ClientBaseError < StandardError
+  def initialize(response)
+    error_message = { status: response.code, body: JSON.parse(response.body) }
+    super(error_message)
+  end
+end

data/lib/hubspot_client/model/communication_preference.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module HubspotClient
+  module Model
+    class CommunicationPreference
+      def self.definitions
+        Client::CommunicationPreference.new.definitions
+      end
+    end
+  end
+end

data/lib/hubspot_client/model/company.rb

@@ -3,8 +3,6 @@
 module HubspotClient
   module Model
     class Company < OpenStruct
-      UPDATABLE_PROPERTIES = %i[name phone address city zip].freeze
-
       def self.find(hubspot_id: nil)
         response = Client::Company.new.find_by_id(hubspot_id)
 
@@ -14,16 +12,14 @@ module HubspotClient
       end
 
       def self.create(properties)
-        sliced_properties = properties.slice(*UPDATABLE_PROPERTIES)
-        response = Client::Company.new.create(sliced_properties)
+        response = Client::Company.new.create(properties)
 
         new(response['properties'])
       end
 
       def update(new_properties = {})
         assign_attributes(new_properties)
-        properties = to_h.slice(*UPDATABLE_PROPERTIES)
-        response = Client::Company.new.update(hs_object_id, properties)
+        response = Client::Company.new.update(hs_object_id, to_h)
 
         return true if response.code == 200
 

data/lib/hubspot_client/model/contact.rb

@@ -5,8 +5,6 @@ module HubspotClient
     class MissingParameter < StandardError; end
 
     class Contact < OpenStruct
-      UPDATABLE_PROPERTIES = %i[firstname lastname email phone lifecyclestage].freeze
-
       def self.find(hubspot_id: nil, email: nil)
         response = if hubspot_id
                      Client::Contact.new.find_by_id(hubspot_id)
@@ -20,16 +18,14 @@ module HubspotClient
       end
 
       def self.create(properties)
-        sliced_properties = properties.slice(*UPDATABLE_PROPERTIES)
-        response = Client::Contact.new.create(sliced_properties)
+        response = Client::Contact.new.create(properties)
 
         new(response['properties'])
       end
 
       def update(new_properties = {})
         assign_attributes(new_properties)
-        properties = to_h.slice(*UPDATABLE_PROPERTIES)
-        response = Client::Contact.new.update(hs_object_id, properties)
+        response = Client::Contact.new.update(hs_object_id, to_h)
 
         return true if response.code == 200
 
@@ -45,6 +41,18 @@ module HubspotClient
         self
       end
 
+      def create_communication_subscription(subscription_id:, legal_basis: nil, legal_basis_explanation: nil)
+        properties = {
+          emailAddress: email,
+          subscriptionId: subscription_id
+        }
+
+        properties[:legalBasis] = legal_basis if legal_basis
+        properties[:legalBasisExplanation] = legal_basis_explanation if legal_basis_explanation
+
+        Client::CommunicationPreference.new.subscribe(properties)
+      end
+
       def primary_company
         @primary_company ||= Company.find(hubspot_id: associatedcompanyid)
       end

data/lib/hubspot_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HubspotClient
-  VERSION = '0.1.0.beta2'
+  VERSION = '0.2.0'
 end

data/lib/hubspot_client.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
 require 'httparty'
-require 'hubspot_client/version'
-require 'hubspot_client/configuration'
-require 'hubspot_client/client/contact'
+require 'hubspot_client/client_base_error'
+require 'hubspot_client/client/communication_preference'
 require 'hubspot_client/client/company'
+require 'hubspot_client/client/contact'
 require 'hubspot_client/client/properties'
-require 'hubspot_client/model/contact'
+require 'hubspot_client/configuration'
+require 'hubspot_client/model/communication_preference'
 require 'hubspot_client/model/company'
+require 'hubspot_client/model/contact'
+require 'hubspot_client/version'
 
 module HubspotClient
   class << self

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hubspot_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0.beta2
+  version: 0.2.0
 platform: ruby
 authors:
 - Garllon
+- romankonz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-29 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -145,6 +146,7 @@ dependencies:
 description: Hubspot client to handle CRM objects.
 email:
 - garllon@protonmail.com
+- roman@konz.me
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -159,10 +161,13 @@ files:
 - bin/console
 - hubspot_client.gemspec
 - lib/hubspot_client.rb
+- lib/hubspot_client/client/communication_preference.rb
 - lib/hubspot_client/client/company.rb
 - lib/hubspot_client/client/contact.rb
 - lib/hubspot_client/client/properties.rb
+- lib/hubspot_client/client_base_error.rb
 - lib/hubspot_client/configuration.rb
+- lib/hubspot_client/model/communication_preference.rb
 - lib/hubspot_client/model/company.rb
 - lib/hubspot_client/model/contact.rb
 - lib/hubspot_client/version.rb
@@ -184,11 +189,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Hubspot client