ruby_hubspot 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73a758e2f280d0f2037dafdd54d2c1d33f14ce51def4d2dcfbe7ac22bc56dd9d
-  data.tar.gz: 6e3da77a360119e2e9ce4ec501319b6fa84c287d8bde548786152a9d986b7a9c
+  metadata.gz: b8af2ad903e1a672868c2f6757a2ab8da3e40e37cbf4ba313d2555b225573b77
+  data.tar.gz: ee56a7bfa400e723ee9fa61c213f49aebdf5e0909a7a8c8ddbc1877338827f37
 SHA512:
-  metadata.gz: cfcd28ef611dfbe36c99513f3e8c964284f3ab4f3c2a8e3cf2cef16afb7650963298a5cb10f09254bd575f6120748c8b3e004972afc82a323a06594b9b20552d
-  data.tar.gz: dae19d601f3664ce858875f2defb165f73cf654b7434f50bda8195df18c0d11c9dbf5fbe3d70bbd122e661962fd83d9abfe2ee561beaba444e17706d2f30e4ab
+  metadata.gz: 8fd784b6059bc371265e1812d99d49b43d322e496e0f308f976f1748ce69743450accb276ecb458a5ed75a246d82a912dbc6ca4c7e56c316fb7ab04d09cc6f68
+  data.tar.gz: a0188d60c29d1642c317b948d0ddbf7f217ec99762054a85d174474ac8f34cb17afb2ee73434d3b3a06d1333c6ed06ef3965464205764d6920866734febaff7a

data/lib/ruby_hubspot/companies.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# 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])
+
+    response(GET, individual_company_path(params[:id]))
+  end
+
+  # updates a company
+  def update_company(**params)
+    validate_access_token
+    id_handler(params[:id])
+
+    params_to_update = params.dup
+    params_to_update.delete(:id)
+
+    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])
+
+    response(DELETE, individual_company_path(params[:id]))
+  end
+
+  # creates an idintificator
+  def individual_company_path(id)
+    INDIVIDUAL_COMPANY + id.to_s
+  end
+end

data/lib/ruby_hubspot/constants.rb

@@ -1,8 +1,45 @@
 # frozen_string_literal: true
 
-# Constants module
+# Constants module includes all constants
 module Constants
-  API_URL           = 'https://api.hubapi.com/'
-  CONTENT_TYPE      = 'application/json'
-  AUTHORIZATION_KEY = 'Bearer '
+  # 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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# 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])
+
+    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
+
+    params_to_update = params.dup
+    params_to_update.delete(:id)
+
+    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|
+        if params.key?(key)
+          identificator_handler(params[key])
+
+          return key == :email ? EMAIL + params[key].to_s : VID + params[key].to_s
+        end
+      end
+    )
+  end
+end

data/lib/ruby_hubspot/error_handler.rb

@@ -1,12 +1,35 @@
 # frozen_string_literal: true
 
-# Error module
+# Error module adds new error methods
 module ErrorHandler
-  ACCESS_TOKEN_ERROR = 'Access Token should exist'
+  # 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
 end

data/lib/ruby_hubspot/hubspot.rb

@@ -3,18 +3,24 @@
 require 'faraday'
 require_relative 'error_handler'
 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
+  include Contacts
+  include Companies
 
   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
 
@@ -27,7 +33,7 @@ class Hubspot
     Faraday.send(http_method) do |request|
       request.url(API_URL + path)
       request.headers = headers
-      request.body = body(params)
+      request.body = body(path, params)
     end
   end
 
@@ -38,15 +44,27 @@ class Hubspot
     }
   end
 
-  def body(**params)
+  def body(path, **params)
     return unless params
 
     {
-      properties: properties(params)
+      properties: properties(path, params)
     }.to_json
   end
 
-  def properties(params)
+  def properties(path, params)
+    return special_fields(params) if path.include? INDIVIDUAL_COMPANY
+
+    usual_fields(params)
+  end
+
+  def special_fields(params)
+    params.map do |key, value|
+      { "name": key, "value": value }
+    end
+  end
+
+  def usual_fields(params)
     params.map do |key, value|
       { "property": key, "value": value }
     end

data/lib/ruby_hubspot/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Version module
 module RubyHubspot
-  VERSION = '1.0.0'
+  # 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.0
+  version: 1.0.2
 platform: ruby
 authors:
 - sofiyareverse
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-23 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
@@ -115,7 +129,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/ruby_hubspot.rb
+- lib/ruby_hubspot/companies.rb
 - lib/ruby_hubspot/constants.rb
+- lib/ruby_hubspot/contacts.rb
 - lib/ruby_hubspot/error_handler.rb
 - lib/ruby_hubspot/hubspot.rb
 - lib/ruby_hubspot/version.rb