archived_remote_object 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255eec19ca259dc36cf8fdd0bdeac77e787044de8130631c539f3363c8a5cbf1
-  data.tar.gz: c33825094d55dce29d7f45e13fca5a2ff18ba21048140fdb12b2bf9a44b41054
+  metadata.gz: b0210c27f442830b091c1849865ace9a29e961fea290e953e85e3315458e774a
+  data.tar.gz: 3024af7b02b867cb3a56f752a4cc714a0d457965a6c9737b6edd5dd2cd880be9
 SHA512:
-  metadata.gz: 878e44a20cccd12a454ca35d040588a38a37745c5f598646b1b4a543fa19df30c280b875feda87dd39878b5aab7701a88ac1970e804b245773961ee348a3d684
-  data.tar.gz: 3eaaf3e07296ea1e6648dcc03d20657bca9ea6526f72c1c76ba5ff3d1f3675bdc6c7b983b584394065c3eb5af96fc2c940c868a6c6519d5eae108c1e26361397
+  metadata.gz: eefb9c00c28a82b6f3722f52daa39e0edb6b0aee1fe6d652a3f091c003ccb56de792efd4f7821b901f9e7b41da84c95b905570d29e06529cdfa3ba248f88b1e5
+  data.tar.gz: 33eacea6fee046f83957d2fb8d79dbc0bf4456173a566f4cc062b1f8e789cdcb985f00d19de3e30d34e610e8a2db0e2153fa5a4f0834129f12c7d9545e5b82a1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Aleksey Strizhak
+
+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/lib/archived_remote_object.rb

@@ -0,0 +1,25 @@
+require "archived_remote_object/version"
+require "archived_remote_object/configuration"
+require "archived_remote_object/archive/archived_object"
+require "archived_remote_object/archive/restored_object"
+require "archived_remote_object/aws_s3/archived_object"
+require "archived_remote_object/aws_s3/remote_object"
+require "archived_remote_object/aws_s3/client"
+
+module ArchivedRemoteObject
+  def self.get_object(key) # rubocop:disable Metrics/MethodLength
+    Archive::RestoredObject.new(
+      key: key,
+      archived_object: Archive::ArchivedObject.new(
+        key: key,
+        remote_object: AwsS3::ArchivedObject.new(
+          key: key,
+          remote_object: AwsS3::RemoteObject.new(
+            key: key,
+            remote_client: AwsS3::Client.new
+          )
+        )
+      )
+    ).call
+  end
+end

data/lib/archived_remote_object/archive/archived_object.rb

@@ -0,0 +1,65 @@
+require "archived_remote_object/aws_s3/archived_object"
+
+module ArchivedRemoteObject
+  module Archive
+    class ArchivedObject
+      CantBeRestoredError = Class.new(StandardError)
+      CantStopArchivingOnDurationError = Class.new(StandardError)
+
+      def initialize(
+        key:,
+        remote_object: AwsS3::ArchivedObject.new(key: key)
+      )
+        self.remote_object = remote_object
+      end
+
+      def archived?
+        remote_object.archived?
+      end
+
+      def restore_in_progress?
+        return false unless archived?
+
+        remote_object.restore_in_progress?
+      end
+
+      def restored?
+        return false unless archived?
+
+        remote_object.restored?
+      end
+
+      def restore
+        raise CantBeRestoredError if available? || restore_in_progress?
+
+        remote_object.restore
+      end
+
+      def stop_archiving_on_duration
+        raise CantStopArchivingOnDurationError if !restored? || restore_in_progress?
+
+        remote_object.stop_archiving_on_duration
+      end
+
+      def available?
+        !archived? || restored?
+      end
+
+      def sync
+        tap { remote_object.sync }
+      end
+
+      def debug_state
+        {
+          restore_in_progress: restore_in_progress?,
+          restored: restored?,
+          **remote_object.debug_state
+        }
+      end
+
+      private
+
+      attr_accessor :remote_object
+    end
+  end
+end

data/lib/archived_remote_object/archive/restored_object.rb

@@ -0,0 +1,46 @@
+require "ostruct"
+require "archived_remote_object/archive/archived_object"
+
+module ArchivedRemoteObject
+  module Archive
+    class RestoredObject
+      def initialize(
+        key:,
+        archived_object: Archive::ArchivedObject.new(key: key)
+      )
+        self.archived_object = archived_object
+      end
+
+      def call
+        assign_attributes
+
+        if attributes.status == :archived
+          archived_object.restore
+          attributes.status = :restoration_initiated
+        end
+
+        attributes
+      end
+
+      private
+
+      def attributes
+        @attributes ||= OpenStruct.new
+      end
+
+      def assign_attributes # rubocop:disable Metrics/AbcSize
+        if archived_object.available?
+          attributes.status = :available
+        elsif archived_object.restore_in_progress?
+          attributes.status = :in_progress
+          attributes.debug_state = archived_object.debug_state
+        else
+          attributes.status = :archived
+          attributes.debug_state = archived_object.debug_state
+        end
+      end
+
+      attr_accessor :archived_object
+    end
+  end
+end

data/lib/archived_remote_object/aws_s3/archived_object.rb

@@ -0,0 +1,70 @@
+require "archived_remote_object/aws_s3/remote_object"
+
+module ArchivedRemoteObject
+  module AwsS3
+    class ArchivedObject
+      RestoreResponseChangedError = Class.new(StandardError)
+
+      def initialize(
+        key:,
+        remote_object: AwsS3::RemoteObject.new(key: key)
+      )
+        self.key = key
+        self.remote_object = remote_object
+      end
+
+      def archived?
+        remote_object.attributes.storage_class == "DEEP_ARCHIVE"
+      end
+
+      def restore_in_progress?
+        restore_in_progress = parse_restore_status[0]
+        return false unless restore_in_progress
+
+        restore_in_progress.to_s.downcase == "true"
+      end
+
+      def restored?
+        return false unless expiry_date
+
+        Time.parse(expiry_date) > Time.now
+      end
+
+      def restore
+        remote_object.restore(key: key, duration: restore_duration_days)
+      end
+
+      def stop_archiving_on_duration
+        remote_object.storage_class = 'STANDARD'
+      end
+
+      def sync
+        tap { remote_object.sync }
+      end
+
+      def debug_state
+        remote_object.debug_state
+      end
+
+      private
+
+      attr_accessor :key, :remote_object
+
+      def restore_duration_days
+        ArchivedRemoteObject.configuration.archive_restore_duration_days
+      end
+
+      def expiry_date
+        parse_restore_status[1]
+      end
+
+      def parse_restore_status
+        remote_object.attributes.restore =~ /ongoing-request="(.+?)"(, expiry-date="(.+?)")?/
+        last_match = Regexp.last_match
+        raise RestoreResponseChangedError if !remote_object.attributes.restore.nil? && !last_match
+
+        last_match&.captures || []
+      end
+    end
+  end
+end

data/lib/archived_remote_object/aws_s3/client.rb

@@ -0,0 +1,72 @@
+require "aws-sdk-s3"
+
+module ArchivedRemoteObject
+  module AwsS3
+    class Client
+      attr_accessor :s3_client
+
+      def initialize
+        self.s3_client = Aws::S3::Client.new(
+          stub_responses: stub_enabled?,
+          region: ArchivedRemoteObject.configuration.aws_region,
+          credentials: Aws::Credentials.new(
+            ArchivedRemoteObject.configuration.aws_access_key_id,
+            ArchivedRemoteObject.configuration.aws_secret_access_key
+          )
+        )
+      end
+
+      def fetch_object_data(key:, stubbed_response: {})
+        if stub_enabled? && !stubbed?(:head_object)
+          response = {
+            storage_class: "DEEP_ARCHIVE",
+            restore: nil,
+            **stubbed_response
+          }
+          s3_client.stub_responses(:head_object, response)
+        end
+        s3_client.head_object(bucket: bucket, key: key)
+      end
+
+      def restore(key:, duration:)
+        s3_client.stub_responses(:restore_object) if stub_enabled? && !stubbed?(:restore_object)
+        s3_client.restore_object(bucket: bucket, key: key, restore_request: { days: duration })
+      end
+
+      def assign_tag(key:, set:)
+        s3_client.stub_responses(:put_object_tagging) if stub_enabled? && !stubbed?(:put_object_tagging)
+        s3_client.put_object_tagging(bucket: bucket, key: key, tagging: { tag_set: [{ key: set[0], value: set[1] }] })
+      end
+
+      def assign_storage_class(key:, storage_class:)
+        s3_client.stub_responses(:copy_object) if stub_enabled? && !stubbed?(:copy_object)
+        s3_client.copy_object(bucket: bucket, key: key, copy_source: "#{bucket}/#{key}", storage_class: storage_class)
+      end
+
+      def delete(key:)
+        s3_client.stub_responses(:delete_object) if stub_enabled? && !stubbed?(:delete_object)
+        s3_client.delete_object(bucket: bucket, key: key)
+      end
+
+      def exists?(key:)
+        !!fetch_object_data(key: key)
+      rescue Aws::S3::Errors::NotFound
+        false
+      end
+
+      private
+
+      def bucket
+        ArchivedRemoteObject.configuration.aws_bucket
+      end
+
+      def stub_enabled?
+        ArchivedRemoteObject.configuration.stub_client_requests
+      end
+
+      def stubbed?(key)
+        !!s3_client.instance_variable_get('@stubs').fetch(key, nil)
+      end
+    end
+  end
+end

data/lib/archived_remote_object/aws_s3/remote_object.rb

@@ -0,0 +1,61 @@
+require "archived_remote_object/aws_s3/client"
+
+module ArchivedRemoteObject
+  module AwsS3
+    class RemoteObject
+      attr_accessor :key, :remote_client
+
+      def initialize(
+        key:,
+        remote_client: AwsS3::Client.new
+      )
+        self.key = key
+        self.remote_client = remote_client
+      end
+
+      def attributes
+        return @attributes if @attributes
+
+        fetch_attributes
+      end
+
+      def restore(**args)
+        remote_client.restore(**args)
+      end
+
+      def assign_tag(key:, value:)
+        remote_client.assign_tag(key: self.key, set: [key, value])
+      end
+
+      def storage_class=(storage_class)
+        # accepts STANDARD, STANDARD_IA, ONEZONE_IA, GLACIER, INTELLIGENT_TIERING, DEEP_ARCHIVE
+        remote_client.assign_storage_class(key: key, storage_class: storage_class)
+      end
+
+      def delete
+        remote_client.delete(key: key)
+      end
+
+      def exists?
+        remote_client.exists?(key: key)
+      end
+
+      def sync
+        tap { fetch_attributes }
+      end
+
+      def debug_state
+        {
+          restore: attributes.restore,
+          storage_class: attributes.storage_class
+        }
+      end
+
+      private
+
+      def fetch_attributes
+        @attributes = remote_client.fetch_object_data(key: key)
+      end
+    end
+  end
+end

data/lib/archived_remote_object/configuration.rb

@@ -0,0 +1,13 @@
+require "ostruct"
+
+module ArchivedRemoteObject
+  class << self
+    def configuration
+      @configuration ||= OpenStruct.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/archived_remote_object/version.rb

@@ -0,0 +1,3 @@
+module ArchivedRemoteObject
+  VERSION = "0.1.5".freeze
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archived_remote_object
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Aleksey Strizhak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-07 00:00:00.000000000 Z
+date: 2021-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -73,7 +73,16 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE.txt
+- lib/archived_remote_object.rb
+- lib/archived_remote_object/archive/archived_object.rb
+- lib/archived_remote_object/archive/restored_object.rb
+- lib/archived_remote_object/aws_s3/archived_object.rb
+- lib/archived_remote_object/aws_s3/client.rb
+- lib/archived_remote_object/aws_s3/remote_object.rb
+- lib/archived_remote_object/configuration.rb
+- lib/archived_remote_object/version.rb
 homepage: https://github.com/Mifrill/archived_remote_object.git
 licenses:
 - MIT
@@ -95,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.16
 signing_key: 
 specification_version: 4
 summary: Get archived remote object with delayed restore