zoho_hub 0.1.56 → 0.2.0

data/lib/zoho_hub/connection.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
+require 'faraday_middleware'
 require 'rainbow'
 require 'addressable'
 
@@ -21,43 +22,37 @@ module ZohoHub
     def initialize(access_token:, api_domain: DEFAULT_DOMAIN, expires_in: 3600, refresh_token: nil)
       @access_token = access_token
       @expires_in = expires_in
-      @api_domain = api_domain || DEFAULT_DOMAIN
+      @api_domain = api_domain
       @refresh_token ||= refresh_token # do not overwrite if it's already set
     end
 
-    def get(path, params = {}, &block)
+    def get(path, params = {})
       log "GET #{path} with #{params}"
 
-      response = with_refresh do
-        adapter(&block).get(path, params)
-      end
+      response = with_refresh { adapter.get(path, params) }
       response.body
     end
 
-    def post(path, params = {}, &block)
+    def post(path, params = {})
       log "POST #{path} with #{params}"
 
-      response = with_refresh do
-        adapter(&block).post(path, params)
-      end
+      response = with_refresh { adapter.post(path, params) }
       response.body
     end
 
-    def put(path, params = {}, &block)
+    def put(path, params = {})
       log "PUT #{path} with #{params}"
 
-      response = with_refresh do
-        adapter(&block).put(path, params)
-      end
+      response = with_refresh { adapter.put(path, params) }
       response.body
     end
 
     def access_token?
-      @access_token.present?
+      @access_token
     end
 
     def refresh_token?
-      @refresh_token.present?
+      @refresh_token
     end
 
     def log(text)
@@ -78,7 +73,7 @@ module ZohoHub
         log "Refreshing outdated token... #{@access_token}"
         params = ZohoHub::Auth.refresh_token(@refresh_token)
 
-        @on_refresh_cb.call(params) if @on_refresh_cb.present?
+        @on_refresh_cb.call(params) if @on_refresh_cb
 
         @access_token = params[:access_token]
 
@@ -102,7 +97,7 @@ module ZohoHub
     def adapter
       Faraday.new(url: base_url) do |conn|
         conn.headers = authorization_header if access_token?
-        yield conn if block_given?
+        conn.use FaradayMiddleware::ParseJson
         conn.response :json, parser_options: { symbolize_names: true }
         conn.response :logger if ZohoHub.configuration.debug?
         conn.adapter Faraday.default_adapter

data/lib/zoho_hub/{records → deprecated_and_only_for_reference_records}/account.rb

@@ -6,7 +6,7 @@ module ZohoHub
   class Account < BaseRecord
     attributes :id, :name, :territories, :company_number, :employee_count, :company_type, :industry
     attributes :billing_city, :billing_code, :billing_country, :billing_street, :billing_state
-    attributes :account_type, :industry_section, :region
+    attributes :account_type
 
     # This is the ID to be used when the borrower has no organisation (unlikely) or belongs to
     # multiple organisations.

data/lib/zoho_hub/{records → deprecated_and_only_for_reference_records}/contact.rb

@@ -4,18 +4,14 @@ require 'zoho_hub/records/base_record'
 
 module ZohoHub
   class Contact < BaseRecord
-    attributes :id, :email, :salutation, :first_name, :mobile, :role, :last_name, :vendor_id
-    attributes :account_id, :owner_id, :campaign_id, :status, :campaign_detail, :phone
-    attributes :mailing_city, :mailing_zip, :mailing_country, :mailing_street, :mailing_state
-    attributes :date_of_birth, :relationship_to_business
+    attributes :id, :email, :salutation, :first_name, :mobile, :role, :last_name
+    attributes :account_id, :owner_id, :campaign_id, :status, :campaign_detail
 
     attribute_translation(
       id: :id,
       role: :platform_cont_type,
       status: :platform_cont_status,
-      use_proceeds: :use_proceeds,
-      date_of_birth: :Date_of_Birth,
-      relationship_to_business: :Relationship_to_business
+      use_proceeds: :use_proceeds
     )
 
     DEFAULTS = {
@@ -34,7 +30,6 @@ module ZohoHub
       @account_id ||= params.dig(:Account_Name, :id)
       @owner_id ||= params.dig(:Owner, :id)
       @campaign_id ||= params.dig(:Campaign_Lookup, :id)
-      @vendor_id ||= params.dig(:Vendor_Name, :id)
     end
 
     def to_params
@@ -43,7 +38,6 @@ module ZohoHub
       params[:Account_Name] = { id: @account_id } if @account_id
       params[:Owner] = { id: @owner_id } if @owner_id
       params[:Campaign_Lookup] = { id: @campaign_id } if @campaign_id
-      params[:Vendor_Name] = { id: @vendor_id } if @vendor_id
 
       params
     end

data/lib/zoho_hub/deprecated_and_only_for_reference_records/funder.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ZohoHub
+  class Vendor < BaseRecord
+    def initialize(params)
+      puts Rainbow(params).red.bright
+    end
+  end
+end

data/lib/zoho_hub/{records → deprecated_and_only_for_reference_records}/potential.rb

@@ -9,14 +9,6 @@ module ZohoHub
     attributes :currency, :territory, :employee_count, :turnover, :industry, :region
     attributes :review_outcome, :first_created, :last_modified, :preferred_term, :project_notes
     attributes :campaign_id, :account_id, :contact_id, :campaign_detail, :reviewers_comment
-    attributes :accounting_software, :banking_provider, :turnover_figure
-    attributes :guarantee_types, :home_ownership_status
-    attributes :accountant_id, :vat_registration, :published_all_of_market
-    attributes :credit_risk_band, :live_ccjs, :satisfied_ccjs
-    attributes :state, :number_of_connections
-    attributes :submitted_to_lender_panel, :last_attachment_uploaded, :funds_timeline
-    attributes :cancellation_reason, :stripe_payment_reference
-    attributes :portal_session_id, :portal_session_url, :portal_agent_session_url
 
     DEFAULTS = {
       currency: 'GBP',
@@ -31,21 +23,7 @@ module ZohoHub
       code: :Project_Ref_No,
       description: :Project_description,
       employee_count: :Number_of_Employees,
-      use_proceeds: :use_proceeds,
-      vat_registration: :Pick_List_15,
-      live_ccjs: :Live_CCJs,
-      satisfied_ccjs: :Satisfied_CCJs,
-      published_all_of_market: :Published_to_All_of_Market,
-      state: :State1,
-      submitted_to_lender_panel: :Submitted_to_Lender_Panel1,
-      number_of_connections: :Number_of_Connections,
-      turnover_figure: :Turnover_figure,
-      last_attachment_uploaded: :Last_Attachment_Uploaded,
-      funds_timeline: :When_will_you_needs_the_funds,
-      cancellation_reason: :If_Application_Cancelled_select_reason,
-      portal_session_id: :Portal_Session_ID,
-      portal_session_url: :Portal_Session_URL,
-      portal_agent_session_url: :Portal_Agent_Session_URL,
+      use_proceeds: :use_proceeds
     )
 
     def initialize(params)
@@ -59,7 +37,6 @@ module ZohoHub
       @account_id ||= params.dig(:Account_Name, :id)
       @contact_id ||= params.dig(:Contact_Name, :id)
       @campaign_id ||= params.dig(:Campaign_Source, :id)
-      @accountant_id ||= params.dig(:Accountant_Name, :id)
     end
 
     def to_params
@@ -68,7 +45,6 @@ module ZohoHub
       params[:Campaign_Source] = { id: @campaign_id } if @campaign_id
       params[:Account_Name] = { id: @account_id } if @account_id
       params[:Contact_Name] = { id: @contact_id } if @contact_id
-      params[:Accountant_Name] = { id: @accountant_id } if @accountant_id
 
       params
     end

data/lib/zoho_hub/deprecated_and_only_for_reference_records/product.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ZohoHub
+  class Product < BaseRecord
+    def initialize(params)
+      puts Rainbow(params).red.bright
+    end
+  end
+end

data/lib/zoho_hub/deprecated_and_only_for_reference_records/quote.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/records/base_record'
+
+module ZohoHub
+  class Quote < BaseRecord
+    attributes :id, :stage, :subject
+    attributes :potential_id
+
+    attribute_translation(
+      id: :id,
+      stage: :Quote_Stage
+    )
+
+    def initialize(params)
+      puts Rainbow(params).bright.red
+      attributes.each do |attr|
+        zoho_key = attr_to_zoho_key(attr)
+
+        send("#{attr}=", params[zoho_key] || params[attr])
+      end
+
+      @potential_id ||= params.dig(:Deal_Name, :id)
+      @lender_organisation_id ||= params.dig(:Account_Name, :id)
+    end
+
+    def to_params
+      params = super
+
+      params[:Deal_Name] = { id: @potential_id } if @potential_id
+      params[:Account_Name] = { id: @lender_organisation_id } if @lender_organisation_id
+    end
+  end
+end

data/lib/zoho_hub/errors.rb

@@ -12,7 +12,4 @@ module ZohoHub
 
   class ZohoAPIError < StandardError
   end
-
-  class AttachmentLinkTakenError < StandardError
-  end
 end

data/lib/zoho_hub/module_builder.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/string_utils'
+
+module ZohoHub
+  class ModuleBuilder
+    class << self
+      def build_from_cache
+        cached_module_definitions.map do |file|
+          json = MultiJson.load(File.read(file), symbolize_keys: true)
+
+          create_module(json)
+        end
+      end
+
+      def cached_module_definitions
+        Dir[File.join(ZohoHub.root, 'cache', 'modules', '**')]
+      end
+
+      def create_module(json)
+        fields = cached_module_fields(json[:api_name])
+
+        klass = Class.new(ZohoHub::BaseRecord) do
+          request_path json[:api_name]
+
+          translations = {}
+          fields.each do |field|
+            key = StringUtils.underscore(field[:api_name])
+
+            translations[key] = field[:api_name]
+          end
+
+          if translations.any?
+            attributes(*translations.keys)
+            attribute_translation(translations)
+          end
+
+          def initialize(params)
+            attributes.each do |attr|
+              zoho_key = attr_to_zoho_key(attr)
+
+              send("#{attr}=", params[zoho_key] || params[attr])
+            end
+          end
+        end
+
+        ZohoHub.const_set(StringUtils.camelize(json[:singular_label]), klass)
+      end
+
+      def cached_module_fields(module_name)
+        file = File.join(ZohoHub.root, 'cache', 'fields', "#{module_name}.json")
+
+        return [] unless File.exist?(file)
+
+        json_content = File.read(file)
+
+        MultiJson.load(json_content, symbolize_keys: true)
+      end
+    end
+  end
+end

data/lib/zoho_hub/oauth_callback_server.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'sinatra/base'
+
+module ZohoHub
+  class OauthCallbackServer < Sinatra::Base
+    enable :logging
+
+    CALLBACK_PATH = 'oauth2callback'
+
+    before do
+      content_type :json
+    end
+
+    get "/#{CALLBACK_PATH}" do
+      grant_token = params[:code]
+
+      # This will trigger a post request to get both the token and the refresh token
+      @variables = ZohoHub::Auth.get_token(grant_token)
+
+      puts "Variables: #{@variables.inspect}"
+
+      erb :variables
+    end
+  end
+end

data/lib/zoho_hub/response.rb

@@ -7,9 +7,7 @@ module ZohoHub
     end
 
     def invalid_data?
-      if data.is_a?(Array)
-        return data.first[:code] == 'MANDATORY_NOT_FOUND'
-      end
+      return false if data.is_a?(Array)
 
       data[:code] == 'INVALID_DATA'
     end
@@ -42,7 +40,6 @@ module ZohoHub
 
     def msg
       msg = data[:message]
-      msg << ", error in #{data.dig(:details, :api_name)}" if data.dig(:code) == 'INVALID_DATA'
 
       if data.dig(:details, :expected_data_type)
         expected = data.dig(:details, :expected_data_type)

data/lib/zoho_hub/settings/field.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/with_connection'
+require 'zoho_hub/with_attributes'
+
+module ZohoHub
+  module Settings
+    class Field
+      include WithConnection
+      include WithAttributes
+
+      REQUEST_PATH = 'settings/fields'
+
+      attributes :custom_field, :lookup, :convert_mapping, :visible, :field_label, :length,
+                 :view_type, :read_only, :api_name, :unique, :data_type, :formula, :currency, :id,
+                 :decimal_place, :pick_list_values, :auto_number
+
+      def self.all_for(module_name)
+        fields = all_json_for(module_name)
+        fields.map { |json| new(json) }
+      end
+
+      def self.all_json_for(module_name)
+        response = get(REQUEST_PATH, module: module_name)
+        response[:fields]
+      end
+
+      def initialize(json = {})
+        attributes.each { |attr| send("#{attr}=", json[attr]) }
+      end
+    end
+  end
+end

data/lib/zoho_hub/settings/module.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/with_connection'
+require 'zoho_hub/with_attributes'
+
+require 'zoho_hub/settings/field'
+
+module ZohoHub
+  module Settings
+    # Zoho CRM has standard modules such as, Leads, Accounts, Contacts, Deals, Forecasts,
+    # Activities, etc,. Using Zoho CRM REST API, you can retrieve the list of available modules.
+    #
+    # convertable: Describes if the user can convert the record into another type of record.
+    #              For example: Convert Leads in to Deals.
+    # creatable: Checks if the user can create a record in the current module.
+    # generated_type: Describes the type of module which would be generated by the user. There are
+    #                 4 types: default, web, custom, linking.
+    # api_supported: The modules which are currently not accessible by APIs have value as "false".
+    #                If the modules are supported in the future, the value automatically changes
+    #                to "true".
+    # modified_time: The date and time of changes made by the user.
+    #
+    # More details: https://www.zoho.com/crm/help/api/v2/#Modules-APIs
+    class Module
+      include WithConnection
+      include WithAttributes
+
+      REQUEST_PATH = 'settings/modules'
+
+      attributes :convertable, :editable, :deletable, :web_link, :singular_label, :modified_time,
+                 :viewable, :api_supported, :creatable, :plural_label, :api_name, :modified_by,
+                 :generated_type, :id, :module_name, :fields
+
+      def self.all
+        modules = all_json
+        modules.map { |json| new(json) }
+      end
+
+      def self.all_json
+        response = get(REQUEST_PATH)
+        response[:modules]
+      end
+
+      def initialize(json = {})
+        attributes.each { |attr| send("#{attr}=", json[attr]) }
+      end
+    end
+  end
+end

data/lib/zoho_hub/string_utils.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module ZohoHub
+  class StringUtils
+    class << self
+      def demodulize(text)
+        text.split('::').last
+      end
+
+      def pluralize(text)
+        "#{text}s"
+      end
+
+      def camelize(text)
+        result = text.split(/[_\s]/)
+
+        return result.first if result.size == 1
+
+        result.map(&:capitalize).join
+      end
+
+      def underscore(text)
+        return text unless text =~ /[A-Z-]/
+
+        result = text.dup
+        result.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        result.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        result.tr!('-', '_')
+        result.downcase!
+        result
+      end
+    end
+  end
+end

data/lib/zoho_hub/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZohoHub
-  VERSION = '0.1.56'
+  VERSION = '0.2.0'
 end

data/lib/zoho_hub/views/variables.erb

@@ -0,0 +1,72 @@
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+  <head>
+    <meta charset="utf-8">
+    <title>Zoho CRM authentication</title>
+    <style media="screen">
+      body {
+        font-family: sans-serif;
+        padding: 20px 50px;
+      }
+
+      ul.variables {
+        padding: 20px;
+        background-color: #eaeaea;
+        font-family: monospace;
+        list-style: none;
+        line-height: 1.5em;
+        margin-bottom: 50px;
+      }
+
+      li.error {
+        color: #aa0000;
+      }
+
+      div.config {
+        padding: 20px;
+        background-color: #eaeaea;
+        font-family: monospace;
+        line-height: 1.5em;
+      }
+
+      pre {
+        margin: 0;
+        padding: 0;
+      }
+
+      code {
+        padding: 0;
+        margin: 0;
+      }
+    </style>
+  </head>
+
+  <body>
+    <h2>Here's what you have to add to your environment variables:</h2>
+
+    <ul class="variables">
+      <li>ZOHO_CLIENT_ID=<%= ZohoHub.configuration.client_id %></li>
+      <li>ZOHO_SECRET=<%= ZohoHub.configuration.secret %></li>
+      <li>ZOHO_API_DOMAIN=<%= @variables[:api_domain] %></li>
+      <% if @variables[:refresh_token] %>
+      <li>ZOHO_REFRESH_TOKEN=<%= @variables[:refresh_token] %></li>
+      <% else %>
+      <li class="error">
+        ZOHO_REFRESH_TOKEN=zoho didn't send the refresh token. Please review your configuration.
+        Check <a href="https://github.com/rikas/zoho_hub">the documentation</a> to understand why
+        this is important and how to solve the problem.
+      </li>
+      <% end %>
+    </ul>
+
+    <h2>Then you need a configuration block like this one:</h2>
+    <div class="config">
+      <pre><code>ZohoHub.configure do |config|
+  config.client_id      = ENV['ZOHO_CLIENT_ID']
+  config.secret         = ENV['ZOHO_SECRET']
+  config.api_domain     = ENV['ZOHO_API_DOMAIN']
+  config.refresh_token  = ENV['ZOHO_REFRESH_TOKEN']
+end</code></pre>
+    </div>
+  </body>
+</html>

data/lib/zoho_hub/with_attributes.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module ZohoHub
+  # Allows adding attributes to a class, as <tt>attr_accessors</tt> that can then be listed from the
+  # class or an instance of that class.
+  #
+  # === Example
+  #
+  #   class User
+  #     include ZohoHub::WithAttributes
+  #
+  #     attributes :first_name, :last_name, :email
+  #   end
+  #
+  #   User.attributes # => [:first_name, :last_name, :email]
+  #   User.new.attributes # => [:first_name, :last_name, :email]
+  #
+  #   user = User.new
+  #   user.first_name = 'Ricardo'
+  #   user.last_name = 'Otero'
+  #   user.first_name # => "Ricardo"
+  module WithAttributes
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def attributes(*attributes)
+        @attributes ||= []
+
+        return @attributes unless attributes
+
+        attr_accessor(*attributes)
+
+        @attributes += attributes
+      end
+
+      def attribute_translation(translation = nil)
+        @attribute_translation ||= {}
+
+        return @attribute_translation unless translation
+
+        @attribute_translation = translation
+      end
+
+      def zoho_key_translation
+        @attribute_translation.to_a.map(&:rotate).to_h
+      end
+    end
+
+    # Returns the list of attributes defined for the instance class.
+    def attributes
+      self.class.attributes
+    end
+
+    private
+
+    def attr_to_zoho_key(attr_name)
+      translations = self.class.attribute_translation
+
+      return translations[attr_name.to_sym] if translations.key?(attr_name.to_sym)
+
+      attr_name.to_s.split('_').map(&:capitalize).join('_').to_sym
+    end
+
+    def zoho_key_to_attr(zoho_key)
+      translations = self.class.zoho_key_translation
+
+      return translations[zoho_key.to_sym] if translations.key?(zoho_key.to_sym)
+
+      zoho_key.to_sym
+    end
+  end
+end

data/lib/zoho_hub/with_connection.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ZohoHub
+  # Adds the ability to do API requests (GET / PUT and POST requests) when included in a class.
+  module WithConnection
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def get(path, params = {})
+        ZohoHub.connection.get(path, params)
+      end
+
+      def post(path, params = {})
+        ZohoHub.connection.post(path, params.to_json)
+      end
+
+      def put(path, params = {})
+        ZohoHub.connection.put(path, params.to_json)
+      end
+    end
+
+    def get(path, params = {})
+      self.class.get(path, params)
+    end
+
+    def post(path, params = {})
+      self.class.post(path, params)
+    end
+
+    def put(path, params = {})
+      self.class.put(path, params)
+    end
+  end
+end