reactor_sdk 0.1.0

data/lib/reactor_sdk/endpoints/environments.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+##
+# @file endpoints/environments.rb
+# @description Endpoint group for Adobe Launch Environment resources.
+#
+#   Environments map to deployment targets within a property.
+#   Each property has three built-in environments: development, staging,
+#   and production. Additional environments can be created for personal
+#   developer sandboxes — this is how LaunchGuard provisions per-developer
+#   workspaces.
+#
+#   Important: the Reactor API requires a host relationship when creating
+#   an environment. Fetch the property's hosts first and pass the host_id
+#   to the create method. Most properties have exactly one Akamai host.
+#
+#   Example:
+#     hosts = client.hosts.list_for_property(property_id)
+#     client.environments.create(
+#       property_id: property_id,
+#       name:        "jsmith-dev",
+#       stage:       "development",
+#       host_id:     hosts.first.id
+#     )
+#
+# @domain Endpoints
+# @see https://developer.adobe.com/experience-platform/documentation/tags/api/endpoints/environments/
+#
+
+module ReactorSDK
+  module Endpoints
+    class Environments < BaseEndpoint
+      ##
+      # Lists all environments for a given property.
+      # Follows pagination automatically — returns all environments.
+      #
+      # @param property_id [String] Adobe property ID
+      # @return [Array<ReactorSDK::Resources::Environment>]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the property does not exist
+      #
+      def list_for_property(property_id)
+        list_resources("/properties/#{property_id}/environments", Resources::Environment)
+      end
+
+      ##
+      # Retrieves a single environment by its Adobe ID.
+      #
+      # @param environment_id [String] Adobe environment ID (format: "EN" + hex string)
+      # @return [ReactorSDK::Resources::Environment]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the environment does not exist
+      #
+      def find(environment_id)
+        fetch_resource("/environments/#{environment_id}", Resources::Environment)
+      end
+
+      ##
+      # Creates a new environment within a property.
+      #
+      # Requires a host_id — fetch the property's hosts first:
+      #   hosts = client.hosts.list_for_property(property_id)
+      #   host_id = hosts.first.id
+      #
+      # Used by LaunchGuard to provision personal developer sandboxes
+      # when a new user joins an organisation.
+      #
+      # @param property_id [String] Adobe property ID
+      # @param name        [String] Display name (e.g. "jsmith-dev")
+      # @param stage       [String] One of: "development", "staging", "production"
+      # @param host_id     [String] Adobe host ID — required by the Reactor API
+      # @return [ReactorSDK::Resources::Environment] The newly created environment
+      # @raise [ReactorSDK::UnprocessableEntityError] if attributes are invalid
+      # @raise [ReactorSDK::ConfigurationError] if host_id is blank
+      #
+      def create(property_id:, name:, host_id:, stage: 'development')
+        if host_id.nil? || host_id.strip.empty?
+          raise ConfigurationError,
+                'host_id is required to create an environment. ' \
+                'Fetch the property hosts first: client.hosts.list_for_property(property_id)'
+        end
+
+        create_resource(
+          "/properties/#{property_id}/environments",
+          'environments',
+          Resources::Environment,
+          attributes: { name: name, stage: stage },
+          relationships: {
+            host: {
+              data: { id: host_id, type: 'hosts' }
+            }
+          }
+        )
+      end
+
+      ##
+      # Updates an existing environment.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @param attributes     [Hash]   Fields to update
+      # @return [ReactorSDK::Resources::Environment]
+      #
+      def update(environment_id, attributes)
+        update_resource(
+          "/environments/#{environment_id}",
+          environment_id,
+          'environments',
+          Resources::Environment,
+          attributes: attributes
+        )
+      end
+
+      ##
+      # Retrieves the host assigned to an environment.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @return [ReactorSDK::Resources::Host]
+      #
+      def host(environment_id)
+        fetch_resource("/environments/#{environment_id}/host", Resources::Host)
+      end
+
+      ##
+      # Retrieves the raw host relationship linkage for an environment.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @return [Hash, nil]
+      #
+      def host_relationship(environment_id)
+        fetch_relationship("/environments/#{environment_id}/relationships/host")
+      end
+
+      ##
+      # Retrieves the library currently assigned to an environment.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @return [ReactorSDK::Resources::Library]
+      #
+      def library(environment_id)
+        fetch_resource("/environments/#{environment_id}/library", Resources::Library)
+      end
+
+      ##
+      # Retrieves the property that owns an environment.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @return [ReactorSDK::Resources::Property]
+      #
+      def property(environment_id)
+        fetch_resource("/environments/#{environment_id}/property", Resources::Property)
+      end
+
+      ##
+      # Lists builds produced for an environment.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @return [Array<ReactorSDK::Resources::Build>]
+      #
+      def builds(environment_id)
+        list_resources("/environments/#{environment_id}/builds", Resources::Build)
+      end
+
+      ##
+      # Deletes an environment permanently.
+      # Only non-built-in environments (personal sandboxes) should be deleted.
+      #
+      # @param environment_id [String] Adobe environment ID
+      # @return [nil]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the environment does not exist
+      #
+      def delete(environment_id)
+        delete_resource("/environments/#{environment_id}")
+      end
+    end
+  end
+end

data/lib/reactor_sdk/endpoints/extension_package_usage_authorizations.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module ReactorSDK
+  module Endpoints
+    class ExtensionPackageUsageAuthorizations < BaseEndpoint
+      def list
+        list_resources(
+          '/extension_package_usage_authorizations',
+          Resources::ExtensionPackageUsageAuthorization
+        )
+      end
+
+      def list_for_package(extension_package_id)
+        list_resources(
+          "/extension_packages/#{extension_package_id}/extension_package_usage_authorizations",
+          Resources::ExtensionPackageUsageAuthorization
+        )
+      end
+
+      def create(extension_package_id:, authorized_org_id:)
+        create_resource(
+          "/extension_packages/#{extension_package_id}/extension_package_usage_authorizations",
+          'extension_package_usage_authorizations',
+          Resources::ExtensionPackageUsageAuthorization,
+          attributes: { authorized_org_id: authorized_org_id }
+        )
+      end
+
+      def update(authorization_id, state:)
+        update_resource(
+          "/extension_package_usage_authorizations/#{authorization_id}",
+          authorization_id,
+          'extension_package_usage_authorizations',
+          Resources::ExtensionPackageUsageAuthorization,
+          attributes: { state: state }
+        )
+      end
+
+      def delete(authorization_id)
+        delete_resource("/extension_package_usage_authorizations/#{authorization_id}")
+      end
+
+      def extension_package(authorization_id)
+        fetch_resource(
+          "/extension_package_usage_authorizations/#{authorization_id}/extension_package",
+          Resources::ExtensionPackage
+        )
+      end
+    end
+  end
+end

data/lib/reactor_sdk/endpoints/extension_packages.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module ReactorSDK
+  module Endpoints
+    class ExtensionPackages < BaseEndpoint
+      def list(params: {})
+        list_resources('/extension_packages', Resources::ExtensionPackage, params: params)
+      end
+
+      def find(extension_package_id)
+        fetch_resource("/extension_packages/#{extension_package_id}", Resources::ExtensionPackage)
+      end
+
+      def create(package_path:)
+        response = @connection.post_multipart('/extension_packages', file_path: package_path)
+        @parser.parse(response['data'], Resources::ExtensionPackage, response: response)
+      end
+
+      def update(extension_package_id, package_path:)
+        response = @connection.post_multipart(
+          "/extension_packages/#{extension_package_id}",
+          file_path: package_path
+        )
+        @parser.parse(response['data'], Resources::ExtensionPackage, response: response)
+      end
+
+      def private_release(extension_package_id)
+        transition(extension_package_id, action: 'release_private')
+      end
+
+      def discontinue(extension_package_id)
+        transition(extension_package_id, action: 'discontinue')
+      end
+
+      def versions(extension_package_id)
+        list_resources(
+          "/extension_packages/#{extension_package_id}/versions",
+          Resources::ExtensionPackage
+        )
+      end
+
+      def usage_authorizations(extension_package_id)
+        list_resources(
+          "/extension_packages/#{extension_package_id}/extension_package_usage_authorizations",
+          Resources::ExtensionPackageUsageAuthorization
+        )
+      end
+
+      private
+
+      def transition(extension_package_id, action:)
+        update_resource(
+          "/extension_packages/#{extension_package_id}",
+          extension_package_id,
+          'extension_packages',
+          Resources::ExtensionPackage,
+          attributes: {},
+          meta: { action: action }
+        )
+      end
+    end
+  end
+end

data/lib/reactor_sdk/endpoints/extensions.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+##
+# @file endpoints/extensions.rb
+# @description Endpoint group for Adobe Launch Extension resources.
+#
+#   Extensions provide the delegates (conditions, actions, data element
+#   types) available within a property. The Core extension is always
+#   present. Third-party extensions are installed separately.
+#
+#   Important: extensions must be revised before they can be added to
+#   a library. Call revise(extension_id) before libraries.add_extensions.
+#
+# @domain Endpoints
+# @see https://developer.adobe.com/experience-platform/documentation/tags/api/endpoints/extensions/
+#
+
+module ReactorSDK
+  module Endpoints
+    class Extensions < BaseEndpoint
+      ##
+      # Lists all extensions installed in a given property.
+      # Follows pagination automatically — returns all extensions.
+      #
+      # @param property_id [String] Adobe property ID
+      # @return [Array<ReactorSDK::Resources::Extension>]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the property does not exist
+      #
+      def list_for_property(property_id)
+        records = @paginator.all("/properties/#{property_id}/extensions")
+        records.map { |r| @parser.parse(r, Resources::Extension) }
+      end
+
+      ##
+      # Retrieves a single extension by its Adobe ID.
+      #
+      # @param extension_id [String] Adobe extension ID (format: "EX" + hex string)
+      # @return [ReactorSDK::Resources::Extension]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the extension does not exist
+      #
+      def find(extension_id)
+        response = @connection.get("/extensions/#{extension_id}")
+        @parser.parse(response['data'], Resources::Extension)
+      end
+
+      ##
+      # Creates an extension within a property.
+      #
+      # @param property_id [String]
+      # @param attributes [Hash]
+      # @param relationships [Hash]
+      # @return [ReactorSDK::Resources::Extension]
+      #
+      def create(property_id:, attributes:, relationships:)
+        create_resource(
+          "/properties/#{property_id}/extensions",
+          'extensions',
+          Resources::Extension,
+          attributes: attributes,
+          relationships: relationships
+        )
+      end
+
+      ##
+      # Revises an extension so it can be added to a library.
+      #
+      # Adobe Launch requires every resource to be explicitly revised before
+      # it can be added to a library.
+      #
+      # Always call revise before libraries.add_extensions.
+      #
+      # @param extension_id [String] Adobe extension ID
+      # @return [ReactorSDK::Resources::Extension] The revised extension
+      # @raise [ReactorSDK::ResourceNotFoundError] if the extension does not exist
+      #
+      def revise(extension_id)
+        update_resource(
+          "/extensions/#{extension_id}",
+          extension_id,
+          'extensions',
+          Resources::Extension,
+          attributes: {},
+          meta: { action: 'revise' }
+        )
+      end
+
+      def delete(extension_id)
+        delete_resource("/extensions/#{extension_id}")
+      end
+
+      def extension_package(extension_id)
+        fetch_resource("/extensions/#{extension_id}/extension_package", Resources::ExtensionPackage)
+      end
+
+      def libraries(extension_id)
+        list_resources("/extensions/#{extension_id}/libraries", Resources::Library)
+      end
+
+      def property(extension_id)
+        fetch_resource("/extensions/#{extension_id}/property", Resources::Property)
+      end
+
+      def origin(extension_id)
+        fetch_resource("/extensions/#{extension_id}/origin", Resources::Extension)
+      end
+
+      ##
+      # Resolves the extension across the ordered upstream library chain.
+      #
+      # @param extension_or_id [String, ReactorSDK::Resources::Extension]
+      # @param library_id [String] Adobe library ID used as the comparison root
+      # @param property_id [String] Adobe property ID containing the library chain
+      # @return [ReactorSDK::Resources::UpstreamChain]
+      #
+      def upstream_chain(extension_or_id, library_id:, property_id:)
+        libraries_endpoint.upstream_chain_for_resource(
+          extension_or_id,
+          library_id: library_id,
+          property_id: property_id,
+          resource_type: 'extensions'
+        )
+      end
+
+      ##
+      # Fetches the extension from a library-context review snapshot together
+      # with dependent resources and normalized review payload.
+      #
+      # @param extension_id [String]
+      # @param library_id [String]
+      # @param property_id [String]
+      # @return [ReactorSDK::Resources::ComprehensiveExtension]
+      #
+      def find_comprehensive(extension_id, library_id:, property_id:)
+        snapshot = libraries_endpoint.find_snapshot(library_id, property_id: property_id)
+        comprehensive = snapshot.comprehensive_resource(extension_id, resource_type: 'extensions')
+        unless comprehensive
+          raise ReactorSDK::ResourceNotFoundError,
+                "Extension #{extension_id} was not found in library #{library_id}"
+        end
+
+        comprehensive
+      end
+
+      ##
+      # Resolves the extension across the ordered upstream chain using
+      # snapshot-aware comprehensive review objects.
+      #
+      # @param extension_or_id [String, ReactorSDK::Resources::Extension]
+      # @param library_id [String]
+      # @param property_id [String]
+      # @return [ReactorSDK::Resources::ComprehensiveUpstreamChain]
+      #
+      def comprehensive_upstream_chain(extension_or_id, library_id:, property_id:)
+        libraries_endpoint.comprehensive_upstream_chain_for_resource(
+          extension_or_id,
+          library_id: library_id,
+          property_id: property_id,
+          resource_type: 'extensions'
+        )
+      end
+
+      def list_notes(extension_id)
+        list_notes_for_path("/extensions/#{extension_id}/notes")
+      end
+
+      def create_note(extension_id, text)
+        create_note_for_path("/extensions/#{extension_id}/notes", text)
+      end
+
+      private
+
+      def libraries_endpoint
+        @libraries_endpoint ||= Endpoints::Libraries.new(
+          connection: @connection,
+          paginator: @paginator,
+          parser: @parser
+        )
+      end
+    end
+  end
+end

data/lib/reactor_sdk/endpoints/hosts.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+##
+# @file endpoints/hosts.rb
+# @description Endpoint group for Adobe Launch Host resources.
+#
+#   Hosts define where Adobe Launch builds are deployed. A host ID is
+#   required when creating an environment — fetch the property's hosts
+#   first and pass the ID to environments.create.
+#
+#   Most properties have exactly one Adobe-managed Akamai host created
+#   automatically. Use list_for_property to retrieve it.
+#
+# @domain Endpoints
+# @see https://developer.adobe.com/experience-platform/documentation/tags/api/endpoints/hosts/
+#
+
+module ReactorSDK
+  module Endpoints
+    class Hosts < BaseEndpoint
+      ##
+      # Lists all hosts for a given property.
+      # Follows pagination automatically — returns all hosts.
+      #
+      # Most properties have exactly one host — the Adobe-managed Akamai host.
+      # Call this before creating an environment to obtain the host ID.
+      #
+      # @param property_id [String] Adobe property ID
+      # @return [Array<ReactorSDK::Resources::Host>]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the property does not exist
+      #
+      def list_for_property(property_id)
+        list_resources("/properties/#{property_id}/hosts", Resources::Host)
+      end
+
+      ##
+      # Retrieves a single host by its Adobe ID.
+      #
+      # @param host_id [String] Adobe host ID (format: "HT" + hex string)
+      # @return [ReactorSDK::Resources::Host]
+      # @raise [ReactorSDK::ResourceNotFoundError] if the host does not exist
+      #
+      def find(host_id)
+        fetch_resource("/hosts/#{host_id}", Resources::Host)
+      end
+
+      ##
+      # Creates a host within a property.
+      #
+      # @param property_id [String] Adobe property ID
+      # @param attributes  [Hash]   Host attributes exactly as accepted by Reactor
+      # @return [ReactorSDK::Resources::Host]
+      #
+      def create(property_id:, attributes:)
+        create_resource(
+          "/properties/#{property_id}/hosts",
+          'hosts',
+          Resources::Host,
+          attributes: attributes
+        )
+      end
+
+      ##
+      # Updates an existing host.
+      #
+      # @param host_id     [String] Adobe host ID
+      # @param attributes  [Hash]   Fields to update
+      # @return [ReactorSDK::Resources::Host]
+      #
+      def update(host_id, attributes)
+        update_resource(
+          "/hosts/#{host_id}",
+          host_id,
+          'hosts',
+          Resources::Host,
+          attributes: attributes
+        )
+      end
+
+      ##
+      # Deletes a host permanently.
+      #
+      # @param host_id [String] Adobe host ID
+      # @return [nil]
+      #
+      def delete(host_id)
+        delete_resource("/hosts/#{host_id}")
+      end
+
+      ##
+      # Retrieves the property that owns a host.
+      #
+      # @param host_id [String] Adobe host ID
+      # @return [ReactorSDK::Resources::Property]
+      #
+      def property(host_id)
+        fetch_resource("/hosts/#{host_id}/property", Resources::Property)
+      end
+    end
+  end
+end