WatersOfOblivion-coltrane 0.0.0

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.0 2009-06-22
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/coltrane.rb
+script/console
+script/destroy
+script/generate
+spec/coltrane_spec.rb
+spec/spec_helper.rb

data/README.rdoc

@@ -0,0 +1,48 @@
+= coltrane
+
+* http://github.com/WatersOfOblivion/coltrane
+
+== DESCRIPTION:
+
+Coltrane is a Sinatra[http://sinatrarb.com]-like framework for FTP.
+
+== FEATURES/PROBLEMS:
+
+None, yet.
+
+== SYNOPSIS:
+
+  # TODO
+
+== REQUIREMENTS:
+
+* None, yet.
+
+== INSTALL:
+
+* sudo gem install WatersOfOblivion-coltrane -s http://gems.github.com/
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Jonathan Bryant
+
+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/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/coltrane'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('coltrane', Coltrane::VERSION) do |p|
+  p.developer('Jonathan Bryant', 'jonathan@watersofoblivion.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+task :default => :spec

data/lib/coltrane.rb

@@ -0,0 +1,306 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'eventmachine'
+
+module Coltrane
+  VERSION = '0.0.0'
+
+  class ColtraneError < Exception; end
+
+  class SyntaxError < ColtraneError
+    def initialize command, params
+      super "Invalid syntax for #{command}: #{params}"
+    end
+  end
+
+  class UnknownCommand < ColtraneError
+    def initialize cmd
+      super "Unknown command: #{cmd}"
+    end
+  end
+
+  class RoutingError < ColtraneError
+    def initialize cmd, path
+      super "Unknown route: #{cmd.upcase} #{path}"
+    end
+  end
+
+  class ProtocolError < ColtraneError
+    def initialize actual, *expected
+      super "Protocol error: expected one of #{expected.join(", ")}, received #{actual}.  Goodbye"
+    end
+  end
+
+  class Request
+    class << self
+      def command *args, &block
+        name = args.shift
+        regexp = args.first.is_a?(Regexp) ? args.shift : /(.*)/
+        variables = args
+        block ||= Proc.new { |x| x }
+
+        variables.each do |var|
+          attr_accessor var unless var.nil? || (respond_to?(var) && respond_to?("#{var}=".to_sym))
+        end
+
+        define_method name do |params|
+          @command = name
+          match_data = regexp.match params
+          if match_data
+            variables.zip match_data.captures do |var, cap|
+              instance_variable_set "@#{var}", cap.strip if var
+            end
+            instance_eval &block if block_given?
+          else
+            raise SyntaxError.new @command, params
+          end
+        end
+      end
+    end
+
+    attr_accessor :command
+
+    def initialize req
+      req.strip =~ /^(\w+)(.*)$/
+      begin
+        send $1.downcase.to_sym, $2.strip
+      rescue NameError
+        raise UnknownCommand.new req
+      end
+    end
+
+    command :abor
+    command :acct, :account_info
+    command :allo, /(\d+)(\s+R\s+(\d+))?/, :size, nil, :max_record_size do
+      @size = @size.to_i
+      @max_record_size = @max_record_size.to_i if @max_record_size
+    end
+    command :appe, :path
+    command :cdup
+    command :cwd,  :path
+    command :dele, :path
+    command :help, :command
+    command :list, :path
+    command :mtdm, :path
+    command :mkd,  :path
+    command :mode, /([SBC])/i, :mode do
+      @mode.upcase!
+    end
+    command :nlst, :path
+    command :noop
+    command :pass, :password
+    command :pasv
+    command :port, /(\d{1,3}),(\d{1,3}),(\d{1,3}),(\d{1,3}),(\d{1,3}),(\d{1,3})/, :oct1, :oct2, :oct3, :oct4, :port1, :port2 do
+      self.class.attr_accessor :ip_address, :port_num
+      @ip_address = "#{@oct1}.#{@oct2}.#{@oct3}.#{@oct4}"
+      @port_num = @port1.to_i * 256 + @port2.to_i
+    end
+    command :pwd
+    command :quit
+    command :rein
+    command :rest, /(\d+)/, :position do
+      @position = @position.to_i
+    end
+    command :retr, :path
+    command :rmd,  :path
+    command :rnfr, :path
+    command :rnto, :path
+    command :site, :site_cmd
+    command :size, :path
+    command :stat, :path
+    command :stor, :path
+    command :stou
+    command :stru, /([FRP])/i, :structure do
+      @structure.upcase!
+    end
+    command :syst
+    command :type, /([ILAE])\s*(N|T|C|\d+)?/i, :type, :second_type do
+      (@second_type ||= "").strip!
+      @type.upcase!
+      if ["A", "E"].include? @type
+        @second_type ||= "N"
+        @second_type.upcase!
+      elsif @type == "L"
+        @second_type = @second_type.to_i
+      end
+    end
+    command :user, :username
+  end
+
+  class Response
+    attr_accessor :code, :status
+
+    def initialize code = 0, status = ""
+      @code, @status = code, status
+    end
+
+    def to_s
+      status = @status.split(/\r?\n/m)
+      final = status.pop
+      status.map! { |s| "#{@code}-#{s}\r\n" }
+      status.push "#{@code} #{final}\r\n"
+      status.join
+    end
+  end
+
+  class Application < EventMachine::Connection
+    class << self
+      def list path, &block
+        route :list, path, &block
+      end
+
+      def retr path, &block
+        route :retr, path, &block
+      end
+
+      def stor path, &block
+        route :stor, path, &block
+      end
+
+      def dele path, &block
+        route :dele, path, &block
+      end
+
+      def route cmd, path, &block
+        keys = []
+        special_chars = %w{. + ( )}
+        path = path.to_str.gsub(/((:\w+)|[\*#{special_chars.join}])/) do |match|
+          case match
+          when "*"
+            keys << 'splat'
+            "(.*?)"
+          when *special_chars
+            Regexp.escape match
+          else
+            keys << $2[1..-1]
+            "([^/?&#]+)"
+          end
+        end
+        routes[cmd].push(:path => /^#{path}$/, :keys => keys, :block => block)
+      end
+
+      def routes
+        @routes ||= { :list => [], :retr => [], :stor => [], :dele => [] }
+      end
+
+      def launch!
+        EventMachine.run do
+          EventMachine.start_server 'localhost', 2100, self
+        end
+      end
+
+      private
+
+      def state name, &block
+        define_method name, &block
+        private name
+      end
+    end
+
+    def post_init
+      @routes = self.class.routes
+      @pwd = '/'
+      transition :welcome
+      send_data send(@state)
+    end
+
+    def receive_data data
+      @request = Request.new data
+      @response =
+        begin
+          send(@state)
+        rescue SyntaxError => ex
+          Response.new 501, ex.message
+        rescue UnknownCommand => ex
+          Response.new 502, ex.message
+        rescue RoutingError => ex
+          Response.new 550, ex.message
+        rescue ProtocolError => ex
+          Response.new 421, ex.message
+        rescue Exception => ex
+          Response.new 599, "Unknown error: #{ex.message}"
+        end
+      send_data @response
+
+      if @response && @response.code == 421
+        close_connection
+      end
+    end
+
+    state :welcome do
+      on do
+        transition :user
+        Response.new 220, "Welcome!"
+      end
+    end
+
+    state :user do
+      on :user do
+        if @request.username.downcase == "anonymous"
+          transition :anon
+          Response.new 331, "Please use your email address as a password"
+        else
+          @user = @request.username
+          transition :pass
+          Response.new 331, "Password needed"
+        end
+      end
+    end
+
+    state :anon do
+      on :pass do
+        transition :logged_in
+        Response.new 230, "Thanks"
+      end
+    end
+
+    state :pass do
+      on :pass do
+        if @user == "jbryant" && @request.password == "password"
+          transition :type
+          Response.new 230, "Authenticated"
+        else
+          Response.new 421, "Authentication failed.  Goodbye"
+        end
+      end
+    end
+
+    state :type do
+      on :type do
+        @type = @request.type
+        transition :mode
+        Response.new 250, "Okay"
+      end
+    end
+
+    state :mode do
+      on :port do
+        puts "Active"
+        transition :ready
+        Response.new 227, "=1,1,1,1,1,1"
+      end
+
+      on :pasv do
+        puts "Passive"
+        transition :ready
+        Response.new 227, "=1,1,1,1,1,1"
+      end
+    end
+
+    state :ready do
+      Response.new 200, "Foo"
+    end
+
+    private
+
+    def transition state
+      @state = state
+    end
+
+    def on cmd = nil, &block
+      instance_eval &block if cmd.nil? || @request.command == cmd
+    end
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/coltrane.rb'}"
+puts "Loading coltrane gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/coltrane_spec.rb

@@ -0,0 +1,115 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Coltrane
+  describe Request do
+    before do
+      io = mock "IO"
+      io.stub! :gets => "list /path"
+      @request = Request.new(io)
+    end
+
+    describe :new do
+    end
+
+    it "should have a :command attribute" do
+      @request.command.should == :list
+      @request.command = :foo
+      @request.command.should == :foo
+    end
+
+    it "should have a :path attribute" do
+      @request.path.should == "/path"
+      @request.path = "/htap"
+      @request.path.should == "/htap"
+    end
+  end
+
+  describe Response do
+    before do
+      @io = mock "IO"
+      @response = Response.new(@io)
+    end
+
+    it "should have a :code attribute" do
+      @response.code = 220
+      @response.code.should == 220
+    end
+
+    it "should have a :message attribute" do
+      @response.status = "Ready"
+      @response.status.should == "Ready"
+    end
+
+    describe :finalize! do
+      it "should output the response to the stream" do
+        @response.code = 220
+        @response.status = "Ready"
+        @io.should_receive(:puts).with "220 Ready\r\n"
+        @io.should_receive(:flush)
+        @response.finalize!
+      end
+    end
+  end
+
+  describe Application do
+    describe "class method" do
+      before do
+        @app = Class.new Application
+        @block = Proc.new {}
+      end
+
+      describe :list do
+        it "should delegate to route" do
+          @app.should_receive(:route).with(:list, '/path', &@block)
+          @app.list '/path', &@block
+        end
+      end
+
+      describe :retr do
+        it "should delegate to route" do
+          @app.should_receive(:route).with(:retr, '/path', &@block)
+          @app.retr '/path', &@block
+        end
+      end
+
+      describe :stor do
+        it "should delegate to route" do
+          @app.should_receive(:route).with(:stor, '/path', &@block)
+          @app.stor '/path', &@block
+        end
+      end
+
+      describe :dele do
+        it "should delegate to route" do
+          @app.should_receive(:route).with(:dele, '/path', &@block)
+          @app.dele '/path', &@block
+        end
+      end
+
+      describe :route do
+        it "should accept a command, a path, and a block" do
+          @app.route :list, '/path' do end
+        end
+
+        it "should store the route by command" do
+          @app.routes
+        end
+      end
+
+      describe :launch! do
+        it "should start the application" do
+          @app.launch!
+        end
+      end
+    end
+
+    describe :new do
+    end
+
+    describe :main_loop do
+    end
+
+    describe :process do
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'coltrane'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: WatersOfOblivion-coltrane
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- Jonathan Bryant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.4.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Coltrane is a Sinatra[http://sinatrarb.com]-like framework for FTP.
+email: 
+- jonathan@watersofoblivion.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/coltrane.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/coltrane_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/WatersOfOblivion/coltrane
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: coltrane
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Coltrane is a Sinatra[http://sinatrarb.com]-like framework for FTP.
+test_files: []
+