mountable_file_server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fc6b91b6cf9ef96d1231d0f403e7f468fd75d1f4
+  data.tar.gz: 9b00ac82aff5a58988d8154d91ccc8e465684d55
+SHA512:
+  metadata.gz: f2a1ecd0b539c510c677273bf44fac23df744c0c48ee225c13ea8dd964e2a03bfa1f9f6fb1df61ba0857b6cbafd3a725ce5cfae96d8217d17baae991b3d71789
+  data.tar.gz: a3dbbe1fbcba59f7e70963827c17f1b506e151bc1f8c45a9300939c42aef5a5b457d8d8e15e10478e01498a00a64f6f1a400d47e0f0b5a81f77433e2a2e1c91d

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.log
+*.sqlite3
+test/rails-dummy/tmp/
+test/rails-dummy/uploads/
+.ruby-version

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mountable_file_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 David Strauß
+
+MIT License
+
+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,64 @@
+The fundamental idea is that your application only deals with identifiers of uploaded files in string form. No need to handle files directly. It should not complicate testing. It should allow files that are publicly accessible and private files that are not. Uploads happen via Ajax without additional work on the application developers side. It allows easy customization and adaption of the file upload process on the frontend to give a good user experience.
+
+While it is possible to use in an Ruby on Rails application the gem itself does not depend on it and does not assume you use it.
+
+## Concept
+You mount a tiny Sinatra application, the `MountableFileServer::Endpoint`, at an URL path of your choosing. The endpoint accepts AJAX file uploads and can also deliver requested files that are already permanently stored. (Later on we take a closer look in which scenarios it makes sense to deliver file requests via the endpoint instead of your webserver.)
+
+For every uploaded file the endpoint responds with an unique identifier, a simple string. This identifier allows you to identify an uploaded file later on. Therefore it is the only thing your application needs to know and persist. The JavaScript provided by the gem handles the AJAX file upload and writes the identifier to a hidden input field with the same `name` attribute as the original file input field. When the form is submitted your application only deals with a simple string value from a hidden input field instead of an actual file upload.
+
+At first a newly uploaded file is only stored temporarly, when the user submits the form and your application deemed it valid and persists the data it is the applications responsibility to move the uploaded file to the permanent storage using the `MountableFileServer::Storage` class. This is necessary to prevent accumulating file garbage due to abandoned forms where an upload already happened.
+
+## Moving Parts
+`MountableFileServer::Endpoint` is a Sinatra application that can be mounted anywhere you want. It accepts uploads and responds with requested files if necessary. `MountableFileServer::Storage` is responsible for working with the actual files. Both take a `MountableFileServer::Configuration` which is used to define key settings specific to your usage scenario.
+
+## Configuration
+~~~ruby
+configuration = MountableFileServer::Configuration.new stored_at: '~/uploads', mounted_at: '/uploads'
+~~~
+
+~~~ruby
+storage = MountableFileServer::Storage.new config
+upload = MountableFileServer::Upload.new file: file_parameters[:tempfile].read, type: 'public'
+
+identifier = storage.store_temporary upload: upload
+storage.move_to_permanent_storage identifier: identifier
+
+storage.path_for identifier: identifier
+storage.url_for identifier: identifier
+~~~
+
+~~~html
+<input type="file" name="avatar" data-endpoint="/uploads" data-type="public">
+~~~
+
+
+
+Wieso ist MFS besser?
+
+Losgekoppelt von der Anwendung / Active Record
+Beispiel Schaltwerk beim Fahrrad im Bezug auf Versionen
+Komplexe Lösungen mit hunderten Issues wo probleme erwähnt werden
+Erlaubt es einfach gute UI zu machen
+Upload passiert nicht im Request zum Controller
+Private Uploads
+
+Funktioniert nur wenn du Dateien auf deinem Server hast.
+Nichts für Gem Installier Programmierer die erwarten das ein Gem ihren UseCase ohne zusätzlichen Aufwand löst.
+
+
+Open Fragen:
+Upload nur auf Gruppe X einschränken
+
+
+Example1:Topic: Realestatephotography
+Subtopic: Housesforsale
+Angle: Picturesthatinspirebuyers Oneword: Preparation
+What: Is wrong with most advertising photos? Why: Are they wrong?
+How: Can they be improved?
+Who: Is best to take the photos?
+Objections:
+Lack of time
+Houses still sell Cost Deception
+Example: Changingagents/changingpictures/ sale
+Summary: Advantages

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test/"
+  t.libs << "test/acceptance"
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test
+

data/lib/mountable_file_server.rb

@@ -0,0 +1,9 @@
+require "mountable_file_server/version"
+
+module MountableFileServer
+  require "mountable_file_server/configuration"
+  require "mountable_file_server/storage"
+  require "mountable_file_server/endpoint"
+  require "mountable_file_server/identifier"
+  require "mountable_file_server/access"
+ end

data/lib/mountable_file_server/access.rb

@@ -0,0 +1,44 @@
+require 'url_safe_base64'
+
+module MountableFileServer
+  class Access
+    NotAccessibleViaURL = Class.new(ArgumentError)
+
+    attr_reader :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def temporary_path_for(identifier:)
+      File.join configuration.stored_at, 'tmp', identifier
+    end
+
+    def path_for(identifier:)
+      identifier = Identifier.new identifier
+      File.join configuration.stored_at, identifier.type, identifier.filename
+    end
+
+    def url_for(identifier:, resize: nil)
+      identifier = Identifier.new identifier
+
+      raise NotAccessibleViaURL unless identifier.public?
+
+      if resize
+        resize_part = UrlSafeBase64.encode64 resize
+        File.join configuration.mounted_at, identifier.filename.gsub('.', ".#{resize_part}.")
+      else
+        File.join configuration.mounted_at, identifier.filename
+      end
+    end
+
+    def file_for(identifier:)
+      paths = [
+                path_for(identifier: identifier),
+                temporary_path_for(identifier: identifier)
+              ]
+
+      File.new paths.find { |path| File.file? path }
+    end
+  end
+end

data/lib/mountable_file_server/access_helper.rb

@@ -0,0 +1,7 @@
+# module MountableFileServer
+#   module AccessHelper
+#     def path_for_upload(filename)
+#       File.join(MountableFileServer.configuration.mounted_at, filename)
+#     end
+#   end
+# end

data/lib/mountable_file_server/ajax_upload_helper.rb

@@ -0,0 +1,18 @@
+# module MountableFileServer
+#   module AjaxUploadHelper
+#     module FormBuilder
+#       def ajax_upload_field(method, options = {})
+#         @template.ajax_upload_field(@object_name, method, objectify_options(options))
+#       end
+#     end
+
+#     def ajax_upload_field(object_name, method, options = {})
+#       file_input = file_field(object_name, method, options.merge({ data: { 'upload-url' => MountableFileServer.public_upload_url } }))
+#       hidden_input = hidden_field(object_name, method, options)
+#       content_tag(:div, class: MountableFileServer.configuration.input_class) do
+#         concat file_input
+#         concat hidden_input
+#       end
+#     end
+#   end
+# end

data/lib/mountable_file_server/configuration.rb

@@ -0,0 +1,10 @@
+module MountableFileServer
+  class Configuration
+    attr_reader :mounted_at, :stored_at
+
+    def initialize(mounted_at:, stored_at:)
+      @mounted_at = mounted_at
+      @stored_at = stored_at
+    end
+  end
+end

data/lib/mountable_file_server/endpoint.rb

@@ -0,0 +1,55 @@
+require 'sinatra'
+require 'url_safe_base64'
+require 'mini_magick'
+
+module MountableFileServer
+  class Endpoint < Sinatra::Base
+    attr_reader :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+      super
+    end
+
+    post '/' do
+      path = params[:file][:tempfile].path
+      filename = params[:file][:filename]
+      type = params[:type]
+      storage = Storage.new configuration
+
+      storage.store_temporary(path: path, type: type, filename: filename).to_str
+    end
+
+    get '/*' do
+      deliver_file unescape(request.path_info)
+    end
+
+    def deliver_file(filename)
+      path_to_file = File.join(configuration.stored_at, 'public', filename)
+
+      if File.file?(path_to_file)
+        send_file path_to_file
+      else
+        if filename.count('.') == 2
+          parts = filename.split('.')
+          base_filename = "#{parts[0]}.#{parts[2]}"
+          path_to_base_file = File.join(configuration.stored_at, 'public', base_filename)
+
+          if File.file?(path_to_base_file)
+            resize_command = UrlSafeBase64.decode64 parts[1]
+            image = MiniMagick::Image.open path_to_base_file
+            image.resize resize_command.to_s
+            image.write path_to_file
+            send_file path_to_file
+          else
+            not_found
+          end
+        else
+          not_found
+        end
+
+        not_found
+      end
+    end
+  end
+end

data/lib/mountable_file_server/identifier.rb

@@ -0,0 +1,37 @@
+require 'securerandom'
+
+module MountableFileServer
+  class Identifier
+    attr_reader :type, :filename
+
+    def self.generate_for(filename:, type:)
+      extension = File.extname filename
+
+      new "#{type}-#{SecureRandom.hex}#{extension}"
+    end
+
+    def initialize(identifier)
+      @type = /(\w+)-\w+/.match(identifier)[1]
+      @filename = /\w+-(.+)$/.match(identifier)[1]
+
+      raise ArgumentError.new("Unkown type `#{type}`") unless valid_type?
+    end
+
+    def to_str
+      "#{type}-#{filename}"
+    end
+
+    def ==(other)
+      to_str == other.to_str
+    end
+
+    def public?
+      type == 'public'
+    end
+
+  private
+    def valid_type?
+      ['public', 'private'].include?(type)
+    end
+  end
+end

data/lib/mountable_file_server/rails.rb

@@ -0,0 +1,6 @@
+require 'mountable_file_server'
+
+module MountableFileServer
+  class Engine < Rails::Engine
+  end
+end

data/lib/mountable_file_server/storage.rb

@@ -0,0 +1,52 @@
+module MountableFileServer
+  class Storage
+    attr_reader :access
+
+    def initialize(configuration)
+      @access = Access.new configuration
+    end
+
+    def store_temporary(path:, type:, filename:)
+      file_to_be_stored = File.new path
+      identifier = random_identifier filename: filename, type: type
+      path = access.temporary_path_for identifier: identifier
+
+      File.open(path, 'wb') do |file|
+        file.write file_to_be_stored.read
+      end
+
+      identifier
+    end
+
+    def store_permanently(path:, type:, filename:)
+      identifier = store_temporary path: path, type: type, filename: filename
+      move_to_permanent_storage identifier: identifier
+      identifier
+    end
+
+    def move_to_permanent_storage(identifier:)
+      identifier = Identifier.new identifier
+      from = access.temporary_path_for identifier: identifier
+      to = access.path_for identifier: identifier
+
+      FileUtils.move from, to
+    end
+
+    def remove_from_permanent_storage(identifier:)
+      identifier = Identifier.new identifier
+      path = access.path_for identifier: identifier
+
+      FileUtils.rm path
+    end
+
+  private
+    def random_identifier(filename:, type:)
+      loop do
+        identifier = Identifier.generate_for filename: filename, type: type
+        path = access.temporary_path_for identifier: identifier
+
+        break identifier unless File.exists?(path)
+      end
+    end
+  end
+end

data/lib/mountable_file_server/version.rb

@@ -0,0 +1,3 @@
+module MountableFileServer
+  VERSION = "0.0.1"
+end

data/mountable_file_server.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mountable_file_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mountable_file_server"
+  spec.version       = MountableFileServer::VERSION
+  spec.authors       = ["David Strauß"]
+  spec.email         = ["david@strauss.io"]
+  spec.summary       = %q{Simple mountable server that handles file uploads}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/stravid/mountable_file_server"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "minitest"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "capybara"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "poltergeist"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "bogus"
+
+  spec.add_runtime_dependency "sinatra"
+  spec.add_runtime_dependency "mini_magick"
+  spec.add_runtime_dependency "url_safe_base64"
+end

data/vendor/assets/javascripts/mountable_file_server.js

@@ -0,0 +1,59 @@
+(function() {
+  var lastUploadId = 0;
+  var finishedUploads = [];
+
+  var dispatchEvent = function($element, name, payload) {
+    var event = document.createEvent('CustomEvent');
+
+    event.initCustomEvent(name, true, false, payload);
+    $element.dispatchEvent(event);
+  };
+
+  var uploadFile = function($element, file, uploadId) {
+    var url = $element.getAttribute('data-endpoint');
+    var type = $element.getAttribute('data-type');
+    var xhr = new XMLHttpRequest();
+    var formData = new FormData();
+
+    formData.append('file', file);
+    formData.append('type', type);
+
+    xhr.open('POST', url, true);
+
+    xhr.onreadystatechange = function() {
+      if (xhr.readyState === 4 && xhr.status === 200) {
+        finishedUploads.push(uploadId);
+
+        dispatchEvent($element, 'upload:success', {
+          uploadId: uploadId,
+          identifier: xhr.responseText,
+          wasLastUpload: lastUploadId == finishedUploads.length
+        });
+      }
+    }
+
+    xhr.upload.addEventListener('progress', function(progressEvent) {
+      if (progressEvent.lengthComputable) {
+        dispatchEvent($element, 'upload:progress', {
+          uploadId: uploadId,
+          progress: progressEvent
+        });
+      }
+    });
+
+    xhr.send(formData);
+
+    dispatchEvent($element, 'upload:start', {
+      uploadId: uploadId,
+      file: file
+    });
+  };
+
+  var internalUploadFiles = function($element, files) {
+    for (var i = 0; i < files.length; i++) {
+      uploadFile($element, files[i], ++lastUploadId);
+    }
+  };
+
+  window.uploadFiles = internalUploadFiles;
+})();

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: mountable_file_server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Strauß
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: rails
+  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: capybara
+  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'
+- !ruby/object:Gem::Dependency
+  name: poltergeist
+  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: rack-test
+  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: bogus
+  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: sinatra
+  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: mini_magick
+  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: url_safe_base64
+  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'
+description: ''
+email:
+- david@strauss.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mountable_file_server.rb
+- lib/mountable_file_server/access.rb
+- lib/mountable_file_server/access_helper.rb
+- lib/mountable_file_server/ajax_upload_helper.rb
+- lib/mountable_file_server/configuration.rb
+- lib/mountable_file_server/endpoint.rb
+- lib/mountable_file_server/identifier.rb
+- lib/mountable_file_server/rails.rb
+- lib/mountable_file_server/storage.rb
+- lib/mountable_file_server/version.rb
+- mountable_file_server.gemspec
+- vendor/assets/javascripts/mountable_file_server.js
+homepage: https://github.com/stravid/mountable_file_server
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple mountable server that handles file uploads
+test_files: []