mountable_file_server 0.1.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9eca97072a7e354d3523e099982afc7cf4234516
-  data.tar.gz: 938444d589b364fb81bb16ab26244425601ba4eb
+SHA256:
+  metadata.gz: '086ef547685f9b8f4ca5d2dc5ef78d599006fb16da4b26c9037123ce63d2d260'
+  data.tar.gz: c7ddc3f6ab666fe4a24d45acc4d83ae9bf5e8f66d1a7382913f1387bde8522e5
 SHA512:
-  metadata.gz: 09226be2ad7e5f2ccfac19be367b42f44d94e9570a91a2046f541468a1aaca317eae56baf4829455e450814c831e30f3147897ee344f842f245ca846a812d45b
-  data.tar.gz: 9f5d940813c63c26497be28472b5e12175ca4be1bec7903f8f5f21fe6412f89cdddaf26e75be3e2e3b4de40a628f898030e33b8f2b509c312625781edcd8067c
+  metadata.gz: 50e035cca646a00c33bdefed071fce9a0177e6f36f5595c10e9e34d20a349a9fb26905ea727c2adb7f0c20bde582a5b2245eb83a507bb5b1aa959ae003a7fcbd
+  data.tar.gz: 31a502e8602d71c906e208a0b75749d0467fa522938868c2848ece0c9b725ae742b168f8b6d9f58ec82881a4253f2fb3ecf104a541743e39ea0ff136877ace08

data/.gitignore

@@ -16,4 +16,4 @@ mkmf.log
 *.sqlite3
 test/rails-dummy/tmp/
 test/rails-dummy/uploads/
-.ruby-version
+/.local-data/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# 3.0.2
+* Fix deprecation warning when calling metadata class initializer with keyword arguments.
+* Don't break when uploading a private file.
+
+# 3.0.1
+* Repair broken `FileAccessor` class.
+
+# 3.0.0
+* **Breaking Change**: Remove `MountableFileServer::Client`. Use `MountableFileServer::Adapter` instead.
+
+# 2.1.0
+* Relax Sinatra dependency so Ruby on Rails 4 can use Rack 1.X
+
+# 2.0.0
+* Remove HTTP endpoints for moving and deleting uploads due to security concerns.
+* Return 404 for unknown or malformed FIDs.
+
 # 0.0.2 - 24.08.2015
 * Internal refactorings.
 * Introduce `Adapter` class to have one point of contact.

data/README.md

@@ -4,7 +4,7 @@ Mountable File Server can be used with any Ruby (on Rails) application and it re
 app only stores reference to uploaded file
 
 ## MountableFileServer::Server
-The core of Mountable File Server (MFS) is a small HTTP API that accepts file uploads and offers endpoints to interact with uploaded files. While the frontend deals directly with the HTTP API, your Ruby application will want to use the Ruby Client `MountableFileServer::Client`.
+The core of Mountable File Server (MFS) is a small HTTP API that accepts file uploads and offers endpoints to interact with uploaded files. While the frontend deals directly with the HTTP API, your Ruby application will want to use the Ruby adapter `MountableFileServer::Adapter`.
 
 
 
@@ -53,7 +53,7 @@ end
 ~~~
 
 ## Configuration
-As seen in the previous section there is a global configuration at `MountableFileServer.configuration` available.  
+As seen in the previous section there is a global configuration at `MountableFileServer.configuration` available.
 This is an instance of the `MountableFileServer::Configration` class. The global configuration is a default argument for all classes that require access to the configuration. In situations where you have multiple endpoints with different settings you can pass in you own configuration objects instead.
 
 The global configuration can be configured through a block.
@@ -81,36 +81,41 @@ The `files` argument is an array of `File` objects or an `FileList` object. Thes
 
 Following events will be dispatched on the element that was passed to `uploadFiles`. When you are listening to one of these events you can access the described attributes on the `event.detail` object.
 
-`upload:start` is dispatched when the upload starts.  
+`upload:start` is dispatched when the upload starts.
 It has the attributes `uploadId` and `file`. The `uploadId` is local and can be used to identify events in a scenario where multiple files are uploaded. The `file` attribute is the original `File` object and useful for showing a preview or other information about the file.
 
-`upload:progress` is continuously dispatched while the upload is happening.  
+`upload:progress` is continuously dispatched while the upload is happening.
 It has the attributes `uploadId` and `progress`. The `progress` attribute is the original [ProgressEvent](https://developer.mozilla.org/en-US/docs/Web/API/ProgressEvent) object of the AJAX request.
 
-`upload:success` is dispatched when the upload succeeded.  
+`upload:success` is dispatched when the upload succeeded.
 It has the attributes `uploadId`, `uid` and `wasLastUpload`. The `uid` attribute is the unique identifier generated by the MountableFileServer. You will want to add it to your form and store it along your other data. The `wasLastUpload` attribute indicates if this was the last upload in progress.
 
 ## Ruby API
 The `MountableFileServer::Adapter` class allows you to interact with uploaded files. It takes a `MountableFileServer::Configuration` instance as argument and uses `MountableFileServer.configuration` by default.
 
-`MountableFileServer::Adapter#store_temporary(input, type, extension)`  
+`MountableFileServer::Adapter#store_temporary(input, type, extension)`
 Stores the input as file in the temporary storage and returns the `uid` of the file. `input` can be a path to a file or an [IO](http://ruby-doc.org/core-2.2.2/IO.html) object. `type` can be `public` or `private` and the `extension` argument specifies the extension the file should have.
 
-`MountableFileServer::Adapter#store_permanent(input, type, extension)`  
+`MountableFileServer::Adapter#store_permanent(input, type, extension)`
 Stores the input as file in the permanent storage and returns the `uid` of the file. `input` can be a path to a file or an [IO](http://ruby-doc.org/core-2.2.2/IO.html) object. `type` can be `public` or `private` and the `extension` argument specifies the extension the file should have.
 
-`MountableFileServer::Adapter#move_to_permanent_storage(uid)`  
+`MountableFileServer::Adapter#move_to_permanent_storage(uid)`
 Moves a file from the temporary storage to the permanent one. This is mostly used in a scenario where users upload files. A file uploaded through the endpoint is initially only stored in the temporary storage. The application has to move it explicitly to the permanent storage. For example after all validations passed.
 
-`MountableFileServer::Adapter#remove_from_permanent_storage(uid)`  
+`MountableFileServer::Adapter#remove_from_permanent_storage(uid)`
 Removes the file from the permanent storage.
 
-`MountableFileServer::Adapter#url_for(uid)`  
+`MountableFileServer::Adapter#url_for(uid)`
 Returns the URL for an uploaded file. Only works for public files, if you pass the `uid` of a private file an error will be raised.
 
-`MountableFileServer::Adapter#pathname_for(id)`  
+`MountableFileServer::Adapter#pathname_for(id)`
 Returns a [Pathname](http://ruby-doc.org/stdlib-2.2.2/libdoc/pathname/rdoc/Pathname.html) object for the uploaded file. The pathname will always point to the file on disk independent from the files type or current storage location.
 
+# Development
+Run the migrations of the Ruby on Rails dummy application to make sure you can run the tests: `cd test/rails-dummy && RAILS_ENV=test bundle exec rake db:migrate`.
+
+Run tests with `bundle exec rake test`.
+
 # Publish on RubyGems.org
 
 1. Increment `lib/mountable_image_server/version.rb` to your liking.

data/lib/mountable_file_server/adapter.rb

@@ -33,9 +33,8 @@ module MountableFileServer
     end
 
     def url_for(uid)
-      # uid = UniqueIdentifier.new uid
-      # FileAccessor.new(uid, configuration).url
-      configuration.base_url + uid
+      uid = UniqueIdentifier.new uid
+      FileAccessor.new(uid, configuration).url
     end
 
     def pathname_for(uid)

data/lib/mountable_file_server/file_accessor.rb

@@ -1,3 +1,4 @@
+require 'mountable_file_server/uri'
 require 'pathname'
 
 module MountableFileServer

data/lib/mountable_file_server/metadata.rb

@@ -39,7 +39,7 @@ module MountableFileServer
         parameters[:height] = dimensions[1]
       end
 
-      new(parameters)
+      new(**parameters)
     end
   end
 end

data/lib/mountable_file_server/rails.rb

@@ -1,6 +1,5 @@
 require 'mountable_file_server'
 require 'mountable_file_server/server'
-require 'mountable_file_server/client'
 
 module MountableFileServer
   class Engine < Rails::Engine

data/lib/mountable_file_server/server.rb

@@ -11,7 +11,7 @@ module MountableFileServer
       pathname = Pathname(params[:file][:tempfile].path)
       type = params[:type]
       fid = adapter.store_temporary(pathname, type, pathname.extname)
-      url = adapter.url_for(fid)
+      url = adapter.url_for(fid) if fid.public?
       metadata = Metadata.for_path(pathname)
 
       content_type :json
@@ -25,25 +25,13 @@ module MountableFileServer
     end
 
     get '/:fid' do |fid|
-      adapter = Adapter.new
-      pathname = adapter.pathname_for(fid)
-      send_file pathname
-    end
-
-    post '/:fid/store-permanent' do |fid|
-      adapter = Adapter.new
-      adapter.move_to_permanent_storage(fid)
-
-      content_type :json
-      status 200
-    end
-
-    delete '/:fid' do |fid|
-      adapter = Adapter.new
-      adapter.remove_from_storage(fid)
-
-      content_type :json
-      status 200
+      begin
+        adapter = Adapter.new
+        pathname = adapter.pathname_for(fid)
+        send_file pathname
+      rescue MissingFile, MalformedIdentifier
+        status 404
+      end
     end
   end
 end

data/lib/mountable_file_server/unique_identifier.rb

@@ -2,11 +2,14 @@ require 'securerandom'
 
 module MountableFileServer
   UnknownType = Class.new(ArgumentError)
+  MalformedIdentifier = Class.new(ArgumentError)
 
   class UniqueIdentifier < String
     attr_reader :type, :filename
 
     def initialize(string)
+      raise MalformedIdentifier.new unless /(\w+)-(.+)$/.match(string)
+
       @type, @filename = /(\w+)-(.+)$/.match(string).captures
 
       raise UnknownType.new(type) unless known_type?

data/lib/mountable_file_server/version.rb

@@ -1,3 +1,3 @@
 module MountableFileServer
-  VERSION = "0.1.0"
+  VERSION = "3.0.2"
 end

data/mountable_file_server.gemspec

@@ -18,17 +18,17 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", "~> 5.8.0"
-  spec.add_development_dependency "rails", "~> 5.0.2"
-  spec.add_development_dependency "capybara", "~> 2.4.4"
+  spec.add_development_dependency "rails", "~> 5.0.7.2"
+  spec.add_development_dependency "capybara", "2.18.0"
   spec.add_development_dependency "sqlite3", "~> 1.3.10"
-  spec.add_development_dependency "poltergeist", "~> 1.6.0"
+  spec.add_development_dependency "poltergeist", "1.18.1"
   spec.add_development_dependency "rack-test", "~> 0.6.3"
-  spec.add_development_dependency "webmock", "~> 2.1.0"
+  spec.add_development_dependency "mocha", "1.11.2"
 
-  spec.add_runtime_dependency "sinatra", "~> 2.0.0.rc1"
+  spec.add_runtime_dependency "sinatra", ">= 1.4.8"
   spec.add_runtime_dependency "dry-configurable", "~> 0.1.6"
   spec.add_runtime_dependency "dimensions", "~> 1.3.0"
 end

data/shell.nix

@@ -0,0 +1,26 @@
+{
+  pkgs ? import (fetchGit {
+    url = https://github.com/NixOS/nixpkgs-channels;
+    ref = "nixos-20.03";
+  }) {},
+  ruby ? pkgs.ruby_2_5,
+  bundler ? pkgs.bundler.override { inherit ruby; }
+}:
+
+pkgs.mkShell {
+  buildInputs = with pkgs; [
+    ruby
+    bundler
+    git
+    sqlite
+    zlib
+    phantomjs
+    rubyPackages_2_5.nokogiri
+  ];
+
+  shellHook = ''
+    mkdir -p .local-data/gems
+    export GEM_HOME=$PWD/.local-data/gems
+    export GEM_PATH=$GEM_HOME
+  '';
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mountable_file_server
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 3.0.2
 platform: ruby
 authors:
 - David Strauß
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-10 00:00:00.000000000 Z
+date: 1970-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.0.7.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.2
+        version: 5.0.7.2
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.4.4
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -98,16 +98,16 @@ dependencies:
   name: poltergeist
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 1.18.1
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -123,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.3
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.11.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc1
+        version: 1.4.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.0.rc1
+        version: 1.4.8
 - !ruby/object:Gem::Dependency
   name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
@@ -186,6 +186,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -194,7 +195,6 @@ files:
 - Rakefile
 - lib/mountable_file_server.rb
 - lib/mountable_file_server/adapter.rb
-- lib/mountable_file_server/client.rb
 - lib/mountable_file_server/file_accessor.rb
 - lib/mountable_file_server/metadata.rb
 - lib/mountable_file_server/rails.rb
@@ -204,6 +204,7 @@ files:
 - lib/mountable_file_server/uri.rb
 - lib/mountable_file_server/version.rb
 - mountable_file_server.gemspec
+- shell.nix
 - vendor/assets/javascripts/mountable_file_server.js
 homepage: https://github.com/stravid/mountable_file_server
 licenses:
@@ -224,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Simple mountable server that handles file uploads

data/lib/mountable_file_server/client.rb

@@ -1,44 +0,0 @@
-require 'net/http'
-require 'uri'
-require 'stringio'
-
-module MountableFileServer
-  class Client
-    def move_to_permanent_storage(fid)
-      if MountableFileServer.config.base_url.start_with?('http')
-        uri = ::URI.parse(MountableFileServer.config.base_url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.set_debug_output($stdout)
-        request = Net::HTTP::Post.new(uri.request_uri + fid + '/store-permanent')
-
-        http.request(request)
-      else
-        MountableFileServer::Server.new.call({
-          "rack.input" => StringIO.new(""),
-          "REQUEST_METHOD"=> "POST",
-          "PATH_INFO"=> "/#{fid}/store-permanent",
-        })
-      end
-    end
-
-    def remove_from_storage(fid)
-      if MountableFileServer.config.base_url.start_with?('http')
-        uri = ::URI.parse(MountableFileServer.config.base_url)
-        http = Net::HTTP.new(uri.host, uri.port)
-        request = Net::HTTP::Delete.new(uri.request_uri + fid)
-
-        http.request(request)
-      else
-        MountableFileServer::Server.new.call({
-          "rack.input" => StringIO.new(""),
-          "REQUEST_METHOD"=> "DELETE",
-          "PATH_INFO"=> "/#{fid}",
-        })
-      end
-    end
-
-    def url_for(fid)
-      MountableFileServer.config.base_url + fid
-    end
-  end
-end