swxruby 0.7

data/CHANGELOG

@@ -0,0 +1,21 @@
+== 0.7 2008-03-11
+
+* 1 major enhancement:
+  * Gem Release
+
+* 1 minor enhancement:
+  * Added handling of symbols
+
+* Miscellaneous:
+  * Fleshed out README file quite a bit
+  
+== 0.5 2007-11-29
+
+* 1 major enhancement:
+  * Rails controller integration (render :swx => @foo)
+
+* 1 minor bugfix:
+  * Fixed handling of nil values in hash to bytecode conversion
+
+* Miscellaneous:
+  * Added CHANGELOG, LICENSE, and README files

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jed Hurt
+
+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

@@ -0,0 +1,143 @@
+= SWX Ruby 0.7
+
+Primary Repo: http://github.com/meekish/swxruby
+
+=== What is SWX?
+
+SWX is the native data format for the Flash Platform.
+
+SWX RPC is a remote procedure call protocol encoded in SWX and a viable alternative to XML and Flash Remoting. It's simple enough that you can get up and running with it in about five minutes. SWX RPC is perfect for building mashups (with easy-to-use APIs for Flickr, Twitter, and others), mobile applications (Flash Lite 2.0 and 2.1), and other data-driven Flash sites and applications. Official web site at http://swxformat.org
+
+=== What is SWX Ruby?
+
+SWX Ruby is the Ruby implementation of SWX RPC. It allows Rubyists to leverage their Ruby skills to build data-driven Flash applications using the wonderfully simple SWX data format. The current beta version assembles AVM1 SWF files (compatible with Flash 8 and below). By its 1.0 release, SWX Ruby will also assemble AVM2 SWF files. Official web site at http://swxruby.org
+
+=== Installation
+
+==== Gem
+
+gem install swxruby
+
+  Note: The SWX Ruby gem declares 'json_pure' as a dependency. json_pure
+  is the pure Ruby variant of the JSON gem. If you have a C compiler and 
+  would like better performance then do 'gem install json'
+
+==== Rails plugin
+
+After installing the gem, do:
+
+  swxruby --rails PATH_TO_ROOT_OF_YOUR_RAILS_APP
+
+This will unpack a plugin into your Rails app. For further explanation of the files installed, see 'Rails Usage' below.
+
+<b>Living on the Edge:</b> The Rails init script (init.rb) sits in the root of the SWX Ruby tree, thus you can simply throw the git HEAD into vendor/plugins/swxruby to run the plugin on edge
+
+  git clone git://github.com/meekish/swxruby.git vendor/plugins/swxruby
+  ruby vendor/plugins/swxruby/install.rb
+
+=== Gem Usage (For Merb, Camping, Sinatra, et al.)
+
+Require the SWX Ruby gem
+
+  require 'rubygems'
+  require 'swxruby'
+
+Define a service class in the SwxServiceClasses namespace
+
+  module SwxServiceClasses
+    class Simple
+      def echo_data(data)
+        data
+      end
+    end
+  end
+  
+Start making calls to SwxGateway#process
+
+  @swx_bytecode = SwxGateway.process(:serviceClass => 'Simple', :method => 'echo_data', :args => 'Hello World!', :debug => true)
+  # => Returns a binary string of SWX bytecode containing the result of SwxServiceClasses::Simple.new.echo_data('Hello World!')
+  
+Use your framework's preferred method to wrap the swx bytecode in a file shell and send it on its way. Here's how Rails and Merb do it:
+
+  send_data(@swx_bytecode, :filename => 'data.swf', :type => 'application/swf')
+  
+==== Example of Gem Usage
+
+Here's a full Merb app (this and a Flash client are included in examples/standalone/)  
+
+  # standalone.rb
+  
+  require 'rubygems'
+  require 'swxruby'
+
+  # Service Class
+  class SwxServiceClasses::HelloMerb
+    def just_say_the_words
+      'Hello from Merb!'
+    end
+  end
+
+  # Merb Application
+  Merb::Router.prepare { |r| r.match('/').to(:controller => 'swx_ruby', :action =>'gateway') }
+
+  class SwxRuby < Merb::Controller
+    def gateway
+      send_data(SwxGateway.process(params), :filename => 'data.swf', :type => 'application/swf')
+    end
+  end
+  
+  # Start with 'merb -I standalone.rb' and you're off!
+  
+=== Rails Plugin Usage
+
+When running as a Rails plugin, SWX Ruby will look for your service classes in
+RAILS_ROOT/app/services. Simply create standard Ruby classes and drop them
+in this folder. SWX Ruby will instantiate your service class (while forcing
+it into the SwxServiceClasses namespace), call the specified method, and
+send the response back to the Flash Player.
+
+Take a peek at services/hello_world.rb for a working service class example.
+Alright, alright, I'll just show it to you here:
+
+  # hello_world.rb----------------------------------------
+  # Class and method names follow standard Ruby convention
+  class HelloWorld
+  	# Service class methods are instance methods.
+  	def just_say_the_words
+  		'Hello World!'
+  	end
+  end
+  #-------------------------------------------------------
+
+Here's an example to call HelloWorld#just_say_the_words from Flash 
+(place a MovieClip on stage with an instance name of 'loader' and
+fire up your Rails development server):
+
+  //------------------------------------------------------
+  loader.serviceClass = "HelloWorld";
+  // Method names follow ActionScript convention 
+  // (converted to underscored server-side)
+  loader.method = "justSayTheWords";
+  loader.debug = true;
+  loader.loadMovie("http://localhost:3000/swx", "POST");
+
+  function onEnterFrame() {
+   // Will output 'Hello World!' once the SWX file is loaded.
+   trace(loader.result);
+  }
+  //------------------------------------------------------
+
+When you're ready for some robust ActionScriptery, head to 
+http://swxformat.org/download to grab the SWX ActionScript library.
+
+Oh yeah, you may return ActiveRecord objects from your service classes; 
+SWX Ruby will happily serialize them for you. Go ahead, give it a try!
+
+NOTE: You may notice some Security Sandbox Violations when testing the example
+above in the Flash IDE. Rest assured, this is OK. Visit 
+http://swxformat.org/132 for further explanation.
+
+=== Get In Touch
+
+Please post bug reports/suggestions to http://groups.google.com/group/swxruby
+

data/Rakefile

@@ -0,0 +1,111 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+require './lib/swxruby'
+
+NAME = 'swxruby'
+SUDO = 'sudo'
+
+task :release do
+  sh("rubyforge add_release 4428 5478 #{SwxRuby::VERSION} ./pkg/swxruby-#{SwxRuby::VERSION}.gem")
+end
+
+
+# ==============================
+# = Packaging and Installation =
+# ==============================
+CLEAN.include ["**/.*.swf", "pkg", "*.gem", "doc"]
+
+spec = Gem::Specification.new do |s|
+  s.name         = NAME
+  s.rubyforge_project = NAME
+  s.version      = SwxRuby::VERSION
+  s.author       = 'Jed Hurt'
+  s.email        = 'jed.hurt@gmail.com'
+  s.homepage     = 'http://swxruby.org'
+  s.summary      = 'SWX Ruby: The Ruby Implementation of SWX RPC'
+  s.bindir       = 'bin'
+  s.description  = s.summary
+  s.executables  = %w( swxruby )
+  s.require_path = 'lib'
+  s.files        = %w( LICENSE README Rakefile CHANGELOG init.rb install.rb ) + Dir["{bin,spec,lib,examples}/**/*"]
+
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w( README LICENSE CHANGELOG )
+  #s.rdoc_options     += RDOC_OPTS + ["--exclude", "^(app|uploads)"]
+
+  # Dependencies
+  s.add_dependency "json_pure"
+  # Requirements
+  s.requirements << "install the json gem to get faster json parsing"
+  s.required_ruby_version = ">= 1.8.4"
+end
+
+Rake::GemPackageTask.new(spec) do |package|
+  package.gem_spec = spec
+end
+
+desc 'Run :package and install the resulting .gem'
+task :install => :package do
+  sh %{#{SUDO} gem install --local pkg/#{NAME}-#{SwxRuby::VERSION}.gem --no-rdoc --no-ri}
+end
+
+desc 'Run :clean and uninstall the .gem'
+task :uninstall => :clean do
+  sh %{#{SUDO} gem uninstall #{NAME}}
+end
+
+# ==================
+# = Documentation  =
+# ==================
+Rake::RDocTask.new(:rdoc) do |rd|    
+  rd.main = 'README' # 'name' will be the initial page displayed
+  rd.rdoc_dir = 'doc' # set the output directory
+  rd.rdoc_files.add(['README', 'LICENSE', 'CHANGELOG', 'lib/**/*.rb', 'examples/**/*.rb']) # List of files to include in the rdoc generation
+  rd.title = 'SWX Ruby: The Ruby Implementation of SWX RPC' # Title of the RDoc documentation
+  rd.options << '--inline-source' # Show method source code inline, rather than via a popup link
+  rd.options << '--line-numbers' # Include line numbers in the source code
+  # rd.template = "html" # Name of the template to be used by rdoc
+  # rd.options << "--accessor accessorname[,..]" # comma separated list of additional class methods that should be treated like 'attr_reader' and friends.
+  # rd.options << "--all" # include all methods (not just public) in the output
+  # rd.options << "--charset charset" # specifies HTML character-set
+  # rd.options << "--debug" # displays lots on internal stuff
+  # rd.options << "--diagram" # Generate diagrams showing modules and classes using dot.
+  # rd.options << "--exclude pattern" # do not process files or directories matching pattern unless they're explicitly included
+  # rd.options << "--extension new=old" #  Treat files ending with .new as if they ended with .old
+  # rd.options << "--fileboxes" # classes are put in boxes which represents files, where these classes reside.
+  # rd.options << "--force-update" # forces to scan all sources even if newer than the flag file.
+  # rd.options << "--fmt format name" # set the output formatter (html, chm, ri, xml)
+  # rd.options << "--image-format gif/png/jpg/jpeg" # Sets output image format for diagrams. Default is png.
+  # rd.options << "--include dir[,dir...]" #  set (or add to) the list of directories to be searched.
+  # rd.options << "--merge" # when creating ri output, merge processed classes into previously documented classes of the name name
+  # rd.options << "--one-file" # put all the output into a single file
+  # rd.options << "--opname name" # Set the 'name' of the output. Has no effect for HTML format.
+  # rd.options << "--promiscuous" # Show module/class in the files page.
+  # rd.options << "--quiet" #  don't show progress as we parse
+  # rd.options << "--ri" # generate output for use by 'ri.' local
+  # rd.options << "--ri-site" # generate output for use by 'ri.' sitewide
+  # rd.options << "--ri-system" # generate output for use by 'ri.' system wide, for Ruby installs.
+  # rd.options << "--show-hash" # A name of the form #name in a comment is a possible hyperlink to an instance method name. When displayed, the '#' is removed unless this option is specified
+  # rd.options << "--style stylesheet url" # specifies the URL of a separate stylesheet.
+  # rd.options << "--tab-width n" # Set the width of tab characters (default 8)
+  # rd.options << "--webcvs url" # Specify a URL for linking to a web frontend to CVS.    
+end
+
+desc 'Sync docs at swxruby.org'
+task :sync_docs => :rdoc do
+  sh('rsync -avz ./doc/* meekish@swxruby.org:/var/www/www.swxruby.org/web/docs/')
+end
+
+# =========
+# = Specs =
+# =========
+desc 'Run all specs'
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ['--format', 'specdoc', '--colour']
+  # t.libs = ["lib", "server/lib" ]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end

data/bin/swxruby

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+
+OPTIONS = {}
+MANDATORY_OPTIONS = %w(rails_dir)
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Usage: #{File.basename($0)} [options]
+
+Description:
+  This script will install the SWX Ruby Rails plugin in your Rails application.
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on('--rails RAILS_DIR',
+          "The root of your Rails application") { |rails_dir| OPTIONS[:rails_dir] = rails_dir }
+  opts.on('--essentials',
+          "Don't unpack example service classes") { OPTIONS[:essentials] = true }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+
+# =====================================
+# = Install the SWX Ruby Rails plugin =
+# =====================================
+require 'fileutils'
+include FileUtils
+
+RAILS_ROOT = File.expand_path(OPTIONS[:rails_dir])
+SWX_RUBY_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+unless File.exist?("#{RAILS_ROOT}/vendor/plugins/swxruby")
+	puts '*** Creating vendor/plugins/swxruby directory ***'
+  mkdir("#{RAILS_ROOT}/vendor/plugins/swxruby")
+end
+
+unless File.exist?("#{RAILS_ROOT}/vendor/plugins/swxruby/init.rb")
+	puts '*** Copying initialisation file to vendor/plugins/swxruby/init.rb ***'
+  cp(File.join(SWX_RUBY_ROOT, 'init.rb'), "#{RAILS_ROOT}/vendor/plugins/swxruby/init.rb")
+end
+
+ESSENTIALS = OPTIONS[:essentials]
+require File.join(SWX_RUBY_ROOT, 'install.rb')

data/examples/standalone/standalone.rb

@@ -0,0 +1,37 @@
+# = Merb Standalone SWX Ruby Server
+# 
+# An example of how simple it is to build a standalone SWX Ruby server using Merb.
+# 
+# == Prerequisites
+# 
+# * SWX Ruby Gem (gem install swxruby)
+# * merb-core 0.9.1 or later (gem install merb-core)
+# 
+# == Take it for a spin
+# 
+# * Open a terminal in the examples/standalone directory and execute 'merb -I standalone.rb' to fire up the Merb server.
+# * Open standalone.fla in Flash 8 or later.
+# * Publish Preview (ctrl+enter on Windows; cmd+enter on OS X).
+# * Watch as the output panel begins tracing "Hello from Merb!".
+require 'rubygems'
+require 'swxruby'
+
+# =================
+# = Service Class =
+# =================
+class SwxServiceClasses::HelloMerb
+  def just_say_the_words
+    'Hello from Merb!'
+  end
+end
+
+# ====================
+# = Merb Application =
+# ====================
+Merb::Router.prepare { |r| r.match('/').to(:controller => 'swx_ruby_controller', :action =>'gateway') }
+
+class SwxRubyController < Merb::Controller
+  def gateway
+    send_data(SwxGateway.process(params), :filename => 'data.swf', :type => 'application/swf')
+  end
+end

data/init.rb

@@ -0,0 +1,22 @@
+begin
+  require 'rubygems'
+  require 'swxruby'
+rescue
+  # If the swxruby gem isn't installed, assume this plugin installation is
+  # running from a checkout of trunk and fail silently.
+end
+require 'swx_gateway'
+require 'yaml'
+
+# Tell SwxGateway where app root and config file are located
+SwxGateway.app_root = RAILS_ROOT
+SwxGateway.swx_config = YAML.load_file(File.join(RAILS_ROOT, 'config', 'swx.yml'))
+
+# Load the service classes
+SwxGateway.init_service_classes
+
+# Initialize Rails controller integration (render :swx  => 'my data')
+require 'rails_integration/render_decorator'
+
+# Register the SWX mime tytpe
+Mime::Type.register "application/swf", :swx

data/install.rb

@@ -0,0 +1,69 @@
+# Taken from Railties
+def gsub_file(relative_destination, regexp, *args, &block)
+  path = relative_destination
+  content = File.read(path).gsub(regexp, *args, &block)
+  File.open(path, 'wb') { |file| file.write(content) }
+end
+
+SWX_RUBY_ROOT ||= File.expand_path(File.dirname(__FILE__))
+readme = IO.readlines(File.join(SWX_RUBY_ROOT, 'README'))
+@rails_usage = readme.slice(readme.index("=== Rails Plugin Usage\n")..-1)
+
+begin
+  require 'fileutils'
+	include FileUtils
+  
+	# Copy config file
+  unless File.exist?("#{RAILS_ROOT}/config/swx.yml")
+		puts '*** Copying config file to config/swx.yml ***'
+    cp(File.join(SWX_RUBY_ROOT, 'lib', 'swxruby', 'rails_integration', 'swx.yml'), "#{RAILS_ROOT}/config/swx.yml")
+  end
+
+	# Copy SWX controller
+	unless File.exist?("#{RAILS_ROOT}/app/controllers/swx_controller.rb")
+		puts '*** Copying SWX controller to app/controllers/swx_controller.rb ***'
+	  cp(File.join(SWX_RUBY_ROOT, 'lib', 'swxruby', 'rails_integration', 'swx_controller.rb'), "#{RAILS_ROOT}/app/controllers/swx_controller.rb")
+	end
+	
+	# Create services directory
+	unless File.exist?("#{RAILS_ROOT}/app/services")
+		puts '*** Creating services directory at app/services ***'
+		mkdir("#{RAILS_ROOT}/app/services")
+	end
+
+	unless ESSENTIALS
+  	# Copy TestDataTypes class to app/services
+  	unless File.exist?("#{RAILS_ROOT}/app/services/test_data_types.rb")
+  		puts '*** Copying TestDataTypes service class to app/services ***'
+  		cp(File.join(SWX_RUBY_ROOT, 'lib', 'swxruby', 'services', 'test_data_types.rb'), "#{RAILS_ROOT}/app/services/test_data_types.rb")
+  	end
+	
+  	# Copy HelloWorld class to app/services
+  	unless File.exist?("#{RAILS_ROOT}/app/services/hello_world.rb")
+  		puts '*** Copying HelloWorld service class to app/services ***'
+  		cp(File.join(SWX_RUBY_ROOT, 'lib', 'swxruby', 'services', 'hello_world.rb'), "#{RAILS_ROOT}/app/services/hello_world.rb")
+  	end
+	end
+	
+	# Add route for SWX gateway to routes.rb
+	puts '*** Adding route for SWX gateway to routes.rb ***'
+	sentinel = 'ActionController::Routing::Routes.draw do |map|'
+	gsub_file "#{RAILS_ROOT}/config/routes.rb", /(#{Regexp.escape(sentinel)})/mi do |match|
+	  "#{match}\n  map.swx '/swx', :controller => 'swx', :action => 'gateway'\n"
+	end
+
+	# Check for installation of JSON gem
+	print '*** Checking if JSON gem is installed'
+	require 'rubygems'
+	require 'json'
+	puts ': JSON gem detected ***'
+	
+	puts @rails_usage
+rescue LoadError
+	puts @rails_usage
+	
+	puts '!!!!! You do not have the JSON gem installed. SWX Ruby will not function without it.'
+	puts '!!!!! Please "gem install json" to get the JSON gem, then SWX Ruby should be ready to roll.'
+rescue Exception => e
+  puts 'ERROR INSTALLING SWX Ruby: ' + e.message
+end