file_store 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 033d82e34fc2d7300183e67f190556b556d87d44
-  data.tar.gz: c0fb965cfdbe67d8add8e57f43ad5a8574cad9fa
+  metadata.gz: 9fff72cdc5645c1080b8753bc93094675979b4f8
+  data.tar.gz: c43124ef49f590095bc4e15b858766e363649a67
 SHA512:
-  metadata.gz: 37d5b82dc70d0075bc0f21e282e93230855a9d0d550b3071ea026d11b6d4a4f20fa5b7bd2c6b2ea811172bd638e76b5af516fca08ff9b1cc490cce60889c316b
-  data.tar.gz: 81026ca72dda868b9d74bd1da7ce50cd419631c2658df81fd5494dd4720e1b5b5d65b3ea3f0d201954b807dae1e26de4678582972c506bca38b57d10b02f02a0
+  metadata.gz: 9f12572c541306fd26abe99669b3f702c15df09f76d4c19e1a70e7440121790e3d9841e81e3a0c90a76552c9c5d800a88a755984dd1db4286f3ff9765917adee
+  data.tar.gz: 80ac8001ddba6019313e361c4050f35343b73898b0846b97053a8d61e04efa661b11f4012dd254257303953f175cdf212c11e1fadab72c3dc8993747c5744189

data/lib/file_store.rb

@@ -0,0 +1,17 @@
+require 'file_store/version'
+
+module FileStore
+  autoload(:Config,    'file_store/config')
+  autoload(:Instance,  'file_store/instance')
+  autoload(:Providers, 'file_store/providers')
+
+  class << self
+    def method_missing(meth, *args, &block)
+      instance.public_send(meth, *args, &block)
+    end
+
+    def instance
+      @__instance ||= Instance.new
+    end
+  end # Class Methods
+end # FileStore

data/lib/file_store/config.rb

@@ -0,0 +1,21 @@
+module FileStore
+  class Config
+    VALID_CONFIGS = [:aws_access_key, :aws_access_secret, :aws_s3_bucket,
+      :aws_region].freeze
+
+    def initialize
+      @_config_hash = {}
+    end
+
+    ##
+    # Set up accessors for the config fields
+    VALID_CONFIGS.each { |config|
+      define_method(config) { @_config_hash[config] }
+      define_method("#{config}=") { |value| @_config_hash[config] = value }
+    }
+
+    def to_h
+      @_config_hash
+    end
+  end # Config
+end # FileStore

data/lib/file_store/instance.rb

@@ -0,0 +1,28 @@
+module FileStore
+  class Instance
+    def config
+      (@__config ||= Config.new).tap { |config| yield config if block_given? }
+    end
+
+    def provider
+      # Default to the S3 provider. This will be our only provider in the
+      # forseeable future.
+      @__provider ||= Providers::S3.new(config.to_h)
+    end
+
+    private
+
+    def respond_to_missing?(meth)
+      provider.respond_to?(meth) || super
+    end
+
+    def method_missing(meth, *args, &block)
+      if provider.respond_to?(meth)
+        meth = provider.mocked? ? "mock_#{meth}" : meth
+        provider.public_send(meth, *args, &block)
+      else
+        super
+      end
+    end
+  end # Instance
+end # FileStore

data/lib/file_store/providers.rb

@@ -0,0 +1,6 @@
+module FileStore
+  module Providers
+    autoload(:Provider, 'file_store/providers/provider')
+    autoload(:S3,       'file_store/providers/s3')
+  end # Providers
+end # FileStore

data/lib/file_store/providers/provider.rb

@@ -0,0 +1,93 @@
+require 'securerandom'
+
+module FileStore
+  module Providers
+    class Provider
+      attr_reader :options
+
+      def initialize(opts = {})
+        if (missing_fields = required_configs - opts.keys).length > 0
+          fail "missing fields: #{missing_fields.join(', ')}"
+        end
+
+        @mock = false
+        @options = opts
+      end
+
+      def upload(prefix, file_name, data = nil)
+        ext = _generate_ext_if_needed(file_name)
+        file_path = generate_unique_path(prefix) + "/#{file_name}#{ext}"
+        file_id = upload!(file_path, data)
+        "#{_provider_name}://#{file_id}"
+      end
+
+      def download_url(file_id, opts = {})
+        # Extract the provider from the file_id. i.e. For S3: s3://file/id/path
+        # Validate that the current provider matches the file_id's provider
+        extracted_file_id = file_id.gsub(/\A(.*):\/\//, '')
+        fail "invalid provider: #{$1}" unless $1 == _provider_name
+        download_url!(extracted_file_id, opts)
+      end
+
+      def mock!
+        @mock = true
+      end
+
+      def mocked?
+        !!@mock
+      end
+
+      def mock_upload(prefix, file_name, data = nil)
+        ext = _generate_ext_if_needed(file_name)
+        prefix + _generate_random_path + "/#{file_name}#{ext}"
+      end
+
+      def mock_download_url(file_id, opts = {})
+        "http://mocked_download_url.com/#{file_id}"
+      end
+
+      protected
+
+      def upload!(prefix, file_name, data = nil)
+        fail NotImplementedError
+      end
+
+      def download_url!(file_id, opts = {})
+        fail NotImplementedError
+      end
+
+      def generate_unique_path(prefix)
+        20.times do
+          path = prefix + _generate_random_path
+          return path unless path_exists?(path)
+        end
+
+        fail "could not find unique path"
+      end
+
+      def path_exists?(path)
+        fail NotImplementedError
+      end
+
+      def required_configs
+        fail NotImplementedError
+      end
+
+      private
+
+      ##
+      # Will create a random path of four 3-digit numbers i.e. /123/456/789/321
+      def _generate_random_path
+        4.times.map { '/%03d' %  SecureRandom.random_number(1000) }.join
+      end
+
+      def _provider_name
+        self.class.name.split('::').last.downcase
+      end
+
+      def _generate_ext_if_needed(file_name)
+        File.extname(file_name).length > 0 ? '' : '.dat'
+      end
+    end # Provider
+  end # Providers
+end # FileStore

data/lib/file_store/providers/s3.rb

@@ -0,0 +1,89 @@
+require 'aws-sdk'
+
+module FileStore
+  module Providers
+    class S3 < Provider
+      REQUIRED_CONFIGS = [:aws_access_key, :aws_access_secret, :aws_s3_bucket,
+        :aws_region].freeze
+      DEFAULT_S3_OPTIONS = {
+        server_side_encryption: 'AES256'.freeze,
+        acl: 'private'.freeze
+      }.freeze
+
+      def initialize(opts = {})
+        super
+
+        @_synchronizer = Mutex.new
+        @_s3_interface = ::Aws::S3::Resource.new(
+          access_key_id: options[:aws_access_key],
+          secret_access_key: options[:aws_access_secret],
+          region: options[:aws_region]
+        )
+        @_s3_bucket = _s3_interface.bucket(_bucket_name)
+      end
+
+      protected
+
+      ##
+      # Send data directly to S3 either as a String / IO object, or as a
+      # multi-part upload
+      def upload!(file_path, data = nil)
+        _synchronize do
+          _s3_object(file_path).put(DEFAULT_S3_OPTIONS.merge(body: data))
+          "#{_bucket_name}/#{file_path}"
+        end
+      end
+
+      ##
+      # Generate a download url for the object on S3 referenced by the file_id.
+      # Pass in a ttl as an option for the link expiration time in seconds.
+      def download_url!(file_id, opts = {})
+        options = { expires_in: opts[:ttl] || 600 }
+        bucket_name, file_id = _extract_bucket_name(file_id)
+        fail "invalid bucket: #{bucket_name}" unless bucket_name == _bucket_name
+        fail "object: #{file_id} doesn't exist" unless _object_exists?(file_id)
+
+        _s3_object(file_id).presigned_url(:get, options)
+      end
+
+      def path_exists?(path)
+        _s3_bucket.objects(prefix: path).one?
+      end
+
+      def required_configs
+        REQUIRED_CONFIGS
+      end
+
+      private
+
+      def _extract_bucket_name(file_id)
+        split_file_id = file_id.split('/')
+        [split_file_id.shift, split_file_id.join('/')]
+      end
+
+      def _s3_interface
+        @_s3_interface
+      end
+
+      def _s3_bucket
+        @_s3_bucket
+      end
+
+      def _bucket_name
+        options[:aws_s3_bucket]
+      end
+
+      def _s3_object(path = "")
+        _s3_bucket.object(path)
+      end
+
+      def _object_exists?(path)
+        _s3_object(path).exists?
+      end
+
+      def _synchronize(&block)
+        @_synchronizer.synchronize(&block)
+      end
+    end # S3
+  end # Providers
+end # FileStore

data/lib/file_store/version.rb

@@ -0,0 +1,3 @@
+module FileStore
+  VERSION = '0.1.0'
+end

metadata

@@ -1,24 +1,59 @@
 --- !ruby/object:Gem::Specification
 name: file_store
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- Robert Honer
 - Kayvon Ghaffari
+- Robert Honer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
-dependencies: []
+date: 2016-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.14
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
-- robert@payout.com
 - kayvon@payout.com
+- robert@payout.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/file_store.rb
+- lib/file_store/config.rb
+- lib/file_store/instance.rb
+- lib/file_store/providers.rb
+- lib/file_store/providers/provider.rb
+- lib/file_store/providers/s3.rb
+- lib/file_store/version.rb
 homepage: http://github.com/payout/file_store
 licenses:
 - MIT