sendrly 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0201aa9b578217b1acb1afe695d4df1ce4865dbe329eedf3a6557fb653a73717
+  data.tar.gz: cc89e9529c5a1cda7a9a6b57e7ebbfb0fdfe50fb8866494dad6b8fe7dbf56a2f
+SHA512:
+  metadata.gz: 1ac118a09873a02564b47f394894edaf1e3e7d15cdf54be209f1bb3837aa69a7f81ed3053e643247f26360be4e99da0d35c9067bf57ca9ed8600111a932ce8d6
+  data.tar.gz: 9814a5ed7bb17b565cfb4ce13eb02faf7623023eaaa80b0279a9eeeae3ca6328dca7a89386f861a46cba2ac15e006db9073bc29a9fbc47ae8f2e71a7b4d0b216

data/README.md

@@ -0,0 +1,133 @@
+# Sendrly Ruby SDK
+
+The official Ruby SDK for [Sendrly](https://sendrly.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sendrly'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install sendrly
+```
+
+## Usage
+
+### Initialize the client
+
+```ruby
+require 'sendrly'
+
+# Create a new client instance
+client = Sendrly.new(api_key: 'your_api_key')
+
+# Enable debug logging
+client = Sendrly.new(api_key: 'your_api_key', debug: true)
+```
+
+### Send an event
+
+```ruby
+# Simple event
+client.send_event(
+  email: 'user@example.com',
+  event: 'user.signup'
+)
+
+# Event with properties
+client.send_event(
+  email: 'user@example.com',
+  event: 'order.completed',
+  contact_properties: {
+    name: 'John Smith',
+    plan: 'enterprise'
+  },
+  event_properties: {
+    order_id: 'ORD-123',
+    amount: 499.99
+  }
+)
+```
+
+### Get contact details
+
+```ruby
+begin
+  contact = client.get_contact('user@example.com')
+  puts contact[:properties][:name]
+rescue Sendrly::APIError => e
+  if e.code == 'NOT_FOUND'
+    puts 'Contact not found'
+  else
+    puts "API error: #{e.message}"
+  end
+end
+```
+
+### List events
+
+```ruby
+# Get all signup events
+signups = client.list_events('user.signup')
+signups.each do |event|
+  puts event[:properties][:source]
+end
+
+# Calculate total revenue from orders
+orders = client.list_events('order.completed')
+total_revenue = orders.sum { |order| order[:properties][:amount] }
+```
+
+### Delete a contact
+
+```ruby
+begin
+  client.delete_contact('user@example.com')
+  puts 'Contact deleted successfully'
+rescue Sendrly::APIError => e
+  puts "Failed to delete contact: #{e.message}"
+end
+```
+
+### Error handling
+
+The SDK can raise the following errors:
+
+- `Sendrly::ValidationError`: When input validation fails
+- `Sendrly::APIError`: When the API returns an error response
+- `Sendrly::NetworkError`: When there's a network-related error
+
+```ruby
+begin
+  client.send_event(email: 'invalid', event: 'test')
+rescue Sendrly::ValidationError => e
+  puts "Validation failed: #{e.errors}"
+rescue Sendrly::APIError => e
+  puts "API error (#{e.code}): #{e.message}"
+rescue Sendrly::NetworkError => e
+  puts "Network error: #{e.message}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sendrly/sendrly-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). 

data/lib/sendrly/client.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require "faraday"
+require "json"
+require "logger"
+require_relative "errors"
+require_relative "contracts"
+
+module Sendrly
+  class Client
+    BASE_URL = "https://stebgknkomdhjikpcytk.supabase.co/functions/v1"
+
+    attr_reader :api_key, :debug
+
+    def initialize(api_key:, debug: false)
+      @api_key = api_key
+      @debug = debug
+      @logger = Logger.new($stdout)
+      @logger.level = debug ? Logger::DEBUG : Logger::INFO
+      @http_client = Faraday.new(url: BASE_URL) do |f|
+        f.request :json
+        f.response :json
+        f.headers["Content-Type"] = "application/json"
+        f.headers["apikey"] = api_key
+      end
+
+      validate_config!
+      log "Initialized with config: #{config_for_log}"
+    end
+
+    def send_event(email:, event:, marketing_opt_out: false, contact_properties: {}, event_properties: {})
+      result = Contracts::EventPayload.new.call(
+        email: email,
+        event: event,
+        marketing_opt_out: marketing_opt_out,
+        contact_properties: contact_properties,
+        event_properties: event_properties
+      )
+      raise ValidationError, result.errors.to_h unless result.success?
+
+      # Match the exact payload structure expected by the Edge Function
+      payload = {
+        contact: {
+          email: email,
+          marketing_opt_out: marketing_opt_out,
+          properties: contact_properties
+        },
+        event: {
+          name: event,
+          properties: event_properties
+        }
+      }
+
+      log "=== Request Details ==="
+      log "Endpoint: #{BASE_URL}/event"
+      log "Headers: #{@http_client.headers.inspect}"
+      log "Payload: #{payload.inspect}"
+
+      response = make_request(:post, "event", payload)
+      
+      log "Event sent successfully"
+      response
+    end
+
+    def get_contact(email)
+      log "Getting contact: #{email}"
+      
+      result = Contracts::Email.new.call(email: email)
+      raise ValidationError, result.errors.to_h unless result.success?
+
+      log "Making GET request to: #{BASE_URL}/find-contact with email: #{email}"
+      response = make_request(:get, "find-contact", email: email)
+      
+      if !response["success"]
+        raise NotFoundError, response["error"] || "Contact not found"
+      end
+      
+      response["contact"]
+    end
+
+    def list_events(event_name)
+      log "Listing events: #{event_name}"
+      
+      result = Contracts::EventName.new.call(event: event_name)
+      raise ValidationError, result.errors.to_h unless result.success?
+
+      log "Making GET request to: #{BASE_URL}/get-event with event: #{event_name}"
+      response = make_request(:get, "get-event", event: event_name)
+      
+      if !response["success"]
+        raise APIError.new(response["error"] || "Failed to list events", "API_ERROR")
+      end
+      
+      response["events"] || []
+    end
+
+    def delete_contact(email)
+      log "Deleting contact: #{email}"
+      
+      result = Contracts::Email.new.call(email: email)
+      raise ValidationError, result.errors.to_h unless result.success?
+
+      log "Making DELETE request to: #{BASE_URL}/delete-contact with email: #{email}"
+      response = make_request(:delete, "delete-contact", email: email)
+      
+      if !response["success"]
+        if response["error"]&.include?("not found")
+          raise NotFoundError, "Contact not found"
+        else
+          raise APIError.new(response["error"] || "Failed to delete contact", "API_ERROR")
+        end
+      end
+      
+      response
+    end
+
+    private
+
+    def validate_config!
+      result = Contracts::Config.new.call(api_key: api_key, debug: debug)
+      raise ValidationError, result.errors.to_h unless result.success?
+    end
+
+    def make_request(method, path, params = {})
+      log "=== Request Details ==="
+      log "Method: #{method.upcase}"
+      log "Path: #{path}"
+      log "Headers: #{@http_client.headers.inspect}"
+      log "Params: #{params.inspect}"
+
+      response = case method
+      when :get, :delete
+        query = URI.encode_www_form(params)
+        full_url = "#{path}?#{query}"
+        log "Full URL: #{full_url}"
+        @http_client.public_send(method, full_url)
+      else
+        @http_client.public_send(method, path, params)
+      end
+
+      log "=== Response Details ==="
+      log "Status: #{response.status}"
+      log "Headers: #{response.headers.inspect}"
+      log "Body: #{response.body.inspect}"
+
+      handle_response(response)
+    rescue Faraday::Error => e
+      log "=== Network Error ==="
+      log "Error class: #{e.class}"
+      log "Error message: #{e.message}"
+      log "Backtrace:"
+      e.backtrace.each { |line| log "  #{line}" }
+      raise NetworkError, "Network error: #{e.message} (#{e.class})"
+    end
+
+    def handle_response(response)
+      data = response.body
+
+      unless response.success?
+        error_code = case response.status
+        when 401 then "INVALID_API_KEY"
+        when 403 then "FORBIDDEN"
+        when 404 then "NOT_FOUND"
+        when 429 then "RATE_LIMITED"
+        else "API_ERROR"
+        end
+
+        error_msg = if data.is_a?(Hash)
+          data["error"] || data["message"] || "Unknown API error"
+        else
+          "Invalid response format: #{data.inspect}"
+        end
+
+        log "=== Error Response ==="
+        log "Status code: #{response.status}"
+        log "Error code: #{error_code}"
+        log "Error message: #{error_msg}"
+        
+        case error_code
+        when "NOT_FOUND"
+          raise NotFoundError, error_msg
+        when "INVALID_API_KEY"
+          raise InvalidAPIKeyError, error_msg
+        when "FORBIDDEN"
+          raise InvalidAPIKeyError, "Invalid or missing API key"
+        when "RATE_LIMITED"
+          raise APIError.new("Rate limit exceeded", error_code)
+        else
+          raise APIError.new(error_msg, error_code)
+        end
+      end
+
+      data
+    end
+
+    def log(message)
+      @logger&.debug("[Sendrly] #{message}")
+    end
+
+    def config_for_log
+      { api_key: "#{api_key[0..5]}...#{api_key[-5..]}", debug: debug }
+    end
+  end
+end 

data/lib/sendrly/contracts.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "dry/validation"
+
+module Sendrly
+  module Contracts
+    class Config < Dry::Validation::Contract
+      params do
+        required(:api_key).filled(:string)
+        optional(:debug).filled(:bool)
+      end
+
+      rule(:api_key) do
+        key.failure("must not be empty") if value.strip.empty?
+      end
+
+      def self.call(params)
+        new.call(params)
+      end
+    end
+
+    class Email < Dry::Validation::Contract
+      EMAIL_REGEX = /\A[^@\s]+@[^@\s]+\.[^@\s]+\z/
+
+      params do
+        required(:email).filled(:string)
+      end
+
+      rule(:email) do
+        key.failure("must be a valid email address") unless EMAIL_REGEX.match?(value)
+      end
+
+      def self.call(params)
+        new.call(params)
+      end
+    end
+
+    class EventName < Dry::Validation::Contract
+      params do
+        required(:event).filled(:string)
+      end
+
+      rule(:event) do
+        key.failure("must not be empty") if value.strip.empty?
+        key.failure("must be a valid event name (e.g., 'category.event')") unless value.include?(".")
+      end
+
+      def self.call(params)
+        new.call(params)
+      end
+    end
+
+    class EventPayload < Dry::Validation::Contract
+      EMAIL_REGEX = /\A[^@\s]+@[^@\s]+\.[^@\s]+\z/
+
+      ALLOWED_PROPERTY_TYPES = [
+        String,
+        Integer,
+        Float,
+        TrueClass,
+        FalseClass,
+        NilClass
+      ].freeze
+
+      params do
+        required(:email).filled(:string)
+        required(:event).filled(:string)
+        optional(:marketing_opt_out).filled(:bool)
+        optional(:contact_properties).maybe(:hash)
+        optional(:event_properties).maybe(:hash)
+      end
+
+      rule(:email) do
+        key.failure("must be a valid email address") unless EMAIL_REGEX.match?(value)
+      end
+
+      rule(:event) do
+        key.failure("must not be empty") if value.strip.empty?
+        key.failure("must be a valid event name (e.g., 'category.event')") unless value.include?(".")
+      end
+
+      rule(:contact_properties) do
+        if value && !value.empty?
+          validate_properties(key, value, "contact_properties")
+        end
+      end
+
+      rule(:event_properties) do
+        if value && !value.empty?
+          validate_properties(key, value, "event_properties")
+        end
+      end
+
+      def self.call(params)
+        params = {
+          marketing_opt_out: false,
+          contact_properties: {},
+          event_properties: {}
+        }.merge(params)
+        new.call(params)
+      end
+
+      private
+
+      def validate_properties(key, value, field_name)
+        unless value.is_a?(Hash)
+          key.failure("#{field_name} must be a hash")
+          return
+        end
+
+        value.each do |prop_key, prop_value|
+          # Check key format
+          unless prop_key.is_a?(String) || prop_key.is_a?(Symbol)
+            key.failure("#{field_name} keys must be strings or symbols, got #{prop_key.class} for '#{prop_key}'")
+            next
+          end
+
+          # Check value type
+          unless ALLOWED_PROPERTY_TYPES.any? { |type| prop_value.is_a?(type) }
+            key.failure(
+              "#{field_name}['#{prop_key}'] has invalid type: #{prop_value.class}. " \
+              "Allowed types are: #{ALLOWED_PROPERTY_TYPES.map(&:name).join(', ')}"
+            )
+            next
+          end
+
+          # Additional validation for strings and numbers
+          case prop_value
+          when String
+            if prop_value.length > 1000
+              key.failure("#{field_name}['#{prop_key}'] string is too long (max 1000 characters)")
+            end
+          when Integer, Float
+            if prop_value.abs > 1e15
+              key.failure("#{field_name}['#{prop_key}'] number is too large (max 1e15)")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sendrly/errors.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Sendrly
+  class Error < StandardError; end
+
+  class ValidationError < Error
+    attr_reader :errors
+
+    def initialize(errors)
+      @errors = errors
+      super("Validation failed: #{errors}")
+    end
+  end
+
+  class APIError < Error
+    attr_reader :code
+
+    def initialize(message, code)
+      @code = code
+      super(message)
+    end
+  end
+
+  class NetworkError < Error; end
+
+  class NotFoundError < Error
+    def code
+      "NOT_FOUND"
+    end
+  end
+
+  class InvalidAPIKeyError < Error
+    def code
+      "INVALID_API_KEY"
+    end
+  end
+end 

data/lib/sendrly/version.rb

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

data/lib/sendrly.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require_relative "sendrly/errors"
+require_relative "sendrly/contracts"
+require_relative "sendrly/client"
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+module Sendrly
+  def self.new(api_key:, debug: false)
+    Client.new(api_key: api_key, debug: debug)
+  end
+end 

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: sendrly
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sendrly Team
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2025-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Official Ruby SDK for Sendrly - Simple, type-safe email automation for
+  developers
+email:
+- team@sendrly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sendrly.rb
+- lib/sendrly/client.rb
+- lib/sendrly/contracts.rb
+- lib/sendrly/errors.rb
+- lib/sendrly/version.rb
+homepage: https://github.com/Sendrly/sendrly-sdk-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/Sendrly/sendrly-sdk-ruby/issues
+  changelog_uri: https://github.com/Sendrly/sendrly-sdk-ruby/blob/main/CHANGELOG.md
+  documentation_uri: https://github.com/Sendrly/sendrly-sdk-ruby#readme
+  homepage_uri: https://github.com/Sendrly/sendrly-sdk-ruby
+  source_code_uri: https://github.com/Sendrly/sendrly-sdk-ruby
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: Official Sendrly SDK - Simple, type-safe email automation for developers
+test_files: []