volley-ruby 1.0.0

data/lib/volley/volley_client.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/retry'
+require 'json'
+require_relative 'volley_exception'
+require_relative 'resources/organizations_resource'
+require_relative 'resources/projects_resource'
+require_relative 'resources/sources_resource'
+require_relative 'resources/destinations_resource'
+require_relative 'resources/connections_resource'
+require_relative 'resources/events_resource'
+require_relative 'resources/delivery_attempts_resource'
+require_relative 'resources/webhooks_resource'
+
+module Volley
+  # Main client for interacting with the Volley API.
+  class VolleyClient
+    DEFAULT_BASE_URL = 'https://api.volleyhooks.com'
+    DEFAULT_TIMEOUT = 30
+
+    attr_reader :api_token, :base_url, :organization_id
+    attr_reader :organizations, :projects, :sources, :destinations, :connections, :events, :delivery_attempts, :webhooks
+
+    # Initializes a new instance of the VolleyClient class.
+    #
+    # @param api_token [String] Your Volley API token
+    # @param base_url [String, nil] Custom base URL (defaults to https://api.volleyhooks.com)
+    # @param organization_id [Integer, nil] Organization ID for all requests
+    # @param http_client [Faraday::Connection, nil] Custom Faraday HTTP client (optional)
+    def initialize(api_token, base_url: nil, organization_id: nil, http_client: nil)
+      raise ArgumentError, 'API token is required' if api_token.nil? || api_token.empty?
+
+      @api_token = api_token
+      @base_url = base_url || DEFAULT_BASE_URL
+      @organization_id = organization_id
+
+      @http_client = http_client || build_http_client
+
+      # Initialize resource clients
+      @organizations = Resources::OrganizationsResource.new(self)
+      @projects = Resources::ProjectsResource.new(self)
+      @sources = Resources::SourcesResource.new(self)
+      @destinations = Resources::DestinationsResource.new(self)
+      @connections = Resources::ConnectionsResource.new(self)
+      @events = Resources::EventsResource.new(self)
+      @delivery_attempts = Resources::DeliveryAttemptsResource.new(self)
+      @webhooks = Resources::WebhooksResource.new(self)
+    end
+
+    # Sets the organization ID for subsequent requests.
+    #
+    # @param organization_id [Integer] The organization ID to use
+    def set_organization_id(organization_id)
+      @organization_id = organization_id
+    end
+
+    # Clears the organization ID (uses default organization).
+    def clear_organization_id
+      @organization_id = nil
+    end
+
+    # Gets the current organization ID.
+    #
+    # @return [Integer, nil] The organization ID, or nil if not set
+    def get_organization_id
+      @organization_id
+    end
+
+    # Performs an HTTP request with authentication.
+    #
+    # @param method [String] HTTP method (GET, POST, PUT, DELETE)
+    # @param path [String] API path (e.g., /api/org)
+    # @param data [Hash, nil] Request body data (for POST/PUT)
+    # @param query_params [Hash, nil] Query parameters
+    # @return [Hash] Response data
+    # @raise [VolleyException] If the request fails
+    def request(method, path, data: nil, query_params: nil)
+      url = "#{@base_url}#{path}"
+
+      headers = {
+        'Authorization' => "Bearer #{@api_token}",
+        'Content-Type' => 'application/json',
+        'Accept' => 'application/json'
+      }
+      headers['X-Organization-ID'] = @organization_id.to_s if @organization_id
+
+      response = @http_client.public_send(method.downcase.to_sym) do |req|
+        req.url url
+        req.headers = headers
+        req.body = data.to_json if data && %w[post put].include?(method.downcase)
+        req.params = query_params if query_params
+      end
+
+      handle_response(response)
+    rescue Faraday::Error => e
+      raise VolleyException.new("Request failed: #{e.message}", 0)
+    end
+
+    private
+
+    def build_http_client
+      Faraday.new do |f|
+        f.request :retry, {
+          max: 3,
+          interval: 1,
+          retry_statuses: [429, 500, 502, 503, 504]
+        }
+        f.adapter Faraday.default_adapter
+      end
+    end
+
+    def handle_response(response)
+      unless response.success?
+        error_message = 'Request failed'
+        begin
+          error_data = JSON.parse(response.body)
+          error_message = error_data['error'] || error_data['message'] || error_message
+        rescue JSON::ParserError
+          error_message = response.body || error_message
+        end
+        raise VolleyException.new(error_message, response.status)
+      end
+
+      return {} if response.body.nil? || response.body.empty?
+
+      JSON.parse(response.body)
+    rescue JSON::ParserError
+      {}
+    end
+  end
+end
+

data/lib/volley/volley_exception.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Volley
+  # Exception thrown when a Volley API request fails.
+  class VolleyException < StandardError
+    attr_reader :status_code
+
+    # Initializes a new instance of the VolleyException class.
+    #
+    # @param message [String] Error message
+    # @param status_code [Integer] HTTP status code
+    def initialize(message = '', status_code = 0)
+      super(message)
+      @status_code = status_code
+    end
+
+    # Checks if the exception represents an unauthorized error (401).
+    #
+    # @return [Boolean]
+    def unauthorized?
+      @status_code == 401
+    end
+
+    # Checks if the exception represents a forbidden error (403).
+    #
+    # @return [Boolean]
+    def forbidden?
+      @status_code == 403
+    end
+
+    # Checks if the exception represents a not found error (404).
+    #
+    # @return [Boolean]
+    def not_found?
+      @status_code == 404
+    end
+
+    # Checks if the exception represents a rate limit error (429).
+    #
+    # @return [Boolean]
+    def rate_limited?
+      @status_code == 429
+    end
+
+    # Checks if the exception represents a server error (5xx).
+    #
+    # @return [Boolean]
+    def server_error?
+      @status_code >= 500 && @status_code < 600
+    end
+  end
+end
+

data/lib/volley.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'volley/version'
+require_relative 'volley/volley_exception'
+require_relative 'volley/volley_client'
+
+# Main module for the Volley Ruby SDK
+module Volley
+end
+

data/volley-ruby.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'lib/volley/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'volley-ruby'
+  spec.version       = Volley::VERSION
+  spec.authors       = ['Volley']
+  spec.email         = ['support@volleyhooks.com']
+
+  spec.summary       = 'Official Ruby SDK for the Volley API'
+  spec.description   = 'Official Ruby SDK for the Volley webhook infrastructure API'
+  spec.homepage      = 'https://github.com/volleyhq/volley-ruby'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/volleyhq/volley-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/volleyhq/volley-ruby/blob/main/CHANGELOG.md'
+  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 .github .rspec .rubocop Gemfile Rakefile])
+    end
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.6.0'
+
+  spec.add_dependency 'faraday', '~> 2.0'
+  spec.add_dependency 'faraday-retry', '~> 2.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.50'
+  spec.add_development_dependency 'webmock', '~> 3.18'
+end
+

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: volley-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Volley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-12-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-retry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Official Ruby SDK for the Volley webhook infrastructure API
+email:
+- support@volleyhooks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- RELEASING.md
+- TESTING.md
+- examples/example.rb
+- lib/volley.rb
+- lib/volley/models.rb
+- lib/volley/models/connection.rb
+- lib/volley/models/delivery_attempt.rb
+- lib/volley/models/destination.rb
+- lib/volley/models/event.rb
+- lib/volley/models/organization.rb
+- lib/volley/models/project.rb
+- lib/volley/models/source.rb
+- lib/volley/resources.rb
+- lib/volley/resources/connections_resource.rb
+- lib/volley/resources/delivery_attempts_resource.rb
+- lib/volley/resources/destinations_resource.rb
+- lib/volley/resources/events_resource.rb
+- lib/volley/resources/organizations_resource.rb
+- lib/volley/resources/projects_resource.rb
+- lib/volley/resources/sources_resource.rb
+- lib/volley/resources/webhooks_resource.rb
+- lib/volley/version.rb
+- lib/volley/volley_client.rb
+- lib/volley/volley_exception.rb
+- volley-ruby.gemspec
+homepage: https://github.com/volleyhq/volley-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/volleyhq/volley-ruby
+  source_code_uri: https://github.com/volleyhq/volley-ruby
+  changelog_uri: https://github.com/volleyhq/volley-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Official Ruby SDK for the Volley API
+test_files: []