stashify-microsoft-azure-storage-blob 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f362690b51717f2929c5094f92697ac2c5fd9f2be42705c8906d8babe89ae7b
-  data.tar.gz: d39a411efe8df9b899657f779c6223d0d389816af222e307870e282191f77fb4
+  metadata.gz: 9bf4a5c60d0c540b066d9f8f6136ed1b1e4eedfb7c29abe9f63c6ba27c3249a4
+  data.tar.gz: 7d5acba2556225832082e647adcd26383db572697433825e1afa8dd572953437
 SHA512:
-  metadata.gz: bb7c749c53a8e66dc478364bbee8188e49cd4512cdc52a204f7c570a6d5e92b6399ae6be16cf33337f528db2998fcd43460a9f7d1e7576c517b5a6781e95b338
-  data.tar.gz: 70ef742cc743e5b4e777ef62666843400f64cf8128ae41e2cf1bcfb766583d2086e341982a077761f54adea7ffcb692d6a901f8b7dbe947e43a08362e9db97a1
+  metadata.gz: 6ffe30f9f84580e9cceb14cc2a1dfe8faa0e46b3bcdfd8cddd64c76e2c9c3f366c8ba7b031fb7df4d57096267bc00d3d43c8a303e918403443ae962e7c2f842f
+  data.tar.gz: 0a9c013a77bb3ad60e28126da53bc80877f5a966c57c629b2a123767bcc20270770c5f253e4cafdfb7696413f181e85661e62b0897d55caee3f5694253761ae8

data/.reek.yml

@@ -1,7 +1,4 @@
 detectors:
-  IrresponsibleModule:
-    enabled: false
-
   UncommunicativeVariableName:
     accept:
       - e

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.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stashify-microsoft-azure-storage-blob (1.0.0)
+    stashify-microsoft-azure-storage-blob (1.0.1)
       azure-storage-blob (~> 2.0.3)
       stashify (~> 3.1.0)
 

data/README.md

@@ -1,8 +1,6 @@
 # Stashify::Microsoft::Azure::Storage::Blob
 
-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/microsoft/azure/storage/blob`. 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 Azure Blob Storage. It operates under the assumption that the "/" in file names has the typical meaning of a path separater.
 
 ## Installation
 
@@ -22,7 +20,35 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+This implementation is built expecting an instance of `Azure::Storage::Blob::BlobService` and `Azure::Storage::Blob::Container::Container`. 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 "azure/storage/blob"
+=> true
+> client = Azure::Storage::Blob::BlobService.create
+=> 
+#<Azure::Storage::Blob::BlobService:0x0000563aa41d14a8
+> container = Azure::Storage::Blob::Container::Container.new
+=> 
+...
+> container.name = "some-container"
+...
+> file = Stashify::File::Microsoft::Azure::Storage::Blob.new(client: client, 
+container: container, path: "path/to/file")
+=> 
+#<Stashify::File::Microsoft::Azure::Storage::Blob:0x0000555afaadd6f8
+...
+> file.contents
+=> "foo"
+> require "stashify/directory/microsoft/azure/storage/blob"
+=> true
+> dir = Stashify::Directory::Microsoft::Azure::Storage::Blob.new(client: client, container: container, path: "path/to")
+=> 
+#<Stashify::Directory::Microsoft::Azure::Storage::Blob:0x0000555afa40c7c0
+...
+> dir.find("file") == file
+=> true
+```
 
 ## Development
 

data/lib/stashify/directory/microsoft/azure/storage/blob.rb

@@ -9,6 +9,12 @@ module Stashify
     module Microsoft
       module Azure
         module Storage
+          # An implementation for interacting with Azure Blob Storage
+          # as if they had directories with "/" as a path
+          # separator. In addition to a path, it also needs a
+          # Azure::Storage::Blob::BlobService and
+          # Azure::Storage::Blob::Container::Container objects
+          # representing the container the file resides within.
           class Blob < Stashify::Directory
             attr_reader :container
 

data/lib/stashify/file/microsoft/azure/storage/blob.rb

@@ -7,6 +7,11 @@ module Stashify
     module Microsoft
       module Azure
         module Storage
+          # An implementation for interacting with files in Azure Blob
+          # Storage. The constructor needs an instance of
+          # Azure::Storage::Blob::BlobService and
+          # Azure::Storage::Blob::Container::Container in order to
+          # know which bucket to interact with.
           class Blob < Stashify::File
             def initialize(client:, container:, path:)
               @client = client

data/lib/stashify/microsoft/azure/storage/blob/version.rb

@@ -5,7 +5,7 @@ module Stashify
     module Azure
       module Storage
         module Blob
-          VERSION = "1.0.0"
+          VERSION = "1.0.1"
         end
       end
     end

data/stashify-microsoft-azure-storage-blob.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/stashify/microsoft/azure/storage/blob/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stashify-microsoft-azure-storage-blob"
+  spec.version = Stashify::Microsoft::Azure::Storage::Blob::VERSION
+  spec.authors = ["Lambda Null"]
+  spec.email = ["lambda.null.42@gmail.com"]
+
+  spec.summary = "An implementation of the Stashify abstraction for Azure's Blob Storage"
+  spec.description = "Interact with Azure Blob Storage using the common building blocks provided by Stashify"
+  spec.homepage = "https://github.com/Lambda-Null/stashify-microsoft-azure-storage-blob"
+  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 "azure-storage-blob", "~> 2.0.3"
+  spec.add_dependency "stashify", "~> 3.1.0"
+
+  # 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-microsoft-azure-storage-blob
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Lambda Null
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-02 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: azure-storage-blob
@@ -63,6 +63,7 @@ files:
 - lib/stashify/microsoft/azure/storage/blob.rb
 - lib/stashify/microsoft/azure/storage/blob/version.rb
 - sig/stashify/microsoft/azure/storage/blob.rbs
+- stashify-microsoft-azure-storage-blob.gemspec
 homepage: https://github.com/Lambda-Null/stashify-microsoft-azure-storage-blob
 licenses:
 - MIT