reactor_sdk 0.1.0

data/lib/reactor_sdk/response_parser.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+##
+# @file response_parser.rb
+# @description Transforms raw JSON:API response hashes into typed Ruby objects.
+#
+#   The Reactor API returns JSON:API format where every resource has:
+#     id         — the Adobe resource ID string
+#     type       — the resource type (e.g. "rules", "properties")
+#     attributes — a hash of the resource's field values
+#     meta       — optional metadata hash
+#
+#   For Revision resources, the response also includes:
+#     relationships — identifies the entity this revision belongs to
+#     included      — full snapshot of the revisioned resource at this point
+#
+#   This parser handles both standard resources and the richer Revision
+#   response without the caller needing to know the difference.
+#
+# @domain Infrastructure
+#
+
+module ReactorSDK
+  class ResponseParser
+    TYPE_REGISTRY = {
+      'app_configurations' => Resources::AppConfiguration,
+      'audit_events' => Resources::AuditEvent,
+      'builds' => Resources::Build,
+      'callbacks' => Resources::Callback,
+      'companies' => Resources::Company,
+      'data_elements' => Resources::DataElement,
+      'environments' => Resources::Environment,
+      'extension_package_usage_authorizations' => Resources::ExtensionPackageUsageAuthorization,
+      'extension_packages' => Resources::ExtensionPackage,
+      'extensions' => Resources::Extension,
+      'hosts' => Resources::Host,
+      'libraries' => Resources::Library,
+      'notes' => Resources::Note,
+      'profiles' => Resources::Profile,
+      'properties' => Resources::Property,
+      'revisions' => Resources::Revision,
+      'rule_components' => Resources::RuleComponent,
+      'rules' => Resources::Rule,
+      'secrets' => Resources::Secret
+    }.freeze
+
+    ##
+    # Parses a single JSON:API resource hash into a typed resource object.
+    #
+    # For Revision resources, also extracts the included entity snapshot
+    # and relationships from the full response envelope if provided.
+    #
+    # @param data           [Hash]       Raw JSON:API data hash
+    # @param resource_class [Class]      Resource class to instantiate
+    # @param response       [Hash, nil]  Full response envelope — used to extract
+    #                                    included array for Revision resources
+    # @return [Object] An instance of resource_class populated with parsed data
+    # @raise [ArgumentError] if data is nil
+    # @raise [KeyError]      if required JSON:API fields are missing
+    #
+    def parse(data, resource_class, response: nil)
+      raise ArgumentError, 'data cannot be nil' if data.nil?
+
+      base_args = {
+        id: data.fetch('id'),
+        type: data.fetch('type'),
+        attributes: data.fetch('attributes', {}),
+        meta: data.fetch('meta', {}),
+        relationships: data.fetch('relationships', {})
+      }
+
+      base_args.merge!(extract_revision_extras(data, response)) if resource_class == Resources::Revision
+
+      resource_class.new(**base_args)
+    end
+
+    ##
+    # Parses an array of JSON:API resource hashes into typed resource objects.
+    # Returns an empty array if data_array is nil or empty.
+    #
+    # @param data_array     [Array<Hash>] Array of raw JSON:API data hashes
+    # @param resource_class [Class]       Resource class to instantiate for each item
+    # @param response       [Hash, nil]   Full response envelope (passed through to parse)
+    # @return [Array<Object>] Array of resource_class instances
+    #
+    def parse_many(data_array, resource_class, response: nil)
+      Array(data_array).map { |data| parse(data, resource_class, response: response) }
+    end
+
+    ##
+    # Parses a single resource into the best matching SDK class
+    # using its JSON:API type.
+    #
+    # @param data [Hash]
+    # @param response [Hash, nil]
+    # @return [ReactorSDK::Resources::BaseResource]
+    #
+    def parse_auto(data, response: nil)
+      resource_class = TYPE_REGISTRY.fetch(data.fetch('type'), Resources::BaseResource)
+      parse(data, resource_class, response: response)
+    end
+
+    ##
+    # Parses a heterogeneous collection into typed SDK resources.
+    #
+    # @param data_array [Array<Hash>]
+    # @param response [Hash, nil]
+    # @return [Array<ReactorSDK::Resources::BaseResource>]
+    #
+    def parse_many_auto(data_array, response: nil)
+      Array(data_array).map { |data| parse_auto(data, response: response) }
+    end
+
+    private
+
+    ##
+    # Extracts the included entity snapshot and relationships from a Revision response.
+    #
+    # When fetching GET /revisions/:id, Adobe returns the full revisioned resource
+    # in the `included` array. This method finds the matching included resource
+    # and returns it alongside the relationships hash for entity identity extraction.
+    #
+    # @param data     [Hash]       The revision data object
+    # @param response [Hash, nil]  Full response envelope containing included array
+    # @return [Hash] Extra keyword args for Revision.new
+    #
+    def extract_revision_extras(data, response)
+      relationships   = data.fetch('relationships', nil)
+      included_entity = find_included_entity(data, response)
+
+      {
+        revision_relationships: relationships,
+        included_entity: included_entity
+      }
+    end
+
+    ##
+    # Finds the included entity resource matching this revision's entity relationship.
+    # Returns nil if no included array is present (e.g. list responses).
+    #
+    # @param data     [Hash]       The revision data object
+    # @param response [Hash, nil]  Full response envelope
+    # @return [Hash, nil] The matching included resource hash or nil
+    #
+    def find_included_entity(data, response)
+      return nil unless response.is_a?(Hash)
+
+      included = Array(response['included'])
+      return nil if included.empty?
+
+      entity_data = data.dig('relationships', 'entity', 'data')
+      return nil unless entity_data.is_a?(Hash)
+
+      included.find do |item|
+        item['id'] == entity_data['id'] &&
+          item['type'] == entity_data['type']
+      end
+    end
+  end
+end

data/lib/reactor_sdk/version.rb

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

data/lib/reactor_sdk.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday/multipart'
+require 'faraday/net_http'
+require 'faraday/retry'
+require 'json'
+require 'uri'
+
+require_relative 'reactor_sdk/version'
+require_relative 'reactor_sdk/error'
+require_relative 'reactor_sdk/configuration'
+require_relative 'reactor_sdk/authentication'
+require_relative 'reactor_sdk/rate_limiter'
+require_relative 'reactor_sdk/connection'
+require_relative 'reactor_sdk/paginator'
+require_relative 'reactor_sdk/resources/base_resource'
+require_relative 'reactor_sdk/resources/company'
+require_relative 'reactor_sdk/resources/property'
+require_relative 'reactor_sdk/resources/environment'
+require_relative 'reactor_sdk/resources/host'
+require_relative 'reactor_sdk/resources/rule'
+require_relative 'reactor_sdk/resources/rule_component'
+require_relative 'reactor_sdk/resources/data_element'
+require_relative 'reactor_sdk/resources/extension'
+require_relative 'reactor_sdk/resources/app_configuration'
+require_relative 'reactor_sdk/resources/callback'
+require_relative 'reactor_sdk/resources/extension_package'
+require_relative 'reactor_sdk/resources/extension_package_usage_authorization'
+require_relative 'reactor_sdk/resources/library'
+require_relative 'reactor_sdk/resources/library_with_resources'
+require_relative 'reactor_sdk/resources/upstream_chain_entry'
+require_relative 'reactor_sdk/resources/upstream_chain'
+require_relative 'reactor_sdk/resources/build'
+require_relative 'reactor_sdk/resources/revision'
+require_relative 'reactor_sdk/resources/audit_event'
+require_relative 'reactor_sdk/resources/note'
+require_relative 'reactor_sdk/resources/profile'
+require_relative 'reactor_sdk/resources/search_results'
+require_relative 'reactor_sdk/resources/secret'
+require_relative 'reactor_sdk/response_parser'
+require_relative 'reactor_sdk/reference_extractor'
+require_relative 'reactor_sdk/resource_metadata'
+require_relative 'reactor_sdk/resource_normalizer'
+require_relative 'reactor_sdk/library_snapshot_builder'
+require_relative 'reactor_sdk/library_comparison_builder'
+require_relative 'reactor_sdk/resources/comprehensive_resource'
+require_relative 'reactor_sdk/resources/comprehensive_rule'
+require_relative 'reactor_sdk/resources/comprehensive_data_element'
+require_relative 'reactor_sdk/resources/comprehensive_extension'
+require_relative 'reactor_sdk/resources/library_snapshot_extension_index'
+require_relative 'reactor_sdk/resources/library_snapshot_index'
+require_relative 'reactor_sdk/resources/library_snapshot'
+require_relative 'reactor_sdk/resources/library_comparison_entry'
+require_relative 'reactor_sdk/resources/library_comparison'
+require_relative 'reactor_sdk/resources/comprehensive_upstream_chain_entry'
+require_relative 'reactor_sdk/resources/comprehensive_upstream_chain'
+require_relative 'reactor_sdk/endpoints/base_endpoint'
+require_relative 'reactor_sdk/endpoints/companies'
+require_relative 'reactor_sdk/endpoints/app_configurations'
+require_relative 'reactor_sdk/endpoints/callbacks'
+require_relative 'reactor_sdk/endpoints/secrets'
+require_relative 'reactor_sdk/endpoints/properties'
+require_relative 'reactor_sdk/endpoints/environments'
+require_relative 'reactor_sdk/endpoints/hosts'
+require_relative 'reactor_sdk/endpoints/rules'
+require_relative 'reactor_sdk/endpoints/rule_components'
+require_relative 'reactor_sdk/endpoints/data_elements'
+require_relative 'reactor_sdk/endpoints/extensions'
+require_relative 'reactor_sdk/endpoints/extension_packages'
+require_relative 'reactor_sdk/endpoints/extension_package_usage_authorizations'
+require_relative 'reactor_sdk/endpoints/libraries'
+require_relative 'reactor_sdk/endpoints/builds'
+require_relative 'reactor_sdk/endpoints/revisions'
+require_relative 'reactor_sdk/endpoints/audit_events'
+require_relative 'reactor_sdk/endpoints/profiles'
+require_relative 'reactor_sdk/endpoints/search'
+require_relative 'reactor_sdk/endpoints/notes'
+require_relative 'reactor_sdk/client'

data/reactor_sdk.gemspec

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative 'lib/reactor_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'reactor_sdk'
+  spec.version = ReactorSDK::VERSION
+  spec.authors = ['Dhairya Gabhawala']
+  spec.email = ['gabhawaladhairya@gmail.com']
+
+  spec.summary     = 'Ruby SDK for the Adobe Launch Reactor API'
+  spec.description = <<~DESC
+    A production-ready Ruby SDK for the Adobe Launch (Data Collection)
+    Reactor API v1. Handles OAuth Server-to-Server authentication,
+    JSON:API response parsing, cursor-based pagination, per-org rate
+    limiting, retry logic, and a typed error hierarchy.
+  DESC
+  spec.homepage = 'https://github.com/dhairyagabha/reactor_sdk'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata = {
+    'source_code_uri' => spec.homepage,
+    'documentation_uri' => 'https://reactor-sdk.dhairyagabhawala.com',
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri' => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    'rubygems_mfa_required' => 'true'
+  }
+
+  # Only include what belongs in the published gem
+  spec.files = Dir.chdir(__dir__) do
+    Dir.glob(%w[
+               lib/**/*.rb
+               sig/**/*.rbs
+               LICENSE.txt
+               README.md
+               CHANGELOG.md
+               reactor_sdk.gemspec
+             ])
+  end
+
+  spec.require_paths = ['lib']
+
+  # ── Runtime dependencies ─────────────────────────────────────────
+  # HTTP client with middleware support
+  spec.add_dependency 'faraday',          '~> 2.9'
+  # Automatic retry on 429 and 5xx responses
+  spec.add_dependency 'faraday-retry',    '~> 2.2'
+  # Net::HTTP adapter for Faraday
+  spec.add_dependency 'faraday-net_http', '~> 3.3'
+  # Multipart upload support for extension package archive endpoints
+  spec.add_dependency 'faraday-multipart', '~> 1.1'
+
+  # ── Development dependencies ─────────────────────────────────────
+  # Interactive console for local development
+  spec.add_development_dependency 'irb',           '~> 1.17'
+  # Test framework
+  spec.add_development_dependency 'rspec',         '~> 3.13'
+  # Record and replay real HTTP interactions in tests
+  spec.add_development_dependency 'vcr',           '~> 6.3'
+  # Block real HTTP in tests
+  spec.add_development_dependency 'webmock',       '~> 3.23'
+  # Code style enforcement
+  spec.add_development_dependency 'rubocop',       '~> 1.65'
+  spec.add_development_dependency 'rubocop-rspec', '~> 3.0'
+  # Documentation generation
+  spec.add_development_dependency 'yard',          '~> 0.9'
+  # Rake task runner
+  spec.add_development_dependency 'rake',          '~> 13.0'
+end

data/sig/reactor_sdk.rbs

@@ -0,0 +1,346 @@
+module ReactorSDK
+  VERSION: String
+
+  class Configuration
+  end
+
+  class Client
+    attr_reader companies: Endpoints::Companies
+    attr_reader properties: Endpoints::Properties
+    attr_reader app_configurations: Endpoints::AppConfigurations
+    attr_reader callbacks: Endpoints::Callbacks
+    attr_reader secrets: Endpoints::Secrets
+    attr_reader environments: Endpoints::Environments
+    attr_reader hosts: Endpoints::Hosts
+    attr_reader rules: Endpoints::Rules
+    attr_reader rule_components: Endpoints::RuleComponents
+    attr_reader data_elements: Endpoints::DataElements
+    attr_reader extensions: Endpoints::Extensions
+    attr_reader extension_packages: Endpoints::ExtensionPackages
+    attr_reader extension_package_usage_authorizations: Endpoints::ExtensionPackageUsageAuthorizations
+    attr_reader libraries: Endpoints::Libraries
+    attr_reader builds: Endpoints::Builds
+    attr_reader audit_events: Endpoints::AuditEvents
+    attr_reader revisions: Endpoints::Revisions
+    attr_reader profiles: Endpoints::Profiles
+    attr_reader search: Endpoints::Search
+    attr_reader notes: Endpoints::Notes
+    attr_reader config: Configuration
+
+    def initialize: (
+      client_id: String,
+      client_secret: String,
+      org_id: String,
+      ?base_url: String,
+      ?ims_token_url: String,
+      ?timeout: Integer,
+      ?logger: untyped,
+      ?auto_refresh_token: bool
+    ) -> void
+  end
+
+  module Endpoints
+    class BaseEndpoint
+    end
+
+    class Companies < BaseEndpoint
+    end
+
+    class Properties < BaseEndpoint
+    end
+
+    class AppConfigurations < BaseEndpoint
+    end
+
+    class Callbacks < BaseEndpoint
+    end
+
+    class Secrets < BaseEndpoint
+    end
+
+    class Environments < BaseEndpoint
+    end
+
+    class Hosts < BaseEndpoint
+    end
+
+    class Rules < BaseEndpoint
+      def upstream_chain: (String | Resources::Rule rule_or_id, library_id: String, property_id: String) -> Resources::UpstreamChain
+      def find_comprehensive: (String rule_id, library_id: String, property_id: String) -> Resources::ComprehensiveRule
+      def comprehensive_upstream_chain: (
+        String | Resources::Rule rule_or_id,
+        library_id: String,
+        property_id: String
+      ) -> Resources::ComprehensiveUpstreamChain
+    end
+
+    class RuleComponents < BaseEndpoint
+    end
+
+    class DataElements < BaseEndpoint
+      def upstream_chain: (String | Resources::DataElement data_element_or_id, library_id: String, property_id: String) -> Resources::UpstreamChain
+      def find_comprehensive: (
+        String data_element_id,
+        library_id: String,
+        property_id: String
+      ) -> Resources::ComprehensiveDataElement
+      def comprehensive_upstream_chain: (
+        String | Resources::DataElement data_element_or_id,
+        library_id: String,
+        property_id: String
+      ) -> Resources::ComprehensiveUpstreamChain
+    end
+
+    class Extensions < BaseEndpoint
+      def upstream_chain: (String | Resources::Extension extension_or_id, library_id: String, property_id: String) -> Resources::UpstreamChain
+      def find_comprehensive: (
+        String extension_id,
+        library_id: String,
+        property_id: String
+      ) -> Resources::ComprehensiveExtension
+      def comprehensive_upstream_chain: (
+        String | Resources::Extension extension_or_id,
+        library_id: String,
+        property_id: String
+      ) -> Resources::ComprehensiveUpstreamChain
+    end
+
+    class ExtensionPackages < BaseEndpoint
+    end
+
+    class ExtensionPackageUsageAuthorizations < BaseEndpoint
+    end
+
+    class Libraries < BaseEndpoint
+      def find_snapshot: (String library_id, property_id: String) -> Resources::LibrarySnapshot
+      def compare: (
+        String current_library_id,
+        baseline_library_id: String,
+        property_id: String
+      ) -> Resources::LibraryComparison
+      def upstream_chain_for_resource: (
+        String | Resources::BaseResource resource_or_id,
+        library_id: String,
+        property_id: String,
+        ?resource_type: String
+      ) -> Resources::UpstreamChain
+      def comprehensive_upstream_chain_for_resource: (
+        String | Resources::BaseResource resource_or_id,
+        library_id: String,
+        property_id: String,
+        ?resource_type: String
+      ) -> Resources::ComprehensiveUpstreamChain
+    end
+
+    class Builds < BaseEndpoint
+    end
+
+    class AuditEvents < BaseEndpoint
+    end
+
+    class Revisions < BaseEndpoint
+    end
+
+    class Profiles < BaseEndpoint
+    end
+
+    class Search < BaseEndpoint
+    end
+
+    class Notes < BaseEndpoint
+    end
+  end
+
+  module Resources
+    class BaseResource
+      attr_reader id: String
+      attr_reader type: String
+      attr_reader attributes: Hash[untyped, untyped]
+      attr_reader meta: Hash[untyped, untyped]
+      attr_reader relationships: Hash[untyped, untyped]
+
+      def initialize: (
+        id: String,
+        type: String,
+        ?attributes: Hash[untyped, untyped],
+        ?meta: Hash[untyped, untyped],
+        ?relationships: Hash[untyped, untyped]
+      ) -> void
+      def []: (String | Symbol key) -> untyped
+      def relationship_data: (String | Symbol name) -> Hash[untyped, untyped]?
+      def relationship_id: (String | Symbol name) -> String?
+      def relationship_ids: (String | Symbol name) -> Array[String]
+      def ==: (untyped other) -> bool
+      def to_h: -> Hash[Symbol, untyped]
+    end
+
+    class SearchResults
+      attr_reader results: Array[BaseResource]
+      attr_reader meta: Hash[untyped, untyped]
+
+      def initialize: (
+        results: Array[BaseResource],
+        ?meta: Hash[untyped, untyped]
+      ) -> void
+      def each: { (BaseResource) -> untyped } -> Array[BaseResource]
+      def total_hits: -> Integer
+    end
+
+    class UpstreamChainEntry
+      attr_reader library: BaseResource
+      attr_reader stage: String?
+      attr_reader resource: BaseResource?
+      attr_reader revision_id: String?
+      attr_reader revision: Revision?
+
+      def initialize: (
+        library: BaseResource,
+        stage: String?,
+        resource: BaseResource?,
+        revision_id: String?,
+        revision: Revision?
+      ) -> void
+      def present?: -> bool
+      def entity_snapshot: -> Hash[untyped, untyped]?
+    end
+
+    class UpstreamChain
+      attr_reader resource_id: String
+      attr_reader resource_type: String?
+      attr_reader property_id: String
+      attr_reader target_library_id: String
+      attr_reader target_resource: BaseResource?
+      attr_reader target_revision_id: String?
+      attr_reader entries: Array[UpstreamChainEntry]
+
+      def initialize: (
+        resource_id: String,
+        resource_type: String?,
+        property_id: String,
+        target_library_id: String,
+        target_resource: BaseResource?,
+        target_revision_id: String?,
+        entries: Array[UpstreamChainEntry]
+      ) -> void
+      def each: { (UpstreamChainEntry) -> untyped } -> Array[UpstreamChainEntry]
+      def nearest_match: -> UpstreamChainEntry?
+      def found?: -> bool
+    end
+
+    class ComprehensiveResource
+      attr_reader resource: BaseResource
+      def associated_records: -> Array[BaseResource]
+      def normalized_payload: -> Hash[untyped, untyped]
+      def normalized_json: -> String
+    end
+
+    class ComprehensiveRule < ComprehensiveResource
+      attr_reader rule_components: Array[RuleComponent]
+    end
+
+    class ComprehensiveDataElement < ComprehensiveResource
+      attr_reader referenced_data_elements: Array[DataElement]
+      attr_reader impacted_rules: Array[Rule]
+    end
+
+    class ComprehensiveExtension < ComprehensiveResource
+      attr_reader data_elements: Array[DataElement]
+      attr_reader rule_components: Array[RuleComponent]
+      attr_reader rules: Array[Rule]
+    end
+
+    class LibrarySnapshot
+      attr_reader property_id: String
+      attr_reader library: LibraryWithResources
+      attr_reader rules: Array[Rule]
+      attr_reader data_elements: Array[DataElement]
+      attr_reader extensions: Array[Extension]
+      attr_reader rule_components: Array[RuleComponent]
+      attr_reader rule_components_by_rule_id: Hash[String, Array[RuleComponent]]
+      def top_level_resources: -> Array[BaseResource]
+      def all_resources: -> Array[BaseResource]
+      def resource_by_id: -> Hash[String, BaseResource]
+      def find_resource: (String resource_id) -> BaseResource?
+      def rule_components_for_rule: (String | Rule rule_or_id) -> Array[RuleComponent]
+      def referenced_data_elements_for: (String | DataElement data_element_or_id) -> Array[DataElement]
+      def impacted_rules_for: (String | DataElement data_element_or_id) -> Array[Rule]
+      def data_elements_for_extension: (String | Extension extension_or_id) -> Array[DataElement]
+      def rule_components_for_extension: (String | Extension extension_or_id) -> Array[RuleComponent]
+      def rules_for_extension: (String | Extension extension_or_id) -> Array[Rule]
+      def resource_revision_id: (String | BaseResource resource_or_id) -> String?
+      def comprehensive_resource: (String resource_id, ?resource_type: String) -> (ComprehensiveRule | ComprehensiveDataElement | ComprehensiveExtension)?
+    end
+
+    class ComprehensiveUpstreamChainEntry
+      attr_reader library: BaseResource
+      attr_reader stage: String?
+      attr_reader resource: BaseResource?
+      attr_reader revision_id: String?
+      attr_reader revision: Revision?
+      attr_reader comprehensive_resource: ComprehensiveResource?
+      def present?: -> bool
+      def entity_snapshot: -> Hash[untyped, untyped]?
+      def normalized_payload: -> Hash[untyped, untyped]?
+      def normalized_json: -> String?
+    end
+
+    class ComprehensiveUpstreamChain
+      attr_reader resource_id: String
+      attr_reader resource_type: String?
+      attr_reader property_id: String
+      attr_reader target_library_id: String
+      attr_reader target_resource: BaseResource?
+      attr_reader target_revision_id: String?
+      attr_reader target_comprehensive_resource: ComprehensiveResource?
+      attr_reader entries: Array[ComprehensiveUpstreamChainEntry]
+      def each: { (ComprehensiveUpstreamChainEntry) -> untyped } -> Array[ComprehensiveUpstreamChainEntry]
+      def nearest_match: -> ComprehensiveUpstreamChainEntry?
+      def found?: -> bool
+    end
+
+    class LibraryComparisonEntry
+      attr_reader resource_id: String
+      attr_reader resource_type: String
+      attr_reader current_library_id: String
+      attr_reader baseline_library_id: String
+      attr_reader current_resource: BaseResource?
+      attr_reader baseline_resource: BaseResource?
+      attr_reader current_revision_id: String?
+      attr_reader baseline_revision_id: String?
+      attr_reader current_comprehensive_resource: ComprehensiveResource?
+      attr_reader baseline_comprehensive_resource: ComprehensiveResource?
+      def resource_name: -> String?
+      def status: -> String
+      def added?: -> bool
+      def removed?: -> bool
+      def modified?: -> bool
+      def unchanged?: -> bool
+      def changed?: -> bool
+      def present_in_current?: -> bool
+      def present_in_baseline?: -> bool
+      def current_normalized_payload: -> Hash[untyped, untyped]?
+      def baseline_normalized_payload: -> Hash[untyped, untyped]?
+      def current_normalized_json: -> String
+      def baseline_normalized_json: -> String
+      def changeset_document: (?position: Integer) -> Hash[Symbol, untyped]
+    end
+
+    class LibraryComparison
+      attr_reader current_library_id: String
+      attr_reader baseline_library_id: String
+      attr_reader property_id: String
+      attr_reader current_snapshot: LibrarySnapshot
+      attr_reader baseline_snapshot: LibrarySnapshot
+      attr_reader entries: Array[LibraryComparisonEntry]
+      def current_library: -> LibraryWithResources
+      def baseline_library: -> LibraryWithResources
+      def each: { (LibraryComparisonEntry) -> untyped } -> Array[LibraryComparisonEntry]
+      def added_entries: -> Array[LibraryComparisonEntry]
+      def removed_entries: -> Array[LibraryComparisonEntry]
+      def modified_entries: -> Array[LibraryComparisonEntry]
+      def unchanged_entries: -> Array[LibraryComparisonEntry]
+      def changed_entries: -> Array[LibraryComparisonEntry]
+      def changeset_documents: (?include_unchanged: bool) -> Array[Hash[Symbol, untyped]]
+    end
+  end
+end