zoho_cpaas-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bfb0a432c3bcd8ea7726b4a15f9ec225b154957b5ec1c035be17d56f7f88b918
+  data.tar.gz: 800040eacab0e7ca29af4c11b5719b5b01df2026563a7d107a0b4f0cbcbd16a3
+SHA512:
+  metadata.gz: f5c99155f0e79c13a28bef5fea5fa744cc0c2792fd1c12b561acda11fa05ce9834e5fb790712b8c010e451aeff5cc10bb861650c910b817cb99f7fdfabd72551
+  data.tar.gz: 6c811757184a494bb5abab61d47ed9563c077078d7cc25ad0cf1ee3c5eebc6a04398fc7249c93ea3da810d7f7497de39c814ff028a41f4901c50f9e71fcc12ae

data/lib/zoho_cpaas/client.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'http'
+
+ZohoCpaas_API_BASE_HOST = 'cpaas.zoho.com'
+
+# ZohoCpaas-ruby is a gem that integrates all endpoints from ZohoCpaas API
+module ZohoCpaas
+  class Client
+    attr_reader :api_token
+    attr_reader :host_region
+
+    # Inits the client.
+    def initialize(api_token = ENV.fetch('ZOHO_ZEPTOMAIL_API_KEY_TOKEN', nil), api_host = ENV.fetch('ZOHO_ZEPTOMAIL_HOSTED_REGION', ZohoCpaas_API_BASE_HOST))
+      raise ArgumentError, 'API key token is not provided' if api_token.nil?
+      @api_token = api_token
+      @host_region = api_host
+    end
+
+    def http
+      HTTP
+        .headers('User-Agent' => "Ruby on Rails ZohoCpaas",
+                 'Accept' => 'application/json',
+                 'Authorization' => "Zoho-enczapikey #{@api_token}")
+    end
+  end
+end

data/lib/zoho_cpaas/mail/sendmail.rb

@@ -0,0 +1,110 @@
+
+# frozen_string_literal: true
+
+require 'base64'
+
+module ZohoCpaas
+  # Send an mail through ZohoCpaas API
+  class SendMail
+    attr_accessor :client,
+                  :from,
+                  :recipients,
+                  :subject,
+                  :body,
+                  :cc,
+                  :bcc,
+                  :reply_to,
+                  :attachments
+
+    def initialize(client = ZohoCpaas::Client.new)
+      @client = client
+      @from = {}
+      @recipients = []
+      @body = nil
+      @bcc = []
+      @cc = []
+      @reply_to = []
+      @subject = nil
+      @attachments = []
+    end
+
+    def add_recipients(recipients)
+      @recipients << {'email_address' => recipients}
+    end
+
+    def add_from(from)
+      @from = from
+    end
+
+    def add_cc(cc)
+      @cc << {'email_address' => cc}
+    end
+
+    def add_bcc(bcc)
+      @bcc << {'email_address' => bcc}
+    end
+
+    def add_reply_to(reply_to)
+      @reply_to << reply_to
+    end
+
+    def add_subject(subject)
+      @subject = subject
+    end
+
+    def add_body(body)
+      @body = body
+    end
+
+    def add_attachment(content:, filename:, mime_type:)
+      content_string = content.to_s
+      if File.readable?(content_string)
+        data = File.read(content_string)
+        content_string = data
+      end
+      add_attachments(content: content_string, filename: filename, mime_type: mime_type)
+    end
+
+    def add_attachments(content:, filename:, mime_type:)
+        data_content = Base64.strict_encode64(content.to_s)
+        @attachments << { 'content' => data_content, 'name' => filename, 'mime_type' => mime_type }
+    end
+
+    def handle_to_response(response)
+        response_data = {}
+        data = JSON.parse(response.body)
+
+        if response.code.to_i / 100 == 2
+          response_data['status'] = 'success'
+          response_data['message'] = data['data'][0]['message'] || 'successfully sent the email'
+        else
+          response_data['status'] = 'failure'
+          response_data['message'] = data['error']['details'][0]['message']
+
+          begin
+            response_data['target'] = data['error']['details'][0]['target']
+          rescue
+          end
+        end
+
+        response_data
+    end
+
+    def send
+      message = {
+        'from' => @from,
+        'to' => @recipients,
+        'subject' => @subject,
+        'htmlbody' => @body,
+        'reply_to' => @reply_to,
+        'cc' => @cc,
+        'bcc' => @bcc,
+        'attachments' => @attachments,
+      }
+      response = client.http.post("https://#{client.host_region}/v1.1/email", json: message)
+      handled = handle_to_response(response)
+      puts "Response: #{handled}"
+      handled
+    end
+  end
+end

data/lib/zoho_cpaas/mail/sendtemplatemail.rb

@@ -0,0 +1,90 @@
+
+# frozen_string_literal: true
+
+require 'json'
+
+module ZohoCpaas
+  # Send an Template Mail through ZohoCpaas API
+  class SendTemplateMail
+    attr_accessor :client,
+                  :from,
+                  :recipients,
+                  :cc,
+                  :bcc,
+                  :reply_to,
+                  :template_key,
+                  :template_value
+
+    def initialize(client = ZohoCpaas::Client.new)
+      @client = client
+      @from = {}
+      @recipients = []
+      @bcc = []
+      @cc = []
+      @reply_to = []
+      @template_key = nil
+      @template_value = nil
+    end
+
+    def add_recipients(recipients)
+      @recipients << {'email_address' => recipients}
+    end
+
+    def add_from(from)
+      @from = from
+    end
+
+    def add_cc(cc)
+      @cc << {'email_address' => cc}
+    end
+
+    def add_bcc(bcc)
+      @bcc << {'email_address' => bcc}
+    end
+
+    def add_reply_to(reply_to)
+      @reply_to << reply_to
+    end
+
+    def add_template(key:, value:)
+      @template_key = key.to_s
+      @template_value = value.is_a?(String) ? JSON.parse(value) : value
+    end
+
+    def handle_to_response(response)
+        response_data = {}
+        data = JSON.parse(response.body)
+
+        if response.code.to_i / 100 == 2
+          response_data['status'] = 'success'
+          response_data['message'] = data['data'][0]['message'] || 'successfully sent the email'
+        else
+          response_data['status'] = 'failure'
+          response_data['message'] = data['error']['details'][0]['message']
+
+          begin
+            response_data['target'] = data['error']['details'][0]['target']
+          rescue
+          end
+        end
+
+        response_data
+    end
+
+    def send
+      message = {
+        'from' => @from,
+        'to' => @recipients,
+        'reply_to' => @reply_to,
+        'cc' => @cc,
+        'bcc' => @bcc,
+        'template_key' => @template_key,
+        'merge_info' => @template_value
+      }
+      response = client.http.post("https://#{client.host_region}/v1.1/email/template", json: message)
+      handled = handle_to_response(response)
+      puts "Response: #{handled}"
+      handled
+    end
+  end
+end

data/lib/zoho_cpaas/ruby.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "ruby/version"
+
+module ZohoCpaas
+  module Ruby
+    class Error < StandardError; end
+  end
+end

data/lib/zoho_cpaas-ruby.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'zoho_cpaas'

data/lib/zoho_cpaas.rb

@@ -0,0 +1,3 @@
+require_relative 'zoho_cpaas/mail/sendmail'
+require_relative 'zoho_cpaas/mail/sendtemplatemail'
+require_relative 'zoho_cpaas/client'

data/lib/zohocpaas_ruby.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'zoho_cpaas'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: zoho_cpaas-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ACO
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Zoho CPaas Ruby SDK.
+email:
+- contact@aurarians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/zoho_cpaas-ruby.rb
+- lib/zoho_cpaas.rb
+- lib/zoho_cpaas/client.rb
+- lib/zoho_cpaas/mail/sendmail.rb
+- lib/zoho_cpaas/mail/sendtemplatemail.rb
+- lib/zoho_cpaas/ruby.rb
+- lib/zohocpaas_ruby.rb
+homepage: https://alexason.com
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://alexason.com
+  source_code_uri: https://alexason.com
+  changelog_uri: https://alexason.com
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Zoho Cpaas Ruby SDK
+test_files: []