omnifiles 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6168535895fcefcd6125d84d87fd2deba8161d36
-  data.tar.gz: 435bc5685890875c42eeaaeb89a76b1f259da2c9
+  metadata.gz: 10d0e6b7d9a8c8ba27681ce9726d63baf309c22e
+  data.tar.gz: 33e13a6d786009124e6312d6a26cd9872fcb50e8
 SHA512:
-  metadata.gz: 2d68c691076c59bc970367d9c8b325c15f38ce4f1b1f74bf757b0409bea74d6bce83089b6305e903a17b08e38b7f321b99c71b4f02d8c59591613b368fe3501c
-  data.tar.gz: 20146b39ff0cff35866da53a4c35492a1b9abf5df4b642cc50c4d2e146eda110ed7b5d01f0efde14b437cd63807854035f77cf3de90b2c0541f58616385038d2
+  metadata.gz: cebc8b5441cbd3d053a7d0465e7867a20d96f5894b1d8090f7ad031123a6bc494388e44552e295cc0abc0f0e1323f90268c935e4f98085b64377308158d27d51
+  data.tar.gz: 41f1711c4d30660f493fcec462beca32fabacf7f6827defb1bedaeef147548572bc4ede0e15d8ff9fdc291b36dfb6e67ba36368a36b831e4c9069b9165214dbc

data/README.md

@@ -1,5 +1,9 @@
 # OmniFiles
 
+[![Gem Version](https://img.shields.io/gem/v/omnifiles.svg)](https://rubygems.org/gems/omnifiles)
+[![Code Climate](https://codeclimate.com/github/theirix/omnifiles/badges/gpa.svg)](https://codeclimate.com/github/theirix/omnifiles)
+[![Dependency Status](https://gemnasium.com/theirix/omnifiles.svg)](https://gemnasium.com/theirix/omnifiles)
+
 File storage and shortener server.
 
 OmniFiles is built with Sinatra and Rack and uses an sqlite database to store shortened
@@ -15,15 +19,14 @@ OmniFiles is a Rack application and can be used as a gem or as a server in local
 
         gem install omnifiles
 
-2. Create a settings file `/path/to/settings.yaml` by copying `config/settings.yaml.example`.
-Location of file must be specified in env variable `OMNIFILES_SETTINGS`.
+2. Point an env variable `OMNIFILES_SETTINGS` to location of a settings file `/path/to/settings.yaml` (see Configurarion).
 
 3. Start an app as a Thin server
 
         OMNIFILES_SETTINGS=/path/to/settings.yaml omnifiles
 Of course, you can provide any additional Thin options:
 
-        OMNIFILES_SETTINGS=/path/to/settings.yaml omnifiles -l /var/log/omnifiles.log -P /var/run/omnifiles.pid -d
+        OMNIFILES_SETTINGS=/path/to/settings.yaml omnifiles -p 3000
 
 ## As a rack app
 
@@ -35,20 +38,36 @@ OmniFiles can be started using `config.ru` with you favourite Rack server.
 
         bundle install
 
-3. Create a settings file `/path/to/settings.yaml` by copying `config/settings.yaml.example`.
-Location of file must be specified in env variable `OMNIFILES_SETTINGS`.
+3. Point an env variable `OMNIFILES_SETTINGS` to location of a settings file `/path/to/settings.yaml` (see Configurarion).
 
 4. Start Rack app
 
         rackup
 
+## Configuration
+
+Settings file template can be found at `config/settings.yaml.example`.
+
+If you prefer production Rack environment, please use `production` instead of `development` section in the config.
+Also specify `-E production` at `omnifiles` (actially Thin) command line.
+
+If you prefer to run omnifiles as a daemon, don't forget to set log and pid location. Author prefer to follow XDG and place all the files at the `~/.local/share/omnifiles`, including the database. So one can use following command line:
+
+    OMNIFILES_SETTINGS=$HOME/.local/share/omnifiles/settings.yaml omnifiles -d -a 127.0.0.1 -p 3000 \
+      -l $HOME/.local/share/omnifiles/omnifiles.log \
+      -P $HOME/.local/share/omnifiles/omnifiles.pid
+
 ## Usage
 
 1. Storing files.
-OmniFiles can store files by issuing an authenticated POST request
+OmniFiles can store files by issuing an authenticated POST form request:
 
         % curl --digest -u user:secret -F "file=@/path/to/file.jpg" 'http://localhost:3000/store'
         http://localhost:3000/f/e63A12
+Or you can post a file just as a binary POST data:
+
+        % curl --digest -u user:secret -H "Content-Type: application/octet-stream" --data-binary "@/path/to/file.jpg" 'http://localhost:3000/store'
+        http://localhost:3000/f/e63A12
 OmniFiles returns a short url in response so you can just issue following command to save URL in clipboard
 
         % curl --digest -u user:secret -F "file=@/path/to/file.jpg" 'http://localhost:3000/store' | pbcopy
@@ -69,4 +88,4 @@ using web browser or curl
 
 ## License information
 
-Please consult with the LICENSE.txt for license information.
+Please consult with the LICENSE.txt for license information. It is MIT by the way.

data/config/settings.yaml.example

@@ -1,5 +1,5 @@
 development:
-  storage_dir: /var/lib/omnifiles/storage
-  db: /var/lib/omnifiles/omnifiles.sqlite3
+  storage_dir: storage
+  db: omnifiles.sqlite3
   auth_opaque: alongopaquekey
   auth_password: secret

data/lib/omnifiles/protectedapp.rb

@@ -3,6 +3,7 @@
 require 'sinatra'
 require 'filemagic'
 require 'uri'
+require 'tempfile'
 require 'settingslogic'
 require 'haml'
 require 'rack'
@@ -42,7 +43,11 @@ module OmniFiles
       halt 404, "File not found" unless data
 
       @url = url('/f/'+name)
-      @original_filename = URI.unescape data['original_filename']
+      if data['original_filename']
+        @original_filename = URI.unescape data['original_filename']
+      else
+        @original_filename = "<i>Not provided</i>"
+      end
       @access_count = data['accessed']
       @mime = data['mime']
       @shortened = name
@@ -50,33 +55,33 @@ module OmniFiles
       haml :stat
     end
 
+    # POST handler with form/body handling
     def store_file
       logger.info "Route POST store"
       begin
         req = Rack::Request.new(env)
-        post_file = req.POST['file']
-        original_filename = URI.escape(File.basename(post_file[:filename]))
-
-        temp_file = post_file[:tempfile]
+        if !req.POST || req.POST == {}
+          logger.info "Saving POST body to temp file"
 
-        # Determine file mime and desired url
-        mime = FileMagic.mime.file temp_file.path
+          original_filename = nil
 
-        # Short URL is composed from escaped filename from form, mime type and leading file bytes
-        shortened = @storage.shorten_file temp_file.path, original_filename, mime
+          # Make a temp file with body content
+          temp_file = Tempfile.new("omnifiles-post-")
+          File.open(temp_file.path, 'wb') do |ftemp|
+            IO.copy_stream(req.body, ftemp)
+          end
+        else
+          logger.info "Using POST form"
 
-        # Save file to storage
-        target_path = File.join(Settings.storage_dir, shortened)
-        raise "Not so unique id #{shortened}" if File.exists? target_path
-        FileUtils.cp temp_file.path, target_path
+          # Use a Rack provided file with content
+          post_file = req.POST['file']
+          original_filename = URI.escape(File.basename(post_file[:filename]))
 
-        # Put record to storage
-        @storage.put_file shortened, original_filename, mime
-        short_url = url('/f/'+shortened)
+          temp_file = post_file[:tempfile]
+        end
 
-        logger.info "Stored file #{target_path} to shortened #{shortened}, magic '#{mime}'"
+        store_with_file temp_file.path, original_filename
 
-        short_url
       ensure
         if temp_file
           temp_file.close
@@ -85,6 +90,31 @@ module OmniFiles
       end
     end
 
+    # Save temporary file to storage
+    def store_with_file path, original_filename
+      # Take a sample of file
+      sample = Digest::MD5.hexdigest(IO.binread(path, 0x100))
+
+      # Determine file mime and desired url
+      mime = FileMagic.mime.file path
+
+      # Short URL is composed from escaped filename from form, mime type and leading file bytes
+      shortened = @storage.shorten_file sample, original_filename, mime
+
+      # Save file to storage
+      target_path = File.join(Settings.storage_dir, shortened)
+      raise "Not so unique id #{shortened}" if File.exists? target_path
+      FileUtils.cp path, target_path
+
+      # Put record to storage
+      @storage.put_file shortened, original_filename, mime
+      short_url = url('/f/'+shortened)
+
+      logger.info "Stored file #{target_path} to shortened #{shortened}, magic '#{mime}'"
+
+      short_url
+    end
+
   end
 
 end

data/lib/omnifiles/publicapp.rb

@@ -30,7 +30,9 @@ module OmniFiles
 
       logger.info "Data #{data}, file #{path}, was at #{filename}"
 
-      headers 'X-Original-Filename' => filename
+      if filename && !filename.empty?
+        headers 'X-Original-Filename' => filename
+      end
       send_file path, :type => mime
     end
 

data/lib/omnifiles/storage.rb

@@ -18,10 +18,11 @@ module OmniFiles
     end
 
     # returns shortened url
-    def shorten_file path, filename, mime
+    def shorten_file sample, filename, mime
       counter = 0
       begin
-        hashing = [filename, mime, Digest::MD5.hexdigest(IO.binread(path, 0x100)), counter.to_s].join '|'
+        # filename can be null
+        hashing = [filename.to_s, mime, sample, counter.to_s].join '|'
         @logger.info "Hashing value " + hashing
         shortened = @shortener.shorten hashing
         counter += 1

data/lib/omnifiles/version.rb

@@ -1,3 +1,3 @@
 module OmniFiles
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnifiles
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - theirix
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-05 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler