carrierwave-azure_rm 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf7e2a2b825546838c1592073e23dfdfc788d951
-  data.tar.gz: d7d62a5cb2493a6dac4baef74282e4713da09545
+  metadata.gz: 0b3dce327bd64abd1f7e58c353cf1894b0ce85b8
+  data.tar.gz: 7e8bee6a2a1d9d6c7082c73656721cea4cc60a97
 SHA512:
-  metadata.gz: aa92f28d352cdc28d453931b66d46a133ae7bed0643df5517353f19742979fc712ff0fe8f00049ae6fc5cd67be952e2ee2f5963b06e95b5f0c7d67289aa978c9
-  data.tar.gz: 4fd3cc7c217fb904b0902c4fc7184c30871afca855e5be3a006f992b2599b89041f7ed1965896c253b962855ba6a2ca21b79ccc41abae73f1b28019b08b865c0
+  metadata.gz: a630896782125313caab539709844c13a38f14fa825ab648e0108218b080709e1b887f37ec14dcf3b02fccc4568c449face8914a79e3c3d7e06cd471dfb158a1
+  data.tar.gz: 5b5aabd4d024ec70063410df71fa694f4cbc1abc712cdbf5c9618cb4a124b47d071255cffcdfb4e477368bbee4749ffd681abcdf4b74a8c4786f36e8e3fa85c8

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Change Log
+
+## [v0.1.0](https://github.com/nooulaif/carrierwave-azure_rm/tree/v0.1.0) (2017-04-24)
+[Full Changelog](https://github.com/nooulaif/carrierwave-azure_rm/compare/v0.0.3...v0.1.0)
+
+**Merged pull requests:**
+
+- Feature/private blobs [\#2](https://github.com/nooulaif/carrierwave-azure_rm/pull/2) ([stestaub](https://github.com/stestaub))
+
+**Implemented enhancements:**
+
+- Updated [azure-storage](https://rubygems.org/gems/azure-storage) to version 0.12.1.preview
+
+## [v0.0.3](https://github.com/nooulaif/carrierwave-azure_rm/tree/v0.0.3) (2017-03-25)
+[Full Changelog](https://github.com/nooulaif/carrierwave-azure_rm/compare/v0.0.2...v0.0.3)
+
+**Merged pull requests:**
+
+- Feature properties without content [\#1](https://github.com/nooulaif/carrierwave-azure_rm/pull/1) ([stestaub](https://github.com/stestaub))
+
+**Implemented enhancements:**
+
+- Updated [azure-storage](https://rubygems.org/gems/azure-storage) to version 0.12.0.preview
+
+## [v0.0.2](https://github.com/nooulaif/carrierwave-azure_rm/tree/v0.0.2) (2016-07-26)
+[Full Changelog](https://github.com/nooulaif/carrierwave-azure_rm/compare/v0.0.1...v0.0.2)
+
+**Fixed bugs:**
+
+- Fixed 'exists?' method
+
+## [v0.0.1](https://github.com/nooulaif/carrierwave-azure_rm/tree/v0.0.1) (2016-07-25)
+[Full Changelog](https://github.com/nooulaif/carrierwave-azure_rm/compare/v0.0.1.preview...v0.0.1)
+
+**Fixed bugs:**
+
+- Ensure container exists in `store!` method
+
+## [v0.0.1.preview](https://github.com/nooulaif/carrierwave-azure_rm/tree/v0.0.1.preview) (2016-07-25)
+
+- Initial commit

data/README.md

@@ -40,6 +40,26 @@ class ExampleUploader < CarrierWave::Uploader::Base
 end
 ```
 
+## Private blobs
+If your container access policy is set to private, carrierwave-azure_rm can automatically
+return signed urls on the files. Enable auto_sign in the configuration:
+
+```ruby
+config.auto_sign_urls = true
+config.token_expire_after = 3600 # optional - Set the expire time of the url to 3600 seconds. Default is 1800 seconds 
+```
+
+If you wish a newly created container to be initialized with a specific access_level you can set the following in
+your config:
+
+```ruby
+config.public_access_level = 'private' # optional - possible values are blob, private, container
+```
+
+This config is only required if your container does not exist and you want it to be configured automatically.
+
+[Manage access to blobs](https://docs.microsoft.com/en-us/azure/storage/storage-manage-access-to-resources) 
+
 ## Issues
 If you have any problems with or questions about this image, please contact me through a [GitHub issue](https://github.com/nooulaif/carrierwave-azure_rm/issues).
 

data/carrierwave-azure_rm.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'carrierwave'
-  gem.add_dependency 'azure-storage', '~> 0.12.0.preview'
+  gem.add_dependency 'azure-storage', '~> 0.12.1.preview'
 
   gem.add_development_dependency 'rake'
   gem.add_development_dependency 'rspec', '~> 3'

data/lib/carrierwave-azure_rm.rb

@@ -7,8 +7,13 @@ class CarrierWave::Uploader::Base
   add_config :azure_storage_access_key
   add_config :azure_storage_blob_host
   add_config :azure_container
+  add_config :public_access_level
+  add_config :auto_sign_urls
+  add_config :token_expire_after
 
   configure do |config|
+    config.public_access_level = 'blob'
+    config.token_expire_after = 1800
     config.storage_engines[:azure_rm] = 'CarrierWave::Storage::AzureRM'
   end
 end

data/lib/carrierwave/azure_rm/version.rb

@@ -1,5 +1,5 @@
 module Carrierwave
   module AzureRM
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

data/lib/carrierwave/storage/azure_rm.rb

@@ -4,13 +4,13 @@ module CarrierWave
   module Storage
     class AzureRM < Abstract
       def store!(file)
-        azure_file = CarrierWave::Storage::AzureRM::File.new(uploader, connection, uploader.store_path)
+        azure_file = CarrierWave::Storage::AzureRM::File.new(uploader, connection, uploader.store_path, signer)
         azure_file.store!(file)
         azure_file
       end
 
       def retrieve!(identifer)
-        CarrierWave::Storage::AzureRM::File.new(uploader, connection, uploader.store_path(identifer))
+        CarrierWave::Storage::AzureRM::File.new(uploader, connection, uploader.store_path(identifer), signer)
       end
 
       def connection
@@ -22,19 +22,34 @@ module CarrierWave
         end
       end
 
+      def signer
+        @signer ||= begin
+          ::Azure::Storage::Core::Auth::SharedAccessSignature.new
+        end
+      end
+
       class File
         attr_reader :path
 
-        def initialize(uploader, connection, path)
+        def initialize(uploader, connection, path, signer = nil)
           @uploader = uploader
           @connection = connection
+          @signer = signer
           @path = path
         end
 
         def ensure_container_exists(name)
           unless @connection.list_containers.any? { |c| c.name == name }
-            @connection.create_container(name, public_access_level: 'blob')
+            @connection.create_container(name, access_level_option)
+          end
+        end
+
+        def access_level
+          unless @public_access_level
+            container, signed_identifiers = @connection.get_container_acl(@uploader.send("azure_container"))
+            @public_access_level = container.public_access_level || 'private' # when container access level is private, it returns nil
           end
+          @public_access_level
         end
 
         def store!(file)
@@ -62,7 +77,15 @@ module CarrierWave
           if @uploader.asset_host
             "#{@uploader.asset_host}/#{path}"
           else
-            @connection.generate_uri(path).to_s
+            uri = @connection.generate_uri(path)
+            if sign_url?(options)
+              @signer.signed_uri(uri, false, { permissions: 'r',
+                                               resource: 'b',
+                                               start: 1.minute.ago.utc.iso8601,
+                                               expiry: expires_at}).to_s
+            else
+              uri.to_s
+            end
           end
         end
 
@@ -88,7 +111,7 @@ module CarrierWave
         end
 
         def filename
-          URI.decode(url).gsub(/.*\/(.*?$)/, '\1')
+          URI.decode(url(skip_signing: true)).gsub(/.*\/(.*?$)/, '\1')
         end
 
         def extension
@@ -106,6 +129,21 @@ module CarrierWave
 
         private
 
+        def access_level_option
+          lvl = @uploader.public_access_level
+          raise "Invalid Access level #{lvl}." unless %w(private blob container).include? lvl
+          lvl == 'private' ? {} : { :public_access_level => lvl }
+        end
+
+        def expires_at
+          expiry = Time.now + @uploader.token_expire_after
+          expiry.utc.iso8601
+        end
+
+        def sign_url?(options)
+          @uploader.auto_sign_urls && !options[:skip_signing] && access_level == 'private'
+        end
+
         def blob
           load_blob if @blob.nil?
           @blob

data/spec/carrierwave-azure_spec.rb

@@ -10,5 +10,15 @@ describe CarrierWave::Uploader::Base do
     is_expected.to respond_to(:azure_storage_access_key)
     is_expected.to respond_to(:azure_storage_blob_host)
     is_expected.to respond_to(:azure_container)
+    is_expected.to respond_to(:auto_sign_urls)
+    is_expected.to respond_to(:token_expire_after)
+  end
+
+  it 'should have public_access_level blob by default' do
+    expect(described_class.public_access_level).to eq 'blob'
+  end
+
+  it 'should have set token_expire_after to 30 minutes' do
+    expect(described_class.token_expire_after).to eq 30*60
   end
 end

data/spec/carrierwave/storage/azure_file_spec.rb

@@ -13,11 +13,17 @@ describe CarrierWave::Storage::AzureRM::File do
       allow(uploader).to receive(:azure_container).and_return('test')
     end
 
-    subject { CarrierWave::Storage::AzureRM::File.new(uploader, storage.connection, 'dummy.txt').url }
+    subject { CarrierWave::Storage::AzureRM::File.new(uploader, storage.connection, 'dummy.txt', storage.signer).url }
 
     context 'with storage_blob_host' do
       before do
+        # This must be first!
         allow(uploader).to receive(:azure_storage_blob_host).and_return('http://example.com')
+
+        # automatic resolving won't work for non existent url
+        struct = Struct.new('Container', :public_access_level).new
+        struct.public_access_level = 'blob'
+        allow(storage.connection).to receive(:get_container_acl).and_return(struct)
       end
 
       it 'should return on asset_host' do
@@ -41,7 +47,7 @@ describe CarrierWave::Storage::AzureRM::File do
       allow(storage.connection).to receive(:get_blob).and_return(nil)
     end
 
-    subject { CarrierWave::Storage::AzureRM::File.new(uploader, storage.connection, 'dummy.txt').exists? }
+    subject { CarrierWave::Storage::AzureRM::File.new(uploader, storage.connection, 'dummy.txt', storage.signer).exists? }
 
     context 'when blob file does not exist' do
       it 'should return false' do

data/spec/carrierwave/storage/azure_spec.rb

@@ -68,11 +68,35 @@ describe CarrierWave::Storage::AzureRM do
     it_should_behave_like 'an expected return value' do
       subject { stored_file }
     end
+
+    context 'private container' do
+      before {
+        allow(uploader).to receive(:public_access_level).and_return('private')
+        allow(uploader).to receive(:azure_container).and_return('carrerwaveprivate')
+        allow(uploader).to receive(:auto_sign_urls).and_return(true)
+      }
+
+      it_should_behave_like 'an expected return value' do
+        subject { stored_file }
+      end
+    end
   end
 
   describe '#retrieve' do
     it_should_behave_like 'an expected return value' do
       subject { retrieved_file }
     end
+
+    context 'private container' do
+      before {
+        allow(uploader).to receive(:public_access_level).and_return('private')
+        allow(uploader).to receive(:azure_container).and_return('carrerwaveprivate')
+        allow(uploader).to receive(:auto_sign_urls).and_return(true)
+      }
+
+      it_should_behave_like 'an expected return value' do
+        subject { retrieved_file }
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-azure_rm
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - nooulaif
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-25 00:00:00.000000000 Z
+date: 2017-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: carrierwave
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0.preview
+        version: 0.12.1.preview
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0.preview
+        version: 0.12.1.preview
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -108,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Microsoft Azure Storage blob support for CarrierWave