s3_file_cache_download 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1622cbece94d617f6c1aae6f4a7c398949536a5
+  data.tar.gz: f0f67fcc8d9a09e061d2bbb279116611368122a5
+SHA512:
+  metadata.gz: 5bb0399303c6b2187f04e230ec34b47af56a6c6a0fa5f8a96dd0c16bc0d77046581c6e0fe8cfd178a0f51af54f8df224a592377fad7050bc8c9a275209e80de8
+  data.tar.gz: bcdcf67d96d9bacc3ecf08432e37186d0394d25f89683a2cdf2302d0ef73af01c923795cc53ae0bbd94297dbfd83e9cc079e9df32b042c0ee50631a1de2b5d88

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 wat-aro
+
+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,63 @@
+# S3FileCacheDownload
+
+PROVIDE helper method that S3 file download use temporaly file
+
+## Usage
+
+First, execute `bin/rails s3_file_cache_download_engine:install:migrations`.
+
+Second, include `S3FileCacheDownload::Helper` module to your controller.
+
+```ruby
+  class YourController
+    include S3FileCacheDownload::Helper
+  end
+```
+
+Call `send_s3_file` method.
+
+```ruby
+  class YourController
+    include S3FileCacheDownload
+
+    def show
+      send_s3_file :your_bucket_name, :your_file_key
+    end
+  end
+```
+
+If you want to use option, you can pass option.
+
+```ruby
+  class YourController
+    include S3FileCacheDownload
+
+    def show
+      send_s3_file :your_bucket_name, :your_file_key, disposition: 'inline'
+    end
+  end
+```
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 's3_file_cache_download'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install s3_file_cache_download
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'bundler/gem_tasks'

data/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/models/s3_file_cache.rb

@@ -0,0 +1,86 @@
+class S3FileCache < ApplicationRecord
+  class << self
+    def find_s3_cache_file_or_create!(s3_file_path, bucket_name)
+      S3FileCache.transaction do
+        s3_file_cache = S3FileCache.find_or_create_by!(s3_full_path: s3_file_path, bucket_name: bucket_name)
+
+        if s3_file_cache.expire?
+          FileUtils.rm(s3_file_cache.place)
+          s3_file_cache.destroy
+
+          s3_file_cache = S3FileCache.create!(s3_full_path: s3_file_path, bucket_name: bucket_name)
+        end
+
+        s3_file_cache.fetch!
+        s3_file_cache
+      end
+    end
+
+    def cleaning_directory_and_record!
+      limit = Time.zone.now - expire_seconds
+
+      expired_files = where('created_at < ?', limit)
+      expired_files.each do |expired_file|
+        FileUtils.rm(expired_file.place)
+        expired_file.destroy
+      end
+    end
+
+    def expire_seconds
+      S3FileCacheDownload.expire_seconds.seconds
+    end
+
+    def file_cache_directory
+      S3FileCacheDownload.file_cache_directory
+    end
+  end
+
+  def expire?
+    created_at + S3FileCacheDownload.expire_seconds < Time.zone.now
+  end
+
+  def fetch!
+    return if File.exist?(place)
+
+    s3_object = S3FileCache::S3Object.new(bucket_name, s3_full_path)
+    File.open(place, 'w') do |file|
+      s3_object.get.each_line do |line|
+        file.write line
+      end
+    end
+  end
+
+  def place
+    "#{S3FileCache.file_cache_directory}/#{id}"
+  end
+
+  def filename
+    File.basename(s3_full_path)
+  end
+
+  class S3Object
+    def initialize(bucket_name, path)
+      @bucket = Aws::S3::Resource.new(client: client).bucket(bucket_name)
+      @path   = path
+    end
+
+    def get
+      body = @bucket.object(@path).get.body
+
+      if block_given?
+        yield body
+      else
+        body
+      end
+    end
+
+    private
+
+    def client
+      @client ||= Aws::S3::Client.new(
+        access_key_id: S3FileCacheDownload.aws_access_key_id,
+        secret_access_key: S3FileCacheDownload.aws_secret_access_key
+      )
+    end
+  end
+end

data/db/migrate/20170404044432_create_s3_file_caches.rb

@@ -0,0 +1,10 @@
+class CreateS3FileCaches < ActiveRecord::Migration[5.0]
+  def change
+    create_table :s3_file_caches do |t|
+      t.string :bucket_name, null: false
+      t.string :s3_full_path, null: false, index: true
+
+      t.timestamps null:false
+    end
+  end
+end

data/lib/s3_file_cache_download/engine.rb

@@ -0,0 +1,4 @@
+module S3FileCacheDownload
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/s3_file_cache_download/version.rb

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

data/lib/s3_file_cache_download.rb

@@ -0,0 +1,42 @@
+require 's3_file_cache_download/engine'
+require 'action_controller'
+require 'active_support/configurable'
+require 'aws-sdk'
+
+module S3FileCacheDownload
+  class FileCacheDirectoryNotFound < StandardError; end
+
+  include ActiveSupport::Configurable
+
+  config_accessor :aws_access_key_id, instance_reader: false, instance_writer: false do
+    ENV['AWS_ACCESS_KEY']
+  end
+
+  config_accessor :aws_secret_access_key, instance_reader: false, instance_writer: false do
+    ENV['AWS_SECRET_ACCESS_KEY']
+  end
+
+  config_accessor :file_cache_directory, instance_reader: false, instance_writer: false do
+    ENV['FILE_CACHE_DIRECTORY']
+  end
+
+  config_accessor :expire_seconds, instance_reader: false, instance_writer: false do
+    ENV['EXPIRE_SECONDS']
+  end
+
+  class << self
+    def configure
+      yield config
+
+      raise FileCacheDirectoryNotFound unless Dir.exist?(config.file_cache_directory)
+    end
+  end
+
+  module Helper
+    def send_s3_file(bucket_name, path, option = {})
+      s3_file_cache = S3FileCache.find_s3_cache_file_or_create!(path, bucket_name)
+
+      send_file s3_file_cache.place, { filename: s3_file_cache.filename }.merge(option)
+    end
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: s3_file_cache_download
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- wat-aro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: 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: sqlite3
+  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: provide helper method that S3 file download use temporaly file
+email:
+- kazutas1008@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/application_record.rb
+- app/models/s3_file_cache.rb
+- db/migrate/20170404044432_create_s3_file_caches.rb
+- lib/s3_file_cache_download.rb
+- lib/s3_file_cache_download/engine.rb
+- lib/s3_file_cache_download/version.rb
+homepage: https://github.com/esminc/s3_file_cache_download
+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.6.8
+signing_key: 
+specification_version: 4
+summary: provide helper method that S3 file download use temporaly file
+test_files: []