useless 0.1.2 → 0.2.0

data/lib/useless/logger.rb

@@ -1,48 +0,0 @@
-require 'logger'
-
-module Useless
-  # Useless::Logger is a wrapper around Logger for the purposes of decorating.
-  class Logger
-    attr_accessor :request_id
-
-    def initialize(io = $stdout)
-      @logger = ::Logger.new(io)
-    end
-
-    def level=(level)
-      @logger.level = level
-    end
-
-    def level
-      @logger.level
-    end
-
-    def fatal(message)
-      add ::Logger::FATAL, message
-    end
-
-    def error(message)
-      add ::Logger::ERROR, message
-    end
-
-    def warn(message)
-      add ::Logger::WARN, message
-    end
-
-    def info(message)
-      add ::Logger::INFO, message
-    end
-
-    def debug(message)
-      add ::Logger::DEBUG, message
-    end
-
-    private
-
-    def add(level, message)
-      formatted_message = message
-      formatted_message = "[#{@request_id}] #{formatted_message}" if @request_id
-      @logger.add level, formatted_message
-    end
-  end
-end

data/lib/useless/rack/base.rb

@@ -1,26 +0,0 @@
-require 'useless/rack/base/files'
-
-module Useless
-  class Rack
-    # Useless::Base is the Rack endpoint for useless.io proper. It has two
-    # responsibilties: show documentation, and serve file from 'useless.fs'.
-    class Base
-      def call(env)
-        # Show platform documentation at root
-        app = ::Rack::URLMap.new '/' => platform_documentation,
-
-          # serve files out of /files/* via the Files Rack endpoint.
-          '/files/'  => Files.new
-
-        app.call(env)
-      end
-
-      def platform_documentation
-        @root_app ||= begin
-          file = File.expand_path('../../../../assets/DOC.html', __FILE__)
-          [200, {'Content-Type' => 'text/html'}, file]
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/base/files.rb

@@ -1,33 +0,0 @@
-require 'useless/fs'
-
-module Useless
-  class Rack
-    class Base
-      # Useless::Base::Files simply retrieves files from Useless::FS and serves
-      # them up.
-      class Files
-        # Provide a helper method for file URLs to keep things consistent.
-        def self.url_for(id)
-          "http://useless.io/files/#{id}"
-        end
-
-        def call(env)
-          # The file ID is everything after the initial '/' in the path
-          id = env['PATH_INFO'][1..-1]
-
-          # Retrieve the file from FS
-          file = env['useless.fs'].get(BSON::ObjectId(id))
-
-          # and serve it up with the associated content type
-          return [200, {'Content-Type' => file.content_type}, file.read]
-
-        # Two things can go wrong, and they'll both raise an error:
-        #   * the specified ID is not a valid object ID
-        #   * there is no file corresponding to the ID in the FS
-        rescue BSON::InvalidObjectId, Useless::FS::FileNotFound
-          [404, {'Content-Type' => 'text/plain'}, "File not found: #{id}"]
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/assets.rb

@@ -1,38 +0,0 @@
-module Useless
-  class Rack
-    module Middleware
-      # `Assets` maps requests to files in the assets directory.
-      class Assets
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          # If the path couldn't be a file in assets, just proxy the request.
-          unless env['PATH_INFO'] =~ /\/\w+/
-            return @app.call(env)
-          end
-
-          # The path is relative to the assets directory in the gem root
-          path = File.expand_path("../../../../assets#{env['PATH_INFO']}", __FILE__)
-
-          # If there's a corresponding file:
-          if File.exists?(path) and !File.directory?(path)
-            # Try to infer the type from the extension, resorting to 'plain'
-            # if we can't.
-            type = path[/\.(\w+)$/, 1] || 'plain'
-
-            # Read the file,
-            response = File.read(path)
-
-            # and serve it up
-            [200, {'Content-Type' => "text/#{type}"}, [response]]
-          else
-            # Otherwise, just pass the request along
-            @app.call(env)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/authentication/access_token.rb

@@ -1,41 +0,0 @@
-module Useless
-  class Rack
-    module Middleware
-      module Authentication
-        # The `Authentication::AccessToken` module defines the behavior for access-
-        # token-based authentication middleware. The middlewares are responsible
-        # only for providing the access token via the `#access_token_for_env`
-        # method.
-        module AccessToken
-          def initialize(app)
-            @app = app
-          end
-
-          def call(env)
-            # If we don't already have a user set in the environment,
-            unless env['useless.user']
-              # check to see if an access token was specified.
-              if access_token = access_token_for_env(env)
-                # If so, and a corresponding user can be found,
-                if user = env['useless.mongo']['users'].find_one('access_token' => access_token)
-                  # set 'useless.user' in the environment.
-                  env['useless.user'] = user
-                else
-                  # Otherwise, return a 401 Unauthorized.
-                  return [401, {'Content-Type' => 'text/plain'}, ["Invalid access token: #{access_token}"]]
-                end
-              end
-            end
-
-            @app.call(env)
-          end
-
-          private
-
-          def access_token_for_env(env)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/authentication/query_string.rb

@@ -1,21 +0,0 @@
-require 'useless/rack/middleware/authentication/access_token'
-
-module Useless
-  class Rack
-    module Middleware
-      module Authentication
-        # The `Authentication::QueryString` middleware attempt to retrieve the
-        # access token from the query string.
-        class QueryString
-          include AccessToken
-
-          private
-
-          def access_token_for_env(env)
-            ::Rack::Utils.parse_query(env['QUERY_STRING'])['access_token']
-          end
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/authentication/request_header.rb

@@ -1,21 +0,0 @@
-require 'useless/rack/middleware/authentication/access_token'
-
-module Useless
-  class Rack
-    module Middleware
-      module Authentication
-        # The `Authentication::RequestHeader` middleware attempts to retrieve the
-        # access token from the `Authorization` request header.
-        class RequestHeader
-          include AccessToken
-
-          private
-
-          def access_token_for_env(env)
-            env['HTTP_AUTHORIZATION']
-          end
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/exceptions.rb

@@ -1,41 +0,0 @@
-module Useless
-  class Rack
-    module Middleware
-      # `Exceptions` is a Rack middleware that handles any exceptions raised by
-      # it's app. It has two responsibilities:
-      #   1. log the exception trace, if a logger is available, and
-      #   2. return a 500 response with the appropriate message
-      class Exceptions
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          @app.call(env)
-        rescue => exception
-          # First, format the exception trace
-          trace = exception.message + "\n" + exception.backtrace.join("\n")
-
-          # If a logger is available,
-          if env['useless.logger']
-            # log the trace as fatal.
-            env['useless.logger'].fatal trace
-          end
-
-          # Next, if the request is authenticated by an admin or we are in development or test,
-          if (env['useless.user'] and env['useless.user']['admin']) or
-              ENV['RACK_ENV'] == 'development'
-            # we will return the trace;
-            message = trace
-          else
-            # otherwise, return a generic message.
-            message = 'An internal server error occurred. Please try again later.'
-          end
-
-          # Finally, return the 500 error.
-          [500, {'Content-Type' => 'text/plain'}, [message]]
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/fs.rb

@@ -1,17 +0,0 @@
-module Useless
-  class Rack
-    module Middleware
-      # `FS` simply adds the Useless.fs instance to env as 'useless.fs'.
-      class FS
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          env['useless.fs'] = Useless::Rack.fs
-          @app.call(env)
-        end
-      end
-    end
-  end
-end

data/lib/useless/rack/middleware/mongo.rb

@@ -1,18 +0,0 @@
-module Useless
-  class Rack
-    module Middleware
-      # `Useless::Mongo` simply adds the Useless.mongo instance to env as
-      # 'useless.mongo'.
-      class Mongo
-        def initialize(app)
-          @app = app
-        end
-
-        def call(env)
-          env['useless.mongo'] = Useless::Rack.mongo
-          @app.call(env)
-        end
-      end
-    end
-  end
-end

data/spec/useless/logger_spec.rb

@@ -1,87 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-require 'useless/logger'
-
-describe Useless::Logger do
-  describe '#fatal' do
-    it 'should emit a fatal message' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.fatal 'Oh noes!'
-
-      io.rewind; message = io.read
-      message.should =~ /FATAL/
-      message.should =~ /Oh noes!$/
-    end
-  end
-
-  describe '#error' do
-    it 'should emit an error message' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.error 'Wrong!'
-
-      io.rewind; message = io.read
-      message.should =~ /ERROR/
-      message.should =~ /Wrong!$/
-    end
-  end
-
-  describe '#warn' do
-    it 'should emit a warn message' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.warn 'Watchout!'
-
-      io.rewind; message = io.read
-      message.should =~ /WARN/
-      message.should =~ /Watchout!$/
-    end
-  end
-
-  describe '#info' do
-    it 'should emit an info message' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.info 'Such and such'
-
-      io.rewind; message = io.read
-      message.should =~ /INFO/
-      message.should =~ /Such and such$/
-    end
-  end
-
-  describe '#debug' do
-    it 'should emit a debug message' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.debug '101011'
-
-      io.rewind; message = io.read
-      message.should =~ /DEBUG/
-      message.should =~ /101011$/
-    end
-
-    it 'should emit nothing if the level is too high' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.level = ::Logger::INFO
-      logger.debug '101011'
-
-      io.rewind; message = io.read
-      message.should == ''
-    end
-  end
-
-  describe '#request_id' do
-    it 'should append the specified ID to all messages' do
-      io = StringIO.new
-      logger = Useless::Logger.new(io)
-      logger.request_id = 'abc123'
-      logger.info 'Yadda'
-
-      io.rewind; message = io.read
-      message.should =~ /abc123/
-      message.should =~ /Yadda$/
-    end
-  end
-end

data/spec/useless/rack/base/files_spec.rb

@@ -1,42 +0,0 @@
-require File.dirname(__FILE__) + '/../../../spec_helper'
-require 'useless/rack/base/files'
-
-describe 'useless.io/files' do
-  include Rack::Test::Methods
-
-  def app
-    Useless::Rack.new
-  end
-
-  describe 'GET /files/:id' do
-    it 'should return a file if one exists for the specified ID' do
-      file = File.open(asset_path('muffin-milk.jpg'))
-      id = Useless::Rack.fs.put(file)
-
-      get Useless::Rack::Base::Files.url_for(id)
-      last_response.should be_ok
-
-      # See spec/useless/fs_spec.rb
-      file.rewind
-      blob = file.read
-      blob.force_encoding('BINARY')
-      blob.should == last_response.body
-    end
-
-    it 'should return a 404 if the file does not exits' do
-      get Useless::Rack::Base::Files.url_for(BSON::ObjectId.new)
-      last_response.should be_not_found
-    end
-
-    it 'should return a 404 if the specified ID is invalid' do
-      get Useless::Rack::Base::Files.url_for('invalid-id')
-      last_response.should be_not_found
-    end
-  end
-
-  describe '.url_for' do
-    it 'should return the appropriate URL for the specified file ID' do
-      Useless::Rack::Base::Files.url_for('abc123').should == 'http://useless.io/files/abc123'
-    end
-  end
-end