rainbow_storage 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c221a06f5c7d6ac3cbbada2cfa3d0f5c02c3d97
+  data.tar.gz: f5016782b665e2df5c3f1c6f75a30cba8b63c724
+SHA512:
+  metadata.gz: 9a18d1deae6e864974972b6e88f024e9bf9df1bee13396fceed742b9cd63b6f66a933952e961a0c25afd77b16f3b5e33b77c19630e7eab6576750634fcb7981f
+  data.tar.gz: b8d4a7113b95c27ae8fb65b1023907632b8df7a6fa03f2e066ad0707ccfbb444c28aad64d713a2256a8afaace3145444a06da85458dd26b0d7015aa1468e6c88

data/lib/rainbow_storage.rb

@@ -0,0 +1,16 @@
+require 'rainbow_storage/configuration'
+require 'rainbow_storage/manager'
+require 'rainbow_storage/path_generator'
+
+module RainbowStorage
+  class << self
+    def manager
+      fail StorageNotConfiguredException unless config
+      RainbowStorage::Manager.new(config, path_generator)
+    end
+
+    def path_generator
+      RainbowStorage::PathGenerator.new(config)
+    end
+  end
+end

data/lib/rainbow_storage/adapters/abstract_adapter.rb

@@ -0,0 +1,34 @@
+module RainbowStorage
+  module Adapters
+    class AbstractAdapter
+      attr_accessor :config
+
+      def initialize(config)
+        @config = config
+        post_initialize
+      end
+
+      def get(path)
+        fail NotImplementedError
+      end
+
+      def put(path, data)
+        fail NotImplementedError
+      end
+
+      def delete(path)
+        fail NotImplementedError
+      end
+
+      def public_url(path)
+        fail NotImplementedError
+      end
+
+      private
+
+      # Hook-method to add custom initialization logic to adapter
+      def post_initialize
+      end
+    end
+  end
+end

data/lib/rainbow_storage/adapters/repository.rb

@@ -0,0 +1,19 @@
+require 'rainbow_storage/exceptions/unknown_adapter_exception'
+
+module RainbowStorage
+  module Adapters
+    class Repository
+      class << self
+        def get(name)
+          adapters[name] || fail(RainbowStorage::UnknownAdapterException, "Unknown adapter '#{name}'")
+        end
+
+        def adapters
+          {
+            s3: RainbowStorage::Adapters::S3::Adapter
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rainbow_storage/adapters/s3.rb

@@ -0,0 +1,8 @@
+require 'rainbow_storage/adapters/s3/adapter'
+
+module RainbowStorage
+  module Adapters
+    module S3
+    end
+  end
+end

data/lib/rainbow_storage/adapters/s3/adapter.rb

@@ -0,0 +1,46 @@
+require 's3'
+require 'rainbow_storage/adapters/abstract_adapter'
+
+module RainbowStorage
+  module Adapters
+    module S3
+      class Adapter < RainbowStorage::Adapters::AbstractAdapter
+        attr_accessor :bucket
+
+        # TODO: should we deal with tempfiles here? or just return a data?
+        def get(path)
+          object = bucket.objects.find(path)
+          tempfile = Tempfile.new
+          tempfile.write(object.content)
+          tempfile.rewind
+          tempfile
+        end
+
+        def put(path, data)
+          new_object = bucket.objects.build(path)
+          new_object.content = data
+          new_object.acl = :public_read
+          new_object.save
+        end
+
+        def delete(path)
+          object = bucket.objects.find(path)
+          object.destroy
+        end
+
+        def public_url(path)
+          object = bucket.objects.find(path)
+          object.temporary_url(Time.now + 1800)
+        end
+
+        private
+
+        def post_initialize
+          @service = ::S3::Service.new(access_key_id: config[:access_key],
+                                     secret_access_key: config[:secret_key])
+          @bucket = @service.bucket(config[:bucket])
+        end
+      end
+    end
+  end
+end

data/lib/rainbow_storage/configuration.rb

@@ -0,0 +1,20 @@
+module RainbowStorage
+  class Configuration
+    attr_accessor :salt, :nesting, :adapter, :adapter_config
+
+    def initialize
+      @salt = 'default_salt'
+      @nesting = 3
+    end
+  end
+
+  class << self
+    def setup
+      yield(config)
+    end
+
+    def config
+      @config ||= RainbowStorage::Configuration.new
+    end
+  end
+end

data/lib/rainbow_storage/exceptions/storage_not_configured_exception.rb

@@ -0,0 +1,3 @@
+module RainbowStorage
+  class StorageNotConfiguredException < StandardError; end;
+end

data/lib/rainbow_storage/exceptions/unknown_adapter_exception.rb

@@ -0,0 +1,3 @@
+module RainbowStorage
+  class UnknownAdapterException < StandardError; end;
+end

data/lib/rainbow_storage/exceptions/unsupported_file_type_exception.rb

@@ -0,0 +1,3 @@
+module RainbowStorage
+  class UnsupportedFileTypeException < StandardError; end;
+end

data/lib/rainbow_storage/manager.rb

@@ -0,0 +1,73 @@
+require 'rainbow_storage/adapters/s3'
+require 'rainbow_storage/adapters/repository'
+require 'rainbow_storage/exceptions/unsupported_file_type_exception'
+require 'open-uri'
+
+module RainbowStorage
+  class Manager
+    attr_accessor :config, :path_generator
+
+    def initialize(config, path_generator)
+      @config         = config
+      @path_generator = path_generator
+    end
+
+    # TODO: maybe introduce RainbowStorage::File class for path, extension, content and content-type?
+    # Usage examples:
+    # RainbowStorage.manager.upload({file: URI('http://site.com/files/1358_1495284100.jpg'), id: 1, extension: '.jpg'})
+    def upload(options = {})
+      validate_upload_options!(options)
+
+      file      = options[:file]
+      id        = options[:id]        || "#{file.object_id}#{Time.now.to_i}"
+      extension = options[:extension] || infer_extenstion_from_file(file)
+
+      content = case file
+      when Tempfile
+        file.rewind
+        file.read
+      when URI
+        open(file.to_s).read
+      else
+        fail RainbowStorage::UnsupportedFileTypeException,
+          "#{file.class} is not valid type for file attribute"
+      end
+
+      path = path_generator.filename(id, extension)
+      adapter.put(path, content)
+    end
+
+    # Usage example:
+    # RainbowStorage.manager.download(1, '.jpg')
+    def download(id, extension = nil)
+      path = path_generator.filename(id, extension)
+      adapter.get(path)
+    end
+
+    # Usage example:
+    # RainbowStorage.manager.remove(1, 'jpg')
+    def remove(id, extension = nil)
+      path = path_generator.filename(id, extension)
+      adapter.delete(path)
+    end
+
+    # Usage example:
+    # RainbowStorage.manager.link(1, 'jpg')
+    def link(id, extension = nil)
+      path = path_generator.filename(id, extension)
+      adapter.public_url(path)
+    end
+
+    private
+
+    def validate_upload_options!(options)
+    end
+
+    def infer_extension_from_file(file)
+    end
+
+    def adapter
+      @adapter ||= RainbowStorage::Adapters::Repository.get(config.adapter).new(config.adapter_config)
+    end
+  end
+end

data/lib/rainbow_storage/path_generator.rb

@@ -0,0 +1,42 @@
+module RainbowStorage
+  class PathGenerator
+    attr_accessor :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    # Add extension to path if present
+    # do not add extra dot before extesion
+    def filename(id, extension)
+      path = filepath(id)
+      return path if extension.nil?
+      "#{path}.#{extension.gsub(/^\./, '')}"
+    end
+
+    # Convert string like `abcdefghi` to `ab/cd/ef/ghi`
+    # to represent location on file system
+    def filepath(id)
+      tokens = hmac(id).chars.each_slice(2).map(&:join)
+      result = []
+      nesting_depth.times { result << tokens.shift }
+      result << tokens.join
+      result.join('/')
+    end
+
+    private
+
+    def hmac(id)
+      digest = OpenSSL::Digest.new('sha1')
+      OpenSSL::HMAC.hexdigest(digest, hmac_key, id.to_s)
+    end
+
+    def hmac_key
+      config.salt
+    end
+
+    def nesting_depth
+      config.nesting
+    end
+  end
+end

data/rainbow_storage.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name          = "rainbow_storage"
+  s.version       = "1.0.1"
+  s.licenses      = ['MIT']
+  s.summary       = "This is an example!"
+  s.description   = "Much longer explanation of the example!"
+  s.author        = "Stanislav Mekhonoshin"
+  s.email         = "ejabberd@gmail.com"
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split($/)
+
+  s.add_runtime_dependency "s3", ["= 0.3.25"]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: rainbow_storage
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Stanislav Mekhonoshin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: s3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.25
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.3.25
+description: Much longer explanation of the example!
+email: ejabberd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- TODO.md
+- lib/rainbow_storage.rb
+- lib/rainbow_storage/adapters/abstract_adapter.rb
+- lib/rainbow_storage/adapters/repository.rb
+- lib/rainbow_storage/adapters/s3.rb
+- lib/rainbow_storage/adapters/s3/adapter.rb
+- lib/rainbow_storage/configuration.rb
+- lib/rainbow_storage/exceptions/storage_not_configured_exception.rb
+- lib/rainbow_storage/exceptions/unknown_adapter_exception.rb
+- lib/rainbow_storage/exceptions/unsupported_file_type_exception.rb
+- lib/rainbow_storage/manager.rb
+- lib/rainbow_storage/path_generator.rb
+- rainbow_storage.gemspec
+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: '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: This is an example!
+test_files: []