hooksniff 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 441fb04faed964e0da0b8827caa0f3f13bd50ff3eec641a928524cecda99d56f
-  data.tar.gz: 937d0f461fb8f52c3dec0a69b0849b8d603719ff883c7ec11ed72ca0bb0dac63
+  metadata.gz: a947ca7c8c9c75d2aac6b59f30cd1e0c7f6096aee40816fb16bba954ff60570b
+  data.tar.gz: da3d3b65337ff775633efc6ce7797cdd23033a3f2b1b9cfb5bdc3096b485f4e1
 SHA512:
-  metadata.gz: 6fb0d72135f9c5e271ef0f9cfc2aec85818fdc164f945b80fb64415196f9b6142408559ea9c3c19a3d1ec6d152f2eaaf691d99446dbb8b7b9b9f38961931b63a
-  data.tar.gz: 3aa6ffb82540a1352671673422fc7751bf47037d262b3e515cbcd5579bc4d027628ef0143834d8c01ad12f8052175391ba5e7591ff8ae38f5577884c7dd96540
+  metadata.gz: f609bcef3b51f1fee6540b705bb9191f54b7cc3c681346a08b1482d1aeef0a52e661f0b26f6e432f30995bbff1b54ae043c775b42938c25975da4fcfe36ac3f8
+  data.tar.gz: a3c6d7bf7516cf4e41fdb531af663d8036056210e853a54c46674e2a56f60a41523b7f53ac06bd4c1e226711c0143281d8f276a89e39820447757b1b2275998a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    svix (1.93.0)
+    hooksniff (1.2.0)
       base64 (~> 0.3.0)
       logger (~> 1.0)
 
@@ -45,11 +45,11 @@ PLATFORMS
 
 DEPENDENCIES
   base64
+  hooksniff!
   logger
   ostruct
   rake (~> 13.0)
   rspec (~> 3.2)
-  svix!
   webmock (~> 3.25)
 
 BUNDLED WITH

data/README.md

@@ -1,14 +1,18 @@
 # HookSniff Ruby SDK
 
 <p align="center">
-  <a href="https://github.com/servetarslan02/HookSniff"><img src="https://img.shields.io/github/license/servetarslan02/HookSniff" alt="License"></a>
-  <a href="https://rubygems.org/gems/hooksniff"><img src="https://img.shields.io/gems/v/hooksniff" alt="Gem"></a>
+  <a href="https://rubygems.org/gems/hooksniff"><img src="https://img.shields.io/gem/v/hooksniff.svg" alt="Gem"></a>
+  <a href="https://github.com/servetarslan02/hooksniff-ruby"><img src="https://img.shields.io/github/license/servetarslan02/hooksniff-ruby" alt="License"></a>
 </p>
 
-Ruby SDK for the [HookSniff](https://hooksniff.com) webhook delivery platform.
+Ruby SDK for the [HookSniff](https://hooksniff.vercel.app) webhook delivery platform.
 
 ## Installation
 
+```ruby
+gem 'hooksniff'
+```
+
 ```bash
 gem install hooksniff
 ```
@@ -16,61 +20,53 @@ gem install hooksniff
 ## Quick Start
 
 ```ruby
-require "hooksniff"
+require 'hooksniff'
 
-client = HookSniff::Client.new("hs_xxx")
+hs = HookSniff::Client.new('hooksniff_xxx')
 
 # List endpoints
-endpoints = client.endpoint.list
+endpoints = hs.endpoints.list
 
-# Create a message
-msg = client.message.create(event_type: "order.created", payload: { order_id: "123" })
+# Send a webhook
+delivery = hs.messages.create(
+  endpoint_id: 'ep_xxx',
+  event: 'order.created',
+  data: { order_id: '123', amount: 99.99 }
+)
+```
+
+## Webhook Verification
 
-# Verify webhook signature
-wh = HookSniff::Webhook.new("whsec_xxx")
+```ruby
+wh = HookSniff::Webhook.new('whsec_xxx')
 payload = wh.verify(body, headers)
 ```
 
-## Resources (30+)
-
-| Resource | Description |
-|----------|-------------|
-| **Endpoint** | CRUD, secret rotation, headers |
-| **Message** | Create, list, get |
-| **MessageAttempt** | List by endpoint/msg, get, resend |
-| **Authentication** | Logout |
-| **EventType** | CRUD |
-| **Statistics** | Aggregate stats |
-| **Health** | API health check |
-| **Environment** | Environment & variable management (Faz 8) |
-| **BackgroundTask** | List, get, cancel (Faz 9) |
-| **OperationalWebhook** | Endpoint & delivery management (Faz 10) |
-| **MessagePoller** | Poll, seek, commit (Faz 11) |
-| **Inbound** | Inbound webhook configs (Faz 12) |
-| **Connector** | Connector & config management (Faz 13) |
-| **Integration** | CRUD, test, events, stats (Faz 14) |
-| **Stream** | Channels, subscriptions, publish (Faz 15) |
-| **Application** | Application management |
-| **ApiKey** | API key CRUD, rotate |
-| **Search** | Full-text delivery search |
-| **Alert** | Alert rule CRUD, test |
-| **Analytics** | Delivery trends, success rate, latency |
-| **Billing** | Subscription, usage, invoices, portal |
-| **Portal** | Profile, plan, notifications |
-| **Team** | Teams, invites, members, roles |
-| **Notification** | List, read, unread count |
-| **Sso** | SSO config management |
-| **AuditLog** | Audit entry listing |
-| **CustomDomain** | Domain management, verification |
-| **RateLimit** | Per-endpoint rate limits |
-| **Routing** | Routing rules, endpoint health |
-| **Template** | Template listing, apply |
-| **Schema** | Schema registry, validation |
-| **Playground** | Test webhooks |
-| **ServiceToken** | Service token management |
-
-## Links
-
-- [Documentation](https://docs.hooksniff.com)
-- [API Reference](https://api.hooksniff.com)
-- [GitHub](https://github.com/servetarslan02/HookSniff)
+## API Resources
+
+| Resource | Methods |
+|----------|---------|
+| Endpoints | list, create, get, update, delete, rotate_secret |
+| Messages | create, list, get |
+| MessageAttempts | list, get, resend, list_by_msg |
+| EventTypes | list, create, get, update, delete |
+| Stream | list_channels, get_channel, create_channel, subscribe, publish |
+| Authentication | login, register, logout |
+| BackgroundTasks | list, get |
+| Connectors | list, get |
+| Integrations | list, get, create, update, delete |
+| Inbound | list, create, get, delete |
+
+## Features
+
+- ✅ HMAC-SHA256 webhook verification
+- ✅ Typed webhook events
+- ✅ Automatic retry with exponential backoff
+- ✅ Pagination helpers
+- ✅ Rate limit header parsing
+- ✅ SSE streaming
+- ✅ Idempotency keys
+
+## License
+
+MIT

data/hooksniff.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name          = "hooksniff"
   spec.version       = HookSniff::VERSION
   spec.authors       = ["HookSniff"]
-  spec.email         = ["support@hooksniff.vercel.app"]
+  spec.email         = ["servetarslan02@gmail.com"]
   spec.license       = "MIT"
 
   spec.summary       = "HookSniff webhooks API client and webhook verification library"

data/lib/hooksniff/api/authentication.rb

@@ -8,19 +8,6 @@ module HookSniff
       @client = client
     end
 
-    def app_portal_access(app_id, app_portal_access_in, options = {})
-      options = options.transform_keys(&:to_s)
-      res = @client.execute_request(
-        "POST",
-        "/v1/auth/portal-access/#{app_id}",
-        headers: {
-          "idempotency-key" => options["idempotency-key"]
-        },
-        body: app_portal_access_in
-      )
-      DashboardAccessOut.deserialize(res)
-    end
-
     def logout(options = {})
       options = options.transform_keys(&:to_s)
       @client.execute_request(

data/lib/hooksniff/api/integration.rb

@@ -7,36 +7,36 @@ module HookSniff
     end
 
     def list
-      @client.request(:get, "/api/v1/integrations")
+      @client.request(:get, "/v1/integrations")
     end
 
     def get(id)
-      @client.request(:get, "/api/v1/integrations/#{id}")
+      @client.request(:get, "/v1/integrations/#{id}")
     end
 
     create_attrs = %i[name description connector_config_id endpoint_id event_filter transform_id retry_policy metadata enabled]
     def create(attrs)
-      @client.request(:post, "/api/v1/integrations", attrs)
+      @client.request(:post, "/v1/integrations", attrs)
     end
 
     def update(id, attrs)
-      @client.request(:put, "/api/v1/integrations/#{id}", attrs)
+      @client.request(:put, "/v1/integrations/#{id}", attrs)
     end
 
     def delete(id)
-      @client.request(:delete, "/api/v1/integrations/#{id}")
+      @client.request(:delete, "/v1/integrations/#{id}")
     end
 
     def test(id)
-      @client.request(:post, "/api/v1/integrations/#{id}/test")
+      @client.request(:post, "/v1/integrations/#{id}/test")
     end
 
     def list_events(id, params = {})
-      @client.request(:get, "/api/v1/integrations/#{id}/events", params)
+      @client.request(:get, "/v1/integrations/#{id}/events", params)
     end
 
     def get_stats(id)
-      @client.request(:get, "/api/v1/integrations/#{id}/stats")
+      @client.request(:get, "/v1/integrations/#{id}/stats")
     end
   end
 end

data/lib/hooksniff/api/statistics.rb

@@ -20,18 +20,5 @@ module HookSniff
       )
       AggregateEventTypesOut.deserialize(res)
     end
-
-    def app_stats(app_id, options = {})
-      options = options.transform_keys(&:to_s)
-      res = @client.execute_request(
-        "GET",
-        "/v1/stats/app/#{app_id}",
-        query_params: {
-          "since" => options["since"],
-          "until" => options["until"]
-        }
-      )
-      res
-    end
   end
 end

data/lib/hooksniff/api/stream.rb

@@ -7,39 +7,58 @@ module HookSniff
     end
 
     def list_channels
-      @client.request(:get, "/api/v1/stream/channels")
+      @client.request(:get, "/v1/stream/channels")
     end
 
     def get_channel(id)
-      @client.request(:get, "/api/v1/stream/channels/#{id}")
+      @client.request(:get, "/v1/stream/channels/#{id}")
     end
 
     def create_channel(attrs)
-      @client.request(:post, "/api/v1/stream/channels", attrs)
+      @client.request(:post, "/v1/stream/channels", attrs)
     end
 
     def update_channel(id, attrs)
-      @client.request(:put, "/api/v1/stream/channels/#{id}", attrs)
+      @client.request(:put, "/v1/stream/channels/#{id}", attrs)
     end
 
     def delete_channel(id)
-      @client.request(:delete, "/api/v1/stream/channels/#{id}")
+      @client.request(:delete, "/v1/stream/channels/#{id}")
     end
 
     def list_messages(id, params = {})
-      @client.request(:get, "/api/v1/stream/channels/#{id}/messages", params)
+      @client.request(:get, "/v1/stream/channels/#{id}/messages", params)
     end
 
     def list_subscriptions
-      @client.request(:get, "/api/v1/stream/subscriptions")
+      @client.request(:get, "/v1/stream/subscriptions")
     end
 
     def disconnect_subscription(id)
-      @client.request(:delete, "/api/v1/stream/subscriptions/#{id}")
+      @client.request(:delete, "/v1/stream/subscriptions/#{id}")
     end
 
     def publish(body)
-      @client.request(:post, "/api/v1/stream/publish", body)
+      @client.request(:post, "/v1/stream/publish", body)
     end
   end
 end
+
+    # Subscribe to real-time events via SSE
+    # @param channel_id [String] Channel ID to subscribe to
+    # @param block [Block] Callback for each event
+    # @return [void]
+    def subscribe(channel_id, &block)
+      @client.request_stream(:get, "/v1/stream/channels/#{channel_id}/subscribe") do |event|
+        block.call(event)
+      end
+    end
+
+    # Subscribe to delivery events (legacy SSE endpoint)
+    # @param block [Block] Callback for each event
+    # @return [void]
+    def subscribe_deliveries(&block)
+      @client.request_stream(:get, "/v1/stream/deliveries") do |event|
+        block.call(event)
+      end
+    end

data/lib/hooksniff/errors.rb

@@ -41,6 +41,13 @@ module HookSniff
     end
   end
 
+  # 408 Request Timeout
+  class RequestTimeoutError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 408, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
   # 409 Conflict
   class ConflictError < ApiError
     def initialize(response_headers: {}, response_body: nil)
@@ -48,6 +55,20 @@ module HookSniff
     end
   end
 
+  # 410 Gone
+  class GoneError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 410, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
+  # 413 Payload Too Large
+  class PayloadTooLargeError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 413, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
   # 422 Unprocessable Entity
   class UnprocessableEntityError < ApiError
     attr_reader :validation_errors
@@ -75,6 +96,13 @@ module HookSniff
     end
   end
 
+  # 501 Not Implemented
+  class NotImplementedError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 501, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
   # 502 Bad Gateway
   class BadGatewayError < ApiError
     def initialize(response_headers: {}, response_body: nil)
@@ -96,6 +124,45 @@ module HookSniff
     end
   end
 
+  # 507 Insufficient Storage
+  class InsufficientStorageError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 507, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
+  # 508 Loop Detected
+  class LoopDetectedError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 508, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
+  # Timeout — request exceeded the configured timeout
+  class TimeoutError < StandardError
+    attr_reader :code
+    def initialize(message = "Request timeout")
+      @code = 0
+      super(message)
+    end
+  end
+
+  # Network error — connection failed
+  class NetworkError < StandardError
+    attr_reader :code
+    def initialize(message = "Network error")
+      @code = 0
+      super(message)
+    end
+  end
+
+  # Authentication error — token invalid, expired, or missing
+  class AuthenticationError < ApiError
+    def initialize(response_headers: {}, response_body: nil)
+      super(code: 401, response_headers: response_headers, response_body: response_body)
+    end
+  end
+
   # Create the appropriate error from a status code
   def self.create_error_from_status(status_code, response_headers: {}, response_body: nil)
     case status_code
@@ -107,8 +174,14 @@ module HookSniff
       ForbiddenError.new(response_headers: response_headers, response_body: response_body)
     when 404
       NotFoundError.new(response_headers: response_headers, response_body: response_body)
+    when 408
+      RequestTimeoutError.new(response_headers: response_headers, response_body: response_body)
     when 409
       ConflictError.new(response_headers: response_headers, response_body: response_body)
+    when 410
+      GoneError.new(response_headers: response_headers, response_body: response_body)
+    when 413
+      PayloadTooLargeError.new(response_headers: response_headers, response_body: response_body)
     when 422
       UnprocessableEntityError.new(response_headers: response_headers, response_body: response_body)
     when 429
@@ -116,12 +189,18 @@ module HookSniff
       RateLimitError.new(retry_after: retry_after, response_headers: response_headers, response_body: response_body)
     when 500
       InternalServerError.new(response_headers: response_headers, response_body: response_body)
+    when 501
+      NotImplementedError.new(response_headers: response_headers, response_body: response_body)
     when 502
       BadGatewayError.new(response_headers: response_headers, response_body: response_body)
     when 503
       ServiceUnavailableError.new(response_headers: response_headers, response_body: response_body)
     when 504
       GatewayTimeoutError.new(response_headers: response_headers, response_body: response_body)
+    when 507
+      InsufficientStorageError.new(response_headers: response_headers, response_body: response_body)
+    when 508
+      LoopDetectedError.new(response_headers: response_headers, response_body: response_body)
     else
       ApiError.new(code: status_code, response_headers: response_headers, response_body: response_body)
     end

data/lib/hooksniff/hooksniff_http_client.rb

@@ -47,7 +47,9 @@ module HookSniff
       # Create request object
       request = request_class.new(uri.request_uri)
       request["Authorization"] = "Bearer #{@token}"
-      request["User-Agent"] = "hooksniff-libs/#{VERSION}/ruby"
+      sdk_ua = "hooksniff-libs/#{VERSION}/ruby"
+      request["User-Agent"] = sdk_ua
+      request["X-HookSniff-SDK"] = sdk_ua
       request["hooksniff-req-id"] = rand(0...(2 ** 64))
 
       # Add headers
@@ -83,26 +85,41 @@ module HookSniff
     end
 
     private def execute_request_with_retries(request, http)
-      res = http.request(request)
+      res = nil
+      retries = [1, 2, 4] # seconds: 1s, 2s, 4s exponential backoff
+      max_retries = retries.length
+
+      retries.each_with_index do |sleep_duration, index|
+        begin
+          res = http.request(request)
+        rescue Net::OpenTimeout, Net::ReadTimeout, Net::WriteTimeout, Timeout::Error, Errno::ETIMEDOUT, IOError => _e
+          # Timeout — retry
+          if index < max_retries - 1
+            sleep(sleep_duration)
+            request["hooksniff-retry-count"] = index + 1
+            next
+          else
+            raise
+          end
+        end
 
-      [0.05, 0.1, 0.2].each_with_index do |sleep_duration, index|
         # 429 Rate Limit — respect Retry-After header
         if Integer(res.code) == 429
           retry_after = res["Retry-After"]
           delay = retry_after ? retry_after.to_f : sleep_duration
           sleep(delay)
           request["hooksniff-retry-count"] = index + 1
-          res = http.request(request)
           next
         end
 
-        unless Integer(res.code) >= 500
-          break
+        # 5xx Server Error — exponential backoff
+        if Integer(res.code) >= 500 && index < max_retries - 1
+          sleep(sleep_duration)
+          request["hooksniff-retry-count"] = index + 1
+          next
         end
 
-        sleep(sleep_duration)
-        request["hooksniff-retry-count"] = index + 1
-        res = http.request(request)
+        break
       end
 
       res
@@ -126,3 +143,25 @@ module HookSniff
     end
   end
 end
+
+# Response metadata accessor
+module HookSniff
+  class << self
+    attr_accessor :last_response
+  end
+end
+
+# Debug logging helper
+module HookSniff
+  module DebugLogger
+    def self.log_request(method, url)
+      return unless HookSniff.respond_to?(:debug) && HookSniff.debug
+      puts "[HookSniff] → #{method.upcase} #{url}"
+    end
+
+    def self.log_response(status_code, elapsed_ms)
+      return unless HookSniff.respond_to?(:debug) && HookSniff.debug
+      puts "[HookSniff] ← #{status_code} (#{elapsed_ms}ms)"
+    end
+  end
+end

data/lib/hooksniff/options.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module HookSniff
+  # Configuration options for the HookSniff client.
+  #
+  # @example
+  #   options = HookSniff::Options.new(
+  #     server_url: "https://custom.hooksniff.com",
+  #     timeout: 60,
+  #     debug: true,
+  #     headers: { "X-Custom" => "value" }
+  #   )
+  #   client = HookSniff::HookSniff.new("token", options)
+  class Options
+    attr_accessor :server_url, :timeout, :debug, :headers, :retry_schedule
+
+    def initialize(
+      server_url: nil,
+      timeout: 30,
+      debug: false,
+      headers: {},
+      retry_schedule: [1, 2, 4]
+    )
+      @server_url = server_url
+      @timeout = timeout
+      @debug = debug
+      @headers = headers || {}
+      @retry_schedule = retry_schedule
+    end
+  end
+end

data/lib/hooksniff/paginator.rb

@@ -0,0 +1,45 @@
+# Pagination Helper for HookSniff Ruby SDK.
+#
+# Usage:
+#   hs.message.list_all(limit: 100).each do |msg|
+#     puts msg.id
+#   end
+#
+#   # Or collect all
+#   all_messages = hs.message.list_all(limit: 100).to_a
+
+module HookSniff
+  class Paginator
+    include Enumerable
+
+    def initialize(fetch_page, limit: nil)
+      @fetch_page = fetch_page
+      @limit = limit
+    end
+
+    def each(&block)
+      return enum_for(:each) unless block_given?
+
+      iterator = nil
+
+      loop do
+        page = @fetch_page.call(limit: @limit, iterator: iterator)
+
+        page.data.each(&block)
+
+        break if page.done || page.iterator.nil? || page.iterator.empty?
+        iterator = page.iterator
+      end
+    end
+
+    # Collect all items into an array
+    def to_a
+      each.to_a
+    end
+
+    # Count all items
+    def count
+      each.count
+    end
+  end
+end

data/lib/hooksniff/response_metadata.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module HookSniff
+  # Response metadata from the last API request.
+  #
+  # Access via +client.last_response+ after any API call.
+  #
+  # @example
+  #   endpoints = client.endpoint.list
+  #   puts client.last_response.request_id
+  #   puts client.last_response.rate_limit_remaining
+  class ResponseMetadata
+    # @return [Integer] HTTP status code
+    attr_reader :status_code
+
+    # @return [String, nil] x-request-id header
+    attr_reader :request_id
+
+    # @return [Integer, nil] x-ratelimit-remaining header
+    attr_reader :rate_limit_remaining
+
+    # @return [Integer, nil] x-ratelimit-reset header (Unix timestamp)
+    attr_reader :rate_limit_reset
+
+    # @return [Hash] All response headers
+    attr_reader :headers
+
+    def initialize(status_code:, request_id: nil, rate_limit_remaining: nil, rate_limit_reset: nil, headers: {})
+      @status_code = status_code
+      @request_id = request_id
+      @rate_limit_remaining = rate_limit_remaining
+      @rate_limit_reset = rate_limit_reset
+      @headers = headers
+    end
+
+    # Create from a Net::HTTP response.
+    def self.from_http_response(response)
+      headers = response.to_hash.transform_values { |v| v.is_a?(Array) ? v.first : v }
+      new(
+        status_code: response.code.to_i,
+        request_id: headers["x-request-id"],
+        rate_limit_remaining: headers["x-ratelimit-remaining"]&.to_i,
+        rate_limit_reset: headers["x-ratelimit-reset"]&.to_i,
+        headers: headers
+      )
+    end
+  end
+end

data/lib/hooksniff/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HookSniff
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end