standardstorage 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb76c120a5013dafd57e21190550e6c15238269695da5fccb006e757b59f45c1
+  data.tar.gz: 3949addf2bab883046708aa67f3cb036892d33f7630b935d19c52e0fc1446276
+SHA512:
+  metadata.gz: c64611460f888d3b6f63c76a512c089acc4761fd7ce06b5386002782903eaa33661f7dfea722069b3554d5b20a88d1936716a6cea8620818166d8ce7faf15943
+  data.tar.gz: f4c00c85b03ceae6ba809dd04c144b45519265cd58f2d8070030a27575686d2560d891c94e8d7fae460135078428e95c98602db9c30c06f9adbed76dc1821b75

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jon Bracy
+
+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/lib/standard_storage.rb

@@ -0,0 +1,37 @@
+class StandardStorage
+
+  attr_reader :partition, :partition_depth
+  
+  def initialize(configs={})
+    @partition = configs.has_key?(:partition) || configs.has_key?(:partition_depth)
+    @partition_depth = if configs[:partition].is_a?(Integer)
+      configs[:partition]
+    else
+      configs[:partition_depth] || 3
+    end
+  end
+
+  def copy_to_tempfile(key)
+    tmpfile = Tempfile.new([File.basename(key), File.extname(key)], binmode: true)
+    cp(key, tmpfile.path)
+    if block_given?
+      begin
+        yield(tmpfile)
+      ensure
+        tmpfile.close!
+      end
+    else
+      tmpfile
+    end
+  end
+  
+  private
+  
+  def partition(value)
+    return value unless @partition
+    
+    split = value.scan(/.{1,4}/)
+    split.shift(@partition_depth).join("/") + split.join("")
+  end
+  
+end

data/lib/standard_storage/b2.rb

@@ -0,0 +1,81 @@
+require 'b2'
+require File.expand_path('../../standard_storage', __FILE__)
+
+class StandardStorage::B2 < StandardStorage
+
+  attr_reader :account_id, :bucket, :prefix
+  
+  def initialize(configs={})
+    super
+    @bucket = configs[:bucket]
+    @prefix = configs[:prefix]
+    @account_id = configs[:account_id]
+
+    @client = ::B2.new({
+      account_id: @account_id,
+      application_key: configs[:application_key]
+    }).buckets.find { |b| b.name == @bucket }
+  end
+  
+  def local?
+    false
+  end
+
+  def url(key, **options)
+    @client.get_download_url(destination(key), **options)
+  end
+
+  def destination(key)
+    [@prefix, partition(key)].compact.join('/').gsub(/^\//, '')
+  end
+
+  def exists?(key)
+    @client.has_key?(destination(key))
+  end
+
+  def write(key, file, meta_info={})
+    file = file.tempfile if file.class.name == "ActionDispatch::Http::UploadedFile"
+    file = File.open(file) if file.is_a?(String)
+    
+    @client.upload_file(destination(key), file, {
+      mime_type: meta_info[:content_type],
+      sha1: meta_info[:sha1],
+      content_disposition: meta_info[:filename] ? "inline; filename=\"#{meta_info[:filename]}\"" : nil
+    })
+  end
+  
+  def cp(key, to)
+    @client.download(destination(key), to)
+  rescue ::B2::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+
+  def read(key, &block)
+    @client.download(destination(key), &block)
+  rescue ::B2::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+
+  def delete(key)
+    @client.delete!(destination(key))
+  end
+  
+  def sha1(key)
+    @client.file(destination(key)).sha1
+  rescue ::B2::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+
+  def last_modified(key)
+    @client.file(destination(key)).uploaded_at
+  rescue ::B2::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+  
+  def mime_type(key)
+    @client.file(destination(key)).mime_type
+  rescue ::B2::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+  
+end

data/lib/standard_storage/filesystem.rb

@@ -0,0 +1,63 @@
+require 'fileutils'
+require File.expand_path('../../standard_storage', __FILE__)
+
+class StandardStorage::Filesystem < StandardStorage
+
+  attr_reader :host, :path, :prefix
+  
+  def initialize(configs={})
+    super
+    @host = configs[:host]
+    @path = configs[:path]
+    @prefix = configs[:prefix]
+  end
+  
+  def local?
+    true
+  end
+
+  def url(key)
+    File.join([@host, path(key)].compact)
+  end
+  
+  def path(key)
+    File.join(['/', @prefix, partition(key)].compact)
+  end
+
+  def destination(key)
+    File.join([@path, partition(key)].compact)
+  end
+
+  def exists?(key)
+    File.exist?(destination(key))
+  end
+
+  def write(key, file, options={})
+    key = destination(key)
+    FileUtils.mkdir_p(File.dirname(key))
+    FileUtils.cp(file.path, key)
+  end
+
+  def cp(source, destination)
+    source = destination(source)
+    FileUtils.cp(source, destination)
+  end
+
+  def read(key, &block)
+    File.read(destination(key), &block)
+  end
+
+  def delete(key)
+    FileUtils.rm(destination(key), force: true)
+  end
+  
+  def last_modified(key)
+    File.mtime(destination(key))
+  end
+  
+  def mime_type(key)
+    command = Terrapin::CommandLine.new("file", '-b --mime-type :file')
+    command.run({ file: destination(key) }).strip
+  end
+  
+end

data/lib/standard_storage/s3.rb

@@ -0,0 +1,104 @@
+require 'aws-sdk-s3'
+require File.expand_path('../../standard_storage', __FILE__)
+
+class StandardStorage::S3 < StandardStorage
+
+  attr_reader :region, :bucket, :bucket_host_alias, :prefix
+
+  # accepts private, public-read, public-read-write,
+  # authenticated-read, aws-exec-read, bucket-owner-read,
+  # bucket-owner-full-control
+  attr_reader :acl
+    
+  # accepts STANDARD, REDUCED_REDUNDANCY, STANDARD_IA, ONEZONE_IA
+  attr_reader :storage_class
+  
+  def initialize(configs={})
+    super
+    @region = configs[:region] || 'us-east-1'
+    @bucket = configs[:bucket]
+    @virtual_host = configs[:virtual_host] || false
+    @prefix = configs[:prefix]
+    @storage_class = configs[:storage_class] || 'STANDARD'
+    @acl = configs[:acl] || 'private'
+    
+    @client = Aws::S3::Client.new({
+      access_key_id: configs[:access_key_id],
+      secret_access_key: configs[:secret_access_key],
+      region: @region
+    })
+  end
+  
+  def object_for(key)
+    Aws::S3::Object.new(@bucket, key, client: @client)
+  end
+  
+  def local?
+    false
+  end
+  
+  def host
+    @bucket_host_alias || "#{@bucket}.s3.amazonaws.com"
+  end
+
+  def url(key, expires_in: nil)
+    object_for(destination(key)).presigned_url(:get, {
+      virtual_host: @virtual_host,
+      expires_in: (expires_in || 900)
+    })
+  end
+
+  def destination(key)
+    File.join([@prefix, partition(key)].compact).gsub(/^\//, '')
+  end
+
+  def exists?(key)
+    object_for(destination(key)).exists?
+  end
+
+  def write(key, file, meta_info={})
+    # If we pass a File type object to upload_file we need to make sure
+    # it is rewound, otherwise it will upload part of the file then timeout
+    # (30+ seconds), then retry. For now we'll just pass the path
+    object_for(destination(key)).upload_file(file.respond_to?(:path) ? file.path : file, {
+      content_type: meta_info[:content_type],
+      content_disposition: meta_info[:filename] ? "inline; filename=\"#{meta_info[:filename]}\"" : nil,
+      content_md5: meta_info[:md5],
+      storage_class: @storage_class,
+      acl: @acl
+    })
+  end
+  
+  def cp(key, to)
+    object_for(destination(key)).download_file(to)
+  rescue Aws::S3::Errors::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+  
+  def read(key, &block)
+    if block
+      object_for(destination(key)).get({}, &block)
+    else
+      object_for(destination(key)).get.body
+    end
+  rescue Aws::S3::Errors::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+
+  def delete(key)
+    object_for(destination(key)).delete
+  end
+  
+  def last_modified(key)
+    object_for(destination(key)).last_modified
+  rescue Aws::S3::Errors::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+
+  def mime_type(key)
+    object_for(destination(key)).content_type
+  rescue Aws::S3::Errors::NotFound => e
+    raise Errno::ENOENT.new(e.message)
+  end
+  
+end

data/lib/standard_storage/version.rb

@@ -0,0 +1,3 @@
+class StandardStorage
+  VERSION = '1.0.0'
+end

data/standardstorage.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path("../lib/standard_storage/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "standardstorage"
+  s.version     = StandardStorage::VERSION
+  s.authors     = ["Jon Bracy"]
+  s.email       = ["jonbracy@gmail.com"]
+  s.homepage    = "https://github.com/malomalo/storage"
+  s.summary     = %q{API for multiple storage backends}
+  s.description = %q{A simple API for multiple storage backends like B2, S3, and the FileSystem}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # Developoment 
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'mocha'
+
+  # Runtime
+  s.add_runtime_dependency 'terrapin'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: standardstorage
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jon Bracy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: terrapin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple API for multiple storage backends like B2, S3, and the FileSystem
+email:
+- jonbracy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/standard_storage.rb
+- lib/standard_storage/b2.rb
+- lib/standard_storage/filesystem.rb
+- lib/standard_storage/s3.rb
+- lib/standard_storage/version.rb
+- standardstorage.gemspec
+homepage: https://github.com/malomalo/storage
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: API for multiple storage backends
+test_files: []