hubspot_client 0.1.0.beta1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12f80ed6afbfbb4fc8561616156762128e77defcca1c53bc4f07b93affaebd18
-  data.tar.gz: eaf249fb97115e5178e4785e3824574973817b78e9cc2713af81b46e4f3833af
+  metadata.gz: 64366ba11cb24670e4a304a5a16307402736fe0f941f725535f148a37329afdc
+  data.tar.gz: d134c5b394c90e1b86d7cc716b20196289ba3c3c1b7768793d5d15fdca86ff0c
 SHA512:
-  metadata.gz: b2f43fe74c400cc82d075ff771392431a55294418195a8514018d9b09a4dce169a0986d829967a0c7653b197ed744afff4267d013702bad2371b40f32bd4a59f
-  data.tar.gz: edd7430e6c3cb224a56fbea5e4e59042c3bb752ac6c3616fbe5763f24f94fbf2cbd8e6cfb82015b49b03fa283c875582ba3f4beb12986125f9f9b8ba31ee8eeb
+  metadata.gz: 5be8964ed3c42cc2e01481da815de2d7f068ff1a4359f092ec1c89a864c761aa51c91cc6c79511004c685bcab19da1a8b7a81d0ec4cdf17b7ccc95de8fdb72b8
+  data.tar.gz: b27567094d0c0cfe0166ee7ae13b0c99012b2f127cddb62d5f703916b17e32864257a39892109360625c528239ddbc0961fbc3df369be1c89c1ded0e0ab6e906

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

@@ -0,0 +1,28 @@
+## 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
+* Add associate company to contact logic
+* Update README to make it more understanble
+
+### Breaking Changes
+None
+
+## 0.1.0.beta1 (2022-11-25)
+
+### Features
+* Add Company Model and Client
+* Add primary_company method to Contact model
+* Add Properties Client
+* Add Matrix for RSpec tests and support for the moment Ruby 3.0 and 3.1
+
+## Breaking Changes
+None

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.beta1)
+    hubspot_client (0.1.0)
       httparty (~> 0.20.0)
 
 GEM

data/README.md

@@ -21,7 +21,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'
@@ -38,6 +38,7 @@ The idea is that the models behave like an ActiveRecord Model.
 
 #### find
 You can find by `hubspot_id` or `email`
+
 ```ruby
 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">
@@ -46,9 +47,62 @@ 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
+
+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"> 
+
+hubspot_contact.associate_primary_company(6582942445)
+=> true
+```
+
 ### Company
 
-[Hubspot- API](https://developers.hubspot.com/docs/api/crm/companies)
+Here you can find the [Hubspot-Companies-API-Documentation](https://developers.hubspot.com/docs/api/crm/companies)
+
+#### find
+
+Find a company be `hubspot_id`
+
+```ruby
+HubspotClient::Model::Company.find(hubspot_id: '6614067165')
+=> #<HubspotClient::Model::Company address="Todesternstraße 1", city="Todestern", createdate="2022-11-28T13:45:40.989Z", hs_lastmodifieddate="2022-11-28T13:45:44.933Z", hs_object_id="6614067165", name="Todesternverwaltungs GmbH", phone="0152123456789", zip="1337">
+```
+
+#### create
+
+```ruby
+example_properties = { name: 'Todesternverwaltungs GmbH',
+                       phone: '0152123456789',
+                       address: 'Todesternstraße 1',
+                       city: 'Todestern',
+                       zip: '1337' }
+
+HubspotClient::Model::Company.create(example_properties)
+=> #<HubspotClient::Model::Company address="Todesternstraße 1", city="Todestern", createdate="2022-11-28T13:45:40.989Z", hs_lastmodifieddate="2022-11-28T13:45:40.989Z", hs_object_id="6614067165", hs_pipeline="companies-lifecycle-pipeline", lifecyclestage="lead", name="Todesternverwaltungs GmbH", phone="0152123456789", zip="1337">  
+```
+
+#### update
+
+```ruby
+hubspot_company = HubspotClient::Model::Company.find(hubspot_id: '6614067165')
+
+# You can change the attribute like so:
+hubspot_company.name = 'Blubber'
+
+# or like so:
+hubspot_company.assign_attributes(name: 'Blubber')
+
+# then you can run:
+hubspot_company.update
+
+# you can also do it directly in the update method:
+hubspot_company.update({ name: 'Blubber' })
+```
+
+
 
 ### Subscription-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 < StandardError; end
+    class FetchDefinitionsNotSuccessful < StandardError; 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
+      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
+      end
+
+      def headers
+        { Authorization: "Bearer #{HubspotClient.configuration.access_token}",
+          'Content-Type': 'application/json' }
+      end
+    end
+  end
+end

data/lib/hubspot_client/client/contact.rb

@@ -5,27 +5,28 @@ module HubspotClient
     class ContactNotFound < StandardError; end
     class ContactNotCreated < StandardError; end
     class ContactNotUpdated < StandardError; end
+    class AssociationError < StandardError; end
 
     class Contact
       include HTTParty
       base_uri 'https://api.hubapi.com'
 
-      BASE_PATH = '/crm/v3/objects/contacts'
+      BASE_PATH_V3 = '/crm/v3/objects/contacts'
       FIND_PROPERTIES = %w[firstname lastname email phone lifecyclestage associatedcompanyid].freeze
 
       def find_by_email(email)
         query_params = find_query_params({ idProperty: 'email' })
-        find_by("#{BASE_PATH}/#{email}?#{query_params}")
+        find_by("#{BASE_PATH_V3}/#{email}?#{query_params}")
       end
 
       def find_by_id(hubspot_id)
         query_params = find_query_params
 
-        find_by("#{BASE_PATH}/#{hubspot_id}?#{query_params}")
+        find_by("#{BASE_PATH_V3}/#{hubspot_id}?#{query_params}")
       end
 
       def create(properties)
-        response = self.class.post(BASE_PATH,
+        response = self.class.post(BASE_PATH_V3,
                                    body: { properties: properties }.to_json,
                                    headers: headers)
 
@@ -35,7 +36,7 @@ module HubspotClient
       end
 
       def update(hubspot_id, properties)
-        response = self.class.patch("#{BASE_PATH}/#{hubspot_id}",
+        response = self.class.patch("#{BASE_PATH_V3}/#{hubspot_id}",
                                     body: { properties: properties }.to_json,
                                     headers: headers)
 
@@ -44,6 +45,15 @@ module HubspotClient
         raise ContactNotUpdated, 'Hubspot could not update'
       end
 
+      def associate_with(hubspot_id, to_object_type, to_object_type_id, association_type = '1')
+        path = "#{BASE_PATH_V3}/#{hubspot_id}/associations/#{to_object_type}/#{to_object_type_id}/#{association_type}"
+        response = self.class.put(path, headers: headers)
+
+        return response if response.code == 200
+
+        raise AssociationError, response
+      end
+
       private
 
       def find_by(path)

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

@@ -20,7 +20,8 @@ module HubspotClient
         new(response['properties'])
       end
 
-      def update
+      def update(new_properties = {})
+        assign_attributes(new_properties)
         properties = to_h.slice(*UPDATABLE_PROPERTIES)
         response = Client::Company.new.update(hs_object_id, properties)
 
@@ -37,6 +38,12 @@ module HubspotClient
 
         self
       end
+
+      def assign_attributes(attributes)
+        attributes.each do |attribute, value|
+          self[attribute] = value
+        end
+      end
     end
   end
 end

data/lib/hubspot_client/model/contact.rb

@@ -26,7 +26,8 @@ module HubspotClient
         new(response['properties'])
       end
 
-      def update
+      def update(new_properties = {})
+        assign_attributes(new_properties)
         properties = to_h.slice(*UPDATABLE_PROPERTIES)
         response = Client::Contact.new.update(hs_object_id, properties)
 
@@ -44,9 +45,35 @@ 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
+
+      def associate_primary_company(hubspot_id)
+        response = Client::Contact.new.associate_with(hs_object_id, 'companies', hubspot_id)
+
+        return true if response.code == 200
+
+        false
+      end
+
+      def assign_attributes(attributes)
+        attributes.each do |attribute, value|
+          self[attribute] = value
+        end
+      end
     end
   end
 end

data/lib/hubspot_client/version.rb

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

data/lib/hubspot_client.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
 require 'httparty'
-require 'hubspot_client/version'
-require 'hubspot_client/configuration'
-require 'hubspot_client/client/contact'
+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.beta1
+  version: 0.1.0
 platform: ruby
 authors:
 - Garllon
+- romankonz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-24 00:00:00.000000000 Z
+date: 2022-11-30 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: []
@@ -152,16 +154,19 @@ files:
 - ".github/workflows/rspec_and_rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - 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/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
@@ -183,11 +188,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.3
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Hubspot client