vienna 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0641d490c3333bf03dc99312ac8f32822255b77a
+  data.tar.gz: 755f234ad7c27ca4ff42a1563251d4cd2fe77e85
+SHA512:
+  metadata.gz: ae8eca143875c44fccd4a77259a51eaa68c1bc618a73dc438538e2b2b542ee651d3408ca6b2af6cc03a6127b4acda30270029d2ec2d5d0e9d0d6176f14fd5b65
+  data.tar.gz: 95f410c94e304d0cf72f1e34c00fcd2bb02e28a26f2ff359cd71ee3efc8dc687d12f6ebd01705b27a4db3414a93c5491d9603e665e55cf14449949fdbe45a323

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mikael Konutgan
+
+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,46 @@
+# Vienna
+
+`Vienna` is a tiny, zero-configuration static file server built on top of `rack`.
+The goal is to place everything in `/public`, add two lines to our `config.ru`
+and let `Vienna` take care of the rest.
+
+Why Vienna? Because it's an awesome city and It's the first thing that came to my mind.
+(I must have gotten the idea from [Cuba](http://cuba.is).)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vienna'
+
+And then execute:
+
+    bundle
+
+Or install it yourself, run:
+
+    gem install vienna
+
+## Usage
+
+Place your static files in `/public`, optionally create `/public/404.html`
+and add this to your `config.ru`:
+
+    require 'vienna'
+    run Vienna
+
+You're done. Now you can deploy to `heroku` or any other place that supports
+rack-based apps. This should also work for most apps built with
+[Jekyll](http://jekyllrb.com) or [Middleman](http://middlemanapp.com) as long as
+you follow the conventions stated above.
+
+If you absolutely must change the root folder for some reason. You can use e.g.
+`run Vienna::Application.new('_site')` instead of `run Vienna`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'yard'
+
+task :default => :test
+
+desc 'Test'
+task :test do
+  Dir.chdir 'spec'
+  system 'ruby -I ../lib spec.rb'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['--markup=markdown']
+end

data/lib/vienna.rb

@@ -0,0 +1,79 @@
+require 'vienna/version'
+require 'rack'
+
+##
+# Zero-configuration convenience wrapper around `Vienna::Application`.
+# Add this to `config.ru`:
+#
+#     require 'vienna'
+#     run Vienna
+#
+# Your static site in `public` will be served.
+#
+
+module Vienna
+
+  class << self
+    def call(env)
+      Application.new.call(env)
+    end
+  end
+  
+  ##
+  # `Vienna::NotFound` is a default endpoint not unlike `Rack::NotFound`.
+  # Initialize it with the path to a 404 page and it will get returned.
+  # The difference is that if a 404 page doesn't exist, a default
+  # response, 'Not Found' will be returned.
+  #
+  # Examples
+  #
+  #     run Vienna::NotFound.new('public/404.html')
+  #
+  #     run Vienna::NotFound.new # Always return 'Not Found'
+  #
+  
+  class NotFound
+    def initialize(path = '')
+      @path = path
+      @content = 'Not Found'
+    end
+    
+    def call(env)
+      if ::File.exist?(@path)
+        @content = ::File.read(@path)
+      end
+      length = @content.length.to_s
+      [404, {'Content-Type' => 'text/html', 'Content-Length' => length}, [@content]]
+    end
+  end
+  
+  ##
+  # `Vienna::Application` serves all files under the given `root`
+  # using `Rack::Static`. If a file/path doen't exist,
+  # `Vienna::NotFound` is run, which always returns `404`.
+  # 
+  # Examples
+  #
+  #     run Vienna::Application.new('_site')
+  #
+  #     run Vienna::Application.new # The root defaults to 'public'
+  #
+  
+  class Application
+    def initialize(root = 'public')
+      @app = Rack::Builder.new do
+        use Rack::Static,
+          :urls => Dir.glob("#{root}/*").map { |fn| fn.gsub(/#{root}/, '')},
+          :root => root,
+          :index => 'index.html',
+          :header_rules => [[:all, {'Cache-Control' => 'public, max-age=3600'}]]
+        
+        run NotFound.new("#{root}/404.html")
+      end
+    end
+    
+    def call(env)
+      @app.call(env)
+    end
+  end
+end

data/lib/vienna/version.rb

@@ -0,0 +1,3 @@
+module Vienna
+  VERSION = '0.4.0'
+end

data/spec/public/404.html

@@ -0,0 +1 @@
+404

data/spec/public/about.html

@@ -0,0 +1 @@
+about

data/spec/public/css/style.css

@@ -0,0 +1 @@
+style

data/spec/public/images/image.svg

@@ -0,0 +1 @@
+image

data/spec/public/index.html

@@ -0,0 +1 @@
+index

data/spec/spec.rb

@@ -0,0 +1,37 @@
+require 'minitest/autorun'
+require 'rack/mock'
+require 'vienna'
+
+describe Vienna do
+  before do
+    app = Rack::Builder.new do
+      use Rack::Lint
+      run Vienna
+    end
+    @request = Rack::MockRequest.new(app)
+  end
+  
+  it 'should serve the index when getting root' do
+    res = @request.get '/'
+    res.body.chomp.must_equal 'index'
+    [200, 304].must_include res.status
+  end
+  
+  it 'should serve all files in the public directory' do
+    @request.get('/css/style.css').body.chomp.must_equal 'style'
+    @request.get('/images/image.svg').body.chomp.must_equal 'image'
+    @request.get('/about.html').body.chomp.must_equal 'about'
+  end
+  
+  it 'should cache all files' do
+    ['/', '/css/style.css', '/images/image.svg', 'about.html'].each do |path|
+      @request.get(path).headers['Cache-Control'].must_equal 'public, max-age=3600'
+    end
+  end
+  
+  it 'should serve `404-html` for pages that aren\'t found' do
+    res = @request.get '/path'
+    res.body.chomp.must_equal '404'
+    res.status.must_equal 404
+  end
+end

data/vienna.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vienna/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'vienna'
+  spec.version       = Vienna::VERSION
+  spec.authors       = ['Mikael Konutgan']
+  spec.email         = ['me@kmikael.com']
+  spec.description   = %q{Tiny, zero-configuration static file server built on top of rack}
+  spec.summary       = %q{Tiny, zero-configuration static file server built on top of rack}
+  spec.homepage      = 'https://github.com/kmikael/vienna'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency 'rack', '~> 1.5'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'yard', '~> 0.8'
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: vienna
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Mikael Konutgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Tiny, zero-configuration static file server built on top of rack
+email:
+- me@kmikael.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vienna.rb
+- lib/vienna/version.rb
+- spec/public/404.html
+- spec/public/about.html
+- spec/public/css/style.css
+- spec/public/images/image.svg
+- spec/public/index.html
+- spec/spec.rb
+- vienna.gemspec
+homepage: https://github.com/kmikael/vienna
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Tiny, zero-configuration static file server built on top of rack
+test_files:
+- spec/public/404.html
+- spec/public/about.html
+- spec/public/css/style.css
+- spec/public/images/image.svg
+- spec/public/index.html
+- spec/spec.rb
+has_rdoc: