zoho_hub 0.1.19 → 0.1.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 188458cc4b12a4b5cf49b5b60d90080155062b0cec01d0dfee6fe27033fdf0bf
-  data.tar.gz: 0eea8ca6a0194291bcda5131dbcd2ad57c076a7bbf0019f002ebee5a9f155d17
+  metadata.gz: ebb43093884ef3e4b2590191125e4b21084cf470cae45bdd57bfa3796f62ae2d
+  data.tar.gz: 168f9f71eba69af19fee9b086d7b39d5d267f262125f669a7aec118816fbc5b8
 SHA512:
-  metadata.gz: 8c351b12147a572dc58f7894866aaea3e8c1997c7692996ef639464128c70d33dd9bed69878e4223f99ab6a0b83f71c6522216a756ed412629fbbe2173c3290d
-  data.tar.gz: d1ca2871139875c0ba865804498479d9a76c849defe206c54441282df68f3ebac942a3b54c2a775afa715e91042503cf439bccfcfdb0cf68d6ca5a3d389cbe06
+  metadata.gz: 6a7c32dc1b4e7286884a5d06febe06d211e6784f61cff3688196029480b5e8e056aa5ae90b2976f95919c2c937d769cdb529c8e234a8db4be37bf3ebb8e50b6f
+  data.tar.gz: 37763d48728fa49b24f9aec36d3866717140292d5e1f59c02c18e74214f5ae5644474cfa54b93f18180a9385f9a4e693ee245eb2eb30153c39959798cae2a47f

data/.gitignore

@@ -8,6 +8,7 @@
 /spec/reports/
 /tmp/
 Gemfile.lock
+/cache/
 
 # rspec failure tracking
 .rspec_status

data/lib/zoho_hub.rb

@@ -15,6 +15,7 @@ require 'zoho_hub/records/account'
 require 'zoho_hub/records/quote'
 require 'zoho_hub/records/vendor'
 require 'zoho_hub/records/product'
+require 'zoho_hub/records/attachment'
 
 module ZohoHub
   module_function

data/lib/zoho_hub/connection.rb

@@ -26,24 +26,30 @@ module ZohoHub
       @refresh_token ||= refresh_token # do not overwrite if it's already set
     end
 
-    def get(path, params = {})
+    def get(path, params = {}, &block)
       log "GET #{path} with #{params}"
 
-      response = with_refresh { adapter.get(path, params) }
+      response = with_refresh do
+        adapter(&block).get(path, params)
+      end
       response.body
     end
 
-    def post(path, params = {})
+    def post(path, params = {}, &block)
       log "POST #{path} with #{params}"
 
-      response = with_refresh { adapter.post(path, params) }
+      response = with_refresh do
+        adapter(&block).post(path, params)
+      end
       response.body
     end
 
-    def put(path, params = {})
+    def put(path, params = {}, &block)
       log "PUT #{path} with #{params}"
 
-      response = with_refresh { adapter.put(path, params) }
+      response = with_refresh do
+        adapter(&block).put(path, params)
+      end
       response.body
     end
 
@@ -98,6 +104,7 @@ 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/errors.rb

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

data/lib/zoho_hub/records/attachment.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'zoho_hub/records/base_record'
+
+module ZohoHub
+  class Attachment < BaseRecord
+    attributes :id, :parent_id, :file_name, :link_url, :type, :created_time
+    attributes :parent, :attachment_url
+
+    # 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,
+      link_url: :'$link_url',
+      type: :'$type'
+    )
+
+    def initialize(params)
+      attributes.each do |attr|
+        zoho_key = attr_to_zoho_key(attr)
+
+        send("#{attr}=", params[zoho_key] || params[attr])
+      end
+
+      @parent_id = params.dig(:Parent_Id, :id)
+    end
+
+    class << self
+      def exists?(id, parent:)
+        !find(id, parent: parent).nil?
+      rescue RecordNotFound
+        false
+      end
+
+      def find(id, parent:)
+        body = get(File.join(request_path, id.to_s), parent: parent)
+        response = build_response(body)
+
+        if response.empty?
+          raise RecordNotFound, "Couldn't find #{request_path.singularize} with 'id'=#{id}"
+        end
+
+        new(response.data)
+      end
+
+      def get(path, parent:, **params)
+        # remove /search added by where method
+        path = path.sub('/search', '')
+        ZohoHub.connection.get(parent_module_path(path, parent), params)
+      end
+
+      def post(path, parent:, **params)
+        ZohoHub.connection.post(parent_module_path(path, parent), params) do |conn|
+          conn.request :multipart
+          conn.request :url_encoded
+        end
+      end
+
+      def put(_path, _params = {})
+        raise NotImplementedError
+      end
+
+      def parent_module_path(path, parent)
+        File.join(
+          parent.class.request_path,
+          parent.id,
+          path
+        )
+      end
+    end
+
+    def post(path, _params = {})
+      self.class.post(path, parent: parent, **to_params)
+    end
+
+    def put(_path, _params = {})
+      raise NotImplementedError
+    end
+
+    def save(*)
+      super
+    rescue => e
+      if e.message.include?('Attachment link already exists')
+        raise AttachmentLinkTakenError, e.message
+      else
+        raise e
+      end
+    end
+
+    def to_params
+      { attachmentUrl: attachment_url }
+    end
+
+    private
+
+    def to_input(**)
+      to_params
+    end
+
+    def parent_module_path(path)
+      self.class.parent_module_path(path, parent)
+    end
+  end
+end

data/lib/zoho_hub/records/base_record.rb

@@ -49,7 +49,7 @@ module ZohoHub
 
         response = get(path, params)
 
-        data = response.nil? ? [] : response[:data]
+        data = response.nil? ? [] : response.fetch(:data, [])
 
         data.map { |info| new(info) }
       end
@@ -75,16 +75,16 @@ module ZohoHub
         data.map { |info| new(info) }
       end
 
-      def get(path, params = {})
-        ZohoHub.connection.get(path, params)
+      def get(path, params = {}, &block)
+        ZohoHub.connection.get(path, params, &block)
       end
 
-      def post(path, params = {})
-        ZohoHub.connection.post(path, params.to_json)
+      def post(path, params = {}, &block)
+        ZohoHub.connection.post(path, params.to_json, &block)
       end
 
-      def put(path, params = {})
-        ZohoHub.connection.put(path, params.to_json)
+      def put(path, params = {}, &block)
+        ZohoHub.connection.put(path, params.to_json, &block)
       end
 
       def exists?(id)
@@ -124,14 +124,11 @@ module ZohoHub
     # Save the record to Zoho
     # trigger: ['workflow', 'approval', 'blueprint']
     def save(trigger:)
-      json = { data: [to_params] }
-      json[:trigger] = Array(trigger) if trigger
-
       body = if new_record? # create new record
-               post(self.class.request_path, json)
+               post(self.class.request_path, to_input(trigger: trigger))
              else # update existing record
                path = File.join(self.class.request_path, id)
-               put(path, json)
+               put(path, to_input(trigger: trigger))
              end
 
       response = build_response(body)
@@ -144,6 +141,13 @@ module ZohoHub
       response.data
     end
 
+    def to_input(trigger:)
+      json = { data: [to_params] }
+      json[:trigger] = Array(trigger) if trigger
+
+      json
+    end
+
     def new_record?
       !id.present?
     end

data/lib/zoho_hub/records/potential.rb

@@ -9,6 +9,9 @@ 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',
@@ -23,7 +26,8 @@ module ZohoHub
       code: :Project_Ref_No,
       description: :Project_description,
       employee_count: :Number_of_Employees,
-      use_proceeds: :use_proceeds
+      use_proceeds: :use_proceeds,
+      vat_registration: :Pick_List_15
     )
 
     def initialize(params)
@@ -37,6 +41,7 @@ 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
@@ -45,6 +50,7 @@ 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/version.rb

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

data/zoho_hub.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport', '~> 5.2'
+  spec.add_dependency 'activesupport', '~> 5'
   spec.add_dependency 'addressable', '~> 2.5'
   spec.add_dependency 'faraday', '~> 0.15'
   spec.add_dependency 'faraday_middleware', '~> 0.12'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoho_hub
 version: !ruby/object:Gem::Version
-  version: 0.1.19
+  version: 0.1.24
 platform: ruby
 authors:
 - Ricardo Otero
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-07 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -230,6 +230,7 @@ files:
 - lib/zoho_hub/connection.rb
 - lib/zoho_hub/errors.rb
 - lib/zoho_hub/records/account.rb
+- lib/zoho_hub/records/attachment.rb
 - lib/zoho_hub/records/base_record.rb
 - lib/zoho_hub/records/campaign.rb
 - lib/zoho_hub/records/contact.rb
@@ -244,7 +245,7 @@ homepage: https://github.com/rikas/zoho_hub
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -259,8 +260,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
-signing_key: 
+rubyforge_project:
+rubygems_version: 2.7.6
+signing_key:
 specification_version: 4
 summary: Simple gem to connect to Zoho CRM API V2
 test_files: []