mountable_file_server 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53f16655a84e2cec6640805c435f917ce77d482a
-  data.tar.gz: eaa590e6d805b01e5e488308a5bab98406c17732
+  metadata.gz: 9eca97072a7e354d3523e099982afc7cf4234516
+  data.tar.gz: 938444d589b364fb81bb16ab26244425601ba4eb
 SHA512:
-  metadata.gz: 2e1aae6f8f4547649c2b53af4f8771b6d15f393895e4a72eff662d7ae585d023efc06065639de25356f12b7da4608972c737259c1cb4dc25aaee0dab406f0a4e
-  data.tar.gz: beb7392313d97415fb62acc49073981dc9682d6eeb828a1b6dd1f8c5e57238fcc1e6263959fb0a4e10065d9d1e5292228167bbef0776545f6c32efb9a3384eb6
+  metadata.gz: 09226be2ad7e5f2ccfac19be367b42f44d94e9570a91a2046f541468a1aaca317eae56baf4829455e450814c831e30f3147897ee344f842f245ca846a812d45b
+  data.tar.gz: 9f5d940813c63c26497be28472b5e12175ca4be1bec7903f8f5f21fe6412f89cdddaf26e75be3e2e3b4de40a628f898030e33b8f2b509c312625781edcd8067c

data/README.md

@@ -1,3 +1,16 @@
+Mountable File Server can be used with any Ruby (on Rails) application and it removes the pain associated with file uploads.
+
+## Core Idea
+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`.
+
+
+
+
+
+
 MountableFileServer was born out of my frustations with existing Ruby based file upload solutions. It is certainly not comparable with existing feature-rich plug-and-play solutions that are tied to Ruby on Rails.
 
 The fundamental idea is that your application should not be tied to files or handling the upload process. Instead this is handled by a dedicated server which can be run as independet process or be mounted inside your application. It accepts file uploads and returns an unique identifier for the file. This unique identifier is basically a string and the only thing your application has to remember in order to work with uploaded files.
@@ -98,11 +111,8 @@ Returns the URL for an uploaded file. Only works for public files, if you pass t
 `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.
 
-## Example
-TBW
-
-## Deployment
-TBW
+# Publish on RubyGems.org
 
-## License
-[MIT](https://github.com/stravid/mountable_file_server/blob/master/LICENSE.txt)
+1. Increment `lib/mountable_image_server/version.rb` to your liking.
+2. Make a Git commit.
+3. Run `bundle exec rake release`.

data/lib/mountable_file_server/adapter.rb

@@ -1,8 +1,12 @@
+require 'mountable_file_server/storage'
+require 'mountable_file_server/unique_identifier'
+require 'mountable_file_server/file_accessor'
+
 module MountableFileServer
   class Adapter
     attr_reader :configuration
 
-    def initialize(configuration = MountableFileServer.configuration)
+    def initialize(configuration = MountableFileServer.config)
       @configuration = configuration
     end
 
@@ -23,14 +27,15 @@ module MountableFileServer
       Storage.new(configuration).move_to_permanent_storage uid
     end
 
-    def remove_from_permanent_storage(uid)
+    def remove_from_storage(uid)
       uid = UniqueIdentifier.new uid
-      Storage.new(configuration).remove_from_permanent_storage uid
+      Storage.new(configuration).remove_from_storage uid
     end
 
     def url_for(uid)
-      uid = UniqueIdentifier.new uid
-      FileAccessor.new(uid, configuration).url
+      # uid = UniqueIdentifier.new uid
+      # FileAccessor.new(uid, configuration).url
+      configuration.base_url + uid
     end
 
     def pathname_for(uid)

data/lib/mountable_file_server/client.rb

@@ -0,0 +1,44 @@
+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

data/lib/mountable_file_server/file_accessor.rb

@@ -7,17 +7,17 @@ module MountableFileServer
   class FileAccessor
     attr_reader :uid, :configuration
 
-    def initialize(uid, configuration = MountableFileServer.configuration)
+    def initialize(uid, configuration = MountableFileServer.config)
       @uid = uid
       @configuration = configuration
     end
 
     def temporary_pathname
-      Pathname(configuration.stored_at) + 'tmp' + uid
+      Pathname(configuration.storage_path) + 'tmp' + uid
     end
 
     def permanent_pathname
-      Pathname(configuration.stored_at) + uid.type +  uid
+      Pathname(configuration.storage_path) + uid.type + uid
     end
 
     def pathname
@@ -31,7 +31,7 @@ module MountableFileServer
     def url
       raise NotAccessibleViaURL unless uid.public?
 
-      URI.new (Pathname(configuration.mounted_at) + uid).to_s
+      URI.new (Pathname(configuration.base_url) + uid).to_s
     end
 
     private

data/lib/mountable_file_server/metadata.rb

@@ -0,0 +1,45 @@
+require 'dimensions'
+
+module MountableFileServer
+  class Metadata
+    attr_reader :size, :content_type, :height, :width
+
+    def initialize(size:, content_type:, width: nil, height: nil)
+      @size = size
+      @content_type = content_type
+      @width = width
+      @height = height
+    end
+
+    def to_h
+      hash = {
+        size: size,
+        content_type: content_type
+      }
+
+      if width && height
+        hash = hash.merge({
+          height: height,
+          width: width
+        })
+      end
+
+      hash
+    end
+
+    def self.for_path(path)
+      parameters = {}
+
+      parameters[:content_type] = `file --brief --mime-type #{path}`.strip
+      parameters[:size] = File.size(path)
+
+      if ['image/png', 'image/jpeg', 'image/gif', 'image/tiff'].include?(parameters[:content_type])
+        dimensions = Dimensions.dimensions(path)
+        parameters[:width] = dimensions[0]
+        parameters[:height] = dimensions[1]
+      end
+
+      new(parameters)
+    end
+  end
+end

data/lib/mountable_file_server/rails.rb

@@ -1,4 +1,6 @@
 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

@@ -0,0 +1,49 @@
+require 'sinatra/base'
+require 'pathname'
+
+require 'mountable_file_server/adapter'
+require 'mountable_file_server/metadata'
+
+module MountableFileServer
+  class Server < Sinatra::Base
+    post '/' do
+      adapter = Adapter.new
+      pathname = Pathname(params[:file][:tempfile].path)
+      type = params[:type]
+      fid = adapter.store_temporary(pathname, type, pathname.extname)
+      url = adapter.url_for(fid)
+      metadata = Metadata.for_path(pathname)
+
+      content_type :json
+      status 201
+
+      {
+        fid: fid,
+        url: url,
+        metadata: metadata.to_h
+      }.to_json
+    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
+    end
+  end
+end

data/lib/mountable_file_server/storage.rb

@@ -2,7 +2,7 @@ module MountableFileServer
   class Storage
     attr_reader :configuration
 
-    def initialize(configuration = MountableFileServer.configuration)
+    def initialize(configuration = MountableFileServer.config)
       @configuration = configuration
     end
 
@@ -26,8 +26,8 @@ module MountableFileServer
       source.rename destination
     end
 
-    def remove_from_permanent_storage(uid)
-      source = FileAccessor.new(uid, configuration).permanent_pathname
+    def remove_from_storage(uid)
+      source = FileAccessor.new(uid, configuration).pathname
       source.delete
     end
   end

data/lib/mountable_file_server/uri.rb

@@ -1,6 +1,5 @@
 require 'uri'
 require 'pathname'
-require 'url_safe_base64'
 
 module MountableFileServer
   class URI < String
@@ -12,22 +11,8 @@ module MountableFileServer
       UniqueIdentifier.new filename
     end
 
-    def encoded_processing_instructions
-      /\.(\w+)\./.match(filename).captures.first
-    end
-
-    def decoded_processing_instructions
-      UrlSafeBase64.decode64 encoded_processing_instructions
-    end
-
     def filename
       Pathname(::URI.parse(self).path).basename.to_s
     end
-
-    def resize(instructions)
-      encoded_instructions = UrlSafeBase64.encode64 instructions
-
-      URI.new self.gsub('.', ".#{encoded_instructions}.")
-    end
   end
 end

data/lib/mountable_file_server/version.rb

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

data/lib/mountable_file_server.rb

@@ -1,24 +1,10 @@
+require "dry-configurable"
+
 require "mountable_file_server/version"
 
 module MountableFileServer
-  require "mountable_file_server/configuration"
-  require "mountable_file_server/file_accessor"
-  require "mountable_file_server/unique_identifier"
-  require "mountable_file_server/storage"
-  require "mountable_file_server/uri"
-
-  require "mountable_file_server/adapter"
-  require "mountable_file_server/endpoint"
-
-  class << self
-    attr_writer :configuration
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+  extend Dry::Configurable
 
-  def self.configure
-    yield(configuration)
-  end
+  setting :base_url
+  setting :storage_path
 end

data/mountable_file_server.gemspec

@@ -21,15 +21,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.8.0"
-  spec.add_development_dependency "rails", "~> 4.2.3"
+  spec.add_development_dependency "rails", "~> 5.0.2"
   spec.add_development_dependency "capybara", "~> 2.4.4"
   spec.add_development_dependency "sqlite3", "~> 1.3.10"
   spec.add_development_dependency "poltergeist", "~> 1.6.0"
   spec.add_development_dependency "rack-test", "~> 0.6.3"
-  spec.add_development_dependency "bogus", "~> 0.1.6"
+  spec.add_development_dependency "webmock", "~> 2.1.0"
 
-  spec.add_runtime_dependency "rack", "~> 1.6"
-  spec.add_runtime_dependency "sinatra", "~> 1.4.5"
-  spec.add_runtime_dependency "mini_magick"
-  spec.add_runtime_dependency "url_safe_base64"
+  spec.add_runtime_dependency "sinatra", "~> 2.0.0.rc1"
+  spec.add_runtime_dependency "dry-configurable", "~> 0.1.6"
+  spec.add_runtime_dependency "dimensions", "~> 1.3.0"
 end

data/vendor/assets/javascripts/mountable_file_server.js

@@ -1,61 +1,44 @@
 (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);
-
-        response = JSON.parse(xhr.responseText);
-
-        dispatchEvent($element, 'upload:success', {
-          uploadId: uploadId,
-          uid: response.uid,
-          wasLastUpload: lastUploadId == finishedUploads.length
-        });
-      }
-    }
-
-    xhr.upload.addEventListener('progress', function(progressEvent) {
-      if (progressEvent.lengthComputable) {
-        dispatchEvent($element, 'upload:progress', {
-          uploadId: uploadId,
-          progress: progressEvent
+  var MountableFileServerUploader = function(options) {
+    return {
+      url: options.url,
+      uploadFile: function(options) {
+
+        var file = options.file;
+        var type = options.type;
+        var onStart = options.onStart || function() {};
+        var onProgress = options.onProgress || function() {};
+        var onSuccess = options.onSuccess || function() {};
+        var xhr = new XMLHttpRequest();
+        var formData = new FormData();
+
+        formData.append('file', file);
+        formData.append('type', type);
+
+        xhr.open('POST', this.url, true);
+
+        xhr.onreadystatechange = function() {
+          if (xhr.readyState === 4 && xhr.status === 201) {
+            var response = JSON.parse(xhr.responseText);
+
+            response.original_filename = file.name;
+
+            onSuccess(response);
+          }
+        }
+
+        xhr.upload.addEventListener('progress', function(progressEvent) {
+          if (progressEvent.lengthComputable) {
+            onProgress(progressEvent);
+          }
         });
-      }
-    });
-
-    xhr.send(formData);
 
-    dispatchEvent($element, 'upload:start', {
-      uploadId: uploadId,
-      file: file
-    });
-  };
+        xhr.send(formData);
 
-  var internalUploadFiles = function($element, files) {
-    for (var i = 0; i < files.length; i++) {
-      uploadFile($element, files[i], ++lastUploadId);
-    }
+        onStart();
+      }
+    };
   };
 
-  window.uploadFiles = internalUploadFiles;
+  window.MountableFileServerUploader =  MountableFileServerUploader;
 })();

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mountable_file_server
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - David Strauß
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-24 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.3
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -123,75 +123,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.6.3
 - !ruby/object:Gem::Dependency
-  name: bogus
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 2.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.6
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.0.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 2.0.0.rc1
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.5
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.5
-- !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'
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
-  name: url_safe_base64
+  name: dimensions
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 description: ''
 email:
 - david@strauss.io
@@ -208,10 +194,11 @@ files:
 - Rakefile
 - lib/mountable_file_server.rb
 - lib/mountable_file_server/adapter.rb
-- lib/mountable_file_server/configuration.rb
-- lib/mountable_file_server/endpoint.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
+- lib/mountable_file_server/server.rb
 - lib/mountable_file_server/storage.rb
 - lib/mountable_file_server/unique_identifier.rb
 - lib/mountable_file_server/uri.rb
@@ -238,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Simple mountable server that handles file uploads

data/lib/mountable_file_server/configuration.rb

@@ -1,10 +0,0 @@
-module MountableFileServer
-  class Configuration
-    attr_accessor :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

@@ -1,58 +0,0 @@
-require 'sinatra/base'
-require 'url_safe_base64'
-require 'mini_magick'
-require 'pathname'
-
-module MountableFileServer
-  class Endpoint < Sinatra::Base
-    attr_reader :configuration
-
-    def initialize(configuration = MountableFileServer.configuration)
-      @configuration = configuration
-      super
-    end
-
-    post '/' do
-      pathname = Pathname(params[:file][:tempfile].path)
-      type = params[:type]
-      adapter = Adapter.new configuration
-      uid = adapter.store_temporary(pathname, type, pathname.extname)
-
-
-      content_type :json
-      { uid: uid }.to_json
-    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