zoho_hub 0.2.0 → 0.3.0

data/lib/zoho_hub/cli/callback_server.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'launchy'
+require 'optparse'
+
+require 'zoho_hub'
+require 'zoho_hub/oauth_callback_server'
+
+module ZohoHub
+  module Cli
+    class CallbackServer
+      def initialize
+        @options = {}
+      end
+
+      def parser
+        @parser ||= OptionParser.new do |op|
+          op.banner = "Usage: #{op.program_name} server -c CLIENT_ID -s SECRET [options]"
+
+          op.on('-c', '--client-id=client_id', 'The Zoho client ID') do |client|
+            @options[:client_id] = client
+          end
+
+          op.on('-s', '--secret=secret', 'The Zoho secret') do |secret|
+            @options[:secret] = secret
+          end
+
+          op.on('-p', '--port=port', "The port for your callback (#{default_port})") do |port|
+            @options[:port] = port
+          end
+        end
+      end
+
+      def default_port
+        ZohoHub::OauthCallbackServer.settings.port
+      end
+
+      def run(argv = ARGV, env = ENV)
+        exit 1 unless good_run(argv, env)
+
+        ZohoHub::OauthCallbackServer.set(:port, @options[:port]) if @options[:port]
+
+        callback_path = ZohoHub::OauthCallbackServer::CALLBACK_PATH
+        bind_port = ZohoHub::OauthCallbackServer.settings.port
+        bind_address = ZohoHub::OauthCallbackServer.settings.bind
+
+        callback_url = "http://#{bind_address}:#{bind_port}/#{callback_path}"
+
+        ZohoHub.configure do |config|
+          config.client_id    = @options[:client_id] || ENV['ZOHO_CLIENT_ID']
+          config.secret       = @options[:secret] || ENV['ZOHO_SECRET']
+          config.redirect_uri = callback_url
+        end
+
+        if configuration_incomplete?
+          parser.parse %w[--help]
+          exit 1
+        end
+
+        puts "Callback URL: #{callback_url}"
+
+        url = ZohoHub::Auth.auth_url
+        Launchy.open(url)
+
+        puts "Running callback server...."
+        ZohoHub::OauthCallbackServer.run!
+      end
+
+      def configuration_incomplete?
+        !ZohoHub.configuration.client_id || !ZohoHub.configuration.secret
+      end
+
+      def good_run(argv, env)
+        return false unless parse(argv, env)
+
+        true
+      end
+
+      def parse(argv, _env)
+        parser.parse!(argv)
+        true
+      rescue OptionParser::ParseError => error
+        error_output(error)
+      end
+
+      def error_output(error)
+        $stderr.puts "Error: #{error}"
+        $stderr.puts "Try `#{parser.program_name} server --help' for more information"
+
+        false
+      end
+    end
+  end
+end

data/lib/zoho_hub/cli/read_modules.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'fileutils'
+require 'json'
+
+require 'zoho_hub'
+require 'zoho_hub/settings/module'
+
+module ZohoHub
+  module Cli
+    class ReadModules
+      def initialize
+        @options = {}
+      end
+
+      def parser
+        @parser ||= OptionParser.new do |op|
+          op.banner = "Usage: #{op.program_name} read-modules -c CLIENT_ID -s SECRET"
+
+          op.on('-c', '--client-id=client_id', 'The Zoho client ID') do |client|
+            @options[:client_id] = client
+          end
+
+          op.on('-s', '--secret=secret', 'The Zoho secret') do |secret|
+            @options[:secret] = secret
+          end
+
+          op.on('-r', '--refresh-token=token', 'Your refresh token') do |refresh|
+            @options[:refresh_token] = refresh
+          end
+        end
+      end
+
+      def run(argv = ARGV, env = ENV)
+        exit 1 unless good_run(argv, env)
+
+        setup_connection
+
+        client_id = @options[:client_id] || ENV['ZOHO_CLIENT_ID']
+        puts "Reading modules for client ID: #{client_id}..."
+
+        modules_hashes = ZohoHub::Settings::Module.all_json
+
+        puts "Found #{modules_hashes.size} modules"
+
+        modules_hashes.each do |hash|
+          puts "- Caching configuration for #{hash[:plural_label]}"
+          cache_module_info(hash)
+        end
+      end
+
+      def good_run(argv, env)
+        return false unless parse(argv, env)
+
+        true
+      end
+
+      def setup_connection
+        ZohoHub.configure do |config|
+          config.client_id    = @options[:client_id] || ENV['ZOHO_CLIENT_ID']
+          config.secret       = @options[:secret] || ENV['ZOHO_SECRET']
+        end
+
+        refresh_token = @options[:refresh_token] || ENV['ZOHO_REFRESH_TOKEN']
+        token_params = ZohoHub::Auth.refresh_token(refresh_token)
+
+        if configuration_incomplete?(refresh_token)
+          parser.parse %w[--help]
+          exit 1
+        end
+
+        ZohoHub.setup_connection(token_params)
+      end
+
+      def configuration_incomplete?(refresh_token)
+        return true unless refresh_token
+
+        !ZohoHub.configuration.client_id || !ZohoHub.configuration.secret
+      end
+
+      def cache_module_info(info)
+        modules_path = File.join(ZohoHub.root, 'cache', 'modules')
+        FileUtils.mkdir_p(modules_path)
+        file_name = File.join(modules_path, "#{info[:api_name]}.json")
+
+        File.open(file_name, 'w') do |file|
+          file.write(JSON.pretty_generate(info))
+        end
+
+        return unless info[:api_supported]
+
+        cache_module_fields(info)
+      end
+
+      def cache_module_fields(info)
+        fields_array = ZohoHub::Settings::Field.all_json_for(info[:api_name])
+        fields_path = File.join(ZohoHub.root, 'cache', 'fields')
+        FileUtils.mkdir_p(fields_path)
+        file_name = File.join(fields_path, "#{info[:api_name]}.json")
+
+        File.open(file_name, 'w') do |file|
+          file.write(JSON.pretty_generate(fields_array))
+        end
+      end
+
+      def parse(argv, _env)
+        parser.parse!(argv)
+        true
+      rescue OptionParser::ParseError => error
+        error_output(error)
+      end
+
+      def error_output(error)
+        $stderr.puts "Error: #{error}"
+        $stderr.puts "Try `#{parser.program_name} server --help' for more information"
+
+        false
+      end
+    end
+  end
+end

data/lib/zoho_hub/connection.rb

@@ -47,6 +47,13 @@ module ZohoHub
       response.body
     end
 
+    def delete(path, params = {})
+      log "DELETE #{path} with #{params}"
+
+      response = with_refresh { adapter.delete(path, params) }
+      response.body
+    end
+
     def access_token?
       @access_token
     end

data/lib/zoho_hub/oauth_callback_server.rb

@@ -8,10 +8,6 @@ module ZohoHub
 
     CALLBACK_PATH = 'oauth2callback'
 
-    before do
-      content_type :json
-    end
-
     get "/#{CALLBACK_PATH}" do
       grant_token = params[:code]
 

data/lib/zoho_hub/{module_builder.rb → reflection/module_builder.rb}

@@ -9,7 +9,7 @@ module ZohoHub
         cached_module_definitions.map do |file|
           json = MultiJson.load(File.read(file), symbolize_keys: true)
 
-          create_module(json)
+          eval_module_class(json)
         end
       end
 
@@ -17,31 +17,27 @@ module ZohoHub
         Dir[File.join(ZohoHub.root, 'cache', 'modules', '**')]
       end
 
-      def create_module(json)
+      def eval_module_class(json)
         fields = cached_module_fields(json[:api_name])
 
         klass = Class.new(ZohoHub::BaseRecord) do
           request_path json[:api_name]
 
-          translations = {}
+          translations = { id: :id }
           fields.each do |field|
-            key = StringUtils.underscore(field[:api_name])
+            key = StringUtils.underscore(field[:api_name]).to_sym
 
-            translations[key] = field[:api_name]
-          end
-
-          if translations.any?
-            attributes(*translations.keys)
-            attribute_translation(translations)
-          end
+            translations[key] = field[:api_name].to_sym
 
-          def initialize(params)
-            attributes.each do |attr|
-              zoho_key = attr_to_zoho_key(attr)
+            add_validation(key, validate: :length, length: field[:length]) if field[:length]
 
-              send("#{attr}=", params[zoho_key] || params[attr])
+            if field[:data_type] == 'picklist'
+              add_validation(key, validate: :picklist, list: field[:pick_list_values])
             end
           end
+
+          attributes(*translations.keys)
+          attribute_translation(translations)
         end
 
         ZohoHub.const_set(StringUtils.camelize(json[:singular_label]), klass)

data/lib/zoho_hub/response.rb

@@ -31,11 +31,7 @@ module ZohoHub
 
     def data
       data = @params[:data] if @params.dig(:data)
-      data ||= @params
-
-      return data.first if data.is_a?(Array) && data.size == 1
-
-      data
+      data || @params
     end
 
     def msg

data/lib/zoho_hub/string_utils.rb

@@ -8,7 +8,11 @@ module ZohoHub
       end
 
       def pluralize(text)
-        "#{text}s"
+        if ENV.key?('RAILS_ENV')
+          ActiveSupport::Inflector.pluralize(text)
+        else
+          "#{text}s"
+        end
       end
 
       def camelize(text)

data/lib/zoho_hub/validations/base_validation.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ZohoHub
+  module Validations
+    class BaseValidation
+      attr_accessor :record, :field
+
+      def initialize(record, field)
+        @record = record
+        @field = field
+      end
+    end
+  end
+end

data/lib/zoho_hub/validations/validate_length.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/validations/base_validation'
+
+module ZohoHub
+  module Validations
+    class ValidateLength < BaseValidation
+      def validate(options = {})
+        value = record.send(field)
+
+        return unless value
+
+        return if value.size <= options[:length]
+
+        record.add_error(field, 'is too long')
+      end
+    end
+  end
+end

data/lib/zoho_hub/validations/validate_picklist.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/validations/base_validation'
+
+module ZohoHub
+  module Validations
+    class ValidatePicklist < BaseValidation
+      def validate(options = {})
+        value = record.send(field)
+
+        return unless value
+
+        list = options[:list].map { |option| option[:actual_value] }
+
+        return if list.include?(value)
+
+        msg = "has an invalid value `#{value}`. Accepted values: #{list.join(', ')}"
+        record.add_error(field, msg)
+      end
+    end
+  end
+end

data/lib/zoho_hub/version.rb

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

data/lib/zoho_hub/views/variables.erb

@@ -38,6 +38,11 @@
         padding: 0;
         margin: 0;
       }
+
+      footer {
+        margin-top: 60px;
+        font-size: .8em;
+      }
     </style>
   </head>
 
@@ -68,5 +73,7 @@
   config.refresh_token  = ENV['ZOHO_REFRESH_TOKEN']
 end</code></pre>
     </div>
+
+    <footer>ZohoHub <%= ZohoHub::VERSION %></footer>
   </body>
 </html>

data/lib/zoho_hub/with_connection.rb

@@ -19,6 +19,10 @@ module ZohoHub
       def put(path, params = {})
         ZohoHub.connection.put(path, params.to_json)
       end
+
+      def delete(path, params = {})
+        ZohoHub.connection.delete(path, params.to_json)
+      end
     end
 
     def get(path, params = {})
@@ -32,5 +36,9 @@ module ZohoHub
     def put(path, params = {})
       self.class.put(path, params)
     end
+
+    def delete(path, params = {})
+      self.class.delete(path, params)
+    end
   end
 end

data/lib/zoho_hub/with_validations.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/validations/validate_length'
+require 'zoho_hub/validations/validate_picklist'
+
+module ZohoHub
+  module WithValidations
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def add_validation(field, params = {})
+        @validations ||= []
+
+        options = params.dup
+        validate = options.delete(:validate)
+
+        unless validate
+          raise ArgumentError, 'You must provide the validation with the `validate` key!'
+        end
+
+        @validations << { field: field, validate: validate }.merge(options)
+      end
+
+      def validations
+        @validations || []
+      end
+    end
+
+    def validate!
+      @errors = []
+
+      self.class.validations.each { |validation| validate_field!(validation) }
+
+      @errors
+    end
+
+    def errors
+      @errors
+    end
+
+    def validate_field!(params = {})
+      options = params.dup
+      validate = options.delete(:validate)
+
+      validator = Module.const_get("Validations::Validate#{validate.downcase.capitalize}")
+      validator.new(self, options[:field]).validate(options)
+    end
+
+    def add_error(field, message)
+      @errors << { field: field, message: message }
+    end
+  end
+
+  class ValidationError < StandardError
+    attr_reader :record
+
+    def initialize(record)
+      @record = record
+      errors = @record.errors.join(', ')
+
+      super(errors)
+    end
+  end
+end

data/lib/zoho_hub.rb

@@ -9,7 +9,8 @@ require 'zoho_hub/connection'
 require 'zoho_hub/errors'
 require 'zoho_hub/base_record'
 require 'zoho_hub/settings/module'
-require 'zoho_hub/module_builder'
+
+require 'zoho_hub/reflection/module_builder'
 
 require 'multi_json'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoho_hub
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2019-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -242,29 +242,31 @@ files:
 - bin/setup
 - bin/zoho_hub
 - cache/.git_keep
+- examples/models/campaign.rb
+- examples/models/potential.rb
+- examples/models/quote.rb
 - lib/zoho_hub.rb
 - lib/zoho_hub/auth.rb
 - lib/zoho_hub/base_record.rb
+- lib/zoho_hub/cli/callback_server.rb
+- lib/zoho_hub/cli/read_modules.rb
 - lib/zoho_hub/configuration.rb
 - lib/zoho_hub/connection.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/account.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/campaign.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/contact.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/funder.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/potential.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/product.rb
-- lib/zoho_hub/deprecated_and_only_for_reference_records/quote.rb
 - lib/zoho_hub/errors.rb
-- lib/zoho_hub/module_builder.rb
 - lib/zoho_hub/oauth_callback_server.rb
+- lib/zoho_hub/reflection/module_builder.rb
 - lib/zoho_hub/response.rb
 - lib/zoho_hub/settings/field.rb
 - lib/zoho_hub/settings/module.rb
 - lib/zoho_hub/string_utils.rb
+- lib/zoho_hub/validations/base_validation.rb
+- lib/zoho_hub/validations/validate_length.rb
+- lib/zoho_hub/validations/validate_picklist.rb
 - lib/zoho_hub/version.rb
 - lib/zoho_hub/views/variables.erb
 - lib/zoho_hub/with_attributes.rb
 - lib/zoho_hub/with_connection.rb
+- lib/zoho_hub/with_validations.rb
 - zoho_hub.gemspec
 homepage: https://github.com/rikas/zoho_hub
 licenses:

data/lib/zoho_hub/deprecated_and_only_for_reference_records/account.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'zoho_hub/records/base_record'
-
-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
-
-    # This is the ID to be used when the borrower has no organisation (unlikely) or belongs to
-    # multiple organisations.
-    CATCH_ALL_ID = '78265000000826001'
-
-    DEFAULTS = {
-      account_type: 'Prospect'
-    }.freeze
-
-    # The translation from attribute name to the JSON field on Zoho. The default behaviour will be
-    # to Camel_Case the attribute so on this list we should only have exceptions to this rule.
-    attribute_translation(
-      id: :id,
-      name: :Account_Name,
-      company_number: :company_reg_id,
-      employee_count: :No_of_Employees,
-      industry: :Industry_Category
-    )
-
-    def initialize(params)
-      attributes.each do |attr|
-        zoho_key = attr_to_zoho_key(attr)
-
-        send("#{attr}=", params[zoho_key] || params[attr] || DEFAULTS[attr])
-      end
-    end
-
-    def to_params
-      params = super
-
-      params
-    end
-  end
-end

data/lib/zoho_hub/deprecated_and_only_for_reference_records/campaign.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-require 'zoho_hub/records/base_record'
-
-module ZohoHub
-  class Campaign < BaseRecord
-    attributes :id, :name
-
-    def initialize(params)
-      @id = params[:id]
-      @name = params[:Campaign_Name]
-    end
-  end
-end

data/lib/zoho_hub/deprecated_and_only_for_reference_records/contact.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-require 'zoho_hub/records/base_record'
-
-module ZohoHub
-  class Contact < BaseRecord
-    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
-    )
-
-    DEFAULTS = {
-      status: 'active',
-      campaign_detail: 'Web Sign Up'
-    }.freeze
-
-    def initialize(params)
-      attributes.each do |attr|
-        zoho_key = attr_to_zoho_key(attr)
-
-        send("#{attr}=", params[zoho_key] || params[attr] || DEFAULTS[attr])
-      end
-
-      # Setup values as they come from the Zoho API if needed
-      @account_id ||= params.dig(:Account_Name, :id)
-      @owner_id ||= params.dig(:Owner, :id)
-      @campaign_id ||= params.dig(:Campaign_Lookup, :id)
-    end
-
-    def to_params
-      params = super
-
-      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
-    end
-  end
-end

data/lib/zoho_hub/deprecated_and_only_for_reference_records/funder.rb

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

data/lib/zoho_hub/deprecated_and_only_for_reference_records/product.rb

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