rhoconnect 3.1.2 → 3.2.0.beta1

data/commands/commands/rhoconnect/spec.rb

@@ -0,0 +1,15 @@
+Execute.define_task do
+  begin
+    require 'rspec/core/rake_task'
+    desc "spec", "Run source adapter specs"
+    def spec
+      files = File.join('spec','**','*_spec.rb')
+      RSpec::Core::RakeTask.new('rhoconnect:spec') do |t|
+        t.pattern = FileList[files]
+        t.rspec_opts = %w(-fn -b --color)
+      end #do
+      end #spec
+    rescue Exception => e
+      puts "Run source adapter specs error: #{e.inspect}"
+    end #begin
+  end #do

data/commands/commands/rhoconnect/start.rb

@@ -0,0 +1,18 @@
+Execute.define_task do
+  desc "start", "Start rhoconnect server"
+  def start
+    invoke :dtach_installed
+    command = (jruby?) ? trinidad? : (thin? || mongrel? || report_missing_server)
+    if windows?
+      puts 'Starting rhoconnect...'
+      system("#{command} config.ru -P #{rhoconnect_pid}")
+    elsif jruby?
+      puts 'Starting rhoconnect in jruby environment...'
+      system("#{command}")
+    else
+      puts 'Detach with Ctrl+\  Re-attach with rhoconnect attach'
+      sleep 2
+      cmd "dtach -A #{rhoconnect_socket} #{command} config.ru -P #{rhoconnect_pid}"
+    end #if
+  end #start
+end #do

data/commands/commands/rhoconnect/startbg.rb

@@ -0,0 +1,34 @@
+require 'thor/group'
+
+# NOTE: On Windows Process.fork is implemented in a way
+# that it re-starts the parent command with an additional "child#0"
+# argument. Naturally, this leads to Thor rejecting that 2nd invocation
+# since the original command is not supposed to have arguments.
+# To overcome this issue all Background commands
+# should be inside their own Thor::Group-derived class 
+# which declares an additional optional argument (which is not used)
+# but exists merely to support Windows Process.fork artificial implementation
+class StartBg < Thor::Group
+  argument :childname, :optional => true
+  #desc "startbg", "Start rhoconnect server in bg mode (Rhostudio) - this is an internal command"
+  def startbg
+    cmd = (jruby?) ? trinidad? : (thin? || mongrel? || report_missing_server)
+    require 'win32/process' if windows?
+    
+    p1 = Process.fork {  
+      if windows?
+        puts 'Starting rhoconnect ...'
+        system("#{cmd} config.ru -P #{rhoconnect_pid}")
+      elsif jruby?
+        puts 'Starting rhoconnect in jruby environment...'
+        system("#{cmd}")
+      else
+        system("bundle exec #{cmd} config.ru -P #{rhoconnect_pid}")
+      end
+    }
+    Process.detach(p1)
+    
+    exit
+  end #startbg
+end
+Execute.register StartBg, "startbg", "startbg", "Start rhoconnect server in bg mode (Rhostudio) - this is an internal command", :hide => true

data/commands/commands/rhoconnect/startdebug.rb

@@ -0,0 +1,35 @@
+require 'thor/group'
+
+# NOTE: On Windows Process.fork is implemented in a way
+# that it re-starts the parent command with an additional "child#0"
+# argument. Naturally, this leads to Thor rejecting that 2nd invocation
+# since the original command is not supposed to have arguments.
+# To overcome this issue all Background commands
+# should be inside their own Thor::Group-derived class 
+# which declares an additional optional argument (which is not used)
+# but exists merely to support Windows Process.fork artificial implementation
+class StartDebug < Thor::Group
+  argument :childname, :optional => true
+  #desc "startdebug", "Start rhoconnect server in debug mode (Rhostudio) - this is an internal command", :hide => true
+  def startdebug
+    cmd = (jruby?) ? trinidad? : (thin? || mongrel? || report_missing_server)
+    ENV['DEBUG'] = 'yes'
+    require 'win32/process' if windows?
+    
+    p1 = Process.fork {  
+      if windows?
+        puts 'Starting rhoconnect ...'
+        system("#{cmd} config.ru -P #{rhoconnect_pid}")
+      elsif jruby?
+        puts 'Starting rhoconnect in jruby environment...'
+        system("#{cmd}")
+      else
+        system("bundle exec #{cmd} config.ru -P #{rhoconnect_pid}")
+      end
+    }
+    Process.detach(p1)
+
+    exit
+  end #startdebug
+end
+Execute.register StartDebug, "startdebug", "startdebug", "Start rhoconnect server in debug mode (Rhostudio) - this is an internal command", :hide => true

data/commands/commands/rhoconnect/stop.rb

@@ -0,0 +1,11 @@
+Execute.define_task do
+  desc "stop", "Stop rhoconnect server"
+  def stop
+    invoke :dtach_installed
+    if windows?
+      File.delete "#{rhoconnect_pid}" if system("FOR /F %A in (#{rhoconnect_pid}) do taskkill /F /PID %A")
+    else
+      cmd "cat #{rhoconnect_pid} | xargs kill -3"
+    end #if
+  end #stop
+end #do

data/commands/commands/rhoconnect/war.rb

@@ -0,0 +1,32 @@
+Execute.define_task do
+  desc "war", "Build executable WAR file to be used in Java App Servers"
+  def war
+    if jruby? then
+      puts "building the WAR file"
+      if not File::exists? "config/warble.rb"
+        puts "generating Warbler's config file"
+        includeDirs = []
+        Dir.mkdir('config') if not File.exists?('config')
+        aFile = File.new("config/warble.rb", "w+")
+        if aFile
+          includeDirs = FileList['*'].exclude do |entry|
+            entry if (not File.directory? entry) || (entry == 'spec')
+          end #if
+          configFile = "Warbler::Config.new do |config|\n" +
+            "config.dirs = %w(#{includeDirs.join(' ')})\n" +
+            "config.includes = FileList[\"./*\"]\n" +
+            "config.excludes = FileList[\"./*.war\",'spec']\nend"
+          aFile.write("#{configFile}")
+          aFile.close
+        else
+          puts "Unable to create config/warble.rb file!"
+        end #if
+      end #if
+      # build the executable WAR using the config/warble.rb file
+      ENV['BUNDLE_WITHOUT'] = ['development','test'].join(':')
+      sh 'warble executable war'
+    else
+      puts "Cannot build WAR files outside of JRuby environment!"
+    end #if
+  end #war
+end #do

data/commands/commands/rhoconnect/web.rb

@@ -0,0 +1,7 @@
+Execute.define_task do
+  desc "web", "Launch the web console in a browser - uses :syncserver: in settings.yml"
+  def web
+  	invoke :config
+    windows? ? sh("start #{$url}") : sh("open #{$url}")
+  end #web
+end #do

data/commands/execute.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require 'json'
+require 'zip/zip'
+require 'uri'
+require 'find'
+$:.unshift File.join(File.dirname(__FILE__), '.')
+$:.unshift File.join(File.dirname(__FILE__), '..')
+require 'lib/rhoconnect/utilities'
+require 'lib/rhoconnect'
+require 'lib/rhoconnect/console/rhoconnect_api'
+
+include Utilities
+
+TASK_DIRS = ['generators', 'commands', 'utilities']
+
+class Execute < Thor
+  # Methods
+  no_tasks {
+    def self.define_task(&block)
+      Execute.class_eval &block
+    end
+  }
+  # Require all tasks defined in the tasks directories
+  TASK_DIRS.each do |dir|
+    Find.find("#{File.expand_path(File.dirname(__FILE__))}/#{dir}") do |path|
+      if !File.directory? path and
+         File.extname(path) == '.rb'
+        require path
+      end #if
+    end #do
+  end #do
+end #Execute

data/commands/generators/app.rb

@@ -0,0 +1,6 @@
+Execute.define_task do
+  desc "app NAME", "Generates a new rhoconnect application."
+  def app(name)
+    Rhoconnect.run_cli(Dir.pwd, 'thorhoconnect', Rhoconnect::VERSION, ARGV)
+  end #app
+end #do

data/commands/generators/source.rb

@@ -0,0 +1,6 @@
+Execute.define_task do
+  desc "source NAME", "Generates a new source adapter."
+  def source(name)
+    Rhoconnect.run_cli(Dir.pwd, 'thorhoconnect', Rhoconnect::VERSION, ARGV)
+  end #source
+end #do

data/commands/utilities/dtach_installed.rb

@@ -0,0 +1,10 @@
+Execute.define_task do
+  desc "dtach_installed", "Check if dtach is installed.", :hide => true
+  def dtach_installed
+    if !windows? and (`which dtach` == '')
+      puts "WARNING: dtach not installed or not on path, some tasks will not work!"
+      puts "  Install with '[sudo] rhoconnect dtach-install'"
+      exit
+    end
+  end #dtach_installed
+end #do

data/doc/benchmarks-running.txt

@@ -54,6 +54,11 @@ To execute the Rhoconnect Benchmark test, use the `rhoconnect-benchmark` command
 		<td width="200"><code>--maxclientloops NUMBER</code></td>
 		<td>This option runs several tests in a loop varying number of concurrent clients between 1 and NUMBER. The specified interval will be split by 5. For example: -m 10 will produce 5 test executions , first for 1 client, then - for 3, 6, 8, and 10</td>
 	</tr>
+	<tr>
+		<td width="20">-S</td>
+		<td width="200"><code>--simtime NUMBER</code></td>
+		<td>This option allows to enforce NUMBER of seconds delay in the source adapter, thus simulating the backend communication round-trip.</td>
+	</tr>
 	<tr>
 		<td width="20">-A</td>
 		<td width="200"><code>--advanced</code></td>

data/doc/command-line.txt

@@ -17,42 +17,28 @@ Enter the name for your RhoConnect application in Project name. You may specify
 
 ## Generating a RhoConnect App from the Command Line
 
-The `rhoconnect` utility is a command line tool for generating RhoConnect applications and sources.
+The `rhoconnect` utility is a command line tool for generating RhoConnect applications and source adapters.
 
-The app name is passed as a parameter.  The `rhoconnect` utility will generate a directory for your application with all the necessary files to get started.  We will start with running `rhoconnect app` to see the usage:
+The app name is passed as a parameter.  The `rhoconnect` utility will generate a directory for your application with all the necessary files to get started.  We will start with running `rhoconnect help app` to see the usage:
 
 	:::term
-	Usage: rhoconnect app [options] [args]
+	Usage:
+		rhoconnect app NAME
 
 	Generates a new rhoconnect application.
 
-	Required:
-	  name        - application name
-
-
-	Options specific for this generator:
-
-	General options:
-	    -p, --pretend                    Run, but do not make any changes.
-	    -f, --force                      Overwrite files that already exist.
-	    -s, --skip                       Skip files that already exist.
-	    -d, --delete                     Delete files that have previously been generated with this generator.
-	        --no-color                   Don't colorize the output
-	    -h, --help                       Show this message
-	        --debug                      Do not catch errors
-
 For example:
 
 	:::term
 	$ rhoconnect app storeserver
 	Generating with app generator:
-	     [ADDED]  storeserver/config.ru
-	     [ADDED]  storeserver/settings/settings.yml
-	     [ADDED]  storeserver/settings/license.key
-	     [ADDED]  storeserver/application.rb
-	     [ADDED]  storeserver/Rakefile
-	     [ADDED]  storeserver/Gemfile
-	     [ADDED]  storeserver/spec/spec_helper.rb
+			 [ADDED]  storeserver/config.ru
+			 [ADDED]  storeserver/settings/settings.yml
+			 [ADDED]  storeserver/settings/license.key
+			 [ADDED]  storeserver/application.rb
+			 [ADDED]  storeserver/Rakefile
+			 [ADDED]  storeserver/Gemfile
+			 [ADDED]  storeserver/spec/spec_helper.rb
 	
 Here's a basic rundown of each of the files that were just generated:
 	
@@ -71,7 +57,8 @@ After generating the application, you might be asked to change directories to yo
 	$ cd storeserver
 	$ bundle install
 
-## Rake Tasks
+## Rake Tasks (Rhoconnect v.3.1 and lower)
+<span class="label label-important">As of version 4.0 of rhoconnect rake tasks will be deprecated!!</span> 
 
 Each RhoConnect application uses [rake](https://github.com/jimweirich/rake) to manage development tasks such as starting/stopping the app, starting resque workers, and running specs.
 
@@ -83,7 +70,7 @@ If you're using MacOS / Linux, install [dtach](http://dtach.sourceforge.net/) on
 
 	:::term
 	$ cd storeserver
- 	$ [sudo] rake dtach:install
+	$ [sudo] rake dtach:install
 
 ### Setup Redis
 
@@ -195,6 +182,208 @@ Here is a complete list of the rake tasks available in a RhoConnect application:
 	rake rhoconnect:war                 # Build executable WAR file to be used in Java App Servers
 	rake rhoconnect:web                 # Launch the web console in a browser - uses :syncserver: in settings.yml
 
+## Rhoconnect CLI (Rhoconnect v.3.2+)
+In rhoconnect versions 3.2 and higher the rake utility has been replaced using a ruby utility called [thor](https://github.com/wycats/thor).  
+Using this utility we are able to route all rake-like tasks through a custom command-line interface.  All tasks now are used via the 
+rhoconnect gem's cli. In doing this we have also combined the app and source generators into the same command making it unnecessary to switch
+from rhoconnect to rake at any point, simply use `rhoconnect` throughout.
+
+To issue commands this way simply type rhoconnect followed by the task you wish to perform.  To see a list of all the tasks you can issue with
+rhoconnect, simply type `rhoconnect` or `rhoconnect help`.
+
+	:::term
+	$ rhoconnect help
+	Tasks:
+	  rhoconnect app NAME               # Generates a new rhoconnect application.
+	  rhoconnect attach                 # Attach to rhoconnect console
+	  rhoconnect clean-start            # Clean rhoconnect, get token, and create new user
+	  rhoconnect create-user            # Creates and subscribes user for application in rhoconnect
+	  rhoconnect delete-device          # Deletes a device from rhoconnect
+	  rhoconnect delete-user            # Deletes a user from rhoconnect
+	  rhoconnect dtach-about            # About dtach
+	  rhoconnect dtach-install          # Install dtach 0.8 from source
+	  rhoconnect flushdb                # Flush data store - WARNING: THIS REMOVES ALL DATA IN RHOCONNECT
+	  rhoconnect get-token              # Fetches current api token from rhoconnect
+	  rhoconnect help [TASK]            # Describe available tasks or one specific task
+	  rhoconnect redis-about            # About redis
+	  rhoconnect redis-attach           # Attach to redis dtach socket
+	  rhoconnect redis-download         # Download redis package
+	  rhoconnect redis-install          # Install the latest verison of Redis from Github (requires git, duh)
+	  rhoconnect redis-restart          # Restart redis
+	  rhoconnect redis-start            # Start redis
+	  rhoconnect redis-stop             # Stop redis
+	  rhoconnect reset                  # Reset the rhoconnect database (you will need to run rhoconnect:get_token afterwards)
+	  rhoconnect reset-refresh          # Reset source refresh time
+	  rhoconnect restart                # Alias for `rhoconnect stop; rhoconnect start`
+	  rhoconnect secret                 # Generate a cryptographically secure secret session key
+	  rhoconnect set-admin-password     # Sets the admin password
+	  rhoconnect source NAME            # Generates a new source adapter.
+	  rhoconnect spec                   # Run source adapter specs
+	  rhoconnect start                  # Start rhoconnect server
+	  rhoconnect stop                   # Stop rhoconnect server
+	  rhoconnect war                    # Build executable WAR file to be used in Java App Servers
+	  rhoconnect web                    # Launch the web console in a browser - uses :syncserver: in settings.yml
+
+### Installing DTach (Mac OS / Linux only)
+
+If you're using MacOS / Linux, install [dtach](http://dtach.sourceforge.net/) on your path before running any of the rake tasks.  [DTach](http://dtach.sourceforge.net/) is a simple utility which runs processes in a detached state so you can re-attach your console later.
+
+	:::term
+	$ cd storeserver
+	$ rhoconnect dtach-install
+
+### Setup Redis
+
+Next, you will need to setup and start a [redis](http://redis.io/) server:
+
+	:::term
+	$ rhoconnect redis-install
+	$ rhoconnect redis-start
+
+The server will show that it is running on the console.
+
+### Start the Application
+
+Open a new console window (since the redis server is running in the previous console window). Then change directories to your rhoconnect applciation and start the application.
+
+	:::term
+	$ cd storeserver
+	$ rhoconnect start
+
+If everything went well, you should see the following in your console:
+
+	[05:47:10 PM 2011-04-19] Rhoconnect Server v3.0.0 started...
+	
+To open the web console, navigate to [http://localhost:9292/](http://localhost:9292) in your browser or run:
+
+	:::term
+	$ rhoconnect web
+	
+### Creating executable WAR containers (JRuby environment only)
+
+It is possible to create Java WAR containers for your Rhoconnect application that can be deployed into the
+Java App Servers (for example, JBoss). To create the executable WAR container, execute the following command in your app's root directory:
+	
+	:::term
+	$ cd storeserver
+	$ rhoconnect war
+	
+This will build the WAR file named <your_app>.war that can be deployed into the Java App Server.
+
+
+Below is provided a list of rake tasks and their corresponding rhoconnect command.
+
+<table border="1", cellpadding="5", width="100%">
+	<tr>
+		<th>rake Command</th>
+		<th>rhoconnect command</th>
+	</tr>
+	<tr>
+		<td>rake -T</td>
+		<td>rhoconnect help</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:attach</td>
+		<td>rhoconnect attach</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:clean_start</td>
+		<td>rhoconnect clean-start</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:reate_user</td>
+		<td>rhoconnect create-user</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:delete_device</td>
+		<td>rhoconnect delete-device</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:delete_user</td>
+		<td>rhoconnect delete-user</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:flushdb</td>
+		<td>rhoconnect flushdb</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:get_token</td>
+		<td>rhoconnect get-token</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:reset</td>
+		<td>rhoconnect reset</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:reset_refresh</td>
+		<td>rhoconnect reset-refresh</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:restart</td>
+		<td>rhoconnect restart</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:set_admin_password</td>
+		<td>rhoconnect set-admin-password</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:spec</td>
+		<td>rhoconnect spec</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:start</td>
+		<td>rhoconnect start</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:stop</td>
+		<td>rhoconnect stop</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:war</td>
+		<td>rhoconnect war</td>
+	</tr>
+	<tr>
+		<td>rake rhoconnect:web</td>
+		<td>rhoconnect web</td>
+	</tr>
+	<tr>
+		<td>rake dtach:about</td>
+		<td>rhoconnect dtach-about</td>
+	</tr>
+	<tr>
+		<td>rake dtach:install</td>
+		<td>rhoconnect dtach-install</td>
+	</tr>
+	<tr>
+		<td>rake redis:about</td>
+		<td>rhoconnect redis-about</td>
+	</tr>
+	<tr>
+		<td>rake redis:attach</td>
+		<td>rhoconnect redis-attach</td>
+	</tr>
+	<tr>
+		<td>rake redis:download</td>
+		<td>rhoconnect redis-download</td>
+	</tr>
+	<tr>
+		<td>rake redis:install</td>
+		<td>rhoconnect redis-install</td>
+	</tr>
+	<tr>
+		<td>rake redis:restart</td>
+		<td>rhoconnect redis-restart</td>
+	</tr>
+	<tr>
+		<td>rake redis:start</td>
+		<td>rhoconnect redis-start</td>
+	</tr>
+	<tr>
+		<td>rake redis:stop</td>
+		<td>rhoconnect redis-stop</td>
+	</tr>
+</table>
+
 ## Generate Source
 
 Connecting to a backend service with RhoConnect requires that you write a small amount of code for the query, create, update and delete operations of your particular enterprise backend. The collection of the code for these operations is called a source. You can create source for your RhoConnect application two ways:

data/doc/heroku-addon.txt

@@ -28,7 +28,7 @@ RhoConnect is now setup with your backend service.
 
 Connecting a simple rhodes app
 -------------------------------
-To view a full tutorial about creating a rhodes application and the features of rhodes see [Rhodes framework](http://docs.rhomobile.com/rhodes/tutorial).
+To view a full tutorial about creating a rhodes application and the features of rhodes see [RhoStudio tutorial](http://docs.rhomobile.com/rhostudio.tutorial).
 
 ##Gem installation:
 

data/doc/preparing-production.txt

@@ -35,7 +35,7 @@ Then plug this secret into your `config.ru`:
 
 	:::ruby
 	Rhoconnect::Server.set     :secret, '040a2355475e9d0fb591ef78d5b9ca61a34cbcfd3f11942b18bc1d91f1ca66c27b2e0386333843a7efa29f40fff03624cd908d0883364ffbfa3208ab23fa2664'
-
+ 
 To run RhoConnect in production mode, use `RACK_ENV` environment variable set to "production".  This ensures RhoConnect will use the `:production` section of the settings.  For example:
 
 	:::term
@@ -45,6 +45,24 @@ Will start thin in with `RACK_ENV` set to "production".
 
 NOTE: If you deploy using passenger or on RhoHub, this variable is automatically set to production.
 
+### Asynchronous processing
+
+RhoConnect version 3.2.x introduces a new feature which enables asynchronous processing of the incoming requests to improve the responsiveness of the Rhoconnect application using EventMachine, Fibers API, and Rack Fiber Pool. This new feature is available with Ruby 1.9.x and enabled by default. It is not available with Ruby 1.8.7, JRuby and REE.
+To disable the feature and revert back to synchronous handling, you can use the following options in the `config.ru` file: 
+
+    :::ruby
+    Rhoconnect::Server.set     :use_async_model, false # true by default
+
+By default, the Rhoconnect application is started with Rack FiberPool's size equal to 100 and EventMachine's thread pool size set to 20. To adjust those settings you can use the following options: 
+
+	:::ruby
+	# adjust the Rack FiberPool size
+    Rhoconnect::Server.set     :fiberpool_size, 50     # default is 100
+
+	# adjust the EventMachine Thread Pool size
+	EventMachine.threadpool_size = 25 # default is 20
+
+
 ## settings/settings.yml
 This file contains all source adapter options and settings like the redis server connection.  Before deploying to production, make sure you have the appropriate production settings:
 
@@ -61,3 +79,4 @@ This file contains all source adapter options and settings like the redis server
 ## settings/license.key
 This contains your RhoConnect license key text.  By default, a RhoConnect application comes with a 10 device license.  Please see the [licensing page](/rhoconnect/licensing) for more details.
 
+