refile-azure 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39fdbac6236eeba929fa6ea84e01633012a277f8
+  data.tar.gz: 6708a71cc817de06cc480d7ab3e805fa30f09900
+SHA512:
+  metadata.gz: a9cd033800ef0a6e05aba7bdfb5d78c1a112488a6f13e8cf838c8b777a53a048f6207d267489bcc23bebe8dae449f35bb9dcf9059b05b5d1593bc4a57fc1133f
+  data.tar.gz: 827534b076ddcdc0abd4db4627fad6ff8234ef88c4576eb80fc9c0a3a7d09373b98f8eec331b1b13ee0855b44bc613cf71061e5be7b78b6f4a7b44fda4a22422

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.byebug_history
+mkmf.log
+azure.yml

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in refile-s3.gemspec
+gemspec
+
+gem "refile", github: "refile/refile"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jonas Nicklas
+
+MIT License
+
+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/README.md

@@ -0,0 +1,10 @@
+# Refile::Azure
+
+Microsoft Azure backend for the [Refile][gh] gem. See the Refile documentation for
+more details.
+
+## License
+
+[MIT](LICENSE.txt)
+
+[gh]: http://github.com/refile/refile

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: "spec"
+

data/lib/refile/azure.rb

@@ -0,0 +1,165 @@
+require "azure"
+require "open-uri"
+require "refile"
+require "refile/backend_macros"
+require "refile/azure/version"
+
+module Refile
+
+  # @api private
+  class AzureBackendError < StandardError; end
+
+  # @api private
+  class AzureCredentialsError < AzureBackendError
+    def message
+      "Credentials not found"
+    end
+  end
+
+  # A refile backend which stores files in Microsoft Azure
+  #
+  # @example
+  #   backend = Refile::Backend::Azure.new(
+  #     storage_account_name: 'mystorage',
+  #     storage_access_key: 'secret_key',
+  #     container: "my-container",
+  #   )
+  #   file = backend.upload(StringIO.new("hello"))
+  #   backend.read(file.id) # => "hello"
+  class Azure
+    extend Refile::BackendMacros
+
+    attr_reader :storage_account_name, :container, :max_size
+
+    # Sets up an Azure backend
+    #
+    # @param [String] container         The name of the container where files will be stored
+    # @param [String] prefix            A prefix to add to all files.
+    # @param [Integer, nil] max_size    The maximum size of an uploaded file
+    # @param [#hash] hasher             A hasher which is used to generate ids from files
+    # @param [Hash] azure_options       Additional options to initialize Azure Client with
+    # @see https://github.com/Azure/azure-sdk-for-ruby
+    def initialize(storage_account_name:, storage_access_key:, container:, max_size: nil, hasher: Refile::RandomHasher.new, **azure_options)
+      @azure_options = azure_options
+      @azure = ::Azure.client(
+        azure_options.merge(
+          storage_account_name: storage_account_name,
+          storage_access_key: storage_access_key,
+          storage_blob_host: "https://#{storage_account_name}.blob.core.windows.net"
+        )
+      )
+      @storage_account_name = storage_account_name
+      @container = container
+      @blobs = @azure.blobs
+      @hasher = hasher
+      @max_size = max_size
+    end
+
+    # Upload a file into this backend
+    #
+    # @param [IO] uploadable      An uploadable IO-like object.
+    # @return [Refile::File]      The uploaded file
+    verify_uploadable def upload(uploadable)
+      id = @hasher.hash(uploadable)
+
+      if uploadable.is_a?(Refile::File) and uploadable.backend.is_a?(Azure) and uploadable.backend.storage_account_name == storage_account_name
+        @blobs.copy_blob(@container, id, uploadable.backend.container, uploadable.id)
+      else
+        body = if IO === uploadable
+          uploadable
+        elsif uploadable.respond_to?(:read)
+          uploadable.read
+        else
+          uploadable
+        end
+        @blobs.create_block_blob(@container, id, body)
+      end
+
+      Refile::File.new(self, id)
+    end
+
+    # Get a file from this backend.
+    #
+    # Note that this method will always return a {Refile::File} object, even
+    # if a file with the given id does not exist in this backend. Use
+    # {FileSystem#exists?} to check if the file actually exists.
+    #
+    # @param [String] id           The id of the file
+    # @return [Refile::File]      The retrieved file
+    verify_id def get(id)
+      Refile::File.new(self, id)
+    end
+
+    # Delete a file from this backend
+    #
+    # @param [String] id           The id of the file
+    # @return [void]
+    verify_id def delete(id)
+      @blobs.delete_blob(@container, id)
+    rescue ::Azure::Core::Http::HTTPError => exc
+      raise exc unless exc.status_code == 404
+      nil
+    end
+
+    # Return an IO object for the uploaded file which can be used to read its
+    # content.
+    #
+    # @param [String] id           The id of the file
+    # @return [IO]                An IO object containing the file contents
+    verify_id def open(id)
+      StringIO.new(read(id))
+    end
+
+    # Return the entire contents of the uploaded file as a String.
+    #
+    # @param [String] id           The id of the file
+    # @return [String]             The file's contents
+    verify_id def read(id)
+      blob, body = @blobs.get_blob(@container, id)
+      body
+    rescue ::Azure::Core::Http::HTTPError => exc
+      raise exc unless exc.status_code == 404
+      nil
+    end
+
+    # Return the size in bytes of the uploaded file.
+    #
+    # @param [String] id           The id of the file
+    # @return [Integer]           The file's size
+    verify_id def size(id)
+      @blobs.get_blob_properties(@container, id).properties[:content_length]
+    rescue ::Azure::Core::Http::HTTPError => exc
+      raise exc unless exc.status_code == 404
+      nil
+    end
+
+    # Return whether the file with the given id exists in this backend.
+    #
+    # @param [String] id           The id of the file
+    # @return [Boolean]
+    verify_id def exists?(id)
+      @blobs.get_blob_properties(@container, id)
+      true
+    rescue ::Azure::Core::Http::HTTPError => exc
+      raise exc unless exc.status_code == 404
+      false
+    end
+
+    # Remove all files in this backend. You must confirm the deletion by
+    # passing the symbol `:confirm` as an argument to this method.
+    #
+    # @example
+    #   backend.clear!(:confirm)
+    # @raise [Refile::Confirm]     Unless the `:confirm` symbol has been passed.
+    # @param [:confirm] confirm    Pass the symbol `:confirm` to confirm deletion.
+    # @return [void]
+    def clear!(confirm = nil)
+      raise Refile::Confirm unless confirm == :confirm
+      @blobs.list_blobs(@container).each do |blob|
+        @blobs.delete_blob(@container, blob.name)
+      end
+
+    end
+
+  end
+end

data/lib/refile/azure/version.rb

@@ -0,0 +1,5 @@
+module Refile
+  class Azure
+    VERSION = "0.1.0"
+  end
+end

data/refile-azure.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'refile/azure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "refile-azure"
+  spec.version       = Refile::Azure::VERSION
+  spec.authors       = ["Ivan Pirlik"]
+  spec.email         = ["abmajor7@gmail.com"]
+  spec.summary       = "Microsoft Azure backend for the Refile gem"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1.0"
+
+  spec.add_dependency "refile", "~> 0.6.0"
+  spec.add_dependency "azure", "~> 0.7.5"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "webmock"
+end

data/spec/refile/azure_spec.rb

@@ -0,0 +1,12 @@
+require "refile/spec_helper"
+require "refile/azure"
+
+WebMock.allow_net_connect!
+
+config = YAML.load_file("azure.yml").map { |k, v| [k.to_sym, v] }.to_h
+
+RSpec.describe Refile::Azure do
+  let(:backend) { Refile::Azure.new(max_size: 100, **config) }
+
+  it_behaves_like :backend
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: refile-azure
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Pirlik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: refile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: azure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- abmajor7@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/refile/azure.rb
+- lib/refile/azure/version.rb
+- refile-azure.gemspec
+- spec/refile/azure_spec.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Microsoft Azure backend for the Refile gem
+test_files:
+- spec/refile/azure_spec.rb