sevk 1.0.0 → 1.1.0

data/lib/sevk/webhook_verifier.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'json'
+require 'openssl'
+
+module Sevk
+  class WebhookVerificationError < StandardError; end
+
+  # Verifier for sevk webhook deliveries.
+  #
+  # sevk uses the Svix-compatible signature scheme (svix-id, svix-timestamp,
+  # svix-signature headers), so this helper or the official `svix` gem can be
+  # used. sevk issues canonical whsec_ base64 secrets that can be passed
+  # directly to either verifier.
+  class WebhookVerifier
+    TOLERANCE_SECONDS = 5 * 60
+
+    # Prepares a verifier with the signing secret issued for a webhook.
+    def initialize(secret)
+      raise WebhookVerificationError, 'Webhook secret is required' if secret.nil? || secret.empty?
+
+      @key = if secret.start_with?('whsec_')
+               begin
+                 decoded = Base64.strict_decode64(secret[6..])
+                 raise ArgumentError if decoded.empty?
+
+                 decoded
+               rescue ArgumentError
+                 raise WebhookVerificationError, 'Invalid base64 secret'
+               end
+             else
+               secret
+             end
+    end
+
+    # Verifies the delivery signature and timestamp, then parses its JSON payload.
+    def verify(payload, headers)
+      msg_id = lookup(headers, 'svix-id')
+      msg_timestamp = lookup(headers, 'svix-timestamp')
+      msg_signature = lookup(headers, 'svix-signature')
+
+      if msg_id.nil? || msg_id.empty? || msg_timestamp.nil? || msg_signature.nil?
+        raise WebhookVerificationError, 'Missing required svix headers'
+      end
+
+      raise WebhookVerificationError, 'Invalid timestamp header' unless msg_timestamp.match?(/\A[0-9]+\z/)
+
+      timestamp = Integer(msg_timestamp, 10)
+      now = Time.now.to_i
+      if timestamp < now - TOLERANCE_SECONDS || timestamp > now + TOLERANCE_SECONDS
+        raise WebhookVerificationError, 'Timestamp outside tolerance window'
+      end
+
+      to_sign = "#{msg_id}.#{msg_timestamp}.#{payload}"
+      digest = OpenSSL::HMAC.digest('SHA256', @key, to_sign)
+      expected = "v1,#{Base64.strict_encode64(digest)}"
+
+      msg_signature.split.each do |candidate|
+        next unless secure_compare(expected, candidate)
+
+        begin
+          return JSON.parse(payload)
+        rescue JSON::ParserError
+          raise WebhookVerificationError, 'Invalid JSON payload'
+        end
+      end
+
+      raise WebhookVerificationError, 'Signature mismatch'
+    rescue ArgumentError
+      raise WebhookVerificationError, 'Invalid timestamp header'
+    end
+
+    private
+
+    def lookup(headers, name)
+      headers.each do |key, value|
+        normalized = key.to_s.downcase.tr('_', '-').sub(/\Ahttp-/, '')
+        return value unless value.nil? || normalized != name
+      end
+
+      nil
+    end
+
+    def secure_compare(expected, candidate)
+      return false unless expected.bytesize == candidate.bytesize
+
+      OpenSSL.fixed_length_secure_compare(expected, candidate)
+    end
+  end
+end

data/lib/sevk.rb

@@ -1,28 +1,31 @@
 # frozen_string_literal: true
 
-require "faraday"
-require "faraday/retry"
-require "json"
-
-require_relative "sevk/version"
-require_relative "sevk/error"
-require_relative "sevk/client"
-require_relative "sevk/resources/base"
-require_relative "sevk/resources/contacts"
-require_relative "sevk/resources/audiences"
-require_relative "sevk/resources/templates"
-require_relative "sevk/resources/broadcasts"
-require_relative "sevk/resources/domains"
-require_relative "sevk/resources/topics"
-require_relative "sevk/resources/segments"
-require_relative "sevk/resources/subscriptions"
-require_relative "sevk/resources/emails"
-require_relative "sevk/resources/webhooks"
-require_relative "sevk/resources/events"
-require_relative "sevk/markup/renderer"
+require 'faraday'
+require 'json'
+
+require_relative 'sevk/version'
+require_relative 'sevk/error'
+require_relative 'sevk/client'
+require_relative 'sevk/resources/base'
+require_relative 'sevk/resources/contacts'
+require_relative 'sevk/resources/audiences'
+require_relative 'sevk/resources/templates'
+require_relative 'sevk/resources/broadcasts'
+require_relative 'sevk/resources/domains'
+require_relative 'sevk/resources/topics'
+require_relative 'sevk/resources/segments'
+require_relative 'sevk/resources/subscriptions'
+require_relative 'sevk/resources/emails'
+require_relative 'sevk/resources/webhooks'
+require_relative 'sevk/resources/activity'
+require_relative 'sevk/resources/inbound'
+require_relative 'sevk/resources/outbound'
+require_relative 'sevk/resources/usage'
+require_relative 'sevk/webhook_verifier'
+require_relative 'sevk/markup/renderer'
 
 module Sevk
-  DEFAULT_BASE_URL = "https://api.sevk.io"
+  DEFAULT_BASE_URL = 'https://api.sevk.io'
 
   class << self
     attr_accessor :api_key, :base_url
@@ -39,221 +42,4 @@ module Sevk
       @client = nil
     end
   end
-
-  # Class-based API
-  module Contacts
-    class << self
-      def list(params = {})
-        Sevk.client.contacts.list(**params)
-      end
-
-      def get(id)
-        Sevk.client.contacts.get(id)
-      end
-
-      def create(params)
-        Sevk.client.contacts.create(**params)
-      end
-
-      def update(id, params)
-        Sevk.client.contacts.update(id, **params)
-      end
-
-      def delete(id)
-        Sevk.client.contacts.delete(id)
-      end
-    end
-  end
-
-  module Audiences
-    class << self
-      def list(params = {})
-        Sevk.client.audiences.list(**params)
-      end
-
-      def get(id)
-        Sevk.client.audiences.get(id)
-      end
-
-      def create(params)
-        Sevk.client.audiences.create(**params)
-      end
-
-      def update(id, params)
-        Sevk.client.audiences.update(id, **params)
-      end
-
-      def delete(id)
-        Sevk.client.audiences.delete(id)
-      end
-
-      def add_contacts(id, contact_ids)
-        Sevk.client.audiences.add_contacts(id, contact_ids)
-      end
-    end
-  end
-
-  module Templates
-    class << self
-      def list(params = {})
-        Sevk.client.templates.list(**params)
-      end
-
-      def get(id)
-        Sevk.client.templates.get(id)
-      end
-
-      def create(params)
-        Sevk.client.templates.create(**params)
-      end
-
-      def update(id, params)
-        Sevk.client.templates.update(id, **params)
-      end
-
-      def delete(id)
-        Sevk.client.templates.delete(id)
-      end
-
-      def duplicate(id)
-        Sevk.client.templates.duplicate(id)
-      end
-    end
-  end
-
-  module Broadcasts
-    class << self
-      def list(params = {})
-        Sevk.client.broadcasts.list(**params)
-      end
-
-      def get(id)
-        Sevk.client.broadcasts.get(id)
-      end
-    end
-  end
-
-  module Domains
-    class << self
-      def list(params = {})
-        Sevk.client.domains.list(**params)
-      end
-
-      def get(id)
-        Sevk.client.domains.get(id)
-      end
-    end
-  end
-
-  module Topics
-    class << self
-      def list(audience_id, params = {})
-        Sevk.client.topics.list(audience_id, **params)
-      end
-
-      def get(audience_id, topic_id)
-        Sevk.client.topics.get(audience_id, topic_id)
-      end
-
-      def create(audience_id, params)
-        Sevk.client.topics.create(audience_id, **params)
-      end
-
-      def update(audience_id, topic_id, params)
-        Sevk.client.topics.update(audience_id, topic_id, **params)
-      end
-
-      def delete(audience_id, topic_id)
-        Sevk.client.topics.delete(audience_id, topic_id)
-      end
-    end
-  end
-
-  module Segments
-    class << self
-      def list(audience_id, params = {})
-        Sevk.client.segments.list(audience_id, **params)
-      end
-
-      def get(audience_id, segment_id)
-        Sevk.client.segments.get(audience_id, segment_id)
-      end
-
-      def create(audience_id, params)
-        Sevk.client.segments.create(audience_id, **params)
-      end
-
-      def update(audience_id, segment_id, params)
-        Sevk.client.segments.update(audience_id, segment_id, **params)
-      end
-
-      def delete(audience_id, segment_id)
-        Sevk.client.segments.delete(audience_id, segment_id)
-      end
-    end
-  end
-
-  module Subscriptions
-    class << self
-      def subscribe(params)
-        Sevk.client.subscriptions.subscribe(**params)
-      end
-
-      def unsubscribe(params)
-        Sevk.client.subscriptions.unsubscribe(**params)
-      end
-    end
-  end
-
-  module Emails
-    class << self
-      def send(params)
-        Sevk.client.emails.send(**params)
-      end
-    end
-  end
-
-  module Webhooks
-    class << self
-      def list(params = {})
-        Sevk.client.webhooks.list(**params)
-      end
-
-      def get(id)
-        Sevk.client.webhooks.get(id)
-      end
-
-      def create(params)
-        Sevk.client.webhooks.create(params)
-      end
-
-      def update(id, params)
-        Sevk.client.webhooks.update(id, params)
-      end
-
-      def delete(id)
-        Sevk.client.webhooks.delete(id)
-      end
-
-      def test(id)
-        Sevk.client.webhooks.test(id)
-      end
-
-      def list_events
-        Sevk.client.webhooks.list_events
-      end
-    end
-  end
-
-  module Events
-    class << self
-      def list(params = {})
-        Sevk.client.events.list(**params)
-      end
-
-      def stats
-        Sevk.client.events.stats
-      end
-    end
-  end
 end

metadata

@@ -1,30 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: sevk
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sevk
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: faraday
+  name: base64
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: faraday-retry
+  name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -37,20 +37,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -65,76 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-- !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: webmock
-  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: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Ruby SDK for interacting with the Sevk API. Send emails, manage contacts,
   audiences, templates, and more.
 email:
@@ -143,33 +59,44 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
-- Rakefile
 - lib/sevk.rb
 - lib/sevk/client.rb
 - lib/sevk/error.rb
+- lib/sevk/markup/document_parser.rb
+- lib/sevk/markup/html_document.rb
+- lib/sevk/markup/number_formatting.rb
+- lib/sevk/markup/render_limits.rb
 - lib/sevk/markup/renderer.rb
+- lib/sevk/markup/style_helpers.rb
+- lib/sevk/markup/syntax_highlighting.rb
+- lib/sevk/markup/tag_scanner.rb
+- lib/sevk/markup/template_engine.rb
+- lib/sevk/resources/activity.rb
 - lib/sevk/resources/audiences.rb
 - lib/sevk/resources/base.rb
 - lib/sevk/resources/broadcasts.rb
 - lib/sevk/resources/contacts.rb
 - lib/sevk/resources/domains.rb
 - lib/sevk/resources/emails.rb
-- lib/sevk/resources/events.rb
+- lib/sevk/resources/inbound.rb
+- lib/sevk/resources/outbound.rb
 - lib/sevk/resources/segments.rb
 - lib/sevk/resources/subscriptions.rb
 - lib/sevk/resources/templates.rb
 - lib/sevk/resources/topics.rb
+- lib/sevk/resources/usage.rb
 - lib/sevk/resources/webhooks.rb
 - lib/sevk/version.rb
-- sevk.gemspec
+- lib/sevk/webhook_verifier.rb
 homepage: https://sevk.io
 licenses:
 - MIT
 metadata:
   homepage_uri: https://sevk.io
   source_code_uri: https://github.com/sevk-io/sevk-ruby
-  changelog_uri: https://github.com/sevk-io/sevk-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib

data/Rakefile

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
-
-desc "Update all dependencies to latest versions"
-task :update do
-  sh "bundle update"
-end
-
-desc "Update dependencies and show outdated gems"
-task :outdated do
-  sh "bundle outdated"
-end
-
-desc "Run tests"
-task :test => :spec
-
-desc "Build the gem"
-task :build do
-  sh "gem build sevk.gemspec"
-end
-
-desc "Install the gem locally"
-task :install => :build do
-  sh "gem install sevk-*.gem"
-end
-
-desc "Release the gem to RubyGems"
-task :release => :build do
-  sh "gem push sevk-*.gem"
-end
-
-desc "Clean up build artifacts"
-task :clean do
-  FileUtils.rm_f Dir.glob("sevk-*.gem")
-  FileUtils.rm_rf "pkg"
-end

data/lib/sevk/resources/events.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "base"
-
-module Sevk
-  module Resources
-    class Events < Base
-      def list(page: nil, limit: nil, type: nil, contact_id: nil)
-        params = { page: page, limit: limit, type: type, contact_id: contact_id }
-        client.get("/events#{build_query_string(params)}")
-      end
-
-      def stats
-        client.get("/events/stats")
-      end
-    end
-  end
-end

data/sevk.gemspec

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/sevk/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "sevk"
-  spec.version       = Sevk::VERSION
-  spec.authors       = ["Sevk"]
-  spec.email         = ["dev@sevk.io"]
-
-  spec.summary       = "Ruby SDK for Sevk API"
-  spec.description   = "Ruby SDK for interacting with the Sevk API. Send emails, manage contacts, audiences, templates, and more."
-  spec.homepage      = "https://sevk.io"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/sevk-io/sevk-ruby"
-  spec.metadata["changelog_uri"] = "https://github.com/sevk-io/sevk-ruby/blob/main/CHANGELOG.md"
-
-  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 .github appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "faraday", "~> 2.0"
-  spec.add_dependency "faraday-retry", "~> 2.0"
-  spec.add_dependency "nokogiri", "~> 1.15"
-  spec.add_dependency "rouge", "~> 4.0"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.0"
-end