laneful-ruby 1.1.0 → 1.2.0

data/README.md

@@ -1,343 +0,0 @@
-# Laneful Ruby SDK
-
-A modern Ruby client library for the Laneful email API with support for sending emails, templates, tracking, and webhooks.
-
-## Requirements
-
-- Ruby 3.0 or higher
-- Bundler (for dependency management)
-
-## Installation
-
-### Using Bundler
-
-Add the following to your `Gemfile`:
-
-```ruby
-gem 'laneful-ruby'
-```
-
-Then run:
-
-```bash
-bundle install
-```
-
-### Manual Installation
-
-```bash
-git clone https://github.com/lanefulhq/laneful-ruby.git
-cd laneful-ruby
-bundle install
-bundle exec rake install
-```
-
-## Quick Start
-
-```ruby
-require 'laneful'
-
-# Create client
-client = Laneful::Client.new(
-  'https://your-endpoint.send.laneful.net',
-  'your-auth-token'
-)
-
-# Create email
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com', 'Your Name'))
-  .to(Laneful::Address.new('recipient@example.com', 'Recipient Name'))
-  .subject('Hello from Laneful Ruby SDK!')
-  .text_content('This is a simple test email.')
-  .build
-
-# Send email
-response = client.send_email(email)
-puts "Email sent successfully!"
-```
-
-## Features
-
-- Send single or multiple emails
-- Plain text and HTML content
-- Email templates with dynamic data
-- File attachments
-- Email tracking (opens, clicks, unsubscribes)
-- Custom headers and reply-to addresses
-- Scheduled sending
-- Webhook signature verification
-- Comprehensive error handling
-- Modern Ruby 3.0+ features
-
-## Examples
-
-### Simple Text Email
-
-```ruby
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com'))
-  .to(Laneful::Address.new('user@example.com'))
-  .subject('Simple Email')
-  .text_content('This is a simple text email.')
-  .build
-
-response = client.send_email(email)
-```
-
-### HTML Email with Tracking
-
-```ruby
-tracking = Laneful::TrackingSettings.new(opens: true, clicks: true, unsubscribes: false)
-
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com'))
-  .to(Laneful::Address.new('user@example.com'))
-  .subject('HTML Email with Tracking')
-  .html_content('<h1>Welcome!</h1><p>This is an <strong>HTML email</strong> with tracking enabled.</p>')
-  .text_content('Welcome! This is an HTML email with tracking enabled.')
-  .tracking(tracking)
-  .build
-
-response = client.send_email(email)
-```
-
-### Template Email
-
-```ruby
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com'))
-  .to(Laneful::Address.new('user@example.com'))
-  .template_id('welcome-template')
-  .template_data({
-    'name' => 'John Doe',
-    'company' => 'Acme Corp'
-  })
-  .build
-
-response = client.send_email(email)
-```
-
-### Email with Attachments
-
-```ruby
-# Create attachment from file
-attachment = Laneful::Attachment.from_file('/path/to/document.pdf')
-
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com'))
-  .to(Laneful::Address.new('user@example.com'))
-  .subject('Document Attached')
-  .text_content('Please find the document attached.')
-  .attachment(attachment)
-  .build
-
-response = client.send_email(email)
-```
-
-### Multiple Recipients
-
-```ruby
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com'))
-  .to(Laneful::Address.new('user1@example.com'))
-  .to(Laneful::Address.new('user2@example.com', 'User Two'))
-  .cc(Laneful::Address.new('cc@example.com'))
-  .bcc(Laneful::Address.new('bcc@example.com'))
-  .subject('Multiple Recipients')
-  .text_content('This email has multiple recipients.')
-  .build
-
-response = client.send_email(email)
-```
-
-### Scheduled Email
-
-```ruby
-# Schedule for 24 hours from now
-send_time = Time.now.to_i + (24 * 60 * 60)
-
-email = Laneful::Email::Builder.new
-  .from(Laneful::Address.new('sender@example.com'))
-  .to(Laneful::Address.new('user@example.com'))
-  .subject('Scheduled Email')
-  .text_content('This email was scheduled.')
-  .send_time(send_time)
-  .build
-
-response = client.send_email(email)
-```
-
-### Multiple Emails
-
-```ruby
-emails = [
-  Laneful::Email::Builder.new
-    .from(Laneful::Address.new('sender@example.com'))
-    .to(Laneful::Address.new('user1@example.com'))
-    .subject('Email 1')
-    .text_content('First email content.')
-    .build,
-  Laneful::Email::Builder.new
-    .from(Laneful::Address.new('sender@example.com'))
-    .to(Laneful::Address.new('user2@example.com'))
-    .subject('Email 2')
-    .text_content('Second email content.')
-    .build
-]
-
-response = client.send_emails(emails)
-```
-
-### Custom Timeout
-
-```ruby
-client = Laneful::Client.new(
-  'https://your-endpoint.send.laneful.net',
-  'your-auth-token',
-  timeout: 60  # 60 second timeout
-)
-```
-
-## Webhook Verification
-
-```ruby
-# In your webhook handler
-payload = request.body.read
-signature = request.headers['x-webhook-signature']
-secret = 'your-webhook-secret'
-
-if Laneful::WebhookVerifier.verify_signature(secret, payload, signature)
-  # Process webhook data
-  data = JSON.parse(payload)
-  # Handle webhook event
-else
-  # Invalid signature
-  head :unauthorized
-end
-```
-
-## Error Handling
-
-```ruby
-begin
-  response = client.send_email(email)
-  puts "Email sent successfully"
-rescue Laneful::ValidationException => e
-  puts "Validation error: #{e.message}"
-rescue Laneful::ApiException => e
-  puts "API error: #{e.message}"
-  puts "Status code: #{e.status_code}"
-  puts "Error message: #{e.error_message}"
-rescue Laneful::HttpException => e
-  puts "HTTP error: #{e.message}"
-  puts "Status code: #{e.status_code}"
-rescue StandardError => e
-  puts "Unexpected error: #{e.message}"
-end
-```
-
-## API Reference
-
-### Laneful::Client
-
-#### Constructor
-
-```ruby
-Laneful::Client.new(base_url, auth_token, timeout: 30)
-```
-
-- `base_url` - The base URL of the Laneful API
-- `auth_token` - The authentication token
-- `timeout` - Request timeout in seconds (optional, default: 30)
-
-#### Methods
-
-- `send_email(email)` - Sends a single email
-- `send_emails(emails)` - Sends multiple emails
-
-### Laneful::Email::Builder
-
-#### Required Fields
-
-- `from(address)` - Sender address
-
-#### Optional Fields
-
-- `to(address)` - Recipient addresses
-- `cc(address)` - CC addresses
-- `bcc(address)` - BCC addresses
-- `subject(subject)` - Email subject
-- `text_content(content)` - Plain text content
-- `html_content(content)` - HTML content
-- `template_id(id)` - Template ID
-- `template_data(data)` - Template data
-- `attachment(attachment)` - File attachments
-- `headers(headers)` - Custom headers
-- `reply_to(address)` - Reply-to address
-- `send_time(time)` - Scheduled send time (Unix timestamp)
-- `webhook_data(data)` - Webhook data
-- `tag(tag)` - Email tag
-- `tracking(tracking)` - Tracking settings
-
-### Laneful::Address
-
-```ruby
-Laneful::Address.new(email, name = nil)
-```
-
-- `email` - The email address (required)
-- `name` - The display name (optional)
-
-### Laneful::Attachment
-
-```ruby
-# From file
-Laneful::Attachment.from_file(file_path)
-
-# From raw data
-Laneful::Attachment.new(filename, content_type, content)
-```
-
-### Laneful::TrackingSettings
-
-```ruby
-Laneful::TrackingSettings.new(opens: false, clicks: false, unsubscribes: false)
-```
-
-### Laneful::WebhookVerifier
-
-```ruby
-Laneful::WebhookVerifier.verify_signature(secret, payload, signature)
-```
-
-## Exception Types
-
-- `Laneful::ValidationException` - Thrown when input validation fails
-- `Laneful::ApiException` - Thrown when the API returns an error response
-- `Laneful::HttpException` - Thrown when HTTP communication fails
-- `Laneful::LanefulException` - Base exception class for all SDK exceptions
-
-## Development
-
-### Running Tests
-
-```bash
-bundle exec rspec
-```
-
-### Code Quality
-
-```bash
-bundle exec rubocop
-```
-
-### Documentation
-
-```bash
-bundle exec yard doc
-```
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/examples/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gem 'laneful-ruby'

data/examples/simple_example.rb

@@ -1,123 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'laneful'
-
-# Simple example demonstrating basic usage of the Laneful Ruby SDK
-puts '📧 Laneful Ruby SDK - Simple Example'
-puts "====================================\n"
-
-# Configuration - Replace with your actual credentials
-base_url = 'https://your-subdomain.z1.send.dev.laneful.net'
-auth_token = 'priv-YourAuthTokenHere'
-
-# Email addresses - Replace with your actual addresses
-sender_email = 'sender@yourdomain.com'
-sender_name = 'Your Name'
-recipient_email = 'recipient@example.com'
-recipient_name = 'Recipient Name'
-cc_email = 'cc@example.com'
-cc_name = 'CC Recipient'
-
-# Create client
-begin
-  client = Laneful::Client.new(base_url, auth_token)
-  puts '✅ Client created successfully'
-rescue Laneful::ValidationException => e
-  puts "❌ Failed to create client: #{e.message}"
-  puts 'Please check your base_url and auth_token configuration.'
-  exit 1
-end
-
-# Test 1: Send a simple text email
-puts "\n📝 Test 1: Sending Simple Text Email"
-puts '------------------------------------'
-
-begin
-  email = Laneful::Email::Builder.new
-                                 .from(Laneful::Address.new(sender_email, sender_name))
-                                 .to(Laneful::Address.new(recipient_email, recipient_name))
-                                 .subject('Hello from Laneful Ruby SDK! 🚀')
-                                 .text_content('Hi! This is a test email sent using the Laneful Ruby SDK. ' \
-                                               'The SDK is working perfectly!')
-                                 .tag('ruby-sdk-test')
-                                 .build
-
-  response = client.send_email(email)
-  puts '✅ Simple email sent successfully!'
-  puts "Response: #{response}"
-rescue Laneful::ValidationException => e
-  puts "❌ Validation error: #{e.message}"
-rescue Laneful::ApiException => e
-  puts "❌ API error: #{e.message} (Status: #{e.status_code})"
-  puts "   Details: #{e.error_message}" if e.error_message
-rescue Laneful::HttpException => e
-  puts "❌ HTTP error: #{e.message} (Status: #{e.status_code})"
-end
-
-# Test 2: Send an HTML email with CC
-puts "\n🎨 Test 2: Sending HTML Email with CC"
-puts '-------------------------------------'
-
-begin
-  tracking = Laneful::TrackingSettings.new(opens: true, clicks: true, unsubscribes: false)
-
-  email = Laneful::Email::Builder.new
-                                 .from(Laneful::Address.new(sender_email, sender_name))
-                                 .to(Laneful::Address.new(recipient_email, recipient_name))
-                                 .cc(Laneful::Address.new(cc_email, cc_name))
-                                 .subject('Ruby SDK Test - HTML Email with Tracking 📧')
-                                 .html_content(<<~HTML)
-                                   <!DOCTYPE html>
-                                   <html>
-                                   <head>
-                                       <title>Ruby SDK Test</title>
-                                   </head>
-                                   <body style="font-family: Arial, sans-serif; max-width: 600px; margin: 0 auto; padding: 20px;">
-                                       <h1 style="color: #2c3e50;">🎉 Ruby SDK Test Successful!</h1>
-                                       <p>Hello! This email was sent using the <strong>Laneful Ruby SDK</strong> with modern Ruby features:</p>
-                                       <ul style="background-color: #f8f9fa; padding: 15px; border-radius: 5px;">
-                                           <li>✅ Frozen string literals for immutability</li>
-                                           <li>✅ Keyword arguments for clean APIs</li>
-                                           <li>✅ Safe navigation operator (&.)</li>
-                                           <li>✅ Enhanced exception handling</li>
-                                           <li>✅ Modern Ruby syntax throughout</li>
-                                       </ul>
-                                       <p style="color: #7f8c8d;">This email has tracking enabled for opens and clicks.</p>
-                                       <hr style="border: none; border-top: 1px solid #eee; margin: 20px 0;">
-                                       <p style="font-size: 12px; color: #95a5a6;">
-                                           Sent from: #{sender_email}<br>
-                                           To: #{recipient_email}<br>
-                                           CC: #{cc_email}
-                                       </p>
-                                   </body>
-                                   </html>
-                                 HTML
-                                 .text_content('Ruby SDK Test Successful! Hello! This email was sent using ' \
-                                               'the Laneful Ruby SDK with modern Ruby features including ' \
-                                               'frozen string literals, keyword arguments, safe navigation ' \
-                                               'operator, and enhanced exception handling. This email has ' \
-                                               'tracking enabled for opens and clicks.')
-                                 .tracking(tracking)
-                                 .tag('html-cc-test')
-                                 .build
-
-  response = client.send_email(email)
-  puts '✅ HTML email with CC sent successfully!'
-  puts "Response: #{response}"
-rescue Laneful::ValidationException => e
-  puts "❌ Validation error: #{e.message}"
-rescue Laneful::ApiException => e
-  puts "❌ API error: #{e.message} (Status: #{e.status_code})"
-  puts "   Details: #{e.error_message}" if e.error_message
-rescue Laneful::HttpException => e
-  puts "❌ HTTP error: #{e.message} (Status: #{e.status_code})"
-end
-
-puts "\n🎉 Tests completed!"
-puts "\n📋 Summary:"
-puts '   • Ruby SDK is working correctly'
-puts '   • Real API endpoint is accessible'
-puts '   • Email building and sending functionality is operational'
-puts '   • Error handling is working properly'
-puts "\n💡 Check your email inboxes for the test emails!"

data/laneful-ruby.gemspec

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'lib/laneful/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'laneful-ruby'
-  spec.version       = Laneful::VERSION
-  spec.authors       = ['Laneful Team']
-  spec.email         = ['support@laneful.com']
-
-  spec.summary       = 'Ruby SDK for the Laneful email API'
-  spec.description   = 'A modern Ruby client library for the Laneful email API, ' \
-                       'providing easy integration for email sending, webhooks, and analytics.'
-  spec.homepage      = 'https://github.com/laneful/laneful-ruby'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 3.0.0'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/laneful/laneful-ruby'
-  spec.metadata['changelog_uri'] = 'https://github.com/laneful/laneful-ruby/blob/main/CHANGELOG.md'
-  spec.metadata['documentation_uri'] = 'https://docs.laneful.com/ruby'
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # Specify which files should be added to the gem when it is released.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
-    end
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  # Dependencies
-  spec.add_dependency 'httparty', '~> 0.21'
-  spec.add_dependency 'json', '~> 2.6'
-end

data/scripts/publish.sh

@@ -1,169 +0,0 @@
-#!/bin/bash
-
-# Laneful Ruby SDK Publishing Script
-# This script handles the complete publishing workflow to RubyGems
-
-set -e
-
-# Colors for output
-RED='\033[0;31m'
-GREEN='\033[0;32m'
-YELLOW='\033[1;33m'
-BLUE='\033[0;34m'
-NC='\033[0m' # No Color
-
-# Function to print colored output
-print_status() {
-    echo -e "${BLUE}[INFO]${NC} $1"
-}
-
-print_success() {
-    echo -e "${GREEN}[SUCCESS]${NC} $1"
-}
-
-print_warning() {
-    echo -e "${YELLOW}[WARNING]${NC} $1"
-}
-
-print_error() {
-    echo -e "${RED}[ERROR]${NC} $1"
-}
-
-# Check if required environment variables are set
-check_environment() {
-    print_status "Checking environment variables..."
-    
-    if [ -z "$GEM_HOST_API_KEY" ]; then
-        print_error "GEM_HOST_API_KEY environment variable is not set"
-        print_status "Please set your RubyGems API key:"
-        print_status "export GEM_HOST_API_KEY=your_api_key_here"
-        exit 1
-    fi
-    
-    print_success "Environment variables are set"
-}
-
-# Check if we're in the right directory
-check_directory() {
-    if [ ! -f "laneful-ruby.gemspec" ]; then
-        print_error "laneful-ruby.gemspec not found. Please run this script from the project root."
-        exit 1
-    fi
-    print_success "Found gemspec file"
-}
-
-# Check Ruby version
-check_ruby_version() {
-    print_status "Checking Ruby version..."
-    ruby_version=$(ruby -v | cut -d' ' -f2)
-    required_version="3.0.0"
-    
-    if [ "$(printf '%s\n' "$required_version" "$ruby_version" | sort -V | head -n1)" = "$required_version" ]; then
-        print_success "Ruby version $ruby_version is compatible"
-    else
-        print_error "Ruby version $ruby_version is not compatible. Required: $required_version or higher"
-        exit 1
-    fi
-}
-
-# Install dependencies
-install_dependencies() {
-    print_status "Installing dependencies..."
-    bundle install
-    if [ $? -eq 0 ]; then
-        print_success "Dependencies installed successfully"
-    else
-        print_error "Failed to install dependencies. Aborting publish."
-        exit 1
-    fi
-}
-
-# Run tests
-run_tests() {
-    print_status "Running tests..."
-    bundle exec rspec
-    if [ $? -eq 0 ]; then
-        print_success "All tests passed"
-    else
-        print_error "Tests failed. Aborting publish."
-        exit 1
-    fi
-}
-
-# Run linting
-run_lint() {
-    print_status "Running linter..."
-    bundle exec rubocop
-    if [ $? -eq 0 ]; then
-        print_success "Linting passed"
-    else
-        print_error "Linting failed. Aborting publish."
-        exit 1
-    fi
-}
-
-# Build the gem
-build_gem() {
-    print_status "Building gem..."
-    gem build laneful-ruby.gemspec
-    if [ $? -eq 0 ]; then
-        print_success "Gem built successfully"
-    else
-        print_error "Gem build failed. Aborting publish."
-        exit 1
-    fi
-}
-
-# Publish to RubyGems
-publish_gem() {
-    print_status "Publishing to RubyGems..."
-    gem push laneful-ruby-*.gem
-    if [ $? -eq 0 ]; then
-        print_success "Gem published successfully to RubyGems!"
-    else
-        print_error "Failed to publish gem to RubyGems."
-        exit 1
-    fi
-}
-
-# Clean up
-cleanup() {
-    print_status "Cleaning up..."
-    rm -f laneful-ruby-*.gem
-    print_success "Cleanup completed"
-}
-
-# Main execution
-main() {
-    print_status "Starting Laneful Ruby SDK publishing process..."
-    
-    check_environment
-    check_directory
-    check_ruby_version
-    install_dependencies
-    
-    # Ask for confirmation
-    echo
-    print_warning "This will publish the gem to RubyGems. Are you sure? (y/N)"
-    read -r response
-    if [[ ! "$response" =~ ^[Yy]$ ]]; then
-        print_status "Publishing cancelled."
-        exit 0
-    fi
-    
-    run_tests
-    run_lint
-    build_gem
-    publish_gem
-    cleanup
-    
-    print_success "Publishing process completed successfully!"
-    print_status "Your gem is now available on RubyGems: https://rubygems.org/gems/laneful-ruby"
-}
-
-# Handle script interruption
-trap cleanup EXIT
-
-# Run main function
-main "$@"
-