azure-blob 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ff6c7e8f9d7ec11e85bcb1ea543b9344a9db958fea0d9451221c5be161e0d8b
-  data.tar.gz: fc1a13d7c8f39303c5985de80b7790a378f6a1901b22e4f8cce1eb85789aaeb4
+  metadata.gz: 046a2472eb232c6579a189ea2621c495348c43487d0963d71c7ff47283da59f0
+  data.tar.gz: 18793a16bea30be351fcd78a3e5cdd91375f1df54db1477632851e7ed0a6540b
 SHA512:
-  metadata.gz: eabce34cd075764436fc473b550451fadf2f764a731464345ba2542a7e1ca5f5e5d44286b94b19d11eda554fde4e4a17faaf40eb8ad3ed2e9d8bab798ba8e2bb
-  data.tar.gz: 793a8c163e2b7d489bfd8d4a643ba6c466d043652e5cce3f6ee2798142bfb36ce41e0881028712b57ab45eb357704af3c64d47e66c53d631ee949a50d22c310f
+  metadata.gz: c2881fd3b9681468cf9639b3049876773e15de1853915b48dd22cca0dd34815c60198f45768017de736a475ac1e58e295921f9081e27ea002c40b0518e7e8993
+  data.tar.gz: 7f877ab5f4c5c94f5204088270d6fb2fc6d8b78d4ac88892ec79ee0176bfad30f91f4666176b9c25f0a74b4d3cdbbd30625b4541e3a2b1e9aceb33a7f599a542

data/README.md

@@ -1,6 +1,17 @@
 # AzureBlob
 
-WIP This gem is built as a replacement of azure-storage-blob (deprecated) in Active Storage
+This gem was built to replace azure-storage-blob (deprecated) in Active Storage, but was written to be Rails agnostic.
+
+
+# Active Storage
+
+## Migration
+To migrate from azure-storage-blob to azure-blob:
+
+1- Replace `azure-storage-blob` in your Gemfile with `azure-blob`
+2- Run `bundle install`
+3- change the `AzureStorage` service to `AzureBlob`  in your Active Storage config (`config/storage.yml`)
+4- Restart or deploy the app.
 
 ## License
 

data/lib/active_storage/service/azure_blob_service.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+
+# Copyright (c) David Heinemeier Hansson, 37signals LLC
+
+# 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.
+
+
+require "active_support/core_ext/numeric/bytes"
+require "active_storage/service"
+
+require 'azure_blob'
+
+module ActiveStorage
+  # = Active Storage \Azure Storage \Service
+  #
+  # Wraps the Microsoft Azure Storage Blob Service as an Active Storage service.
+  # See ActiveStorage::Service for the generic API documentation that applies to all services.
+  class Service::AzureBlobService < Service
+    attr_reader :client, :container, :signer
+
+    def initialize(storage_account_name:, storage_access_key:, container:, public: false, **options)
+      @container = container
+      @public = public
+      @client = AzureBlob::Client.new(
+        account_name: storage_account_name,
+        access_key: storage_access_key,
+        container: container,
+        **options)
+    end
+
+    def upload(key, io, checksum: nil, filename: nil, content_type: nil, disposition: nil, custom_metadata: {}, **)
+      instrument :upload, key: key, checksum: checksum do
+        handle_errors do
+          content_disposition = content_disposition_with(filename: filename, type: disposition) if disposition && filename
+
+          client.create_block_blob(key, IO.try_convert(io) || io, content_md5: checksum, content_type: content_type, content_disposition: content_disposition, metadata: custom_metadata)
+        end
+      end
+    end
+
+    def download(key, &block)
+      if block_given?
+        instrument :streaming_download, key: key do
+          stream(key, &block)
+        end
+      else
+        instrument :download, key: key do
+          handle_errors do
+            io = client.get_blob(key)
+            io.force_encoding(Encoding::BINARY)
+          end
+        end
+      end
+    end
+
+    def download_chunk(key, range)
+      instrument :download_chunk, key: key, range: range do
+        handle_errors do
+          io = client.get_blob(key, start: range.begin, end: range.exclude_end? ? range.end - 1 : range.end)
+          io.force_encoding(Encoding::BINARY)
+        end
+      end
+    end
+
+    def delete(key)
+      instrument :delete, key: key do
+        client.delete_blob(key)
+      rescue AzureBlob::Http::FileNotFoundError
+        # Ignore files already deleted
+      end
+    end
+
+    def delete_prefixed(prefix)
+      instrument :delete_prefixed, prefix: prefix do
+        client.delete_prefix(prefix)
+      end
+    end
+
+    def exist?(key)
+      instrument :exist, key: key do |payload|
+        payload[:exist] = blob_for(key).present?
+      end
+    end
+
+    def url_for_direct_upload(key, expires_in:, content_type:, content_length:, checksum:, custom_metadata: {})
+      instrument :url, key: key do |payload|
+        generated_url = client.signed_uri(
+          key,
+          permissions: "rw",
+          expiry: format_expiry(expires_in)
+        ).to_s
+
+        payload[:url] = generated_url
+
+        generated_url
+      end
+    end
+
+    def headers_for_direct_upload(key, content_type:, checksum:, filename: nil, disposition: nil, custom_metadata: {}, **)
+      content_disposition = content_disposition_with(type: disposition, filename: filename) if filename
+
+      { "Content-Type" => content_type, "Content-MD5" => checksum, "x-ms-blob-content-disposition" => content_disposition, "x-ms-blob-type" => "BlockBlob", **custom_metadata_headers(custom_metadata) }
+    end
+
+    def compose(source_keys, destination_key, filename: nil, content_type: nil, disposition: nil, custom_metadata: {})
+      content_disposition = content_disposition_with(type: disposition, filename: filename) if disposition && filename
+
+      client.create_append_blob(
+        destination_key,
+        content_type: content_type,
+        content_disposition: content_disposition,
+        metadata: custom_metadata,
+      )
+
+      source_keys.each do |source_key|
+        stream(source_key) do |chunk|
+          client.append_blob_block(destination_key, chunk)
+        end
+      end
+    end
+
+    private
+      def private_url(key, expires_in:, filename:, disposition:, content_type:, **)
+        client.signed_uri(
+          key,
+          permissions: "r",
+          expiry: format_expiry(expires_in),
+          content_disposition: content_disposition_with(type: disposition, filename: filename),
+          content_type: content_type
+        ).to_s
+      end
+
+      def public_url(key, **)
+        uri_for(key).to_s
+      end
+
+
+      def uri_for(key)
+        client.generate_uri("#{container}/#{key}")
+      end
+
+      def blob_for(key)
+        client.get_blob_properties(key)
+      rescue AzureBlob::Http::FileNotFoundError
+        false
+      end
+
+      def format_expiry(expires_in)
+        expires_in ? Time.now.utc.advance(seconds: expires_in).iso8601 : nil
+      end
+
+      # Reads the object for the given key in chunks, yielding each to the block.
+      def stream(key)
+        blob = blob_for(key)
+
+        chunk_size = 5.megabytes
+        offset = 0
+
+        raise ActiveStorage::FileNotFoundError unless blob.present?
+
+        while offset < blob.size
+          chunk = client.get_blob(key, start: offset, end: offset + chunk_size - 1)
+          yield chunk.force_encoding(Encoding::BINARY)
+          offset += chunk_size
+        end
+      end
+
+      def handle_errors
+        yield
+      rescue AzureBlob::Http::IntegrityError
+        raise ActiveStorage::IntegrityError
+      rescue AzureBlob::Http::FileNotFoundError
+        raise ActiveStorage::FileNotFoundError
+      end
+
+      def custom_metadata_headers(metadata)
+        AzureBlob::Metadata.new(metadata).headers
+      end
+  end
+end

data/lib/azure_blob/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AzureBlob
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: azure-blob
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joé Dupuis
@@ -42,6 +42,7 @@ files:
 - devenv.lock
 - devenv.nix
 - devenv.yaml
+- lib/active_storage/service/azure_blob_service.rb
 - lib/azure_blob.rb
 - lib/azure_blob/blob.rb
 - lib/azure_blob/blob_list.rb