glazed-aws 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abc0ee55acf9c806cea84fd269b250283e24bcdf32f03a41009e3ff75d579b66
+  data.tar.gz: 9d468db2b2b4e4264f9c9c0af4a16617513a87f5c3ace4c8714a47bc13d5236b
+SHA512:
+  metadata.gz: ae2aa7b00c8ab8be71f2a01b9ad64b05b2c905f8736391b8c291926909cab07e0ed239d48b953a6d568d4c45974509fe1ebf9c957c316a82b14e4d0b5e1b83e9
+  data.tar.gz: c4e701032a6baab3fac4a4672be3a4c2d26da14e1d4a1d0153c205184905eb2650b9b7cfb9c7d818ddbeadd99f81039ee6b63947e9300a8eadc2a29e2f422e1e

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.yardopts

@@ -0,0 +1,5 @@
+--load ../support/yard/rbs_inline.rb
+--private
+--protected
+--exclude lib/glazed/v1/
+lib/**/*.rb

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [0.1.0] - 2026-10-14
+
+Initial release.
+
+### Enhancements
+
+- `s3` storage: skips content identical to the stored object by SHA-256 checksum, and writes conditionally (`If-Match`/`If-None-Match`) so concurrent writers are never overwritten unseen
+- `s3` storage supports conditional writes by ETag, so it can hold the `sqlite` state of `glazed orchestrate`

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,3 @@
+# glazed-aws
+
+AWS integrations for [glazed](https://github.com/sorah/glazed): the `s3` storage (`Glazed::Storages::S3`). Installing this gem makes `{"s3": {...}}` storage configs available.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Bundler::GemHelper.tag_prefix = "glazed-aws/"
+
+task default: :spec

data/lib/glazed/aws/version.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+module Glazed
+  module Aws
+    # Gem version.
+    VERSION = '0.1.0' #: String
+  end
+end

data/lib/glazed/aws.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'glazed'
+require_relative 'aws/version'
+
+module Glazed
+  # AWS integrations for glazed.
+  module Aws
+  end
+end

data/lib/glazed/storages/s3.rb

@@ -0,0 +1,192 @@
+# typed: strict
+# frozen_string_literal: true
+
+# SPDX-License-Identifier: Apache-2.0
+
+require 'base64'
+require 'digest'
+require 'aws-sdk-s3'
+require 'glazed/must'
+require 'glazed/proto'
+require 'glazed/storages/base'
+
+module Glazed
+  # Namespace of storage implementations; glazed-aws adds {S3}.
+  module Storages
+    # Amazon S3 bucket. Each file is one object under the prefix; with bucket
+    # versioning, pointers name the exact object version written.
+    #
+    # @example
+    #   storage = Glazed::Storages::S3.new(bucket: 'netconf', prefix: 'raw/')
+    #   storage.write(key: 'core/rt1', content: config, message: 'rt1')
+    class S3 < Base
+      # Content type of stored objects. No charset: devices do not all use UTF-8.
+      CONTENT_TYPE = 'text/plain' #: String
+      # Attempts at writing an object that other writers keep changing.
+      MAX_ATTEMPTS = 3 #: Integer
+
+      # @param bucket [String] bucket name
+      # @param prefix [String] prefix prepended to every key
+      # @param region [String, nil] bucket region; the SDK default when nil
+      # @param client [Aws::S3::Client, nil] client to use instead of building one
+      #: (bucket: String, ?prefix: String, ?region: String?, ?client: ::Aws::S3::Client?) -> void
+      def initialize(bucket:, prefix: '', region: nil, client: nil)
+        super()
+        @bucket = bucket #: String
+        @prefix = prefix #: String
+        @region = region #: String?
+        @client = client #: ::Aws::S3::Client?
+      end
+
+      # Builds a storage from {Proto::V1::S3Storage}.
+      #
+      # @param settings [Google::Protobuf::MessageExts] a {Proto::V1::S3Storage}
+      # @return [S3] the storage
+      # @raise [Must::Violation] when settings is another message
+      #: (Google::Protobuf::MessageExts settings) -> S3
+      def self.from_proto(settings)
+        s3 = Must.be_a(settings, Proto::V1::S3Storage)
+        new(bucket: s3.bucket, prefix: s3.prefix, region: s3.region.empty? ? nil : s3.region)
+      end
+
+      # @return [String] bucket name
+      #: String
+      attr_reader :bucket
+      # @return [String] prefix prepended to every key
+      #: String
+      attr_reader :prefix
+
+      # Puts one object per changed file, compared by SHA-256 checksum. Puts are
+      # conditional on the object checked, so a concurrent writer is never
+      # overwritten unseen. S3 has no multi-object transaction, so the message
+      # is not recorded.
+      #
+      # @param files [Array<Array(String, String)>] keys and contents
+      # @param message [Proc] builds a description of the change, unused
+      # @return [Array<WriteResult>] the object version holding each file, and whether the file changed
+      # @raise [InvalidKey] for an unsafe key
+      # @raise [Aws::S3::Errors::ServiceError] when a request fails, or the object keeps changing under concurrent writers
+      #: (Array[Base::file] files, message: Base::message_builder) -> Array[WriteResult]
+      def write_all(files, message:)
+        files.each { |key, _| validate_key(key) }
+        files.map { |key, content| write_object("#{prefix}#{key}", content) }
+      end
+
+      # Reads the object version a pointer names.
+      #
+      # @param pointer [Proto::V1::Pointer] pointer with an s3 location
+      # @return [String] the content
+      # @raise [ArgumentError] when the pointer is not an s3 location
+      # @raise [Aws::S3::Errors::ServiceError] when the object or version does not exist
+      #: (Proto::V1::Pointer pointer) -> String
+      def read(pointer)
+        location = location_of(pointer, Proto::V1::S3Location)
+        response = if location.version_id.empty?
+          client.get_object(bucket: location.bucket, key: location.key)
+        else
+          client.get_object(bucket: location.bucket, key: location.key, version_id: location.version_id)
+                   end
+        response.body.read.to_s
+      end
+
+      # @return [Boolean] true; versions are ETags
+      #: () -> bool
+      def conditional? = true
+
+      # @param key [String] file key
+      # @return [String, nil] ETag of the object, or nil when it is missing
+      # @raise [InvalidKey] for an unsafe key
+      # @raise [Aws::S3::Errors::ServiceError] for errors other than not found
+      #: (String key) -> String?
+      def version_of(key) = head("#{prefix}#{validate_key(key)}")&.etag
+
+      # @param key [String] file key
+      # @return [Versioned, nil] the content and its ETag, or nil when the object is missing
+      # @raise [InvalidKey] for an unsafe key
+      # @raise [Aws::S3::Errors::ServiceError] for errors other than not found
+      #: (String key) -> Versioned?
+      def read_versioned(key)
+        response = client.get_object(bucket:, key: "#{prefix}#{validate_key(key)}")
+        Versioned.new(content: response.body.read.to_s, version: response.etag)
+      rescue ::Aws::S3::Errors::NoSuchKey
+        nil
+      end
+
+      # Puts the object with If-Match on the expected ETag, or If-None-Match
+      # when it must not exist yet.
+      #
+      # @param key [String] file key
+      # @param content [String] new content
+      # @param expected_version [String, nil] ETag read earlier; nil to create a missing object only
+      # @return [String] ETag of the written object
+      # @raise [Conflict] when the object holds another version
+      # @raise [InvalidKey] for an unsafe key
+      # @raise [Aws::S3::Errors::ServiceError] when the request fails otherwise
+      #: (key: String, content: String, expected_version: String?) -> String
+      def write_if(key:, content:, expected_version:)
+        object_key = "#{prefix}#{validate_key(key)}"
+        checksum = Base64.strict_encode64(Digest::SHA256.digest(content))
+        response = if expected_version
+          client.put_object(bucket:, key: object_key, body: content, checksum_sha256: checksum, if_match: expected_version)
+        else
+          client.put_object(bucket:, key: object_key, body: content, checksum_sha256: checksum, if_none_match: '*')
+                   end
+        response.etag
+      rescue ::Aws::S3::Errors::PreconditionFailed, ::Aws::S3::Errors::ConditionalRequestConflict => e
+        raise Conflict, "s3://#{bucket}/#{object_key} changed: #{e.message}"
+      end
+
+      # @param key [String] object key
+      # @param content [String] content
+      # @return [WriteResult] the version holding the content, and whether it was written
+      # @raise [Aws::S3::Errors::ServiceError] when a request fails or attempts run out
+      #: (String key, String content) -> WriteResult
+      private def write_object(key, content)
+        checksum = Base64.strict_encode64(Digest::SHA256.digest(content))
+        attempts = 0
+        begin
+          attempts += 1
+          current = head(key)
+          if current && current.checksum_sha256 == checksum
+            return WriteResult.new(pointer: pointer(key, current.version_id), changed: false)
+          end
+
+          response = if current
+            client.put_object(bucket:, key:, body: content, content_type: CONTENT_TYPE, checksum_sha256: checksum, if_match: current.etag)
+          else
+            client.put_object(bucket:, key:, body: content, content_type: CONTENT_TYPE, checksum_sha256: checksum, if_none_match: '*')
+                     end
+        rescue ::Aws::S3::Errors::PreconditionFailed, ::Aws::S3::Errors::ConditionalRequestConflict
+          # Another writer changed the object after it was checked.
+          retry if attempts < MAX_ATTEMPTS
+          raise
+        end
+        WriteResult.new(pointer: pointer(key, response.version_id), changed: true)
+      end
+
+      # @param key [String] object key
+      # @return [Aws::S3::Types::HeadObjectOutput, nil] the current object with its checksum, or nil when absent
+      # @raise [Aws::S3::Errors::ServiceError] for errors other than not found
+      #: (String key) -> ::Aws::S3::Types::HeadObjectOutput?
+      private def head(key)
+        client.head_object(bucket:, key:, checksum_mode: 'ENABLED')
+      rescue ::Aws::S3::Errors::NotFound
+        nil
+      end
+
+      # @param key [String] object key
+      # @param version_id [String, nil] object version; nil for an unversioned bucket
+      # @return [Proto::V1::Pointer] pointer to the version
+      #: (String key, String? version_id) -> Proto::V1::Pointer
+      private def pointer(key, version_id)
+        pointer_to(Proto::V1::S3Location.new(bucket:, key:, version_id: version_id.to_s))
+      end
+
+      # @return [Aws::S3::Client] the injected client, or one built on first use
+      #: () -> ::Aws::S3::Client
+      private def client
+        @client ||= @region ? ::Aws::S3::Client.new(region: @region) : ::Aws::S3::Client.new
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: glazed-aws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sorah Fukumori
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: glazed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email:
+- her@sorah.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".yardopts"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/glazed/aws.rb
+- lib/glazed/aws/version.rb
+- lib/glazed/storages/s3.rb
+homepage: https://github.com/sorah/glazed
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/sorah/glazed
+  source_code_uri: https://github.com/sorah/glazed/tree/main/glazed-aws
+  changelog_uri: https://github.com/sorah/glazed/blob/main/glazed-aws/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: AWS integrations for glazed, such as S3 storage
+test_files: []