sendkit 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 45d843cea3a566a7e3089bb891825509074d890b0b7cc714723a46047df19d5a
+  data.tar.gz: a6adac6a88844352ac1b0924a17890998d16d441c6b2d927324895d1a29d06dd
+SHA512:
+  metadata.gz: 9dd53e79481b91be5f1a9142aa3858545bfd84d62402d5fa7f2b9303b140084e607fcdf669d6ef8698383e9eeed7240f06ded52cf70a38e3474adb21d83ac77f
+  data.tar.gz: 9eafe75b279d011de7d87f7b1c59fb0226a67b5ecf90ecc424e0739c8e05e7c8f7373a88bd4dad7fc2dc52068319c594b706c85d2910fff5f84fa245eab7c264

data/README.md

@@ -0,0 +1,72 @@
+# SendKit Ruby SDK
+
+Official Ruby SDK for the [SendKit](https://sendkit.com) email API.
+
+## Installation
+
+```bash
+gem install sendkit
+```
+
+Or add to your Gemfile:
+
+```ruby
+gem "sendkit"
+```
+
+## Usage
+
+### Create a Client
+
+```ruby
+require "sendkit"
+
+client = SendKit::Client.new("sk_your_api_key")
+```
+
+### Send an Email
+
+```ruby
+result = client.emails.send(
+  from: "you@example.com",
+  to: "recipient@example.com",
+  subject: "Hello from SendKit",
+  html: "<h1>Welcome!</h1>"
+)
+
+puts result["id"]
+```
+
+### Send a MIME Email
+
+```ruby
+result = client.emails.send_mime(
+  envelope_from: "you@example.com",
+  envelope_to: "recipient@example.com",
+  raw_message: mime_string
+)
+```
+
+### Error Handling
+
+API errors raise `SendKit::Error`:
+
+```ruby
+begin
+  client.emails.send(...)
+rescue SendKit::Error => e
+  puts e.name        # e.g. "validation_error"
+  puts e.message     # e.g. "The to field is required."
+  puts e.status_code # e.g. 422
+end
+```
+
+### Configuration
+
+```ruby
+# Read API key from SENDKIT_API_KEY environment variable
+client = SendKit::Client.new
+
+# Custom base URL
+client = SendKit::Client.new("sk_...", base_url: "https://custom.api.com")
+```

data/lib/sendkit/client.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/http"
+require "uri"
+
+module SendKit
+  class Client
+    DEFAULT_BASE_URL = "https://api.sendkit.com"
+
+    attr_reader :emails
+
+    def initialize(api_key = nil, base_url: DEFAULT_BASE_URL)
+      @api_key = api_key || ENV["SENDKIT_API_KEY"]
+
+      raise ArgumentError, 'Missing API key. Pass it to the constructor `SendKit::Client.new("sk_...")` or set the SENDKIT_API_KEY environment variable.' if @api_key.nil? || @api_key.empty?
+
+      @base_url = base_url
+      @emails = Emails.new(self)
+    end
+
+    def post(path, body)
+      uri = URI("#{@base_url}#{path}")
+      request = Net::HTTP::Post.new(uri)
+      request["Authorization"] = "Bearer #{@api_key}"
+      request["Content-Type"] = "application/json"
+      request.body = JSON.generate(body)
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
+        http.request(request)
+      end
+
+      parsed = JSON.parse(response.body)
+
+      unless response.is_a?(Net::HTTPSuccess)
+        raise Error.new(
+          parsed["message"] || response.message,
+          name: parsed["name"] || "application_error",
+          status_code: response.code.to_i
+        )
+      end
+
+      parsed
+    end
+  end
+end

data/lib/sendkit/emails.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module SendKit
+  class Emails
+    def initialize(client)
+      @client = client
+    end
+
+    def send(from:, to:, subject:, html: nil, text: nil, cc: nil, bcc: nil,
+             reply_to: nil, headers: nil, tags: nil, scheduled_at: nil, attachments: nil)
+      payload = {from: from, to: to, subject: subject}
+      payload[:html] = html if html
+      payload[:text] = text if text
+      payload[:cc] = cc if cc
+      payload[:bcc] = bcc if bcc
+      payload[:reply_to] = reply_to if reply_to
+      payload[:headers] = headers if headers
+      payload[:tags] = tags if tags
+      payload[:scheduled_at] = scheduled_at if scheduled_at
+      payload[:attachments] = attachments if attachments
+
+      @client.post("/v1/emails", payload)
+    end
+
+    def send_mime(envelope_from:, envelope_to:, raw_message:)
+      @client.post("/v1/emails/mime", {
+        envelope_from: envelope_from,
+        envelope_to: envelope_to,
+        raw_message: raw_message
+      })
+    end
+  end
+end

data/lib/sendkit/error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SendKit
+  class Error < StandardError
+    attr_reader :name, :status_code
+
+    def initialize(message, name: "application_error", status_code: nil)
+      super(message)
+      @name = name
+      @status_code = status_code
+    end
+  end
+end

data/lib/sendkit/version.rb

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

data/lib/sendkit.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "sendkit/version"
+require_relative "sendkit/error"
+require_relative "sendkit/client"
+require_relative "sendkit/emails"

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: sendkit
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- SendKit
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Official Ruby SDK for the SendKit email API. Send transactional emails
+  with a simple, zero-dependency client.
+email:
+- support@sendkit.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sendkit.rb
+- lib/sendkit/client.rb
+- lib/sendkit/emails.rb
+- lib/sendkit/error.rb
+- lib/sendkit/version.rb
+homepage: https://github.com/sendkitdev/sendkit-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sendkitdev/sendkit-ruby
+  source_code_uri: https://github.com/sendkitdev/sendkit-ruby
+  changelog_uri: https://github.com/sendkitdev/sendkit-ruby/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.3
+specification_version: 4
+summary: Ruby SDK for the SendKit email API
+test_files: []