hookdeck 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e777450c58714998a700b290b82c16ef2f43f558bebb6c2fae41dfcd18f5a96
+  data.tar.gz: fd355f47639a424fb853974ef71f8de3bba6d3280188bab553c029c0754ec2ce
+SHA512:
+  metadata.gz: 9131cb7e24b752acc1cda4829b3c81a33d93bca850e7276d2fc465231d4a0196692d70338f2fcc436d3d46b5ef151fdcdc257c8298598f4f1f720118aed35d99
+  data.tar.gz: 5816b5ffb96e5d0ddc0879da48e2f7f74e87ed077157c77920a0add728236fd7a4a7a38f6d1f6471c3bf4992484f862958c33f9f1d9f125adca344c09dfa9658

data/.rubocop.yml

@@ -0,0 +1,42 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'db/**/*'
+    - 'config/**/*'
+    - 'script/**/*'
+    - 'node_modules/**/*'
+    - 'tmp/**/*'
+    - 'Gemfile'
+    - 'Rakefile'
+  SuggestExtensions: false
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 35
+
+
+Metrics/AbcSize:
+  Max: 35
+
+Metrics/ClassLength:
+  Max: 300
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  EnforcedStyle: nested

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,33 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-11-09
+
+### Added
+
+- Initial release of the Hookdeck Ruby SDK
+- Basic API client implementation
+- Support for managing webhook sources
+- Support for managing destinations
+- Support for managing connections
+- Support for managing events
+- Support for managing transformations
+- Support for managing retry rules
+- Support for managing bulk operations
+- Support for managing notifications
+- Support for managing issues
+- Comprehensive error handling
+- Thread-safe HTTP client
+- Configurable retries and timeouts
+- API version support
+- Documentation and examples
+
+### Dependencies
+
+- Faraday for HTTP client
+- Faraday Middleware for request/response handling
+- JSON for payload handling

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Emmanuel ADEBAYO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,22 @@
+.PHONY: setup lint lint-fix test
+
+setup:
+	@echo "Installing dependencies..."
+	@bundle install
+
+lint:
+	@echo "Running RuboCop..."
+	@bundle exec rubocop
+
+lint-fix:
+	@echo "Running RuboCop auto-correct..."
+	@bundle exec rubocop -a
+
+test:
+	@echo "Running tests..."
+	@bundle exec rspec
+
+ci: setup lint test
+	@echo "CI pipeline completed successfully!"
+
+.DEFAULT_GOAL := setup

data/README.md

@@ -0,0 +1,249 @@
+# Hookdeck Ruby SDK
+
+The official Ruby library for the [Hookdeck API](https://hookdeck.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hookdeck'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install hookdeck
+```
+
+## Usage
+
+### Configuration
+
+```ruby
+require 'hookdeck'
+
+# Configure the client globally
+Hookdeck.configure do |config|
+  config.api_key = 'your_api_key'
+  config.api_version = '2024-09-01' # Optional, defaults to latest version
+end
+
+# Or initialize a client instance
+client = Hookdeck.new('your_api_key', api_version: '2024-09-01')
+```
+
+### Sources
+
+```ruby
+# List sources
+sources = client.sources.list(limit: 10)
+
+# Create a source
+source = client.sources.create(
+  name: 'My Webhook Source',
+  url: 'https://api.example.com/webhooks'
+)
+
+# Retrieve a source
+source = client.sources.retrieve('src_123')
+
+# Update a source
+source = client.sources.update('src_123',
+                               name: 'Updated Source Name'
+)
+
+# Disable a source
+client.sources.disable('src_123')
+
+# Enable a source
+client.sources.enable('src_123')
+
+# Delete a source
+client.sources.delete('src_123')
+```
+
+### Destinations
+
+```ruby
+# List destinations
+destinations = client.destinations.list(limit: 10)
+
+# Create a destination
+destination = client.destinations.create(
+  name: 'My API Endpoint',
+  url: 'https://api.example.com/webhooks',
+  http_method: 'POST',
+  headers: {
+    'Authorization': 'Bearer token'
+  }
+)
+
+# Retrieve a destination
+destination = client.destinations.retrieve('dst_123')
+
+# Update a destination
+destination = client.destinations.update('dst_123',
+                                         headers: { 'X-Custom-Header': 'value' }
+)
+
+# Delete a destination
+client.destinations.delete('dst_123')
+```
+
+### Connections
+
+```ruby
+# List connections
+connections = client.connections.list(limit: 10)
+
+# Create a connection
+connection = client.connections.create(
+  source_id: 'src_123',
+  destination_id: 'dst_456',
+  retry_rule_id: 'rr_789'
+)
+
+# Retrieve a connection
+connection = client.connections.retrieve('conn_123')
+
+# Update a connection
+connection = client.connections.update('conn_123',
+                                       ruleset: {
+                                         rules: [
+                                           {
+                                             type: 'filter',
+                                             config: {
+                                               condition: 'event.type == "order.created"'
+                                             }
+                                           }
+                                         ]
+                                       }
+)
+
+# Delete a connection
+client.connections.delete('conn_123')
+```
+
+### Events
+
+```ruby
+# List events
+events = client.events.list(
+  source_id: 'src_123',
+  status: 'failed',
+  created_at: {
+    gte: '2024-01-01T00:00:00Z'
+  }
+)
+
+# Retrieve an event
+event = client.events.retrieve('evt_123')
+
+# Retry an event
+client.events.retry('evt_123')
+
+# Mute an event
+client.events.mute('evt_123')
+```
+
+### Transformations
+
+```ruby
+# List transformations
+transformations = client.transformations.list(limit: 10)
+
+# Create a transformation
+transformation = client.transformations.create(
+  name: 'Add Timestamp',
+  code: 'event.data.timestamp = Date.now(); return event;'
+)
+
+# Retrieve a transformation
+transformation = client.transformations.retrieve('tr_123')
+
+# Update a transformation
+transformation = client.transformations.update('tr_123',
+                                               code: 'return { ...event, modified: true };'
+)
+
+# Run a transformation
+result = client.transformations.run(
+  code: 'return { ...event, processed: true };',
+  event: { data: { type: 'test' } }
+)
+
+# Delete a transformation
+client.transformations.delete('tr_123')
+```
+
+### Issue Triggers
+
+```ruby
+# List issue triggers
+triggers = client.issue_triggers.list(limit: 10)
+
+# Create an issue trigger
+trigger = client.issue_triggers.create(
+  name: 'High Error Rate',
+  type: 'error_rate',
+  config: {
+    threshold: 0.1,
+    window: '15m'
+  }
+)
+
+# Retrieve an issue trigger
+trigger = client.issue_triggers.retrieve('trig_123')
+
+# Update an issue trigger
+trigger = client.issue_triggers.update('trig_123',
+                                       config: { threshold: 0.05 }
+)
+
+# Delete an issue trigger
+client.issue_triggers.delete('trig_123')
+```
+
+## Error Handling
+
+```ruby
+
+begin
+  client.sources.retrieve('invalid_id')
+rescue Hookdeck::NotFoundError => e
+  puts "Resource not found: #{e.message}"
+rescue Hookdeck::ValidationError => e
+  puts "Invalid parameters: #{e.message}"
+rescue Hookdeck::ApiError => e
+  puts "API error: #{e.message}"
+  puts "Status: #{e.status}"
+  puts "Request ID: #{e.request_id}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/toluwaanimi/hookdeck.rb. This project is
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+the [code of conduct](https://github.com/toluwaanimi/hookdeck.rb/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Hookdeck Ruby SDK project's codebases, issue trackers, chat rooms and mailing lists is
+expected to follow the [code of conduct](https://github.com/toluwaanimi/hookdeck.rb/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'standard/rake'
+
+task default: %i[test standard]

data/lib/hookdeck/client.rb

@@ -0,0 +1,168 @@
+module Hookdeck
+  class Client
+    extend Forwardable
+
+    attr_reader :config, :http_client
+
+    def initialize(api_key = nil, options = {})
+      @config = build_config(api_key, options)
+      @http_client = HttpClient.new(@config)
+      initialize_resources
+    end
+
+    # Sends a request to the Hookdeck API.
+    #
+    # @param method [String] The HTTP method.
+    # @param path [String] The path.
+    # @param params [Hash] The parameters.
+    # @param opts [Hash] The options.
+    # @return [Hash] The response.
+    def request(method, path, params = {}, opts = {})
+      response = http_client.connection.public_send(method) do |req|
+        req.url(path)
+        req.params = params if params.any?
+        req.body = opts[:body].to_json if opts[:body]
+        req.headers.merge!(opts[:headers] || {})
+      end
+
+      response.body
+    end
+
+    # Accessor for the Attempt resource.
+    #
+    # @return [Hookdeck::Resources::Attempt] The Attempt resource.
+    def attempts
+      @attempts ||= Hookdeck::Resources::Attempt.new(self)
+    end
+
+    # Accessor for the Bookmark resource.
+    #
+    # @return [Hookdeck::Resources::Bookmark] The Bookmark resource.
+    def bookmarks
+      @bookmarks ||= Hookdeck::Resources::Bookmark.new(self)
+    end
+
+    # Accessor for the Connection resource.
+    #
+    # @return [Hookdeck::Resources::Connection] The Connection resource.
+    def connections
+      @connections ||= Hookdeck::Resources::Connection.new(self)
+    end
+
+    # Accessor for the Event resource.
+    #
+    # @return [Hookdeck::Resources::Event] The Event resource.
+    def events
+      @events ||= Hookdeck::Resources::Event.new(self)
+    end
+
+    # Accessor for the Notification resource.
+    #
+    # @return [Hookdeck::Resources::Notification] The Notification resource.
+    def notifications
+      @notifications ||= Hookdeck::Resources::Notification.new(self)
+    end
+
+    # Accessor for the Source resource.
+    #
+    # @return [Hookdeck::Resources::Source] The Source resource.
+    def sources
+      @sources ||= Hookdeck::Resources::Source.new(self)
+    end
+
+    # Accessor for the Destination resource.
+    #
+    # @return [Hookdeck::Resources::Destination] The Destination resource.
+    def destinations
+      @destinations ||= Hookdeck::Resources::Destination.new(self)
+    end
+
+    # Accessor for the Issue resource.
+    #
+    # @return [Hookdeck::Resources::Issue] The Issue resource.
+    def issues
+      @issues ||= Hookdeck::Resources::Issue.new(self)
+    end
+
+    # Accessor for the IssueTrigger resource.
+    #
+    # @return [Hookdeck::Resources::IssueTrigger] The IssueTrigger resource.
+    def issue_triggers
+      @issue_triggers ||= Hookdeck::Resources::IssueTrigger.new(self)
+    end
+
+    # Accessor for the CustomDomain resource.
+    #
+    # @return [Hookdeck::Resources::CustomDomain] The CustomDomain resource.
+    def custom_domains
+      @custom_domains ||= Hookdeck::Resources::CustomDomain.new(self)
+    end
+
+    # Accessor for the Request resource.
+    #
+    # @return [Hookdeck::Resources::Request] The Request resource.
+    def requests
+      @requests ||= Hookdeck::Resources::Request.new(self)
+    end
+
+    # Accessor for the Transformation resource.
+    #
+    # @return [Hookdeck::Resources::Transformation] The Transformation resource.
+    def transformations
+      @transformations ||= Hookdeck::Resources::Transformation.new(self)
+    end
+
+    # Accessor for the BulkIgnoredEventsRetry resource.
+    #
+    # @return [Hookdeck::Resources::BulkIgnoredEventsRetry] The BulkIgnoredEventsRetry resource.
+    def bulk_ignored_events_retry
+      @bulk_ignored_events_retry ||= Hookdeck::Resources::BulkIgnoredEventsRetry.new(self)
+    end
+
+    # Accessor for the BulkEventRetry resource.
+    #
+    # @return [Hookdeck::Resources::BulkEventRetry] The BulkEventRetry resource.
+    def bulk_events_retry
+      @bulk_events_retry ||= Hookdeck::Resources::BulkEventRetry.new(self)
+    end
+
+    # Accessor for the BulkRequestsRetry resource.
+    #
+    # @return [Hookdeck::Resources::BulkRequestsRetry] The BulkRequestsRetry resource.
+    def bulk_requests_retry
+      @bulk_requests_retry ||= Hookdeck::Resources::BulkRequestsRetry.new(self)
+    end
+
+    private
+
+    # Builds the configuration for the client.
+    #
+    # @param api_key [String] The API key.
+    # @param options [Hash] The options.
+    # @return [Hookdeck::Configuration] The configuration.
+    def build_config(api_key, options)
+      config = Configuration.new
+      config.api_key = api_key || HookDeck.configuration.api_key
+      options.each do |key, value|
+        config.public_send("#{key}=", value) if config.respond_to?("#{key}=")
+      end
+      validate_config!(config)
+      config
+    end
+
+    # Validates the configuration.
+    #
+    # @param config [Hookdeck::Configuration] The configuration.
+    # @raise [Hookdeck::ValidationError] If the API key is not provided.
+    def validate_config!(config)
+      raise ValidationError, 'API key must be provided' if config.api_key.nil?
+    end
+
+    # Initializes the resources.
+    #
+    # Resources are lazy-loaded when accessed
+    def initialize_resources
+      # Resources are lazy-loaded when accessed
+    end
+  end
+end