hubspot_client 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64366ba11cb24670e4a304a5a16307402736fe0f941f725535f148a37329afdc
-  data.tar.gz: d134c5b394c90e1b86d7cc716b20196289ba3c3c1b7768793d5d15fdca86ff0c
+  metadata.gz: 8dd7941d915d5f004993d879b6575183f74a4b63dddd95760f79ee03c2df5453
+  data.tar.gz: 1cb35e4a8c2f29589f6ee0fa488e63bb36fd501c1ad31e9dc426b2798b829e63
 SHA512:
-  metadata.gz: 5be8964ed3c42cc2e01481da815de2d7f068ff1a4359f092ec1c89a864c761aa51c91cc6c79511004c685bcab19da1a8b7a81d0ec4cdf17b7ccc95de8fdb72b8
-  data.tar.gz: b27567094d0c0cfe0166ee7ae13b0c99012b2f127cddb62d5f703916b17e32864257a39892109360625c528239ddbc0961fbc3df369be1c89c1ded0e0ab6e906
+  metadata.gz: a8e0bfd247d726aa8cd993d50d5351dba0429388f37ea8c331fda4e713c652cb1be99ca247eb3a48c7b6010dd5849bdd944a7bf8fbcce2b48e8c0e123cc10685
+  data.tar.gz: 5149870440dcce65666deddab1d44ccd79003f2caa7523a64b580c7bb6ae64892e3504ce84261c15e6f1c981414ed6c2c978fc366fac93f374dcc4b5e7a7d1b2

data/.rubocop.yml

@@ -8,4 +8,4 @@ Style/Documentation:
 
 Metrics/ModuleLength:
   Exclude:
-    - 'spec/hubspot_client/model/contact_spec.rb'
+#    - 'spec/hubspot_client/model/contact_spec.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hubspot_client (0.1.0)
+    hubspot_client (0.2.1)
       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
 
@@ -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/lib/hubspot_client/client/communication_preference.rb

@@ -2,8 +2,8 @@
 
 module HubspotClient
   module Client
-    class SubscriptionNotSuccessful < StandardError; end
-    class FetchDefinitionsNotSuccessful < StandardError; end
+    class SubscriptionNotSuccessful < ClientBaseError; end
+    class FetchDefinitionsNotSuccessful < ClientBaseError; end
 
     class CommunicationPreference
       include HTTParty
@@ -17,7 +17,7 @@ module HubspotClient
 
         return response if response.code == 200
 
-        raise FetchDefinitionsNotSuccessful
+        raise FetchDefinitionsNotSuccessful, response
       end
 
       def subscribe(properties)
@@ -27,7 +27,7 @@ module HubspotClient
 
         return response if response.code == 200
 
-        raise SubscriptionNotSuccessful
+        raise SubscriptionNotSuccessful, response
       end
 
       def headers

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/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.slice(*writable_properties))
 
         return true if response.code == 200
 
@@ -44,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

@@ -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.slice(*writable_properties))
 
         return true if response.code == 200
 
@@ -74,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.1.0'
+  VERSION = '0.2.1'
 end

data/lib/hubspot_client.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'httparty'
+require 'hubspot_client/client_base_error'
 require 'hubspot_client/client/communication_preference'
 require 'hubspot_client/client/company'
 require 'hubspot_client/client/contact'
@@ -9,6 +10,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.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Garllon
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-30 00:00:00.000000000 Z
+date: 2022-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -165,10 +165,12 @@ files:
 - 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/model/property.rb
 - lib/hubspot_client/version.rb
 homepage: https://github.com/Farbfox/hubspot_client/blob/main/README.md
 licenses:
@@ -192,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Hubspot client