stashify-aws-s3 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e829c9cd4d6a20de8ba74954e9700c9264e94d6454b9a09c3a422bcadd6a5ebc
-  data.tar.gz: a196a368b2bcca6df33f91445f03231795503855d41255c7fb00efcbed4af6c3
+  metadata.gz: ce717afda57c7d79f38076ed0a99d31a30addd862130127c39e0b1cd4e9b74e0
+  data.tar.gz: 4d8201ac2421c564ac6ddd315d6423349d6f9ec9be14fc3fa106f5884ce1ba3c
 SHA512:
-  metadata.gz: 4f22f06f44dccd3110f1fc050ca867c00fa838c63746939e7f69860c774f4473893262d4b072c6bf869937f58ba4b9f0038d0a7046fbdf4a7da477fec6b763e8
-  data.tar.gz: 6632d1f70f3144459e13bf448cacaf107371b8807cb4bdcfa235103735674350ff74a4d1618e8d3bc1e6841179f010a4e616347bf8bc907374285ff9d062e8e8
+  metadata.gz: 105eeb1a4271a585ffea9e05dd8accfc38ad2cf95b36d75d8c43f40e202320f7c45fd3ca3fd20fafe0a27b4470cb8b349576686867ce6063f51b1f9d3ff71272
+  data.tar.gz: ee603c5f9313be928fde0d3fb470595af324d6b21c042fb62e6103650b442675a63bbf7ec2d4aae550b246d1594ee986333d96335f2a39660e9206400aa28294

data/.reek.yml

@@ -1,7 +1,4 @@
 detectors:
-  IrresponsibleModule:
-    enabled: false
-
   UncommunicativeModuleName:
     accept:
       - Stashify::AWS::S3

data/.rubocop.yml

@@ -2,9 +2,6 @@ AllCops:
   TargetRubyVersion: 2.6
   NewCops: enable
 
-Style/Documentation:
-  Enabled: false
-
 Style/StringLiterals:
   Enabled: true
   EnforcedStyle: double_quotes

data/Gemfile

@@ -17,4 +17,4 @@ gem "guard-rspec"
 gem "guard-rubocop"
 
 gem "byebug"
-gem "rantly"
+gem "stashify-contract"

data/Gemfile.lock

@@ -1,16 +1,16 @@
 PATH
   remote: .
   specs:
-    stashify-aws-s3 (0.1.0)
+    stashify-aws-s3 (1.2.0)
       aws-sdk-s3 (~> 1.119.2)
-      stashify (~> 3.0.0)
+      stashify (~> 3.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     aws-eventstream (1.2.0)
-    aws-partitions (1.738.0)
+    aws-partitions (1.743.0)
     aws-sdk-core (3.171.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.651.0)
@@ -63,7 +63,7 @@ GEM
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.22.1)
-    parser (3.2.1.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     pry (0.14.2)
       coderay (~> 1.1)
@@ -93,21 +93,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.48.1)
+    rubocop (1.49.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.26.0, < 2.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.28.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     shellany (0.0.1)
-    stashify (3.0.0)
+    stashify (3.2.1)
+    stashify-contract (1.0.1)
+      rantly (~> 2.0.0)
+      rspec (~> 3.0)
     thor (1.2.1)
     unicode-display_width (2.4.2)
 
@@ -121,11 +124,11 @@ DEPENDENCIES
   guard-rspec
   guard-rubocop
   rake (~> 13.0)
-  rantly
   reek (~> 6.1.4)
   rspec (~> 3.0)
   rubocop (~> 1.21)
   stashify-aws-s3!
+  stashify-contract
 
 BUNDLED WITH
    2.2.33

data/README.md

@@ -1,8 +1,6 @@
 # Stashify::Aws::S3
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stashify/aws/s3`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+This is an implementation of the [Stashify](https://rubydoc.info/gems/stashify) abstraction for AWS S3. It operates under the assumption that the "/" in file names has the typical meaning of a path separater.
 
 ## Installation
 
@@ -22,7 +20,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This implementation is built on top of an instance of `Aws::S3::Bucket`. The following usage is an abbreviated form to illustrate how to engage in this particular library. For a more extensive example see [Stashify's Usage](https://rubydoc.info/gems/stashify#usage).
+
+```ruby
+> require "aws-sdk-s3"
+=> true
+> s3 = Aws::S3::Resource.new
+=> #<Aws::S3::Resource:0x0000558723dad2e8 @client=#<Aws::S3::Client>>
+irb(main):005:0> bucket = s3.bucket("some-bucket")
+=> 
+#<Aws::S3::Bucket:0x0000558723f5a6e0
+...
+> file.contents
+=> "foo"
+> require "stashify/directory/aws/s3"
+=> true
+> dir = Stashify::Directory::AWS::S3.new(bucket: bucket, path: "path/to")
+=> 
+#<Stashify::Directory::AWS::S3:0x000055872460c628
+...
+> dir.find("file") == file
+=> true
+```
 
 ## Development
 

data/lib/stashify/aws/s3/version.rb

@@ -3,7 +3,7 @@
 module Stashify
   module AWS
     module S3
-      VERSION = "1.0.0"
+      VERSION = "1.2.0"
     end
   end
 end

data/lib/stashify/directory/aws/s3.rb

@@ -6,6 +6,10 @@ require "stashify/file/aws/s3"
 module Stashify
   class Directory
     module AWS
+      # An implementation for interacting with AWS S3 buckets as if
+      # they had directories with "/" as a path separator. In
+      # addition to a path, it also needs a Aws::S3::Bucket object
+      # representing the bucket the file resides within.
       class S3 < Stashify::Directory
         attr_reader :bucket, :path
 
@@ -14,6 +18,13 @@ module Stashify
           super(path: path)
         end
 
+        def parent
+          Stashify::Directory::AWS::S3.new(
+            bucket: @bucket,
+            path: ::File.dirname(path),
+          )
+        end
+
         def files
           @bucket.objects.map do |object|
             key = object.key
@@ -21,12 +32,6 @@ module Stashify
           end.compact
         end
 
-        def ==(other)
-          self.class == other.class && @bucket == other.bucket && path == other.path
-        end
-
-        private
-
         def directory?(name)
           @bucket.objects(prefix: path_of(name, "")).count.positive?
         end
@@ -35,13 +40,17 @@ module Stashify
           Stashify::Directory::AWS::S3.new(bucket: @bucket, path: path_of(name))
         end
 
-        def file?(name)
+        def exists?(name)
           @bucket.object(::File.join(path, name)).exists?
         end
 
         def file(name)
           Stashify::File::AWS::S3.new(bucket: @bucket, path: ::File.join(path, name))
         end
+
+        def ==(other)
+          self.class == other.class && @bucket == other.bucket && path == other.path
+        end
       end
     end
   end

data/lib/stashify/file/aws/s3.rb

@@ -5,6 +5,9 @@ require "stashify/file"
 module Stashify
   class File
     module AWS
+      # An implementation for interacting with files in AWS S3
+      # buckets. The constructor needs an instance of Aws::S3::Bucket
+      # order to know which bucket to interact with.
       class S3 < Stashify::File
         def initialize(bucket:, path:)
           @bucket = bucket
@@ -22,6 +25,10 @@ module Stashify
         def delete
           @bucket.object(path).delete
         end
+
+        def exists?
+          @bucket.object(path).exists?
+        end
       end
     end
   end

data/stashify-aws-s3.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/stashify/aws/s3/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stashify-aws-s3"
+  spec.version = Stashify::AWS::S3::VERSION
+  spec.authors = ["Lambda Null"]
+  spec.email = ["lambda.null.42@gmail.com"]
+
+  spec.summary = "An AWS S3 implementation of the Stashify abstraction"
+  spec.description = "Interact with AWS S3 using the common building blocks provided by Stashify"
+  spec.homepage = "https://github.com/Lambda-Null/stashify-aws-s3"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "aws-sdk-s3", "~> 1.119.2"
+  spec.add_dependency "stashify", "~> 3.2.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stashify-aws-s3
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-30 00:00:00.000000000 Z
+date: 2023-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-s3
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.2.1
 description: Interact with AWS S3 using the common building blocks provided by Stashify
 email:
 - lambda.null.42@gmail.com
@@ -57,11 +57,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/stashify/aws/s3.rb
 - lib/stashify/aws/s3/version.rb
 - lib/stashify/directory/aws/s3.rb
 - lib/stashify/file/aws/s3.rb
 - sig/stashify/aws/s3.rbs
+- stashify-aws-s3.gemspec
 homepage: https://github.com/Lambda-Null/stashify-aws-s3
 licenses:
 - MIT

data/lib/stashify/aws/s3.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "s3/version"
-
-module Stashify
-  module AWS
-    module S3
-    end
-  end
-end