rhoconnect 4.0.0 → 4.0.1

data/doc/authentication.txt

@@ -113,7 +113,7 @@ Inside of your rhoconnect app you can replace the password parameter with a pem
         puts "socket connected correctly"
         return true
       else
-        puts "socket failed to connnect"
+        puts "socket failed to connect"
         return false
       end
       

data/doc/command-line.txt

@@ -78,7 +78,7 @@ rhoconnect, type `rhoconnect` or `rhoconnect help`.
 	  rhoconnect redis-about            # About redis
 	  rhoconnect redis-attach           # Attach to redis dtach socket
 	  rhoconnect redis-download         # Download redis release 2.6.11
-	  rhoconnect redis-install          # Install the latest verison of Redis from Github (requires git, duh)
+	  rhoconnect redis-install          # Install the latest version of Redis from Github (requires git, duh)
 	  rhoconnect redis-restart          # Restart redis on localhost
 	  rhoconnect redis-start            # Start redis on localhost
 	  rhoconnect redis-status           # Show status of redis servers

data/doc/deploying.txt

@@ -10,9 +10,9 @@ for Ubuntu and CentOS respectively. At this moment supported formats are Debian
 
 Every package provides the following components:
 
-* Ruby 1.9.3-p392
+* Ruby, version 1.9.3
 
-* Node.js, version v0.10.4
+* Node.js, version v0.10.x
 
 * Nginx HTTP server, release 1.3.x
 

data/doc/migration.txt

@@ -10,7 +10,7 @@ However, if you prefer to migrate your RhoConnect app manually, perform the step
 Open the `Gemfile` of your application and find the `rhoconnect` line, it should look something like:
 
 	:::ruby
-	gem 'rhoconnect', '3.3.6'
+	gem 'rhoconnect', '3.4.4'
 
 Change this to the latest release version, which you can find on [rubygems.org](http://rubygems.org/gems/rhoconnect), for example if it is 4.0.1:
 
@@ -56,17 +56,17 @@ The `rhoconnect update` command will generate a reference `Gemfile.new` which yo
 
 You must update `config.ru`, `Rakefile`, 'application.rb' and your source adapter files to match RhoConnect 4.0+ gem requirements.
 
-Replace your existing `config.ru` with the listing below. Save your old `config.ru` since you will use values within it in the new `config.ru`. 
+Replace your existing `config.ru` with the listing below. Save your old `config.ru` since you will use values within it in the new `config.ru`.
 
 	:::ruby
 	# config.ru file
-	
+
 	#!/usr/bin/env ruby
 	require 'rhoconnect/application/init'
 
 	# secret is generated along with the app
 	# NOTE:
-	# Substitute 'REPLACE_ME' string by the Rhoconnect::Server.set :secret value from your old config.ru	
+	# Substitute 'REPLACE_ME' string by the Rhoconnect::Server.set :secret value from your old config.ru
 	Rhoconnect::Server.set     :secret, 'REPLACE_ME'
 
 	# !!! Add your custom initializers and overrides here !!!
@@ -78,14 +78,13 @@ Replace your existing `config.ru` with the listing below. Save your old `config.
 	#Rhoconnect.disable_rc_console = true
 
 	# run RhoConnect Application
-	run Rhoconnect.app	
+	run Rhoconnect.app
 
 And replace your existing `Rakefile` with the following:
 
 	:::ruby
 	require 'rubygems'
 	require 'bundler/setup'
-	require 'rhoconnect/tasks'
 	require 'rhoconnect'
 	require 'resque/tasks'
 
@@ -114,7 +113,7 @@ Move your existing `application.rb` file into `controllers/ruby/application_cont
     		<INSERT YOUR AUTHENTICATION CODE HERE>
   		end
 
-  		get "/rps_login", :rc_handler => :rps_authenticate, 
+  		get "/rps_login", :rc_handler => :rps_authenticate,
         	            :login_required => true do
     		login = params[:login]
     		password = params[:password]
@@ -124,13 +123,13 @@ Move your existing `application.rb` file into `controllers/ruby/application_cont
   		# <.... PLACE HERE ALL OF YOUR EXISTING APPLICATION CODE ...>
 	end
 
-NOTE: You must remove `initializer` method from the ApplicationController class. It is no longer supported. 
+NOTE: You must remove `initializer` method from the ApplicationController class. It is no longer supported.
 
-NOTE: If you had `store_blob` method overriden in the `application.rb` file - you will need to move it into the corresponding model class. Global `store_blob` method is no longer supported.
+NOTE: If you had `store_blob` method overridden in the `application.rb` file - you will need to move it into the corresponding model class. Global `store_blob` method is no longer supported.
 See below for details.
 
 Re-generate your sources by running 'rhoconnect source YOUR_SOURCE' command for all of your application sources. This will create source's controller files in the `controllers/ruby` directory
-and source's model files in the `models/ruby` directory. After that, move your existing files from the `sources` directory into the `models/ruby` directory, replacing the generated model files. 
+and source's model files in the `models/ruby` directory. After that, move your existing files from the `sources` directory into the `models/ruby` directory, replacing the generated model files.
 Then, modify every file to make sure that your SourceAdapter classes now derive from the `Rhoconnect::Model::Base` class - SourceAdapters now became Models:
 
 	:::ruby
@@ -146,10 +145,10 @@ If you had global `store_blob` method in the `application.rb` file - you need to
 		def store_blob(object, field, blob)
 			<YOUR_STORE_BLOB_IMPLEMENTATION>
 		end
-	end 
+	end
 
 If you had source spec files in the `spec/sources` directory - you will need to move them into `spec/models/ruby` directory and adjust the top line of each spec file:
-	
+
 	:::ruby
 	require File.join(File.dirname(__FILE__),'..','..','spec_helper')
 
@@ -158,3 +157,13 @@ Finally, run `bundle install` to install any missing dependencies in your RhoCon
 
 	:::term
 	$ bundle install
+
+### Updating client application
+RhoConnect's HTTP routes have changed starting with 4.0, so you'll want to update your client application's `rhoconfig.txt` to drop the trailing `/application`, for example:
+
+
+	# sync server url, typically this will look like 'http://<hostname>:<port>'
+	# for example: 'http://localhost:9292'
+	syncserver = 'http://192.168.1.108:9292'
+
+Next, modify your client application according to the new [client API docs](/api/RhoConnectClient).  Be sure to check out the [guides](/guide/using_rhoconnect) periodically as new content is added all the time.

data/doc/push-client-setup-android.txt

@@ -65,7 +65,7 @@ Register the Google API project number for your client application. Modify your
 On the Android client, it is possible to set up status bar notifications for PUSH messages. In this case, push notification can be shown on the Android status bar after ruby callback. The user can activate application by touching this notification.
 There are two modes available for push notifications:
  - <i>always</i> - push notification is shown always
- - <i>background</i> - push notification is shown only if application is backgrounded (not started)
+ - <i>background</i> - push notification is shown only if application put into the background (not started)
 If no push notification mode is specified in build.yml then no notifications are shown at all.
 
 	:::yaml

data/doc/push-client-setup-rps.txt

@@ -159,12 +159,14 @@ Then navigate to the directory containing the runtime file and run `adb install`
 
 ### Installing Runtime Apps for Windows Mobile/CE Devices
 
-If you are using a Windows Mobile or CE device, install the following runtime apps on your device.
+If you are using a Windows Mobile or CE device, install the following runtime apps on your device.  If you already have the .NET Compact Framework on your device, make sure it is v3.5 or higher.
 
 * `rhoconnect-push-service.CAB`
 * `NETCFv35.Messages.EN.wm.cab`
 * `NETCFv35.Messages.EN.cab`
 
+**NOTE: On Windows CE 7.0, you may see the following warning: "The program is not compatible with the current operating system and, therefore, may not run on this device."  You can safely ignore this warning and click the "Yes" button.**
+
 Connect your device to your Windows computer. You can use USB-cable, bluetooth or any other method. Start ActiveSync or Windows Mobile Device Center.
 
 Manually copy the .cab files to the device. For example, you can use the device File Explorer to display the .cab files that are on the computer. Click on each .cab file and the installation process will be started; after it is finished, you should see the app icon on your device in Programs.

data/doc/supported-platforms.txt

@@ -2,7 +2,7 @@ Supported Platforms
 ===
 ## Support Matrix
 
-RhoConnect gem is available on the following platforms: 
+RhoConnect gem is available on the following platforms:
 
 <table class="device-caps">
   <tr>
@@ -11,7 +11,7 @@ RhoConnect gem is available on the following platforms:
     <th>Ruby 1.9.3</th>
     <th>Ruby 2.0.0</th>
     <th>JRuby</th>
-    <th>Environment</th>    
+    <th>Environment</th>
   </tr>
   <tr>
     <td class='cap'>Linux</td>
@@ -26,7 +26,7 @@ RhoConnect gem is available on the following platforms:
     <td> Mac OS X 10.7/10.8 </td>
     <td> ruby-1.9.3-p448 </td>
     <td class='tbd'> TBD </td>
-    <td class='tbd'> jruby-1.7.3 </td>
+    <td class='tbd'> jruby-1.7.4 </td>
     <td> Development </td>
   </tr>
   <tr>
@@ -39,8 +39,8 @@ RhoConnect gem is available on the following platforms:
   </tr>
 </table>
 
-Other Ruby versions and releases might work with RhoConnect gem, but there are no guarantees.   
- 
+Other Ruby versions and releases might work with RhoConnect gem, but there are no guarantees.
+
 ## Release Notes
 
 RhoConnect for Windows is supported only in development environments. The components you should have for this environment are:
@@ -52,9 +52,9 @@ RhoConnect for Windows is supported only in development environments. The compon
 * Make 3.81
 * DevKit for Windows (or other Windows development environment)
 
-RhoConnect for Linux is supported for both development and production environments. 
+RhoConnect for Linux is supported for both development and production environments.
 On Linux servers RhoConnect is available in the format of [Debian (deb) and Red Hat (rpm) packages](http://edgedocs.rhomobile.com/rhoconnect/deploying) for Ubuntu and CentOS respectively.
-RhoConnect Mac OS X is supported in development environment. 
+RhoConnect Mac OS X is supported in development environment.
 The components you should have for this environment are:
 
 * Ruby 1.9.3
@@ -62,3 +62,10 @@ The components you should have for this environment are:
 * Redis data store (2.6.x)
 * Thin application server
 * RhoConnect gem with all required dependencies
+
+## Known issues for JRuby:
+
+* Usually JDK is shipped with only weak encryption, and that simply will not allow the proper key sizes being created by openssl. RhoConnect uses strong encryption for license keys and to function properly in JRuby environment installation of Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction policy files might be required.
+* Path to user’s gems, warbler data should not include white spaces (i.e. in user's account name).
+
+

data/examples/simple/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'rhoconnect/tasks'
 require 'rhoconnect'
 require 'resque/tasks'
 

data/generators/rhoconnect.rb

@@ -124,9 +124,21 @@ Executing 'bundle install' for the first time in your freshly baked application!
 
 _RUN_BUNDLER
 
-      puts running_bundler_first_time
-      system("bundle install --gemfile=#{destination_root}/#{name}/Gemfile")
-      puts install_gems_note
+      gem_name, gem_ver_reqs = 'rhoconnect', gem_version
+      found_gspec = Gem::Specification.find_by_name(gem_name, gem_ver_reqs)
+      puts found_gspec
+      if found_gspec
+        puts running_bundler_first_time
+        system("bundle install --gemfile=#{destination_root}/#{name}/Gemfile")
+        puts install_gems_note
+      end
+    rescue  Exception => e
+      warning_msg =  "\n" +
+        "*** Warning:  Generatior failed to run bundler.                 ***\n" +
+        "*** Install required version of rhoconnect gem, or explicitly   ***\n" +
+        "*** define in Gemfile the source to the gem using :path option. ***\n" +
+        "\n"
+      puts warning_msg
     end
   end
 

data/generators/templates/application/Rakefile

@@ -1,6 +1,5 @@
 require 'rubygems'
 require 'bundler/setup'
-require 'rhoconnect/tasks'
 require 'rhoconnect'
 require 'resque/tasks'
 
@@ -10,7 +9,7 @@ task 'resque:setup' do
   # The number of redis connections you want a job to have
   Rhoconnect.connection_pool_size = 1
   require 'rhoconnect/application/init'
-  
+
   Resque.after_fork do
     Store.reconnect
   end

data/js-adapters/ballroom.js

@@ -4,11 +4,17 @@ var redis = require('redis'),
     EventEmitter = require('events').EventEmitter,
     registerEE = new EventEmitter(),
     routes = require('./router'),
-    client_sub = redis.createClient(),
-    client_pub = redis.createClient(),
-    pub_channel = process.argv[2] + "RedisPUB",
+    redis_url = require('url').parse(process.env.REDIS_URL),
+    client_sub = redis.createClient(redis_url.port, redis_url.hostname),
+    client_pub = redis.createClient(redis_url.port, redis_url.hostname),
+    pub_channel = process.argv[2] + "-RedisPUB",
     rcHelpers = require('./rhoconnect_helpers');
 
+if(redis_url.auth) {
+  client_sub.auth(redis_url.auth.split(":")[1]);
+  client_pub.auth(redis_url.auth.split(":")[1]);
+}
+
 //define global hash functions to store callbacks, routes
 rhoconnectCallbacks = {};
 registeredRoutes = {};
@@ -16,8 +22,6 @@ registeredControllers = {};
 registeredModels = {};
 var _c_name = null;
 var _m_name = null;
-//TODO: Don't have test-specific code here
-var prefixDir = '/spec/apps/rhotestapp';
 
 //TODO: This has to be changed in the future
 // The only reason for this - on Windows Node.js
@@ -112,15 +116,19 @@ var registerHandler = function(name) {
 var register = function(){
   var controller_dir = "";
   var model_dir = "";
+  var predefined_model_dir = "";
+  var predefined_controller_dir = "";
   try{
     if(process.argv[3] == 'test' ){
-      controller_dir = process.cwd() + prefixDir + "/controllers/js/";
-      model_dir = process.cwd() + prefixDir + "/models/js/";
+      controller_dir = process.argv[4] + "/controllers/js/";
+      model_dir = process.argv[4] + "/models/js/";
     }
     else{
       controller_dir = process.cwd() + "/controllers/js/";
       model_dir = process.cwd() + "/models/js/";
     }
+    predefined_controller_dir = __dirname + "/../lib/rhoconnect/predefined_adapters/controllers/js/";
+    predefined_model_dir = __dirname + "/../lib/rhoconnect/predefined_adapters/models/js/";
     if(fs.existsSync(model_dir)){
       var modelFiles = fs.readdirSync(model_dir);
       modelFiles.forEach(function(file){
@@ -138,6 +146,23 @@ var register = function(){
         _c_name = null;
       });
     }
+    if(fs.existsSync(predefined_model_dir)){
+      var modelFiles = fs.readdirSync(predefined_model_dir);
+      modelFiles.forEach(function(file){
+        //console.log("requiring model file: " + predefined_model_dir + file);
+        var model = require(predefined_model_dir + file);
+        var functions = Object.keys(model);
+        mapModelFunctions(file.split(".")[0],functions);
+      });
+    }
+    if(fs.existsSync(predefined_controller_dir)){
+      var controllerFiles = fs.readdirSync(predefined_controller_dir);
+      controllerFiles.forEach(function(file){
+        //console.log("requiring controller file: " + predefined_controller_dir + file);
+        require(predefined_controller_dir + file);
+        _c_name = null;
+      });
+    }
   }
   catch(e){
     console.error("Error loading JavaScript files.");
@@ -201,8 +226,10 @@ function mapModelFunctions(model,functions){
 
 function loadModel(name) {
   var prefix = process.cwd();
-  if(process.argv[3] === 'test') {
-    prefix = prefix + prefixDir;
+  if(name.match(/rho_internal/g) !== null){
+    prefix = __dirname + "/../lib/rhoconnect/predefined_adapters";
+  } else if(process.argv[3] === 'test') {
+    prefix = process.argv[4];
   }
   return require(prefix + "/models/js/" + name);
 }

data/js-adapters/node.rb

@@ -24,9 +24,15 @@ module Rhoconnect
           dir  = File.expand_path(File.dirname(__FILE__))
           pwd = Dir.pwd
           node_modules = File.join(pwd,'node_modules')
-          sub_env = { "NODE_PATH" => "#{node_modules}#{File::PATH_SEPARATOR}#{pwd}#{File::PATH_SEPARATOR}#{dir}" }
+          sub_env = { 
+            "NODE_PATH" => "#{node_modules}#{File::PATH_SEPARATOR}#{pwd}#{File::PATH_SEPARATOR}#{dir}", 
+            "REDIS_URL" => Rhoconnect.redis_url 
+          }
           file = File.join(dir,"server.js")
-          args = [sub_env, "node", file, "#{$$}", Rhoconnect.environment.to_s]
+          args = [
+            sub_env, "node", file, Rhoconnect::NodeChannel::PUBSUB_IDENTIFIER, 
+            Rhoconnect.environment.to_s, Rhoconnect.base_directory
+          ]
           @pipe = IO.popen(args, "w")
           log "Starting Node.js process: #{@pipe.pid}"
           @pipe

data/js-adapters/node_channel.rb

@@ -1,5 +1,7 @@
 require 'timeout'
 require 'open-uri'
+require 'securerandom'
+
 module Rhoconnect
   class NodeChannel
     class << self
@@ -9,8 +11,9 @@ module Rhoconnect
 
     RESULT_HASH          = {}
     TIMEOUT              = 30 # seconds
-    PUB_CHANNEL          = "#{$$}RedisSUB" # pub channel must link to redis sub channel
-    SUB_CHANNEL          = "#{$$}RedisPUB" # sub channel must link to redis pub channel
+    PUBSUB_IDENTIFIER    = "#{$$}-#{SecureRandom.hex}"
+    PUB_CHANNEL          = "#{PUBSUB_IDENTIFIER}-RedisSUB" # pub channel must link to redis sub channel
+    SUB_CHANNEL          = "#{PUBSUB_IDENTIFIER}-RedisPUB" # sub channel must link to redis pub channel
     @message_thread,@redis_subscriber,@redis_publisher = nil
 
     class << self
@@ -54,7 +57,7 @@ module Rhoconnect
       end
 
       def publish_channel_and_wait(msg,curr_model)
-        unique_id = get_random_uuid
+        unique_id = get_random_identifier
         msg.merge!(:request_id => unique_id)
         RESULT_HASH[unique_id] = {}
         RESULT_HASH[unique_id][:status] = 'waiting'
@@ -77,7 +80,7 @@ module Rhoconnect
         result = {}
         num_clients = NodeChannel.redis_publisher.publish(channel,msg.to_json)
         if num_clients >= 1
-          result = NodeChannel.wait_for_result(unique_id,curr_model) if unique_id and curr_model
+          result = NodeChannel.wait_for_result(unique_id,curr_model) if unique_id
         else
           log "ERROR: Cannot communicate with Node.js process."
           if Rhoconnect.restart_node_on_error
@@ -142,7 +145,7 @@ module Rhoconnect
       def route_message(msg)
         case msg['route']
         when 'request'
-          result_id = get_random_uuid
+          result_id = get_random_identifier
           RESULT_HASH[msg['request_id']][:pending_js_requests] ||= []
           RESULT_HASH[msg['request_id']][:pending_js_requests] << result_id
           RESULT_HASH[msg['request_id']][result_id] = {}
@@ -156,7 +159,7 @@ module Rhoconnect
           else
             RESULT_HASH[msg['request_id']][:result] = msg["result"]
             pending_js_requests = RESULT_HASH[msg['request_id']][:pending_js_requests]
-            if not pending_js_requests or pending_js_requests.length == 0 
+            if not pending_js_requests or pending_js_requests.length == 0
               RESULT_HASH[msg['request_id']][:status] = 'done'
             end
           end
@@ -188,6 +191,7 @@ module Rhoconnect
             end
           else
             res = klass.send(data['function'])
+            res
           end
         else
           raise Exception.new("Method #{data['function']} not found in model #{curr_model.class.name.to_s}.")

data/js-adapters/rhoconnect_helpers.js

@@ -43,6 +43,10 @@ var Store = function(){
 		var json = this.formatJson('get_data',resp.params,callback);
 		resp.send(json);
 	};
+	this.deleteData = function(resp,callback){
+		var json = this.formatJson('delete_data',resp.params,callback);
+		resp.send(json);
+	};
 
 	this.formatJson = function(method,args,callback){
 		var json = {};

data/js-adapters/router.js

@@ -7,7 +7,6 @@ var router = function(json,send){
       try {
         var request = new Request();
         var resp1 = new Response();
-
         request.params = json['args'];
         request.header = {'request_id':json['request_id'],'route':json['route']};
         request.model = json['model'];
@@ -17,8 +16,11 @@ var router = function(json,send){
         //if calling model function directly load file first
         if(json['klss'] !== undefined){
           var model_dir = '';
-          if(process.argv[3] == 'test' ){
-            model_dir = process.cwd() + "/spec/apps/rhotestapp/models/js/";
+          if(json['klss'].match(/rho_internal/g) !== null){
+            model_dir = __dirname + "/../lib/rhoconnect/predefined_adapters/models/js/";
+          }
+          else if(process.argv[3] == 'test' ){
+            model_dir = process.argv[4] + "/models/js/";
           }
           else{
             model_dir = process.cwd() + "/models/js/";