ruby_hubspot 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21cd2b84ae331bcecbb2efcca76b818420ad5bf3519c783134ba18d3dfa38533
-  data.tar.gz: e7cbd736a5ef3795560e8b98144b3c65bac6857ef2a3592cf8f0655e154a04e9
+  metadata.gz: b8af2ad903e1a672868c2f6757a2ab8da3e40e37cbf4ba313d2555b225573b77
+  data.tar.gz: ee56a7bfa400e723ee9fa61c213f49aebdf5e0909a7a8c8ddbc1877338827f37
 SHA512:
-  metadata.gz: a98ec51d08a95627f0a0e2d6f5983d4ef609277ff2d0cd139c88dac10a5a5d99efb9bdd91c03432324175a10871ad8906dede9b2cd9634116e50032ea131f42e
-  data.tar.gz: 4bd71dd3cb75fb2c067ff4d55d93d1884a5ddfbf973db56cd0ec467cd38da44db945c44b332090a0e2debd9dd840fd14b5034e41a1168759e88b3e8704ad9b7c
+  metadata.gz: 8fd784b6059bc371265e1812d99d49b43d322e496e0f308f976f1748ce69743450accb276ecb458a5ed75a246d82a912dbc6ca4c7e56c316fb7ab04d09cc6f68
+  data.tar.gz: a0188d60c29d1642c317b948d0ddbf7f217ec99762054a85d174474ac8f34cb17afb2ee73434d3b3a06d1333c6ed06ef3965464205764d6920866734febaff7a

data/lib/ruby_hubspot/companies.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
-# Companies module
+# Companies module adds methods for Company objects
 module Companies
   include Constants
 
+  # returns all companies
   def all_companies
     validate_access_token
 
     response(GET, ALL_COMPANIES)
   end
 
+  # creates a company
   def create_company(**params)
     validate_access_token
 
     response(POST, INDIVIDUAL_COMPANY, params)
   end
 
+  # shows a company
   def show_company(**params)
     validate_access_token
     id_handler(params[:id])
@@ -23,6 +26,7 @@ module Companies
     response(GET, individual_company_path(params[:id]))
   end
 
+  # updates a company
   def update_company(**params)
     validate_access_token
     id_handler(params[:id])
@@ -33,6 +37,7 @@ module Companies
     response(PUT, individual_company_path(params[:id]), params_to_update)
   end
 
+  # deletes a company
   def delete_company(**params)
     validate_access_token
     id_handler(params[:id])
@@ -40,6 +45,7 @@ module Companies
     response(DELETE, individual_company_path(params[:id]))
   end
 
+  # creates an idintificator
   def individual_company_path(id)
     INDIVIDUAL_COMPANY + id.to_s
   end

data/lib/ruby_hubspot/constants.rb

@@ -1,25 +1,45 @@
 # frozen_string_literal: true
 
-# Constants module
+# Constants module includes all constants
 module Constants
+  # hubspot api url
   API_URL            = 'https://api.hubapi.com/'
+  # content type for request
   CONTENT_TYPE       = 'application/json'
+  # authorization key for access
   AUTHORIZATION_KEY  = 'Bearer '
+  # method get for request
   GET                = :get
+  # method post for request
   POST               = :post
+  # method patch for request
   PATCH              = :patch
+  # method put for request
   PUT                = :put
+  # method delete for request
   DELETE             = :delete
+  # hubspot all contacts request path
   ALL_CONTACTS       = 'crm/v4/objects/contacts'
+  # hubspot all companies request path
   ALL_COMPANIES      = 'crm/v3/properties/companies'
+  # hubspot all deals request path
   ALL_DEALS          = 'crm/v4/objects/deals'
+  # hubspot all submitions request path
   ALL_SUBMITIONS     = 'crm/v4/objects/feedback_submissions'
+  # hubspot individual contact request path
   INDIVIDUAL_CONTACT = 'contacts/v1/contact'
+  # hubspot individual company request path
   INDIVIDUAL_COMPANY = 'companies/v2/companies/'
+  # hubspot individual deal request path
   INDIVIDUAL_DEAL    = 'deals/v1/deal'
+  # hubspot individual sub request path
   INDIVIDUAL_SUB     = 'feedback_submissions/v1/feedback_submission'
+  # hubspot create or update request path
   CREATE_OR_UPDATE   = '/createOrUpdate'
+  # hubspot vid request path
   VID                = '/vid/'
+  # hubspot email request path
   EMAIL              = '/email/'
+  # hubspot profile request path
   PROFILE            = '/profile'
 end

data/lib/ruby_hubspot/contacts.rb

@@ -1,21 +1,24 @@
 # frozen_string_literal: true
 
-# Contacts module
+# Companies module adds methods for Contact objects
 module Contacts
   include Constants
 
+  # returns all contacts
   def all_contacts
     validate_access_token
 
     response(GET, ALL_CONTACTS)
   end
 
+  # creates a contact
   def create_contact(**params)
     validate_access_token
 
     response(POST, INDIVIDUAL_CONTACT, params)
   end
 
+  # creates or updates a contact
   def create_or_update_contact(**params)
     validate_access_token
     email_handler(params[:email])
@@ -23,12 +26,14 @@ module Contacts
     response(POST, INDIVIDUAL_CONTACT + CREATE_OR_UPDATE + EMAIL + params[:email].to_s, params)
   end
 
+  # shows a contact
   def show_contact(**params)
     validate_access_token
 
     response(GET, INDIVIDUAL_CONTACT + find_idintificator(params) + PROFILE)
   end
 
+  # updates a contact
   def update_contact(**params)
     validate_access_token
 
@@ -38,12 +43,14 @@ module Contacts
     response(POST, INDIVIDUAL_CONTACT + find_idintificator(params) + PROFILE, params_to_update)
   end
 
+  # deletes a contact
   def delete_contact(**params)
     validate_access_token
 
     response(DELETE, INDIVIDUAL_CONTACT + find_idintificator(params))
   end
 
+  # checks and finds an idintificator
   def find_idintificator(params)
     identificator_handler(
       %i[email id].any? do |key|

data/lib/ruby_hubspot/error_handler.rb

@@ -1,26 +1,34 @@
 # frozen_string_literal: true
 
-# Error module
+# Error module adds new error methods
 module ErrorHandler
+  # access token error
   ACCESS_TOKEN_ERROR  = 'Access Token should exist'
+  # email error
   EMAIL_ERROR         = 'Email should exist'
+  # identificator error
   IDENTIFICATOR_ERROR = 'Email or id should exist'
+  # id error
   ID_ERROR            = 'Id should exist'
 
   protected
 
+  # checks access token presence
   def access_token_handler(access_token)
     raise ArgumentError, ACCESS_TOKEN_ERROR unless access_token
   end
 
+  # checks email presence
   def email_handler(email)
     raise ArgumentError, EMAIL_ERROR unless email
   end
 
+  # checks id presence
   def id_handler(id)
     raise ArgumentError, ID_ERROR unless id
   end
 
+  # checks identificator presence
   def identificator_handler(identificator)
     raise ArgumentError, IDENTIFICATOR_ERROR unless identificator
   end

data/lib/ruby_hubspot/hubspot.rb

@@ -6,7 +6,7 @@ require_relative 'constants'
 require_relative 'contacts'
 require_relative 'companies'
 
-# Hubspot main
+# Hubspot main controls and regulate all methods and constants
 class Hubspot
   include ErrorHandler
   include Constants
@@ -15,10 +15,12 @@ class Hubspot
 
   attr_accessor :access_token
 
+  # initializes Hubspot with access token
   def initialize(access_token:)
     @access_token = access_token
   end
 
+  # sends a request to Hubspot with access token and params
   def request(http_method, path, **params)
     validate_access_token
 

data/lib/ruby_hubspot/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Version module
 module RubyHubspot
-  VERSION = '1.0.1'
+  # gem version
+  VERSION = '1.0.2'
 end

data/lib/ruby_hubspot.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
+# Ruby Hubspot includes version and Hubspot class
 require_relative 'ruby_hubspot/version'
 require_relative 'ruby_hubspot/hubspot'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_hubspot
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - sofiyareverse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-28 00:00:00.000000000 Z
+date: 2023-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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: rspec
   requirement: !ruby/object:Gem::Requirement