silk 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Myles Eftos
+
+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.rdoc

@@ -0,0 +1,58 @@
+= silk
+
+Silk is a a flexible framework for building web hosting consoles. It's based around a rake task runner that has a HTTP/JSON interface.
+It allows you to build rake tasks to do things like add users, create email addresses etc. Then you simply wrap the response in a JSON
+envelope, and you can then build your own custom web hosting console.
+
+This gem is just the runner, that need to be installed on all client servers.
+
+== Installation
+
+(Requires Gemcutter)
+
+gem install silk
+
+Create /etc/silk and drop in a Rakefile - you can also add *.rake files in /etc/silk (or $HOME/.silk/) and they will automatically be read in.
+
+== Usage
+
+The gem should install an executable called silk
+
+run silk -h for full argument descriptions.
+
+The system automatically converts the rest URL (only GETs at the moment) into a rake task name - if the name doesn't exist, you'll get a 404. Any query params get passed into the task
+
+So http://localhost:8888/users/get?login=myles
+
+would run the users:get task. do something like this in the rake task:
+
+namespace :users do
+  task :get do |t, args|
+    # args[:login] will be populated with myles
+  end
+end
+
+NOTE: The idea is you write your own rake task to do stuff, and then interface them how you want. The project doesn't care what data you transfer and represent, although it would be possible to share rakefiles and interfaces for common tasks.
+
+By default it runs on port 8888 and will probably need to be run as root to make sure you can do all the stuff you need to do. 
+
+Eventually it'll support SSL certificates etc, but until then, I suggest you either use SSH tunnels, and/or (at the very least) lock down via a firewall. You could also build a rack.up file, and run it behind a web server that gives you more control (Rack.up file is on the todo list).
+
+== Status
+
+This is a really early release, that still needs formal testing (This is so far more proof of concept at this point), and may blow up at any given moment. Feel free to fork and help out.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Myles Eftos. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "silk"
+    gem.executables = "silk"
+    gem.summary = %Q{A framework for creating a hosting console}
+    gem.description = %Q{It allows you to write rake tasks to do common tasks, such as creating email addresses, adding users etc. Silk provides a HTTP wrapper the the rake tasks, and allows communication via JSON objects, which makes it dead easy for them to be called from a web app.}
+    gem.email = "myles@madpilot.com.au"
+    gem.homepage = "http://github.com/madpilot/silk"
+    gem.authors = ["Myles Eftos"]
+    
+    gem.add_dependency 'daemons'
+    gem.add_dependency 'SyslogLogger'
+    
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "silk #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/silk

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib')
+require 'silk'
+Silk.run

data/lib/silk.rb

@@ -0,0 +1,39 @@
+$:.unshift File.join(File.dirname(File.expand_path(__FILE__)), 'silk')
+
+require 'rubygems'
+require 'rake'
+require 'syslog_logger'
+require 'daemons'
+require 'options'
+require 'server'
+require 'tasks'
+
+module Silk
+  def self.run
+    options = Options.parse
+
+    if options[:ontop]
+      options[:logger] = Logger.new(STDOUT)
+    else
+      options[:logger] = SyslogLogger.new('silk')
+    end
+    
+    Silk.options = options
+
+    old_proc_name = $0
+    pwd = Dir.pwd
+    Daemons.call(options) do
+      $0 = old_proc_name
+      Dir.chdir pwd
+      Server.run! :host => options[:bind], :port => options[:port], :environment => :production
+    end
+  end
+
+  def self.options
+    @options
+  end
+
+  def self.options=(options)
+    @options = options
+  end
+end

data/lib/silk/http.rb

@@ -0,0 +1,2 @@
+require 'sinatra'
+require 'json'

data/lib/silk/options.rb

@@ -0,0 +1,70 @@
+require 'optparse'
+ 
+class Options
+  def self.parse
+    options = {
+      :multiple => false
+    }
+ 
+    optparse = OptionParser.new do |opts|
+      opts.banner = "Usage: #{opts.program_name} [options]"
+ 
+      options[:verbose] = false
+      opts.on('-V', '--verbose', 'Be more verbose') do
+        options[:verbose] = true
+      end
+ 
+      opts.on('-h', '--help', "You're looking at it") do
+        puts opts
+        exit(-1)
+      end
+ 
+      options[:ontop] = false
+      opts.on('-f', '--foreground', "Run in the foreground") do
+        options[:ontop] = true
+      end
+ 
+      options[:filter_paths] = [ File.join('', 'etc', 'silk') ] 
+      options[:filter_paths] << File.join(ENV['HOME'], '.silk') if ENV['HOME']
+      
+      opts.on('-r [recipe]', '--recipes [recipe]', /.+/, 'Reads in additional recipes') do |recipes|
+        options[:filter_paths] << recipes
+      end
+ 
+      options[:port] = 8888
+      opts.on('-p [port]', '--port', /\d+/, 'Port to run the server on (Default: 8888)') do |port|
+        options[:port] = port.to_i
+      end
+
+      options[:lock] = false
+      opts.on('-x', '--lock', 'Set a mutex lock') do
+        options[:lock] = true
+      end
+
+      options[:bind] = '0.0.0.0'
+      opts.on('-b', '--bind', /.+/, 'Set the IP address to listen to') do |host|
+        options[:bind] = host
+      end
+
+      options[:server] = %w[thin mongrel webrick]
+      opts.on('-s', '--server', /.+/, 'handler used for built-in web server') do |server|
+        options[:server] = server
+      end
+ 
+      opts.on('-v', '--version') do
+        File.open(File.join(File.dirname(__FILE__), '..', '..', 'VERSION')) do |fh|
+          puts fh.read
+        end
+        exit(0)
+      end
+    end
+ 
+    begin
+      optparse.parse!
+      options
+    rescue OptionParser::InvalidOption => e
+      puts optparse
+      exit(-1)
+    end
+  end
+end

data/lib/silk/server.rb

@@ -0,0 +1,49 @@
+require 'json'
+require 'sinatra/base'
+
+module Silk
+  class Server < Sinatra::Base
+    get %r{\/(.+)} do |c|
+      content_type('application/json')
+
+      options = Silk.options
+      task = c.gsub("/", ":")
+      
+      tasks = Silk::Tasks.new
+      unless tasks.list.include?(task)
+        not_found("Not Found".to_json)
+      end
+
+      results = { :stdout => '', :stderr => '' }
+      params.delete("captures")
+      
+      stdout_read, stdout_write = IO.pipe
+      stderr_read, stderr_write = IO.pipe
+      pid = Process.fork do
+        $stdout.reopen stdout_write
+        $stderr.reopen stderr_write
+        stdout_read.close
+        stderr_read.close
+        tasks.run(task, params)
+      end
+      
+      stdout_write.close
+      stderr_write.close
+      stdout_read.each do |line|
+        results[:stdout] += line
+      end
+      stderr_read.each do |line|
+        results[:stderr] += line
+      end
+      Process.waitpid(pid)
+    
+      headers('X_PROCESS_EXIT_STATUS' => $?.exitstatus.to_s)
+      
+      if $?.exitstatus != 0
+        error(500, results[:stderr])
+      else
+        results[:stdout]
+      end
+    end
+  end
+end

data/lib/silk/tasks.rb

@@ -0,0 +1,25 @@
+require 'rake'
+
+module Silk
+  class Tasks
+    def initialize
+      Rake::Task.clear
+      @app = Rake::Application.new
+      @app.init
+      Silk.options[:filter_paths].each do |path|
+        FileList.new("#{path}/*.rake").each do |file|
+          @app.add_import(file)
+        end
+      end
+      @app.load_rakefile
+    end
+
+    def list
+      return Rake::Task.tasks.map { |task| task.name }
+    end
+
+    def run(task, arguments)
+      Rake::Task[task].execute(arguments)
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'silk'
+
+class Test::Unit::TestCase
+end

data/test/test_silk.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSilk < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: silk
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Myles Eftos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-18 00:00:00 +08:00
+default_executable: silk
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: SyslogLogger
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: It allows you to write rake tasks to do common tasks, such as creating email addresses, adding users etc. Silk provides a HTTP wrapper the the rake tasks, and allows communication via JSON objects, which makes it dead easy for them to be called from a web app.
+email: myles@madpilot.com.au
+executables: 
+- silk
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/silk
+- lib/silk.rb
+- lib/silk/http.rb
+- lib/silk/options.rb
+- lib/silk/server.rb
+- lib/silk/tasks.rb
+- test/helper.rb
+- test/test_silk.rb
+has_rdoc: true
+homepage: http://github.com/madpilot/silk
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A framework for creating a hosting console
+test_files: 
+- test/test_silk.rb
+- test/helper.rb