resend 0.15.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5654ce4fd9c6c9a097803ad5a55c064d5d21bb2c9fa3dddcbe7a334914fba8c3
-  data.tar.gz: 729b8b8acf1a8dd6c016ce8cc5f509a39bfd8806cbfc11f044e0dd732a011088
+  metadata.gz: e3bd3c129bc391019cd0d3f1c30b40da0354cdc38ab1f2eb8b09830f2276afad
+  data.tar.gz: e7d83291e24db93d771f1a7588b5fc57353f62c86b97b5f9df1d09151f403284
 SHA512:
-  metadata.gz: 36611a0d85ebc0938e0edb0df7e3bd9c9e69fb9ed87e1c0d3f19a4512f6305447b7169ac61ad7ce30cd710003d28c0a099bd7901b892f2cb1446f8a7910c4ed4
-  data.tar.gz: 3ec1ae9d87ae9250a8e2eb0463878fca57013d1857ee8aee4fcab208fc7fa2e84c24cb02cc82bd5585b419c3174a24493af20dac27ceef99c7f3229545377dcd
+  metadata.gz: c27434e2d97b55af4a0b8bde50e5cf3c398498c460451e3ee5c367d6a78a47c8f65d3ecf7c5b7455de2a40040c4e6533b587fa7a0ee2af57d7ec262f2c2e7bf0
+  data.tar.gz: 671f1d0e1fb99bcfbd254ac0fa70b15c52da9406d0800188e77585be420ed7ec6ef61d8a9a4778ec03414c5275f30fb28633a17825ce7a8e110fcbb180f80c15

data/README.md

@@ -3,6 +3,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 ![Build](https://github.com/drish/resend-ruby/actions/workflows/build.yml/badge.svg)
 [![Gem Version](https://badge.fury.io/rb/resend.svg)](https://badge.fury.io/rb/resend)
+
 ---
 
 ## Installation
@@ -10,11 +11,13 @@
 To install Resend Ruby and Rails SDK, simply execute the following command in a terminal:
 
 Via RubyGems:
+
 ```
 gem install resend
 ```
 
 Via Gemfile:
+
 ```
 gem 'resend'
 ```
@@ -37,6 +40,19 @@ Resend.configure do |config|
 end
 ```
 
+The `#api_key` method also accepts a block without arguments, which can be useful for lazy or dynamic loading of API keys.
+
+```ruby
+require "resend"
+Resend.api_key = -> { ENV["RESEND_API_KEY"] }
+```
+
+```ruby
+Resend.configure do |config|
+  config.api_key = -> { Current.user.resend_api_key } # Assumes the user has a `resend_api_key` attribute.
+end
+```
+
 ## Example
 
 ```rb
@@ -56,7 +72,6 @@ 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.

data/lib/resend/broadcasts.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "resend/request"
+require "resend/errors"
+
+module Resend
+  # broadcasts api wrapper
+  module Broadcasts
+    class << self
+      # https://resend.com/docs/api-reference/broadcasts/create-broadcast
+      def create(params = {})
+        path = "broadcasts"
+        Resend::Request.new(path, params, "post").perform
+      end
+
+      # https://resend.com/docs/api-reference/broadcasts/send-broadcast
+      def send(params = {})
+        path = "broadcasts/#{params[:broadcast_id]}/send"
+        Resend::Request.new(path, params, "post").perform
+      end
+
+      # https://resend.com/docs/api-reference/broadcasts/list-broadcasts
+      def list
+        path = "broadcasts"
+        Resend::Request.new(path, {}, "get").perform
+      end
+
+      # https://resend.com/docs/api-reference/broadcasts/delete-broadcast
+      def remove(broadcast_id = "")
+        path = "broadcasts/#{broadcast_id}"
+        Resend::Request.new(path, {}, "delete").perform
+      end
+
+      # https://resend.com/docs/api-reference/broadcasts/get-broadcast
+      def get(broadcast_id = "")
+        path = "broadcasts/#{broadcast_id}"
+        Resend::Request.new(path, {}, "get").perform
+      end
+    end
+  end
+end

data/lib/resend/client.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
+require "resend/audiences"
 require "resend/api_keys"
-require "resend/domains"
-require "resend/emails"
+require "resend/broadcasts"
 require "resend/batch"
-require "resend/audiences"
 require "resend/contacts"
+require "resend/domains"
+require "resend/emails"
 require "httparty"
 
 module Resend

data/lib/resend/mailer.rb

@@ -7,6 +7,17 @@ module Resend
   class Mailer
     attr_accessor :config, :settings
 
+    # These are set as `headers` by the Rails API, but these will be filtered out
+    # when constructing the Resend API payload, since they're are sent as post params.
+    # https://resend.com/docs/api-reference/emails/send-email
+    IGNORED_HEADERS = %w[
+      cc bcc
+      from reply-to to subject mime-version
+      html text
+      content-type tags scheduled_at
+      headers
+    ].freeze
+
     def initialize(config)
       @config = config
       raise Resend::Error.new("Make sure your API Key is set", @config) unless Resend.api_key
@@ -51,7 +62,19 @@ module Resend
     end
 
     #
-    # Add custom headers fields
+    # Add custom headers fields.
+    #
+    # Both ways are supported:
+    #
+    #   1. Through the `#mail()` method ie:
+    #     mail(headers: { "X-Custom-Header" => "value" })
+    #
+    #   2. Through the Rails `#headers` method ie:
+    #     headers["X-Custom-Header"] = "value"
+    #
+    #
+    # setting the header values through the `#mail` method will overwrite values set
+    # through the `#headers` method using the same key.
     #
     # @param Mail mail Rails Mail object
     #
@@ -59,7 +82,37 @@ module Resend
     #
     def get_headers(mail)
       params = {}
-      params[:headers] = mail[:headers].unparsed_value if mail[:headers].present?
+
+      if mail[:headers].present? || unignored_headers(mail).present?
+        params[:headers] = {}
+        params[:headers].merge!(headers_values(mail)) if unignored_headers(mail).present?
+        params[:headers].merge!(mail_headers_values(mail)) if mail[:headers].present?
+      end
+
+      params
+    end
+
+    # Gets the values of the headers that are set through the `#mail` method
+    #
+    # @param Mail mail Rails Mail object
+    # @return Hash hash with mail headers values
+    def mail_headers_values(mail)
+      params = {}
+      mail[:headers].unparsed_value.each do |k, v|
+        params[k.to_s] = v
+      end
+      params
+    end
+
+    # Gets the values of the headers that are set through the `#headers` method
+    #
+    # @param Mail mail Rails Mail object
+    # @return Hash hash with headers values
+    def headers_values(mail)
+      params = {}
+      unignored_headers(mail).each do |h|
+        params[h.name.to_s] = h.unparsed_value
+      end
       params
     end
 
@@ -144,5 +197,16 @@ module Resend
       end
       attachments
     end
+
+    #
+    # Get all headers that are not ignored
+    #
+    # @param Mail mail
+    #
+    # @return Array headers
+    #
+    def unignored_headers(mail)
+      @unignored_headers ||= mail.header_fields.reject { |h| IGNORED_HEADERS.include?(h.name.downcase) }
+    end
   end
 end

data/lib/resend/request.rb

@@ -13,7 +13,9 @@ module Resend
     attr_accessor :body, :verb
 
     def initialize(path = "", body = {}, verb = "POST")
-      raise if Resend.api_key.nil?
+      raise if (api_key = Resend.api_key).nil?
+
+      api_key = api_key.call if api_key.is_a?(Proc)
 
       @path = path
       @body = body
@@ -22,7 +24,7 @@ module Resend
         "Content-Type" => "application/json",
         "Accept" => "application/json",
         "User-Agent" => "resend-ruby:#{Resend::VERSION}",
-        "Authorization" => "Bearer #{Resend.api_key}"
+        "Authorization" => "Bearer #{api_key}"
       }
     end
 

data/lib/resend/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resend
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Derich Pacheco
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-15 00:00:00.000000000 Z
+date: 2024-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -49,6 +49,7 @@ files:
 - lib/resend/api_keys.rb
 - lib/resend/audiences.rb
 - lib/resend/batch.rb
+- lib/resend/broadcasts.rb
 - lib/resend/client.rb
 - lib/resend/contacts.rb
 - lib/resend/domains.rb