hookdeck 0.1.0

data/lib/hookdeck/resources/bookmark.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Hookdeck
+  module Resources
+    # @example Create a new bookmark
+    #   client.bookmarks.create(
+    #     label: "Product Update – Out of Stock",
+    #     event_data_id: "evtreq_HlJhb39nsjIP0FDsU3SY0fo7",
+    #     webhook_id: "web_UfM5ZY2wxLD6sLhDaKMcx5wp"
+    #   )
+    #
+    # @example Trigger a bookmark
+    #   client.bookmarks.trigger('bkm_123')
+    #
+    class Bookmark < Base
+      def list(params = {})
+        get('bookmarks', params)
+      end
+
+      # Retrieves a bookmark by ID.
+      #
+      # @param id [String] The ID of the bookmark.
+      # @return [Hash] The bookmark.
+      def retrieve(id)
+        validate_id!(id, 'bkm_')
+        get("bookmarks/#{id}")
+      end
+
+      # Creates a bookmark.
+      # {
+      #   "label": "Product Update – Out of Stock",
+      #   "event_data_id": "evtreq_HlJhb39nsjIP0FDsU3SY0fo7",
+      #   "webhook_id": "web_UfM5ZY2wxLD6sLhDaKMcx5wp"
+      # }
+      # @param params [Hash] The parameters.
+      # @return [Hash] The bookmark.
+      def create(params)
+        post('bookmarks', params)
+      end
+
+      # Updates a bookmark.
+      # @param id [String] The ID of the bookmark.
+      # @param params [Hash] The parameters.
+      # {
+      #   "label": "Product Update – Out of Stock",
+      #   "event_data_id": "evtreq_HlJhb39nsjIP0FDsU3SY0fo7",
+      #   "webhook_id": "web_UfM5ZY2wxLD6sLhDaKMcx5wp"
+      # }
+      # @return [Hash] The bookmark.
+      def update(id, params)
+        validate_id!(id, 'bkm_')
+        put("bookmarks/#{id}", params)
+      end
+
+      # This endpoint uses a bookmark to create events.
+      # @param id [String] The ID of the bookmark.
+      # @param params [Hash] The parameters.
+      # @return [Hash] The bookmark.
+      def trigger(id, params = {})
+        validate_id!(id, 'bkm_')
+        post("bookmarks/#{id}/trigger", params)
+      end
+
+      def delete(id)
+        validate_id!(id, 'bkm_')
+        delete("bookmarks/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/bulk_event_retry.rb

@@ -0,0 +1,40 @@
+module Hookdeck
+  module Resources
+    class BulkEventRetry < Base
+      # List all pending bulk retries
+      def list(params = {})
+        get('bulk/events/retry', params)
+      end
+
+      # Retrieve a single bulk retry
+      # @param [String] id Bulk retry ID
+      def retrieve(id)
+        validate_id!(id, 'bulkr_')
+        get("bulk/events/retry/#{id}")
+      end
+
+      # Cancel a pending bulk retry
+      # @param [String] id Bulk retry ID
+      def cancel(id)
+        validate_id!(id, 'blkr_')
+        post("bulk/events/retry/#{id}/cancel")
+      end
+
+      # Create a new bulk retry
+      # @param [Hash] params Bulk retry attributes
+      # @option params [Array<String>] :event_ids Event IDs to retry
+      # @option params [Hash] :config Override default retry configuration
+      def create(params)
+        post('bulk/events/retry', params)
+      end
+
+      # Get the plan for a bulk retry
+      # @param [Hash] params Bulk retry planning parameters
+      # @option params [Array<String>] :event_ids Event IDs to plan for
+      # @option params [Hash] :config Override default retry configuration
+      def plan(params)
+        get('bulk/events/retry/plan', params)
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/bulk_ignored_event_retry.rb

@@ -0,0 +1,36 @@
+module Hookdeck
+  module Resources
+    class BulkIgnoredEventsRetry < Base
+      # Cancel a pending bulk ignored events retry
+      def cancel_retry(id)
+        post("bulk/ignored-events/retry/#{id}/cancel")
+      end
+
+      # Get the plan for a bulk ignored events retry
+      def plan_retry(params)
+        get('bulk/ignored-events/retry/plan', params)
+      end
+
+      # List all pending bulk ignored events retries
+      def list_retries(params = {})
+        get('bulk/ignored-events/retry', params)
+      end
+
+      # Retrieve a single bulk ignored events retry
+      # @param [String] id Bulk ignored events retry ID
+      def retrieve_retry(id)
+        get("bulk/ignored-events/retry/#{id}")
+      end
+
+      # Create a new bulk ignored events retry
+      def create_retry(params)
+        post('bulk/ignored-events/retry', params)
+      end
+
+      # Cancel a bulk of ignored events
+      def cancel_ignored_events(id)
+        post("bulk/ignored-events/#{id}/cancel")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/bulk_request_retry.rb

@@ -0,0 +1,31 @@
+module Hookdeck
+  module Resources
+    class BulkRequestsRetry < Base
+      # Cancel a pending bulk requests retry
+      def cancel_retry(id)
+        post("bulk/requests/retry/#{id}/cancel")
+      end
+
+      # Get the plan for a bulk requests retry
+      def plan_retry(params)
+        get('bulk/requests/retry/plan', params)
+      end
+
+      # List all pending bulk requests retries
+      def list_retries(params = {})
+        get('bulk/requests/retry', params)
+      end
+
+      # Retrieve a single bulk requests retry
+      # @param [String] id Bulk requests retry ID
+      def retrieve_retry(id)
+        get("bulk/requests/retry/#{id}")
+      end
+
+      # Create a new bulk requests retry
+      def create_retry(params)
+        post('bulk/requests/retry', params)
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/connection.rb

@@ -0,0 +1,62 @@
+# lib/hookdeck/resources/connection.rb
+module Hookdeck
+  module Resources
+    class Connection < Base
+      # List all connections
+      def list(params = {})
+        get('connections', params)
+      end
+
+      # Retrieve a single connection
+      # @param [String] id Connection ID
+      def retrieve(id)
+        get("connections/#{id}")
+      end
+
+      # Create a new connection
+      def create(params)
+        post('connections', params)
+      end
+
+      # Upsert (create or update) a connection
+      def upsert(params)
+        put('connections', params)
+      end
+
+      # Update a connection
+      def update(id, params)
+        put("connections/#{id}", params)
+      end
+
+      # Disable a connection
+      # @param [String] id Connection ID
+      def disable(id)
+        put("connections/#{id}/disable")
+      end
+
+      # Enable a connection
+      # @param [String] id Connection ID
+      def enable(id)
+        put("connections/#{id}/enable")
+      end
+
+      # Pause a connection
+      # @param [String] id Connection ID
+      def pause(id)
+        put("connections/#{id}/pause")
+      end
+
+      # Unpause a connection
+      # @param [String] id Connection ID
+      def unpause(id)
+        put("connections/#{id}/unpause")
+      end
+
+      # Delete a connection
+      # @param [String] id Connection ID
+      def delete(id)
+        delete("connections/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/custom_domain.rb

@@ -0,0 +1,17 @@
+module Hookdeck
+  module Resources
+    class CustomDomain < Base
+      def list(params = {})
+        get('teams/current/custom_domains', params)
+      end
+
+      def create(params = {})
+        post('teams/current/custom_domains', params)
+      end
+
+      def delete(id)
+        delete("teams/current/custom_domains/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/destination.rb

@@ -0,0 +1,49 @@
+module Hookdeck
+  module Resources
+    class Destination < Base
+      # List all destinations
+      def list(params = {})
+        get('destinations', params)
+      end
+
+      # Retrieve a single destination
+      # @param [String] id Destination ID
+      def retrieve(id)
+        get("destinations/#{id}")
+      end
+
+      # Create a new destination
+      def create(params)
+        post('destinations', params)
+      end
+
+      # Upsert (create or update) a destination
+      def upsert(params)
+        put('destinations', params)
+      end
+
+      # Update a destination
+      def update(id, params)
+        put("destinations/#{id}", params)
+      end
+
+      # Disable a destination
+      # @param [String] id Destination ID
+      def disable(id)
+        put("destinations/#{id}/disable")
+      end
+
+      # Enable a destination
+      # @param [String] id Destination ID
+      def enable(id)
+        put("destinations/#{id}/enable")
+      end
+
+      # Delete a destination
+      # @param [String] id Destination ID
+      def delete(id)
+        delete("destinations/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/event.rb

@@ -0,0 +1,29 @@
+module Hookdeck
+  module Resources
+    class Event < Base
+      # List all events
+      def list(params = {})
+        get('events', params)
+      end
+
+      # Retrieve a single event
+      # @param [String] id Event ID
+      def retrieve(id)
+        validate_id!(id, 'evt_')
+        get("events/#{id}")
+      end
+
+      # Retry an event
+      def retry(id, params = {})
+        validate_id!(id, 'evt_')
+        post("events/#{id}/retry", params)
+      end
+
+      # Mute an event
+      def mute(id, params = {})
+        validate_id!(id, 'evt_')
+        put("events/#{id}/mute", params)
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/issue.rb

@@ -0,0 +1,32 @@
+module Hookdeck
+  module Resources
+    class Issue < Base
+      # List all issues
+      def list(params = {})
+        get('issues', params)
+      end
+
+      # Retrieve a single issue
+      # @param [String] id Issue ID
+      def retrieve(id)
+        get("issues/#{id}")
+      end
+
+      # Create a new issue
+      def create(params)
+        post('issues', params)
+      end
+
+      # Update an existing issue
+      def update(id, params)
+        put("issues/#{id}", params)
+      end
+
+      # Delete an issue
+      # @param [String] id Issue ID
+      def delete(id)
+        delete("issues/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/issue_trigger.rb

@@ -0,0 +1,56 @@
+module Hookdeck
+  module Resources
+    class IssueTrigger < Base
+      # List all issue triggers
+      def list(params = {})
+        get('issue-triggers', params)
+      end
+
+      # Retrieve a single issue trigger
+      # @param [String] id Issue trigger ID
+      def retrieve(id)
+        get("issue-triggers/#{id}")
+      end
+
+      # Create a new issue trigger
+      def create(params)
+        post('issue-triggers', params)
+      end
+
+      # Update an issue trigger
+      def update(id, params)
+        put("issue-triggers/#{id}", params)
+      end
+
+      # Upsert (create or update) an issue trigger
+      def upsert(params)
+        put('issue-triggers', params)
+      end
+
+      # Trigger an issue manually
+      # @param [String] id Issue trigger ID
+      # @param [Hash] params Optional trigger parameters
+      def trigger(id, params = {})
+        post("issue-triggers/#{id}", params)
+      end
+
+      # Disable an issue trigger
+      # @param [String] id Issue trigger ID
+      def disable(id)
+        put("issue-triggers/#{id}/disable")
+      end
+
+      # Enable an issue trigger
+      # @param [String] id Issue trigger ID
+      def enable(id)
+        put("issue-triggers/#{id}/enable")
+      end
+
+      # Delete an issue trigger
+      # @param [String] id Issue trigger ID
+      def delete(id)
+        delete("issue-triggers/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/notification.rb

@@ -0,0 +1,30 @@
+module Hookdeck
+  module Resources
+    class Notification < Base
+      # Configure webhook notifications for the project
+      def configure_webhooks(params)
+        validate_webhook_params!(params)
+        put('notifications/webhooks', params)
+      end
+
+      private
+
+      def validate_webhook_params!(params)
+        required_keys = %i[enabled topics source_id]
+        validate_params!(params, required_keys)
+
+        # Validate enabled is boolean
+        validate_boolean!(params[:enabled], 'enabled')
+
+        # Validate topics is array of strings
+        validate_array!(params[:topics], 'topics')
+        params[:topics].each do |topic|
+          validate_string!(topic, 'topic')
+        end
+
+        # Validate source_id format
+        validate_id!(params[:source_id], 'src_')
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/request.rb

@@ -0,0 +1,33 @@
+module Hookdeck
+  module Resources
+    class Request < Base
+      # List all requests
+      def list(params = {})
+        get('requests', params)
+      end
+
+      # Retrieve a single request
+      # @param [String] id Request ID
+      def retrieve(id)
+        get("requests/#{id}")
+      end
+
+      # Retry a request
+      # @param [String] id Request ID
+      def retry(id, params = {})
+        post("requests/#{id}/retry", params)
+      end
+
+      # List events for a request
+      # @param [String] id Request ID
+      def list_events(id, params = {})
+        get("requests/#{id}/events", params)
+      end
+
+      # List ignored events for a request
+      def list_ignored_events(id, params = {})
+        get("requests/#{id}/ignored_events", params)
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/source.rb

@@ -0,0 +1,49 @@
+module Hookdeck
+  module Resources
+    class Source < Base
+      # List all sources
+      def list(params = {})
+        get('sources', params)
+      end
+
+      # Retrieve a single source
+      # @param [String] id Source ID
+      def retrieve(id)
+        get("sources/#{id}")
+      end
+
+      # Create a new source
+      def create(params)
+        post('sources', params)
+      end
+
+      # Upsert (create or update) a source
+      def upsert(params)
+        put('sources', params)
+      end
+
+      # Update a source
+      def update(id, params)
+        put("sources/#{id}", params)
+      end
+
+      # Disable a source
+      # @param [String] id Source ID
+      def disable(id)
+        put("sources/#{id}/disable")
+      end
+
+      # Enable a source
+      # @param [String] id Source ID
+      def enable(id)
+        put("sources/#{id}/enable")
+      end
+
+      # Delete a source
+      # @param [String] id Source ID
+      def delete(id)
+        delete("sources/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources/transformation.rb

@@ -0,0 +1,54 @@
+module Hookdeck
+  module Resources
+    class Transformation < Base
+      # List all transformations
+      def list(params = {})
+        get('transformations', params)
+      end
+
+      # Retrieve a single transformation
+      # @param [String] id Transformation ID
+      def retrieve(id)
+        get("transformations/#{id}")
+      end
+
+      # Create a new transformation
+      def create(params)
+        post('transformations', params)
+      end
+
+      # Update a transformation
+      def update(id, params)
+        put("transformations/#{id}", params)
+      end
+
+      # Upsert (create or update) a transformation
+      def upsert(params)
+        put('transformations', params)
+      end
+
+      # Run a transformation
+      def run(params)
+        put('transformations/run', params)
+      end
+
+      # List executions for a transformation
+      def list_executions(id, params = {})
+        get("transformations/#{id}/executions", params)
+      end
+
+      # Get a specific execution
+      # @param [String] id Transformation ID
+      # @param [String] execution_id Execution ID
+      def retrieve_execution(id, execution_id)
+        get("transformations/#{id}/executions/#{execution_id}")
+      end
+
+      # Delete a transformation
+      # @param [String] id Transformation ID
+      def delete(id)
+        delete("transformations/#{id}")
+      end
+    end
+  end
+end

data/lib/hookdeck/resources.rb

@@ -0,0 +1,20 @@
+module Hookdeck
+  module Resources
+    autoload :Base, 'hookdeck/resources/base'
+    autoload :Bookmark, 'hookdeck/resources/bookmark'
+    autoload :Attempt, 'hookdeck/resources/attempt'
+    autoload :Connection, 'hookdeck/resources/connection'
+    autoload :CustomDomain, 'hookdeck/resources/custom_domain'
+    autoload :Destination, 'hookdeck/resources/destination'
+    autoload :Event, 'hookdeck/resources/event'
+    autoload :EventBulkRetry, 'hookdeck/resources/event_bulk_retry'
+    autoload :IgnoredEventBulkRetry, 'hookdeck/resources/ignored_event_bulk_retry'
+    autoload :Issue, 'hookdeck/resources/issue'
+    autoload :IssueTrigger, 'hookdeck/resources/issue_trigger'
+    autoload :Notification, 'hookdeck/resources/notification'
+    autoload :Request, 'hookdeck/resources/request'
+    autoload :RequestBulkRetry, 'hookdeck/resources/request_bulk_retry'
+    autoload :Source, 'hookdeck/resources/source'
+    autoload :Transformation, 'hookdeck/resources/transformation'
+  end
+end

data/lib/hookdeck/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Hookdeck
+  VERSION = '0.1.0'
+end

data/lib/hookdeck.rb

@@ -0,0 +1,39 @@
+require 'forwardable'
+require 'faraday'
+require 'faraday_middleware'
+require 'json'
+require 'logger'
+require 'uri'
+
+require_relative 'hookdeck/version'
+require_relative 'hookdeck/errors'
+require_relative 'hookdeck/configuration'
+require_relative 'hookdeck/client'
+require_relative 'hookdeck/http_client'
+require_relative 'hookdeck/resources'
+
+module Hookdeck
+  autoload :VERSION, 'hookdeck/version'
+  autoload :Configuration, 'hookdeck/configuration'
+  autoload :Client, 'hookdeck/client'
+  autoload :Resources, 'hookdeck/resources'
+  autoload :Error, 'hookdeck/errors'
+
+  class << self
+    def new(api_key = nil, options = {})
+      Client.new(api_key, options)
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def reset!
+      @configuration = nil
+    end
+  end
+end

data/sig/hookdeck.rbs

@@ -0,0 +1,4 @@
+module Hookdeck
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end