paperclip-tus 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4d16aa83af67ced9c2daa7bda886b630efbac50
-  data.tar.gz: 3efce25971a17375b3d230d0f01314bace8f1d40
+  metadata.gz: 9106d3c91ed9719f32498c1608df42581ee3513c
+  data.tar.gz: b34134c7bfde63fb148a2277fea2b820199745e9
 SHA512:
-  metadata.gz: 8b1bec6195e0840e8a4a8b9dec11d542ac8f029c43571fb7019d82ce4bd3b91b0f2273c89dfdc99b5926fcb58836faf571c75c78a865ca4f71d1b3713dac90e3
-  data.tar.gz: b212de7f85445b9df146ab92de16cfeb41b1c2d414f9691242b2083b4828e1e4fb6d68c14a279814a70e5cbbb20e46ee7c0143d0a21d77df3495fa3a50e192b3
+  metadata.gz: eccd2395fd64cbb404b84650cb8372505fd96d96906b3ef95a0b7f6ae9ecc832f7a3d210ea79113a2a9bf08618d5a837c582456c613401d2748cd5c4855fcaf2
+  data.tar.gz: 42154c130421af151240b0525f793141f3baffc300dc5ff426e2073636039b990b440fa14d8f8a627d002c61946538383ddf750296c5b333cfb7fd3217e1d8c5

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Documentation:
+  Enabled: false

data/README.md

@@ -1,8 +1,8 @@
-# Paperclip::Tus
+# paperclip-tus
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/paperclip/tus`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/deees/paperclip-tus.svg?branch=master)](https://travis-ci.org/deees/paperclip-tus)
 
-TODO: Delete this and the text above, and describe your gem
+paperclip-tus is paperclip io adapter for [tus-ruby-server](https://github.com/janko-m/tus-ruby-server).
 
 ## Installation
 
@@ -22,19 +22,43 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First, make sure you [configure tus ruby server](https://github.com/janko-m/tus-ruby-server/blob/master/README.md#usage) correctly.
+Only `Tus::Storage::Filesystem` storage is supported at the moment.
+
+Then, you need [tus-js-client](https://github.com/tus/tus-js-client). Set it up similar to [this example](https://github.com/tus/tus-js-client/blob/master/README.md#example).
+It's recommended to add `metadata` to `tus.Upload` `options` (to make sure names of uploaded files can be retrieved by the adapter):
+```
+var upload = new tus.Upload(file, {
+      endpoint: ...,
+      metadata: { filename: file.name },
+      ...
+```
+
+Next, in `onSuccess` callback, you should extract file uid and submit it as `has_attached_file` attribute.
+Uid can be extracted from url:
+```
+var upload = new tus.Upload(file, {
+  ...
+  onSuccess: function() {
+    var url_parts = upload.url.split('/')
+    # get last part of url
+    var uid = url_parts[url_parts.length - 1]
+    ... [assign uid to attachment attribute]..
+  }
+  ...
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install:local`.
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/deees/paperclip-tus.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "paperclip/tus"
+require 'bundler/setup'
+require 'paperclip/tus'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "paperclip/tus"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/paperclip/tus/adapter.rb

@@ -38,10 +38,11 @@ module Paperclip
       end
 
       def ensure_tus_filesystem_storage!
-        unless tus_storage.class == ::Tus::Storage::Filesystem
-          raise "Paperclip Tus Adapter does not support #{tus_storage.class.name}!" \
-            "Please set Tus::Server.opts[:storage] to Tus::Storage::Filesystem.new(cache_directory)"
-        end
+        return if tus_storage.class == ::Tus::Storage::Filesystem
+
+        raise 'Paperclip tus adapter does not support ' \
+          "#{tus_storage.class.name}! Please set Tus::Server.opts[:storage] " \
+          'to Tus::Storage::Filesystem.new(cache_directory)'
       end
 
       def copy_to_tempfile(src_path)
@@ -53,5 +54,5 @@ module Paperclip
 end
 
 Paperclip.io_adapters.register Paperclip::Tus::Adapter do |target|
-  String === target && target =~ Paperclip::Tus::Adapter::REGEXP
+  target.is_a?(String) && target =~ Paperclip::Tus::Adapter::REGEXP
 end

data/lib/paperclip/tus/version.rb

@@ -1,5 +1,5 @@
 module Paperclip
   module Tus
-    VERSION = "0.1.0"
+    VERSION = '0.1.1'.freeze
   end
 end

data/lib/paperclip/tus.rb

@@ -1,2 +1,2 @@
-require "paperclip/tus/version"
-require "paperclip/tus/adapter"
+require 'paperclip/tus/version'
+require 'paperclip/tus/adapter'

data/paperclip-tus.gemspec

@@ -1,29 +1,31 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'paperclip/tus/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "paperclip-tus"
+  spec.name          = 'paperclip-tus'
   spec.version       = Paperclip::Tus::VERSION
-  spec.authors       = ["Tomas Brazys"]
-  spec.email         = ["tomas.brazys@gmail.com"]
+  spec.authors       = ['Tomas Brazys']
+  spec.email         = ['tomas.brazys@gmail.com']
 
-  spec.summary       = "TUS server adapter for Paperclip"
-  spec.homepage      = "https://github.com/deees/paperclip-tus"
-  spec.license       = "MIT"
+  spec.summary       = 'tus server adapter for Paperclip'
+  spec.homepage      = 'https://github.com/deees/paperclip-tus'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
 
-  spec.add_runtime_dependency "paperclip", '~> 4.3'
-  spec.add_runtime_dependency "tus-server", '~> 0.10'
+  spec.add_runtime_dependency 'paperclip', '~> 4.3'
+  spec.add_runtime_dependency 'tus-server', '~> 0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-tus
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tomas Brazys
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
+date: 2017-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: paperclip
   requirement: !ruby/object:Gem::Requirement
@@ -89,12 +103,12 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- TODO.txt
 - bin/console
 - bin/setup
 - lib/paperclip/tus.rb
@@ -124,5 +138,5 @@ rubyforge_project:
 rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
-summary: TUS server adapter for Paperclip
+summary: tus server adapter for Paperclip
 test_files: []

data/TODO.txt

@@ -1,2 +0,0 @@
-* README (explain how to use with tus-js-client)
-* rubocop