zoho_hub 0.1.25 → 0.2.0

data/lib/zoho_hub/base_record.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/response'
+require 'zoho_hub/with_connection'
+require 'zoho_hub/with_attributes'
+require 'zoho_hub/string_utils'
+
+module ZohoHub
+  class BaseRecord
+    include WithConnection
+    include WithAttributes
+
+    # Default nnumber of records when fetching all.
+    DEFAULT_RECORDS_PER_PAGE = 200
+
+    # Default page number when fetching all.
+    DEFAULT_PAGE = 1
+
+    # Minimum number of records to fetch when fetching all.
+    MIN_RECORDS = 2
+
+    class << self
+      def request_path(name = nil)
+        @request_path = name if name
+        @request_path ||= StringUtils.pluralize(StringUtils.demodulize(to_s))
+        @request_path
+      end
+
+      def find(id)
+        body = get(File.join(request_path, id.to_s))
+        response = build_response(body)
+
+        if response.empty?
+          raise RecordNotFound, "Couldn't find #{request_path.singularize} with 'id'=#{id}"
+        end
+
+        new(response.data)
+      end
+
+      def where(params)
+        path = File.join(request_path, 'search')
+
+        response = get(path, params)
+        data = response[:data]
+
+        data.map { |info| new(info) }
+      end
+
+      def find_by(params)
+        records = where(params)
+        records.first
+      end
+
+      def create(params)
+        new(params).save
+      end
+
+      def all(options = {})
+        options[:page] ||= DEFAULT_PAGE
+        options[:per_page] ||= DEFAULT_RECORDS_PER_PAGE
+        options[:per_page] = MIN_RECORDS if options[:per_page] < MIN_RECORDS
+
+        body = get(request_path, options)
+        response = build_response(body)
+
+        data = response.nil? ? [] : response.data
+
+        data.map { |json| new(json) }
+      end
+
+      def exists?(id)
+        !find(id).nil?
+      rescue RecordNotFound
+        false
+      end
+
+      alias exist? exists?
+
+      def build_response(body)
+        response = Response.new(body)
+
+        raise InvalidTokenError, response.msg if response.invalid_token?
+        raise RecordInvalid, response.msg if response.invalid_data?
+
+        response
+      end
+    end
+
+    def save
+      body = if new_record? # create new record
+               post(self.class.request_path, data: [to_params])
+             else # update existing record
+               path = File.join(self.class.request_path, id)
+               put(path, data: [to_params])
+             end
+
+      response = build_response(body)
+
+      response.data.dig(:details, :id)
+    end
+
+    def new_record?
+      !id
+    end
+
+    def to_params
+      params = {}
+
+      attributes.each do |attr|
+        key = attr_to_zoho_key(attr)
+
+        params[key] = send(attr)
+      end
+
+      params
+    end
+
+    def build_response(body)
+      self.class.build_response(body)
+    end
+  end
+end

data/lib/zoho_hub/configuration.rb

@@ -2,17 +2,16 @@
 
 module ZohoHub
   class Configuration
-    attr_accessor :client_id, :secret, :redirect_uri, :base_url, :access_type
+    attr_accessor :client_id, :secret, :redirect_uri, :api_domain
     attr_writer :debug
 
-    DEFAULT_BASE_URL = 'https://accounts.zoho.eu'
+    DEFAULT_API_DOMAIN = 'https://accounts.zoho.eu'
 
     def initialize
       @client_id = ''
       @secret = ''
       @redirect_uri = ''
-      @base_url = DEFAULT_BASE_URL
-      @access_type = Auth::DEFAULT_ACCESS_TYPE
+      @api_domain = DEFAULT_API_DOMAIN
     end
 
     def debug?

data/lib/zoho_hub/connection.rb

@@ -22,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)
@@ -79,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]
 
@@ -104,7 +98,6 @@ module ZohoHub
       Faraday.new(url: base_url) do |conn|
         conn.headers = authorization_header if access_token?
         conn.use FaradayMiddleware::ParseJson
-        yield conn if block_given?
         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}/contact.rb

@@ -4,8 +4,8 @@ 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 :id, :email, :salutation, :first_name, :mobile, :role, :last_name
+    attributes :account_id, :owner_id, :campaign_id, :status, :campaign_detail
 
     attribute_translation(
       id: :id,
@@ -30,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
@@ -39,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,9 +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
-    attributes :guarantee_types, :home_ownership_status
-    attributes :accountant_id, :vat_registration
 
     DEFAULTS = {
       currency: 'GBP',
@@ -26,8 +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
+      use_proceeds: :use_proceeds
     )
 
     def initialize(params)
@@ -41,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
@@ -50,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
@@ -43,10 +41,6 @@ module ZohoHub
     def msg
       msg = data[:message]
 
-      if data.dig(:code) == 'INVALID_DATA'
-        msg << ", error in #{data.dig(:details, :api_name)}"
-      end
-
       if data.dig(:details, :expected_data_type)
         expected = data.dig(:details, :expected_data_type)
         field = data.dig(:details, :api_name)