zoho_hub 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1a9e6ab5e3b6d9ed65cbc2c3badfcf03f0e51c8a6ad06a463c1207a3cd4a237
-  data.tar.gz: a4d8cb2d41d6db9967961cc5a4cbbc0fe87ab591821e076940fd6d2bd7079bbf
+  metadata.gz: 7bef57cd4ee9e81ead51f5bffec15c05428ece527014bf0d1cc8b68e1674f1e4
+  data.tar.gz: 1821d02482af55ee1e8f646372b2ee3d502a2aefe7320d7cffae25c70483894f
 SHA512:
-  metadata.gz: 237f2e8a400aea9ab024d48f98938676d3e9a3f69e505affa43c0db474e037d8c6a8a537fd33ceb2b0e8c47a8214d90b0690dbab114f455af130e3f48edc60cd
-  data.tar.gz: 1e70f94611642f4a5557fd59056ea4c1bbaa0687ce15a2300c5722e6079c6759214250eb3e5a6efd0cad271ad434037d9b04cad5f8d4f2b403de6a41bdc67e2f
+  metadata.gz: a1169d827f96c290e368b0cb79a5390ef670eb939f94fc14eee26f5d678f25c5c03bcaa827354dce5b34a5961406a5482a72777a2b496a0619363553b094cc40
+  data.tar.gz: 22d127612237d82e84c79aa9f8602df456bfd4a06d3e1ff7a3b469242aca12974b15e8e924bf983910746d3324411fa230db9306e4af0e27c69665f00533e484

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

@@ -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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zoho_hub
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - Ricardo Otero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-27 00:00:00.000000000 Z
+date: 2020-05-08 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