unsent 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95a31fbac0136fab785027f7812e7b3122ea28f79dcda16dd8bcf30782d6a788
+  data.tar.gz: 893a89d9dba0d1ae63f1c96fe62d30b99bee7029cda09aa8d4d88172f3875b53
+SHA512:
+  metadata.gz: ee78bacbfaa8d1cafe58412d8fef02d342bc01542e255257c5bc2e73ea1a94d9d2a64bdf89939c786fd0f6d4c30c4ce58a6749118c1181ebb41661fe99bff98c
+  data.tar.gz: 2ea07e0707bc12b3db46e94470521d315df377f35fd6e2b060b10ca9fedb8e38619001abfc5022d78f890f7cb238a4d1f0110e30de26a98783a17c9f5a29dd04

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-11-19
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,275 @@
+# Unsent Ruby SDK
+
+Official Ruby SDK for the [Unsent API](https://unsent.dev) - Send transactional emails with ease.
+
+## Prerequisites
+
+- [Unsent API key](https://app.unsent.dev/dev-settings/api-keys)
+- [Verified domain](https://app.unsent.dev/domains)
+- Ruby 3.0 or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unsent'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install unsent
+```
+
+## Usage
+
+### Basic Setup
+
+```ruby
+require 'unsent'
+
+client = Unsent::Client.new('us_xxx')
+```
+
+### Environment Variables
+
+You can also set your API key using environment variables:
+
+```ruby
+# Set UNSENT_API_KEY in your environment
+# Then initialize without passing the key
+client = Unsent::Client.new
+```
+
+### Sending Emails
+
+#### Simple Email
+
+```ruby
+data, error = client.emails.send({
+  to: 'user@example.com',
+  from: 'no-reply@yourdomain.com',
+  subject: 'Welcome',
+  html: '<strong>Hello!</strong>'
+})
+
+if error
+  puts "Error: #{error}"
+else
+  puts "Email sent! ID: #{data['id']}"
+end
+```
+
+#### With Attachments and Scheduling
+
+```ruby
+require 'time'
+
+data, error = client.emails.create({
+  to: 'user@example.com',
+  from: 'no-reply@yourdomain.com',
+  subject: 'Report',
+  text: 'See attached.',
+  attachments: [
+    {
+      filename: 'report.txt',
+      content: 'SGVsbG8gd29ybGQ=' # base64
+    }
+  ],
+  scheduledAt: (Time.now + 600).iso8601 # 10 minutes from now
+})
+```
+
+#### Batch Send
+
+```ruby
+emails = [
+  {
+    to: 'a@example.com',
+    from: 'no-reply@yourdomain.com',
+    subject: 'A',
+    html: '<p>A</p>'
+  },
+  {
+    to: 'b@example.com',
+    from: 'no-reply@yourdomain.com',
+    subject: 'B',
+    html: '<p>B</p>'
+  }
+]
+
+data, error = client.emails.batch(emails)
+puts "Sent #{data['emails'].length} emails" if data
+```
+
+### Managing Emails
+
+#### Get Email
+
+```ruby
+email, error = client.emails.get('email_123')
+puts "Email status: #{email['status']}" if email
+```
+
+#### Update Schedule
+
+```ruby
+data, error = client.emails.update('email_123', {
+  scheduledAt: (Time.now + 3600).iso8601 # 1 hour from now
+})
+```
+
+#### Cancel Scheduled Email
+
+```ruby
+data, error = client.emails.cancel('email_123')
+puts 'Email cancelled successfully' if data
+```
+
+### Contacts
+
+#### Create Contact
+
+```ruby
+data, error = client.contacts.create('book_123', {
+  email: 'user@example.com',
+  firstName: 'Jane',
+  metadata: {
+    plan: 'pro'
+  }
+})
+```
+
+#### Get Contact
+
+```ruby
+contact, error = client.contacts.get('book_123', 'contact_456')
+```
+
+#### Update Contact
+
+```ruby
+data, error = client.contacts.update('book_123', 'contact_456', {
+  firstName: 'John',
+  metadata: {
+    plan: 'enterprise'
+  }
+})
+```
+
+#### Upsert Contact
+
+```ruby
+data, error = client.contacts.upsert('book_123', 'contact_456', {
+  email: 'user@example.com',
+  firstName: 'Jane'
+})
+```
+
+#### Delete Contact
+
+```ruby
+data, error = client.contacts.delete('book_123', 'contact_456')
+```
+
+### Campaigns
+
+#### Create Campaign
+
+```ruby
+data, error = client.campaigns.create({
+  name: 'Welcome Series',
+  subject: 'Welcome!',
+  html: '<p>Thanks for joining us!</p>',
+  from: 'welcome@yourdomain.com',
+  contactBookId: 'book_123'
+})
+```
+
+#### Schedule Campaign
+
+```ruby
+data, error = client.campaigns.schedule('campaign_123', {
+  scheduledAt: '2024-12-01T10:00:00Z'
+})
+```
+
+#### Pause and Resume
+
+```ruby
+# Pause
+data, error = client.campaigns.pause('campaign_123')
+
+# Resume
+data, error = client.campaigns.resume('campaign_123')
+```
+
+### Domains
+
+#### List Domains
+
+```ruby
+domains, error = client.domains.list
+domains.each do |domain|
+  puts "Domain: #{domain['domain']}, Status: #{domain['status']}"
+end if domains
+```
+
+#### Create Domain
+
+```ruby
+data, error = client.domains.create({
+  domain: 'yourdomain.com'
+})
+```
+
+#### Verify Domain
+
+```ruby
+data, error = client.domains.verify(123)
+puts "Verification status: #{data['status']}" if data
+```
+
+## Error Handling
+
+By default, the SDK raises `Unsent::HTTPError` for non-2xx responses:
+
+```ruby
+begin
+  data, error = client.emails.get('email_123')
+rescue Unsent::HTTPError => e
+  puts "HTTP #{e.status_code}: #{e.error['message']}"
+end
+```
+
+To handle errors as return values instead:
+
+```ruby
+client = Unsent::Client.new('us_xxx', raise_on_error: false)
+
+data, error = client.emails.get('email_123')
+if error
+  puts "Error: #{error['message']}"
+else
+  puts "Success!"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/souravsspace/unsent-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/ruby/sdk/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ruby
+  module Sdk
+    VERSION = "0.1.0"
+  end
+end

data/lib/ruby/sdk.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "sdk/version"
+
+module Ruby
+  module Sdk
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/lib/unsent/campaigns.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Unsent
+  class Campaigns
+    def initialize(client)
+      @client = client
+    end
+
+    def create(payload)
+      @client.post("/campaigns", payload)
+    end
+
+    def get(campaign_id)
+      @client.get("/campaigns/#{campaign_id}")
+    end
+
+    def schedule(campaign_id, payload)
+      @client.post("/campaigns/#{campaign_id}/schedule", payload)
+    end
+
+    def pause(campaign_id)
+      @client.post("/campaigns/#{campaign_id}/pause", {})
+    end
+
+    def resume(campaign_id)
+      @client.post("/campaigns/#{campaign_id}/resume", {})
+    end
+  end
+end

data/lib/unsent/client.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "uri"
+
+module Unsent
+  class Client
+    DEFAULT_BASE_URL = "https://api.unsent.dev"
+
+    attr_reader :key, :url, :raise_on_error
+    attr_accessor :emails, :contacts, :campaigns, :domains
+
+    def initialize(key = nil, url: nil, raise_on_error: true)
+      @key = key || ENV["UNSENT_API_KEY"] || ENV["UNSENT_API_KEY"]
+      raise ArgumentError, "Missing API key. Pass it to Unsent::Client.new or set UNSENT_API_KEY environment variable" if @key.nil? || @key.empty?
+
+      base_url = url || ENV["UNSENT_BASE_URL"] || ENV["UNSENT_BASE_URL"] || DEFAULT_BASE_URL
+      @url = "#{base_url}/v1"
+      @raise_on_error = raise_on_error
+
+      # Initialize resource clients
+      @emails = Emails.new(self)
+      @contacts = Contacts.new(self)
+      @campaigns = Campaigns.new(self)
+      @domains = Domains.new(self)
+    end
+
+    def request(method, path, body = nil)
+      uri = URI("#{@url}#{path}")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == "https"
+
+      request = case method.upcase
+                when "GET" then Net::HTTP::Get.new(uri)
+                when "POST" then Net::HTTP::Post.new(uri)
+                when "PUT" then Net::HTTP::Put.new(uri)
+                when "PATCH" then Net::HTTP::Patch.new(uri)
+                when "DELETE" then Net::HTTP::Delete.new(uri)
+                else raise ArgumentError, "Unsupported HTTP method: #{method}"
+                end
+
+      request["Authorization"] = "Bearer #{@key}"
+      request["Content-Type"] = "application/json"
+      request.body = body.to_json if body
+
+      response = http.request(request)
+      default_error = { "code" => "INTERNAL_SERVER_ERROR", "message" => response.message }
+
+      unless response.is_a?(Net::HTTPSuccess)
+        begin
+          payload = JSON.parse(response.body)
+          error = payload["error"] || default_error
+        rescue JSON::ParserError
+          error = default_error
+        end
+
+        raise HTTPError.new(response.code.to_i, error, method.upcase, path) if @raise_on_error
+        return [nil, error]
+      end
+
+      begin
+        data = JSON.parse(response.body)
+        [data, nil]
+      rescue JSON::ParserError
+        [nil, default_error]
+      end
+    end
+
+    def post(path, body)
+      request("POST", path, body)
+    end
+
+    def get(path)
+      request("GET", path)
+    end
+
+    def put(path, body)
+      request("PUT", path, body)
+    end
+
+    def patch(path, body)
+      request("PATCH", path, body)
+    end
+
+    def delete(path, body = nil)
+      request("DELETE", path, body)
+    end
+  end
+end

data/lib/unsent/contacts.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Unsent
+  class Contacts
+    def initialize(client)
+      @client = client
+    end
+
+    def create(book_id, payload)
+      @client.post("/contactBooks/#{book_id}/contacts", payload)
+    end
+
+    def get(book_id, contact_id)
+      @client.get("/contactBooks/#{book_id}/contacts/#{contact_id}")
+    end
+
+    def update(book_id, contact_id, payload)
+      @client.patch("/contactBooks/#{book_id}/contacts/#{contact_id}", payload)
+    end
+
+    def upsert(book_id, contact_id, payload)
+      @client.put("/contactBooks/#{book_id}/contacts/#{contact_id}", payload)
+    end
+
+    def delete(book_id, contact_id)
+      @client.delete("/contactBooks/#{book_id}/contacts/#{contact_id}")
+    end
+  end
+end

data/lib/unsent/domains.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Unsent
+  class Domains
+    def initialize(client)
+      @client = client
+    end
+
+    def list
+      @client.get("/domains")
+    end
+
+    def create(payload)
+      @client.post("/domains", payload)
+    end
+
+    def verify(domain_id)
+      @client.put("/domains/#{domain_id}/verify", {})
+    end
+
+    def get(domain_id)
+      @client.get("/domains/#{domain_id}")
+    end
+
+    def delete(domain_id)
+      @client.delete("/domains/#{domain_id}")
+    end
+  end
+end

data/lib/unsent/emails.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Unsent
+  class Emails
+    def initialize(client)
+      @client = client
+    end
+
+    def send(payload)
+      create(payload)
+    end
+
+    def create(payload)
+      # Normalize from_ to from
+      payload = payload.dup
+      payload[:from] = payload.delete(:from_) if payload.key?(:from_) && !payload.key?(:from)
+      
+      # Convert scheduledAt to ISO 8601 if it's a Time object
+      if payload[:scheduledAt].is_a?(Time)
+        payload[:scheduledAt] = payload[:scheduledAt].iso8601
+      end
+
+      @client.post("/emails", payload)
+    end
+
+    def batch(emails)
+      items = emails.map do |email|
+        email = email.dup
+        email[:from] = email.delete(:from_) if email.key?(:from_) && !email.key?(:from)
+        email[:scheduledAt] = email[:scheduledAt].iso8601 if email[:scheduledAt].is_a?(Time)
+        email
+      end
+
+      @client.post("/emails/batch", items)
+    end
+
+    def get(email_id)
+      @client.get("/emails/#{email_id}")
+    end
+
+    def update(email_id, payload)
+      payload = payload.dup
+      payload[:scheduledAt] = payload[:scheduledAt].iso8601 if payload[:scheduledAt].is_a?(Time)
+      @client.patch("/emails/#{email_id}", payload)
+    end
+
+    def cancel(email_id)
+      @client.post("/emails/#{email_id}/cancel", {})
+    end
+  end
+end

data/lib/unsent/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Unsent
+  class HTTPError < Error
+    attr_reader :status_code, :error, :method, :path
+
+    def initialize(status_code, error, method, path)
+      @status_code = status_code
+      @error = error
+      @method = method
+      @path = path
+      super(to_s)
+    end
+
+    def to_s
+      code = @error["code"] || "UNKNOWN_ERROR"
+      message = @error["message"] || ""
+      "#{@method} #{@path} -> #{@status_code} #{code}: #{message}"
+    end
+  end
+end

data/lib/unsent/types.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Unsent
+  # Type definitions for documentation purposes
+  # Ruby is dynamically typed, so these are just for reference
+  module Types
+    # Email types
+    EmailCreate = Hash # { to:, from:, subject:, html:, text:, attachments:, scheduledAt: }
+    EmailCreateResponse = Hash # { id:, to:, from:, subject:, status:, createdAt: }
+    Email = Hash
+    EmailUpdate = Hash
+    EmailUpdateResponse = Hash
+    EmailCancelResponse = Hash
+    EmailBatchItem = Hash
+    EmailBatchResponse = Hash
+
+    # Contact types
+    Contact = Hash
+    ContactCreate = Hash
+    ContactCreateResponse = Hash
+    ContactUpdate = Hash
+    ContactUpdateResponse = Hash
+    ContactUpsert = Hash
+    ContactUpsertResponse = Hash
+    ContactDeleteResponse = Hash
+
+    # Campaign types
+    Campaign = Hash
+    CampaignCreate = Hash
+    CampaignCreateResponse = Hash
+    CampaignSchedule = Hash
+    CampaignScheduleResponse = Hash
+    CampaignActionResponse = Hash
+
+    # Domain types
+    Domain = Hash
+    DomainCreate = Hash
+    DomainCreateResponse = Hash
+    DomainVerifyResponse = Hash
+    DomainDeleteResponse = Hash
+
+    # Error type
+    APIError = Hash # { code:, message: }
+  end
+end

data/lib/unsent/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Unsent
+  VERSION = "1.0.0"
+end

data/lib/unsent.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "unsent/version"
+require_relative "unsent/client"
+require_relative "unsent/emails"
+require_relative "unsent/contacts"
+require_relative "unsent/campaigns"
+require_relative "unsent/domains"
+require_relative "unsent/types"
+require_relative "unsent/errors"
+
+module Unsent
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: unsent
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sourav
+bindir: exe
+cert_chain: []
+date: 1980-01-01 00:00:00.000000000 Z
+dependencies: []
+description: Official Ruby SDK for the Unsent API. Send transactional emails, manage
+  contacts, campaigns, and domains.
+email:
+- hey@unsent.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/ruby/sdk.rb
+- lib/ruby/sdk/version.rb
+- lib/unsent.rb
+- lib/unsent/campaigns.rb
+- lib/unsent/client.rb
+- lib/unsent/contacts.rb
+- lib/unsent/domains.rb
+- lib/unsent/emails.rb
+- lib/unsent/errors.rb
+- lib/unsent/types.rb
+- lib/unsent/version.rb
+homepage: https://unsent.dev
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://unsent.dev
+  source_code_uri: https://github.com/souravsspace/unsent-ruby
+  changelog_uri: https://github.com/souravsspace/unsent-ruby/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: Ruby SDK for the Unsent API - Send transactional emails with ease
+test_files: []