resend 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aab8a1f078990a6a2c6e40c01f4b72771915d74e5ad8fa19fec67d9e0d00dc7e
-  data.tar.gz: c440488de4a502b5abf3fbe79a83cd3535039fab30533308176f7b39b24477df
+  metadata.gz: fdc5399f47d9b5faaaa0a1406099a416bfafd29d9e07557ff8496617f1f35091
+  data.tar.gz: 5cfe523a3a1f8788551811de440a6e179c40802cbc6a1879180e022e8e9fc38e
 SHA512:
-  metadata.gz: 577cb058bcada5f1cb56820c7ae1a6ba0f93da4035b1ac82d487fc3768a3c9b77a091a76b9cb5a91d5cb4a0331c8d6294f1b629ac40e86e6452e2d99c237b765
-  data.tar.gz: 037aa163eea257ab8c8a779d58dad4bbc166d69d979d258a578843d3229a35d5a90b337d4dd0d4d8680d27707c2ead0be5b8142fa7cf190ab4bbc0674a4149ca
+  metadata.gz: bb127ddf8f4cfc28793690add92c1b38d84c25d54b20cbe00344dc4a72dcdeb1823eaa765a576c1ef68dd50ac27b8cb15da9d7349b71026b8522e2dc01c3c602
+  data.tar.gz: c5bde3db647e5fb1c7c819842a25420f4e296d9a9735e37c6415e3958e93331cc31a577e2e0fd40a7294b08c368522dadadffde1ac1d0769e6a686a9b2afdbbd

data/README.md

@@ -25,7 +25,16 @@ First, you need to get an API key, which is available in the [Resend Dashboard](
 
 ```ruby
 require "resend"
-client = Resend::Client.new "re_YOUR_API_KEY"
+Resend.api_key = ENV["RESEND_API_KEY"]
+```
+
+or
+
+```ruby
+require "resend"
+Resend.configure do |config|
+  config.api_key = ENV["RESEND_API_KEY"]
+end
 ```
 
 ## Example
@@ -33,18 +42,21 @@ client = Resend::Client.new "re_YOUR_API_KEY"
 ```rb
 require "resend"
 
-client = Resend::Client.new "re_YOUR_API_KEY"
+Resend.api_key = ENV["RESEND_API_KEY"]
 
 params = {
-  "from": "team@recomendo.io",
-  "to": "carlosderich@gmail.com",
+  "from": "from@email.io",
+  "to": ["to@email.com", "to1@gmail.com"],
   "html": "<h1>Hello World</h1>",
   "subject": "Hey"
 }
-r = client.send_email(params)
+r = Resend::Emails.send(params)
 puts r
 ```
 
+You can view all the examples in the [examples folder](https://github.com/drish/resend-ruby/tree/main/examples)
+
+
 # Rails and ActiveMailer support
 
 This gem can be used as an ActionMailer delivery method, add this to your `config/environments/environment.rb` file and replace with your api key.

data/lib/resend/api_keys.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "resend/request"
+require "resend/errors"
+
+module Resend
+  # api keys api wrapper
+  module ApiKeys
+    class << self
+      # https://resend.com/docs/api-reference/api-keys/create-api-key
+      def create(params)
+        path = "/api-keys"
+        Resend::Request.new(path, params, "post").perform
+      end
+
+      # https://resend.com/docs/api-reference/api-keys/list-api-keys
+      def list
+        path = "/api-keys"
+        Resend::Request.new(path, {}, "get").perform
+      end
+
+      # https://resend.com/docs/api-reference/api-keys/delete-api-key
+      def remove(api_key_id = "")
+        path = "/api-keys/#{api_key_id}"
+        Resend::Request.new(path, {}, "delete").perform
+      end
+    end
+  end
+end

data/lib/resend/client.rb

@@ -1,62 +1,21 @@
-require_relative "./version"
-require_relative "./errors"
+# frozen_string_literal: true
+
+require "resend/api_keys"
+require "resend/domains"
+require "resend/emails"
 require "httparty"
 
 module Resend
-
+  # Client class.
   class Client
-    BASE_URL = "https://api.klotty.com/".freeze
+    include Resend::Emails
 
-    attr_reader :api_key, :base_url, :timeout
+    attr_reader :api_key
 
     def initialize(api_key)
-      raise ArgumentError.new("API Key is not a string") unless api_key.is_a?(String)
-      @api_key = api_key
-      @timeout = nil
-    end
-
-    def send_email(params)
-      validate!(params)
-
-      options = {
-        headers: {
-          'Content-Type' => 'application/json',
-          "Accept" => "application/json",
-          "User-Agent" => "ruby:#{Resend::VERSION}",
-          "Authorization" => "Bearer #{@api_key}",
-        },
-        body: params.to_json
-      }
-
-      resp = HTTParty.post("#{BASE_URL}/email", options)
-      resp.transform_keys!(&:to_sym)
-      if not resp[:error].nil?
-        handle_error!(resp[:error])
-      end
-      resp
-    end
+      raise ArgumentError, "API Key is not a string" unless api_key.is_a?(String)
 
-    private
-
-    def validate!(params)
-      raise ArgumentError.new("'to' should be an Array or String") unless params[:to].is_a?(String) or params[:to].is_a?(Array)
-      raise ArgumentError.new("Argument 'to' is missing") if params[:to].nil?
-      raise ArgumentError.new("'to' can not be empty") if params[:to].empty?
-
-      raise ArgumentError.new("'from' should be a String") unless params[:from].is_a?(String)
-      raise ArgumentError.new("Argument 'from' is missing") if params[:from].nil?
-      raise ArgumentError.new("'from' can not be empty") if params[:from].empty?
-
-      raise ArgumentError.new("'from' should be a String") unless params[:from].is_a?(String)
-      raise ArgumentError.new("Argument 'subject' is missing") if params[:subject].nil?
-      raise ArgumentError.new("'subject' can not be empty") if params[:subject].empty?
-
-      raise ArgumentError.new("Argument 'text' and 'html' are missing") if params[:text].nil? and params[:html].nil?
-    end
-
-    def handle_error!(error)
-      err = error.transform_keys(&:to_sym)
-      raise Resend::ResendError.new(err[:message])
+      @api_key = api_key
     end
   end
-end
+end

data/lib/resend/domains.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "resend/request"
+require "resend/errors"
+
+module Resend
+  # domains api wrapper
+  module Domains
+    class << self
+      # https://resend.com/docs/api-reference/domains/create-domain
+      def create(params)
+        path = "/domains"
+        Resend::Request.new(path, params, "post").perform
+      end
+
+      # https://resend.com/docs/api-reference/api-keys/list-api-keys
+      def list
+        path = "/domains"
+        Resend::Request.new(path, {}, "get").perform
+      end
+
+      # https://resend.com/docs/api-reference/domains/delete-domain
+      def remove(domain_id = "")
+        path = "/domains/#{domain_id}"
+        Resend::Request.new(path, {}, "delete").perform
+      end
+
+      # https://resend.com/docs/api-reference/domains/verify-domain
+      def verify(domain_id = "")
+        path = "/domains/#{domain_id}/verify"
+        Resend::Request.new(path, {}, "post").perform
+      end
+    end
+  end
+end

data/lib/resend/emails.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "resend/request"
+
+module Resend
+  # Module responsible for wrapping email sending API
+  module Emails
+    class << self
+      # send email functionality
+      # https://resend.com/docs/api-reference/send-email
+      def send(params)
+        path = "emails"
+        Resend::Request.new(path, params, "post").perform
+      end
+
+      def get(email_id = "")
+        path = "emails/#{email_id}"
+        Resend::Request.new(path, {}, "get").perform
+      end
+    end
+
+    # This method is kept here for backwards compatibility
+    # Use Resend::Emails.send instead.
+    def send_email(params)
+      warn "[DEPRECATION] `send_email` is deprecated.  Please use `Resend::Emails.send` instead."
+      Resend::Emails.send(params)
+    end
+  end
+end

data/lib/resend/errors.rb

@@ -1,5 +1,35 @@
+# frozen_string_literal: true
+
 module Resend
-  class ResendError < StandardError
+  # Errors wrapper class
+  # For more info: https://resend.com/docs/api-reference/error-codes
+  class Error < StandardError
+
+    # 4xx HTTP status code
+    ClientError = Class.new(self)
+
+    # 5xx HTTP status code
+    ServerError = Class.new(self)
+
+    # code 500
+    InternalServerError = Class.new(ServerError)
+
+    # code 422
+    InvalidRequestError = Class.new(ServerError)
+
+    # code 404
+    NotFoundError = Class.new(ServerError)
+
+    ERRORS = {
+      404 => Resend::Error::InvalidRequestError,
+      422 => Resend::Error::InvalidRequestError,
+      400 => Resend::Error::InvalidRequestError,
+      500 => Resend::Error::InternalServerError
+    }.freeze
+
+    def initialize(msg, code = nil)
+      super(msg)
+      @code = code
+    end
   end
 end
-

data/lib/resend/mailer.rb

@@ -1,39 +1,42 @@
+# frozen_string_literal: true
+
 require "resend"
 
 module Resend
+  # Mailer class used by railtie
   class Mailer
-
     attr_accessor :config, :settings
 
     def initialize(config)
       @config = config
-      raise Resend::ResendError.new("Config requires api_key", @config) unless @config.has_key?(:api_key)
+      raise Resend::ResendError.new("Config requires api_key", @config) unless @config.key?(:api_key)
+
       @settings = { return_response: true } # avoids NilError exception
       @resend_client = Resend::Client.new config[:api_key]
     end
 
     def deliver!(mail)
+      params = build_resend_params(mail)
+      resp = @resend_client.send_email(params)
+      mail.message_id = resp[:id] if resp[:error].nil?
+      resp
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def build_resend_params(mail)
       params = {
         from: mail[:from].to_s,
         to: mail.to,
-        subject: mail.subject,
+        subject: mail.subject
       }
       params[:cc] = mail[:cc].to_s if mail[:cc].present?
       params[:bcc] = mail[:bcc].to_s if mail[:bcc].present?
       params[:reply_to] = mail[:reply_to].to_s if mail[:reply_to].present?
       params[:html] = mail.body.decoded
-
-      resp = @resend_client.send_email(params)
-
-      if resp[:error].nil? then
-        mail.message_id = resp[:id]
-      end
-
-      resp
+      params
     end
+    # rubocop:enable Metrics/AbcSize
 
-    def resend_client
-      @resend_client
-    end
+    attr_reader :resend_client
   end
-end
+end

data/lib/resend/railtie.rb

@@ -1,11 +1,14 @@
+# frozen_string_literal: true
+
 require "resend"
 require "resend/mailer"
 
 module Resend
+  # Main railtime class
   class Railtie < ::Rails::Railtie
     ActiveSupport.on_load(:action_mailer) do
       add_delivery_method :resend, Resend::Mailer
       ActiveSupport.run_load_hooks(:resend_mailer, Resend::Mailer)
     end
   end
-end
+end

data/lib/resend/request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "resend/version"
+require "resend/errors"
+require "httparty"
+
+module Resend
+  # This class is responsible for making the appropriate HTTP calls
+  # and raising the specific errors based on the response.
+  class Request
+    BASE_URL = "https://api.resend.com/"
+
+    attr_accessor :body, :verb
+
+    def initialize(path = "", body = {}, verb = "POST")
+      raise if Resend.api_key.nil?
+
+      @path = path
+      @body = body
+      @verb = verb
+      @headers = {
+        "Content-Type" => "application/json",
+        "Accept" => "application/json",
+        "User-Agent" => "ruby:#{Resend::VERSION}",
+        "Authorization" => "Bearer #{Resend.api_key}"
+      }
+    end
+
+    # Performs the HTTP call
+    def perform
+      options = {
+        headers: @headers
+      }
+      options[:body] = @body.to_json unless @body.empty?
+      resp = HTTParty.send(@verb.to_sym, "#{BASE_URL}#{@path}", options)
+      resp.transform_keys!(&:to_sym) unless resp.body.empty?
+      handle_error!(resp) if resp[:statusCode] && resp[:statusCode] != 200
+      resp
+    end
+
+    def handle_error!(resp)
+      code = resp[:statusCode]
+      body = resp[:message]
+      error = Resend::Error::ERRORS[code]
+      raise(error.new(body, code)) if error
+    end
+  end
+end

data/lib/resend/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Resend
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/resend.rb

@@ -3,15 +3,17 @@
 require "resend/version"
 require "resend/client"
 
-require 'resend/railtie' if defined?(Rails) && defined?(ActionMailer)
+require "resend/railtie" if defined?(Rails) && defined?(ActionMailer)
 
+# Main Resend module
 module Resend
   class << self
-    attr_accessor :api_key,
+    attr_accessor :api_key
+
     def configure
       yield self if block_given?
       true
     end
-    alias_method :config, :configure
+    alias config configure
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resend
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Derich Pacheco
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-02 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.19.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.20.0
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -46,12 +46,16 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/resend.rb
+- lib/resend/api_keys.rb
 - lib/resend/client.rb
+- lib/resend/domains.rb
+- lib/resend/emails.rb
 - lib/resend/errors.rb
 - lib/resend/mailer.rb
 - lib/resend/railtie.rb
+- lib/resend/request.rb
 - lib/resend/version.rb
-homepage: https://github.com/drish/resend-ruby
+homepage: https://github.com/resendlabs/resend-ruby
 licenses:
 - MIT
 metadata: {}