omnifiles 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6168535895fcefcd6125d84d87fd2deba8161d36
+  data.tar.gz: 435bc5685890875c42eeaaeb89a76b1f259da2c9
+SHA512:
+  metadata.gz: 2d68c691076c59bc970367d9c8b325c15f38ce4f1b1f74bf757b0409bea74d6bce83089b6305e903a17b08e38b7f321b99c71b4f02d8c59591613b368fe3501c
+  data.tar.gz: 20146b39ff0cff35866da53a4c35492a1b9abf5df4b642cc50c4d2e146eda110ed7b5d01f0efde14b437cd63807854035f77cf3de90b2c0541f58616385038d2

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+mkmf.log
+.ruby-version
+.ruby-gemset

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Eugene Seliverstov <theirix@gmail.com>
+
+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,72 @@
+# OmniFiles
+
+File storage and shortener server.
+
+OmniFiles is built with Sinatra and Rack and uses an sqlite database to store shortened
+urls and statistics.
+
+## Installation
+
+OmniFiles is a Rack application and can be used as a gem or as a server in local directory.
+
+### As a gem
+
+1. Install a gem
+
+        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`.
+
+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
+
+## As a rack app
+
+OmniFiles can be started using `config.ru` with you favourite Rack server.
+
+1. Clone a git repo
+
+2. Install dependencies
+
+        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`.
+
+4. Start Rack app
+
+        rackup
+
+## Usage
+
+1. Storing files.
+OmniFiles can store files by issuing an authenticated POST request
+
+        % curl --digest -u user:secret -F "file=@/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
+
+2. Accessing files.
+Just access given URL:
+
+        % curl http://localhost:3000/f/e63A12
+OmniFiles remembers MIME type and composes a correct typed response.
+Header `X-Original-Filename` contains escaped original filename.
+
+3. Viewing statistics.
+OmniFiles provides file access statistics using authenticated requests.
+Visit an url
+
+        http://localhost:3000/stat/e63A12
+using web browser or curl
+
+## License information
+
+Please consult with the LICENSE.txt for license information.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/omnifiles

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'thin'
+
+ARGV.unshift File.expand_path(File.join(File.dirname(File.expand_path(__FILE__)),"..","config.ru"))
+ARGV.unshift '-R'
+ARGV.unshift 'start'
+Thin::Runner.new(ARGV).run!

data/config/settings.yaml.example

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

data/config.ru

@@ -0,0 +1,5 @@
+require 'omnifiles'
+run Rack::URLMap.new({
+ "/f" => OmniFiles::PublicApp,
+ "/" => OmniFiles::ProtectedApp
+})

data/lib/omnifiles/app/css/app.css

@@ -0,0 +1,7 @@
+.left {
+	width: 20%;
+	float: left;
+}
+.right {
+	overflow: auto;
+}

data/lib/omnifiles/protectedapp.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+require 'sinatra'
+require 'filemagic'
+require 'uri'
+require 'settingslogic'
+require 'haml'
+require 'rack'
+
+module OmniFiles
+
+  # Protected app for POST request
+  class ProtectedApp < BaseApp
+
+    register Sinatra::AssetPack
+    assets do
+      css :application, [
+        '/css/app.css'
+      ]
+    end
+
+
+    use Rack::Auth::Digest::MD5, "OmniFiles Realm", Settings.auth_opaque do |_|
+      Settings.auth_password
+    end
+
+    # POST a file
+    post '/store/' do
+      store_file
+    end
+
+    post '/store' do
+      store_file
+    end
+
+    get '/stat/:name' do |name|
+      logger.info "Route GET stat #{name}"
+
+      halt 500, "Wrong URL" if name != BaseApp.sanitize(name)
+
+      data = @storage.get_file name
+      halt 404, "File not found" unless data
+
+      @url = url('/f/'+name)
+      @original_filename = URI.unescape data['original_filename']
+      @access_count = data['accessed']
+      @mime = data['mime']
+      @shortened = name
+
+      haml :stat
+    end
+
+    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]
+
+        # Determine file mime and desired url
+        mime = FileMagic.mime.file temp_file.path
+
+        # 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
+
+        # 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
+
+        # 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
+      ensure
+        if temp_file
+          temp_file.close
+          temp_file.unlink
+        end
+      end
+    end
+
+  end
+
+end

data/lib/omnifiles/publicapp.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+require 'sinatra'
+require 'filemagic'
+require 'uri'
+require 'settingslogic'
+require 'rack'
+
+module OmniFiles
+
+  # Public app for GET request
+  class PublicApp < BaseApp
+
+    # GET a file
+    get '/:name' do |name|
+      logger.info "GET by name #{name}"
+
+      halt 500, "Wrong URL" if name != BaseApp.sanitize(name)
+
+      data = @storage.get_file name
+      logger.info "Data #{data}"
+      halt 404, "File not found" unless data
+
+      path = File.join(Settings.storage_dir, name)
+      filename = data['original_filename']
+      halt 404, "File not found" unless File.exists?(path)
+
+      mime = data['mime']
+      mime = 'application/octet-stream' unless mime && mime != ''
+
+      logger.info "Data #{data}, file #{path}, was at #{filename}"
+
+      headers 'X-Original-Filename' => filename
+      send_file path, :type => mime
+    end
+
+  end
+
+end

data/lib/omnifiles/server.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require 'sinatra'
+require 'sinatra/assetpack'
+require 'settingslogic'
+require 'rack'
+
+module OmniFiles
+
+  # Common sinatra configuration
+  class BaseApp < Sinatra::Application
+    configure do
+      disable :show_exceptions
+    end
+
+    before do
+      logger.info "Fired " + self.class.to_s
+      FileUtils.mkdir_p(Settings.storage_dir)
+      FileUtils.mkdir_p(File.dirname(Settings.db))
+      @storage = Storage.new Settings.db, logger
+    end
+
+    def self.sanitize s
+      s.gsub(/[^0-9A-z.\-]/, '_')
+    end
+  end
+
+end

data/lib/omnifiles/settings.rb

@@ -0,0 +1,12 @@
+require 'settingslogic'
+
+module OmniFiles
+
+  class Settings < Settingslogic
+    settings_file = (ENV['OMNIFILES_SETTINGS'] or '')
+    raise "Please pecify a settings file in env OMNIFILES_SETTINGS" unless File.file?(settings_file)
+    source settings_file
+    namespace ENV['RACK_ENV'] || 'development'
+    load!
+  end
+end

data/lib/omnifiles/shortener.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'digest/md5'
+
+module OmniFiles
+
+  class UrlShortener
+    def initialize salt, bytes_used=1
+      @salt = salt
+      @bytes_used = bytes_used
+      # base62
+      @symbols = (0..9).to_a.map(&:to_s) + ('a'..'z').to_a + ('A'..'Z').to_a
+    end
+
+    def shorten url
+      dig = Digest::MD5.digest(url+@salt.to_s)
+      dig_ints = dig.unpack('N*').first(@bytes_used)
+      dig_value = (0...dig_ints.length)
+        .map { |i| (dig_ints[i] << ((dig_ints.length-i-1)*32)) }
+        .reduce(:+)
+      encode dig_value
+    end
+
+  private
+    def encode(decimal)
+      result = ''
+      while decimal > 0
+        decimal, symbol = decimal.divmod(@symbols.size)
+        result << @symbols[symbol]
+      end
+      result.reverse
+    end
+  end
+
+end

data/lib/omnifiles/storage.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'digest/md5'
+require 'sqlite3'
+
+module OmniFiles
+
+  class Storage
+
+    def initialize db_filename, logger
+      @logger = logger
+      @db = SQLite3::Database.new(db_filename, :results_as_hash => true)
+      if (@db.table_info('files') or []) == []
+        Storage.create_schema @db
+      end
+      @shortener = UrlShortener.new(SecureRandom.hex(8))
+    end
+
+    # returns shortened url
+    def shorten_file path, filename, mime
+      counter = 0
+      begin
+        hashing = [filename, mime, Digest::MD5.hexdigest(IO.binread(path, 0x100)), counter.to_s].join '|'
+        @logger.info "Hashing value " + hashing
+        shortened = @shortener.shorten hashing
+        counter += 1
+        unique_id = @db.get_first_row("SELECT COUNT(shortened) FROM files WHERE shortened = ?", [shortened])[0] == 0
+      end until unique_id
+      shortened
+    end
+
+    def put_file shortened, filename, mime
+      @db.execute("INSERT INTO files (original_filename, shortened, mime, accessed)"+
+        "VALUES ( ?, ?, ?, 0 )",
+        [filename, shortened, mime])
+    end
+
+    # returns full url
+    def get_file shortened
+      data = @db.get_first_row("SELECT * FROM files WHERE shortened = ?", [shortened])
+      if data
+        @db.execute("UPDATE files SET accessed = accessed + 1 WHERE shortened = ?", [shortened])
+      end
+      data
+    end
+
+  private
+    def self.create_schema db
+      db.execute <<-SQL
+      CREATE TABLE files (
+        shortened TEXT NOT NULL,
+        original_filename TEXT,
+        mime TEXT,
+        accessed INTEGER);
+      CREATE INDEX shortened_INDEX ON files (shortened);
+      SQL
+    end
+  end
+
+end

data/lib/omnifiles/version.rb

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

data/lib/omnifiles/views/stat.haml

@@ -0,0 +1,19 @@
+!!!
+%html
+  %head
+    %title OmniFiles statistics
+    = css :application
+  %body
+    %h1 Statistics for #{@shortened}
+    #container
+      .left
+        %p URL:
+        %p Original name:
+        %p Access count:
+        %p MIME:
+      .right
+        %p
+          %a(href=@url) #{@url}
+        %p=@original_filename
+        %p=@access_count
+        %p=@mime

data/lib/omnifiles.rb

@@ -0,0 +1,7 @@
+require "omnifiles/version"
+require "omnifiles/settings"
+require "omnifiles/server"
+require "omnifiles/publicapp"
+require "omnifiles/protectedapp"
+require "omnifiles/storage"
+require "omnifiles/shortener"

data/omnifiles.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'omnifiles/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omnifiles"
+  spec.version       = OmniFiles::VERSION
+  spec.authors       = ["theirix"]
+  spec.email         = ["theirix@gmail.com"]
+  spec.summary       = %q{File storage and URL shortener.}
+  spec.description   = %q{File storage and URL shortener.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "sinatra", "~> 1.4.5"
+  spec.add_development_dependency "sinatra-assetpack", "~> 0.3.3"
+  spec.add_development_dependency "ruby-filemagic", "~> 0.6.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3.10"
+  spec.add_development_dependency "haml", "~> 4.0.0"
+  spec.add_development_dependency "settingslogic", "~> 2.0.0"
+  spec.add_development_dependency "thin", "~> 1.6.0"
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: omnifiles
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- theirix
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-05 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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: sinatra-assetpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.10
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: settingslogic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+description: File storage and URL shortener.
+email:
+- theirix@gmail.com
+executables:
+- omnifiles
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/omnifiles
+- config.ru
+- config/settings.yaml.example
+- lib/omnifiles.rb
+- lib/omnifiles/app/css/app.css
+- lib/omnifiles/protectedapp.rb
+- lib/omnifiles/publicapp.rb
+- lib/omnifiles/server.rb
+- lib/omnifiles/settings.rb
+- lib/omnifiles/shortener.rb
+- lib/omnifiles/storage.rb
+- lib/omnifiles/version.rb
+- lib/omnifiles/views/stat.haml
+- omnifiles.gemspec
+homepage: ''
+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: File storage and URL shortener.
+test_files: []