shrine-tus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 88569c9725438f4ec79a2e475952cf7ba968ce2c
+  data.tar.gz: d5811879b451a6ec5bead0540a2d1582a5b9f5d2
+SHA512:
+  metadata.gz: f2ea7ef342d68564e10f5831e65804106bc8af0b1f53f352d658f340c9bae6de15d18d7dfe375695869b7d7a5934787f9d8e491d1b3a6897690de0aa8bd70b03
+  data.tar.gz: d0874c8447a1b1053bbb4b64f8d5435f9bcd232b0092b9caf4c679f7da91d6a318e29ad9d674d758f23418531b73d0fa99da68120144fa47f2d97cf39ebf71ba

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Janko Marohnić
+
+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,98 @@
+# Shrine::Tus
+
+Provides tools for integrating [Shrine] with [tus-ruby-server].
+
+## Installation
+
+```ruby
+gem "shrine-tus"
+```
+
+## Usage
+
+Once the file has been uploaded to `tus-ruby-server`, you want to attach it to
+a database record and move it to permanent Shrine storage.
+
+```rb
+class VideoUploader < Shrine
+  plugin :default_storage, cache: :tus # set Shrine::Storage::Tus as temporary storage
+end
+```
+```rb
+class Movie < Sequel::Model
+  include VideoUploader::Attachment.new(:video)
+end
+```
+```rb
+file_data #=> {"id":"http://tus-server.org/68db42638388ae645ab747b36a837a79", "storage":"cache", "metadata":{...}}
+Movie.create(video: file_data)
+```
+
+The simplest setup is to have Shrine download the file uploaded to
+`tus-ruby-server` through the app, which you can do by setting
+`Shrine::Storage::Tus` as the temporary Shrine storage.
+
+```rb
+gem "shrine-url", "~> 0.3" # dependency of Shrine::Storage::Tus
+```
+```rb
+require "shrine/storage/tus"
+
+Shrine.storages[:tus] = Shrine::Storage::Tus.new
+```
+```rb
+class VideoUploader < Shrine
+  plugin :default_storage, cache: :tus # set Shrine::Storage::Tus as temporary storage
+end
+```
+
+By default `wget` will be used for downloading, but if you need support for
+partial downloads (e.g. you want to use `restore_cached_data`), you can switch
+to using [Down] for downloads.
+
+```rb
+Shrine::Storage::Tus.new(downloader: :down)
+```
+
+If you want to Shrine, instead of downloading through the `tus-ruby-server`
+app, to download directly from the tus storage, you can assign the tus storage
+instance to `Shrine::Storage::Tus`:
+
+```rb
+Shrine::Storage::Tus.new(tus_storage: Tus::Server.opts[:storage])
+```
+
+Finally, if you want to use the same kind of permanent storage as your
+`tus-ruby-server` uses, you can setup your temporary Shrine storage to match
+the one your tus server uses, and load the `tus` plugin which will translate
+the assigned tus URL to the corresponding storage ID.
+
+```rb
+Shrine.storages = {
+  cache: Shrine::Storage::YourTemporaryStorage.new(...),
+  store: Shrine::Storage::YourPermanentStorage.new(...),
+}
+```
+```rb
+class VideoUploader < Shrine
+  plugin :tus
+end
+```
+
+For more details, and an explanation of pros and cons for each of the
+approaches, see [shrine-tus-demo].
+
+## Contributing
+
+```sh
+$ rake test
+```
+
+## License
+
+[MIT](/LICENSE.txt)
+
+[Shrine]: https://github.com/janko-m/shrine
+[tus-ruby-server]: https://github.com/janko-m/tus-ruby-server
+[Down]: https://github.com/janko-m/down
+[shrine-tus-demo]: https://github.com/janko-m/shrine-tus-demo

data/lib/shrine/plugins/tus.rb

@@ -0,0 +1,38 @@
+require "json"
+
+class Shrine
+  module Plugins
+    module Tus
+      module AttacherMethods
+        def assign(value)
+          if value.is_a?(String) && value != ""
+            data = JSON.parse(value)
+            data["id"] = tus_url_to_storage_id(data["id"], cache.storage)
+            super(data.to_json)
+          else
+            super
+          end
+        end
+
+        private
+
+        def tus_url_to_storage_id(tus_url, storage)
+          tus_uid = tus_url.split("/").last
+
+          if defined?(Storage::FileSystem) && storage.is_a?(Storage::FileSystem)
+            "#{tus_uid}.file"
+          elsif defined?(Storage::Gridfs) && storage.is_a?(Storage::Gridfs)
+            grid_info = storage.bucket.find(filename: tus_uid).limit(1).first
+            grid_info[:_id].to_s
+          elsif defined?(Storage::S3) && storage.is_a?(Storage::S3)
+            tus_uid
+          else
+            raise Error, "undefined conversion of tus URL to storage id for storage #{storage.inspect}"
+          end
+        end
+      end
+    end
+
+    register_plugin(:tus, Tus)
+  end
+end

data/lib/shrine/storage/tus.rb

@@ -0,0 +1,71 @@
+require "shrine/storage/url"
+require "down/chunked_io"
+require "tempfile"
+
+class Shrine
+  module Storage
+    class Tus < Url
+      attr_reader :tus_storage
+
+      def initialize(downloader: :wget, tus_storage: nil)
+        @tus_storage = tus_storage
+
+        super(downloader: downloader)
+      end
+
+      def download(id)
+        if tus_storage
+          download_from_tus_storage(tus_uid(id))
+        else
+          super
+        end
+      end
+
+      def open(id)
+        if tus_storage
+          open_from_tus_storage(tus_uid(id))
+        else
+          super
+        end
+      end
+
+      private
+
+      def download_from_tus_storage(uid)
+        tempfile = Tempfile.new("shrine-tus", binmode: true)
+
+        response = get_tus_file(uid)
+        response.each { |chunk| tempfile << chunk }
+        response.close
+
+        tempfile.open
+        tempfile
+      end
+
+      def open_from_tus_storage(uid)
+        response = get_tus_file(uid)
+
+        Down::ChunkedIO.new(
+          size:     response.length,
+          chunks:   response.each,
+          on_close: ->{response.close},
+        )
+      end
+
+      def get_tus_file(uid)
+        tus_storage.get_file(uid)
+      end
+
+      def tus_uid(url)
+        url.split("/").last
+      end
+
+      # Add "Tus-Resumable" header to HEAD and DELETE requests.
+      def request(*args)
+        super do |req|
+          req["Tus-Resumable"] = "1.0.0"
+        end
+      end
+    end
+  end
+end

data/shrine-tus.gemspec

@@ -0,0 +1,23 @@
+Gem::Specification.new do |gem|
+  gem.name          = "shrine-tus"
+  gem.version       = "0.1.0"
+
+  gem.required_ruby_version = ">= 2.1"
+
+  gem.summary      = "Provides storage and plugin for easier integration between Shrine and tus-ruby-server."
+  gem.homepage     = "https://github.com/janko-m/shrine-tus"
+  gem.authors      = ["Janko Marohnić"]
+  gem.email        = ["janko.marohnic@gmail.com"]
+  gem.license      = "MIT"
+
+  gem.files        = Dir["README.md", "LICENSE.txt", "lib/**/*.rb", "*.gemspec"]
+  gem.require_path = "lib"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "tus-server", "~> 0.10"
+  gem.add_development_dependency "shrine-url", "~> 0.3"
+  gem.add_development_dependency "shrine-gridfs"
+  gem.add_development_dependency "aws-sdk", "~> 2.1"
+  gem.add_development_dependency "webmock"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: shrine-tus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Janko Marohnić
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-04-09 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: 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: tus-server
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: shrine-url
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: shrine-gridfs
+  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: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !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:
+- janko.marohnic@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/shrine/plugins/tus.rb
+- lib/shrine/storage/tus.rb
+- shrine-tus.gemspec
+homepage: https://github.com/janko-m/shrine-tus
+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'
+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: Provides storage and plugin for easier integration between Shrine and tus-ruby-server.
+test_files: []