zoho_hub 0.1.18 → 0.1.23

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84262876f36fb21c0f0cb89d56d8dd531fef6828d72f54f38463861964cb5366
-  data.tar.gz: 494f4ced565252a8ee0cd04cfc982cf53c1bcaf2468227f9919ab24ee24856a2
+  metadata.gz: 326c1af1960621d802fc5d5e107402fa23045503b9b9b4fe3de22ba172b3a1ad
+  data.tar.gz: a5bfe6be91c71486af9cc75425167294d2d67098de39753a5da88308e1f26368
 SHA512:
-  metadata.gz: 2196186030ca801f3ef0a9c3df47418cefab10b90a01ea3a477c4e411161e4adeea38a11428cd1d418af9039780604e5a8f53f8e286bb545a1dc23a6e99b7912
-  data.tar.gz: 582a600fb2751d0ee756b97f88cfe653643a6d37be0208564ba5b6b6d3c2e49ea76bbd3afdd074ca29181b485058b3b46675dbdd181ed73f0a134daa359270d4
+  metadata.gz: b91c01210a1be51bb5231cf033db3d503f61d4132ea9c189bfa5aad8a97f79cd53aebbe0e5c8f13a17522667ca728080cf085c880e3da738da59fdb218b0fa4d
+  data.tar.gz: 95256c0bf960cc1812e069ea8627a1034a9be10d90c57917b69fd1ba0849bb7faa0cfc1e37f9e6e1421172b7bf9017ce65c35b3204d99dbe7b250307d3c002d3

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/records/quote.rb

@@ -4,7 +4,7 @@ require 'zoho_hub/records/base_record'
 
 module ZohoHub
   class Quote < BaseRecord
-    attributes :id, :stage, :subject, :potential_id, :owner_id, :product_id, :account_id
+    attributes :id, :stage, :subject, :potential_id, :owner_id, :product_id, :account_id, :extra_info
 
     attribute_translation(
       id: :id,

data/lib/zoho_hub/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoho_hub
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.23
 platform: ruby
 authors:
 - Ricardo Otero
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-04-03 00:00:00.000000000 Z
+date: 2020-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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.2
-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: []