rhoconnect 3.2.1 → 3.3.1.beta2

data/commands/commands/rhoconnect/spec.rb

@@ -4,12 +4,16 @@ Execute.define_task do
     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
+      pattern = FileList[files]
+      rspec_opts = "-fn -b --color"
+
+      cmd = "bundle exec rspec #{pattern} #{rspec_opts}"
+      puts cmd
+      exec cmd
+      # Another way run rspec examples
+      # RSpec::Core::Runner.run(pattern, $stderr, $stdout)
+    end
+  rescue Exception => e
+    puts "Run source adapter specs error: #{e.inspect}"
+  end
+end

data/commands/commands/rhoconnect/version.rb

@@ -0,0 +1,6 @@
+Execute.define_task do
+  desc "version", "Display rhoconnect version"
+  def version
+    puts Rhoconnect::VERSION
+  end
+end

data/commands/execute.rb

@@ -25,10 +25,14 @@ class Execute < Thor
   # 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'
+      if !File.directory? path and File.extname(path) == '.rb'
+        if File.basename(path, '.rb') == 'spec'
+          rspec_avail = File.exists?(File.join(Dir.pwd,'Gemfile')) && Bundler.load.specs.find{|s| s.name == 'rspec' }
+          # Drop task 'spec' if gem 'rspec' is not in the current bundle.
+          next unless rspec_avail
+        end
         require path
-      end #if
-    end #do
-  end #do
-end #Execute
+      end
+    end
+  end
+end

data/doc/deploying.txt

@@ -93,13 +93,13 @@ To test it you need to as a root user start redis, nginx, and thin servers:
 	:::term
 	$ sudo /etc/init.d/redis start
 	$ sudo /etc/init.d/nginx start
-    	$ sudo /etc/init.d/thin start
+    $ sudo /etc/init.d/thin start
 
 And verify that it's up and running by visiting application web console in your browser:
 
 	http://servername
 
-### Web and application servers configuration
+### Configuration of web and application servers
 Installer compiled and configured Nginx as reverse proxy web server (/opt/nginx) with the following settings:
 
 * Nginx start-up script (/etc/init.d/nginx)
@@ -157,6 +157,66 @@ Configuration file is generated by this command:
     :::term
     $ thin config -C /etc/thin/rhoapp.yml -c /opt/nginx/html/rhoapp/ --socket /tmp/thin.sock --servers 2 --log /opt/nginx/logs/thin.log --pid /var/run/thin.pid -e production
 
+### Development and deployment of RhoConnect applications 
+
+Packaged software does not setup automatically path to installed ruby bins and gems, so you need do it manually. Add necessary bins to the path(s) of the users who will be using this software.  You may also wish to add these items
+to your bash scripts (i.e. `~/.profile` on Ubuntu; `~/.bash_profile` on CentOS) to automatically add them upon login.
+
+    :::text
+    export PATH=/opt/rhoconnect/bin:$PATH
+
+To deploy and develop your rhoconnect app on nginx and thin servers
+
+a) Copy your rhoconnect project (lets name it as `your_rhoconnect_app`) to default location to `/opt/nginx/html` directory
+
+b) Set up for it `nginx` owner
+
+    :::term
+    $ cd /opt/nginx/html
+    $ sudo chown -R nginx:nginx your_rhoconnect_app/
+
+c) Make sure that your app is bundled properly
+    
+    :::term
+    $ cd your_rhoconnect_app
+    $ sudo /opt/rhconnect/bin/bundle install
+
+d) Configure Nginx virtual host for your rhoconnect application. For that edit the file 
+`/opt/nginx/conf/conf.d/rhoconnect.conf`, so that it reflects your specifications (root directive)
+
+    :::text
+    # ...
+    server {
+      listen      80;
+      root  /opt/nginx/html/your_rhoconnect_app/public; # Be sure your app have 'public' folder and root directive 
+                                                        # point to it!
+      # ...
+    }
+
+e) Edit Thin `/etc/thin/rhoapp.yml` configuration file directly 
+
+    :::yaml
+    ---
+    chdir: /opt/nginx/html/your_rhoconnect_app
+    # ...
+      
+  or as root user generate a new one
+   
+    :::term
+    $ env PATH=/opt/rhoconnect/bin:$PATH thin config -C /etc/thin/your_rhoconnect_app.yml \
+    -c /opt/nginx/html/your_rhoconnect_app/ \
+    --socket /tmp/thin.sock --servers 2 --log /opt/nginx/logs/thin.log \
+    --pid /var/run/thin.pid -e production
+
+f) As root user restart Nginx, and Thin servers
+   
+    :::term
+     /etc/init.d/nginx restart
+     /etc/init.d/thin restart
+
+For monitoring and troubleshooting purposes visit web console of your app and look at log files in `/opt/nginx/logs`.
+
+Also you can use RhoConnect `/opt/nginx/html/rhoapp` application as a template and modify it as you wanted. 
 
 ## Deploying into J2EE environment
 In JRuby environment, there is an option to create the WAR container for the RhoConnect app
@@ -165,9 +225,11 @@ and deploy it into the J2EE App Server.
 Deploying the WAR container varies per J2EE App Server, for JBoss it is necessary
 to place the WAR file into the server's deploy directory.
  
+## Deploying on Heroku Cedar
 
+#### Prerequisites
 
-
+* [Heroku account](https://api.heroku.com/login) and [Heroku Toolbelt](https://toolbelt.heroku.com/) 
  
 * Rhoconnect gem version >= 3.2.0
 
@@ -187,20 +249,20 @@ Create in your rhoconnect project file named `Procfile`:
 
 If your application is using resque worker, then you should specify it in the `Procfile` as well:
 
-    :::term
-    web: bundle exec thin start -p $PORT
+	:::term
+	web: bundle exec thin start -p $PORT
     worker: bundle exec rake resque:work 
 
-Now you can run your app locally 
+Now you can run your app locally:
 
-    :::term
+	:::term
     $ gem install foreman
     $ foreman start
 
 
 #### Deploy to Heroku
 Before moving your code to Git you need comment in your project's `Gemfile` declaration of `sqlite3` gem, because target 
-Heroku server has no devel libraries required to build that gem.
+Heroku server has no development libraries required to build that gem.
 
 	:::term
 	$ git init
@@ -209,21 +271,21 @@ Heroku server has no devel libraries required to build that gem.
 	$ heroku create --stack cedar
 	$ heroku addons:add redistogo:nano
 	$ git push heroku master
-    	$ heroku open
+    $ heroku open
      
 #### Monitoring app on Heroku
 Use `heroku ps` to determine the number of processes that are executing.
 Use `heroku logs` to view an aggregated list of log messages from all process types.
 
 	:::term
-    	$ heroku ps
-    	$ heroku logs
+    $ heroku ps
+    $ heroku logs
  
 #### Get connected with Rhodes client
-If you have rhodes client and wanted to sync it with rhoconnect app on Heroku, then set proper sync server URL in `rhoconfig.txt` file
+If you have a rhodes client and wanted to sync it with rhoconnect app on Heroku, then set proper `syncserver` URL in `rhoconfig.txt` file:
 
 	:::term
- 	syncserver = 'http://<your-app-here>.herokuapp.com/application'
+ 	syncserver = 'http://<your-heroku-app-here>.herokuapp.com/application'
 
 
 

data/doc/install.txt

@@ -8,11 +8,11 @@ On Linux, you install the RhoConnect gem from the command line; you can also do
 
 ## Mac OS
 
-If you're running Mac OS, download the latest [MotorolaRhoMobileSuite Installer for Macintosh](http://rhomobile.com/rhostudio-mac). This contains [Redis](http://redis.io/), [RhoConnect](/rhoconnect/introduction) and [Rhodes](/rhodes/introduction).
+If you're running Mac OS, download the latest [Motorola RhoMobile Suite Installer for Macintosh](http://rhomobile.com/rhostudio-mac). This contains [Redis](http://redis.io/), [RhoConnect](/rhoconnect/introduction) and [Rhodes](/rhodes/introduction).
 
 Although Mac OS has [Ruby](http://www.ruby-lang.org/en/) installed, the official way to install Ruby for RhoStudio is to install [Ruby Version Manager](https://rvm.io//) and then install Ruby version 1.9.3.
 
-Click on the MotorolaRhoMobileSuite Installer for Mac download file to open it. You will get a window similar to this:
+Click on the Motorola RhoMobile Suite Installer for Mac download file to open it. You will get a window similar to this:
 
 <img src="http://rhodocs.s3.amazonaws.com/rhodes-devel/rhostudio-mac-install.png" alt="RhoStudioInstaller Mac" />
 
@@ -69,7 +69,7 @@ NOTE: If you get any `no such file to load -- something` messages while running
 
 NOTE: Windows doesn't come with the necessary build tools to install gems ('make', for example). There are various ways to get these tools, but the GnuWin32 project at http://gnuwin32.sourceforge.net/ provides the tools, and can be conveniently installed via the GetGnuWin32 installer at http://sourceforge.net/projects/getgnuwin32/files/. You should follow the GetGnuWin32 instructions carefully.
 
-You can [install RhoStudio as a plugin for Eclipse](rhostudio-eclipse).
+**NOTE: Installing RhoStudio as a plugin for Eclipse is currently disabled.**
 
 RhoSimulator, which comes with RhoStudio for Mac and Windows, does not work with Linux.
 

data/doc/push-client-setup.txt

@@ -52,7 +52,7 @@ To sync all the sources with do_sync, the source name list would specified as 'a
 
 The sound file should be included in the Rhodes application bundle in the `/public/alerts` folder.
 
-### Setting up the Rhodes Client for iPhone, Android, and Blackberry
+## Setting up the Rhodes Client for iPhone, Android, and Blackberry
 
 To set up your Rhodes client for push, refer to these links for your respective platforms.
 

data/doc/rest-api.txt

@@ -36,7 +36,7 @@ All API calls will return http 200 and requested data (if applied). Otherwise, A
 ## API Methods
 
 ### `login`
-Login to the RhoConnect server.
+Before you can use RhoConnect API you should login to the RhoConnect server and get API token:
 
 	:::ruby
 	require 'rest_client'
@@ -46,23 +46,8 @@ Login to the RhoConnect server.
 	login = "rhoadmin"
 	password = ""
 
-	res = RestClient.post("#{server}/login", { :login => login, :password => password }.to_json, :content_type => :json)
+	token = RestClient.post("#{server}/login", { :login => login, :password => password }.to_json, :content_type => :json)
 
-### `get_api_token`
-Before you can use RhoConnect API you should get API token:
-
-	:::ruby
-	require 'rest_client'
-	require 'json'
-
-	server = "http://localhost:9292"
-	login = "rhoadmin"
-	password = ""
-
-	res = RestClient.post("#{server}/login", { :login => login, :password => password }.to_json, :content_type => :json)
-	rhoconnect_session_cookie = 'rhoconnect_session='  + res.cookies['rhoconnect_session']
-	token = RestClient.post("#{server}/api/get_api_token",'',{ 'Cookie' => rhoconnect_session_cookie })
-      	
 ### `get_license_info`
 Returns license information of the currently used license
 
@@ -490,14 +475,11 @@ Return content of a given document (client or source).
 	  "#{server}/api/get_db_doc", 
 	  { 
 		:api_token => token, 
-		:doc => doc, 
-		:data_type => data_type 
+		:doc => doc
 	  }.to_json, 
 	  :content_type => :json
 	).body
 
-`:data_type` should be 'string' for the documents containing single string (size or token docs); otherwise this call will return hash of hashes.
-
 ### `set_db_doc`
 Sets the content of the specified server document. Data should be either a string or hash of hashes. Data type should be set accordingly.
 If `append` flag is set to `true` , the data is appended to the current doc (if it exists) instead of replacing it.
@@ -508,8 +490,7 @@ If `append` flag is set to `true` , the data is appended to the current doc (if
 	  { 
 		:api_token => token, 
 		:doc => doc, 
-		:data => data, 
-		:data_type => data_type,
+		:data => data,
 		:append => false
 	  }.to_json, 
 	  :content_type => :json

data/doc/rhoconnect-redis-stack.txt

@@ -27,10 +27,11 @@ In the AWS Management Console, change the Region to US West (N. California).
 
 <img src="http://rhodocs.s3.amazonaws.com/rhoconnect-redis-aws/cloudformation-tab-ncalif-crop.png" alt="Cloud Formation page N California region" />
 
-We provide a public preconfigured image that contains a blank RhoConnect app:
-
- * `ami-cbc59e8e` (Us West N. California)
+We provide a few public preconfigured images that contains a blank RhoConnect app for `Us West N. California` region:
 
+ * `ami-cbc59e8e` (RhoConnect-3.1.2 with Nginx and phusion passenger)
+ * `ami-0dfca748` (RhoConnect-3.2.0 with Nginx and cluster of thin servers)
+ 
 ### Launching an Instance
 
 To create your own RhoConnect Image, launch an EC2 Image:
@@ -46,7 +47,7 @@ Click the Launch Classic Wizard radio button. Click Continue.
 ### Requesting the Instance
 
 In the Choose an AMI section, click the Community AMIs tab.
-Then paste in the AMI `ami-cbc59e8e`. When the preconfigured RhoConnect AMI appears, click Select.
+Then paste in the AMI ID, i. e. `ami-cbc59e8e`. When the preconfigured RhoConnect AMI appears, click Select.
 
 <img src="http://rhodocs.s3.amazonaws.com/rhoconnect-redis-aws/request-instances-wizard-community-AMIs.png" alt="request instances - choose AMI" />
 
@@ -76,7 +77,7 @@ Click the Add Rule button to add each port.
  * Add port 80 for HTTP.
  * Add port 6379 for redis.
 
-**NOTE:** You may use a preexisting security group if it has ports 22, 80, and 6379 open.
+**NOTE: You may use a preexisting security group if it has ports 22, 80, and 6379 open. **
 
 Enter a firewall name and a group description, then click Continue.
 
@@ -120,11 +121,21 @@ You can test the application.
 	$ sudo /etc/init.d/redis start
 	$ sudo /etc/init.d/nginx start
 
+**NOTE: If your instance based on `ami-0dfca748` (RhoConnect-3.2.0) image, then you need to do one more step:**
+
+    :::term
+    $ sudo /etc/init.d/thin start
+
 If everything is configured properly, then you can login to the RhoConnect web console in your browser by using the instance's public DNS name as the URL in your browser. When you are done, you can stop the application.
 
 	:::term
 	$ sudo /etc/init.d/nginx stop
 	$ sudo /etc/init.d/redis stop
+	
+**NOTE: Do not forget also stop cluster of thin servers if your instance based on `ami-0dfca748` (RhoConnect-3.2.0):**
+
+    :::term
+    $ sudo /etc/init.d/thin stop
 
 ## Create the Image
 
@@ -168,15 +179,23 @@ Now get the template by either providing the URL for the template file, or by up
 
 Click the Provide a Template URL radio button.
 
-Copy the following URL and paste it into the text field below the Provide a Template URL radio button.
+If your custom image based on `ami-cbc59e8e`(RhoConnect-3.1.2) image, then copy the following URL and paste it into the text field below the Provide a Template URL radio button:
 
 `https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template.txt`
 
+If your custom image based on `ami-0dfca748` (RhoConnect-3.2.0), then use this URL:
+
+ `https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template-3.2.txt`
+
 #### Uploading the Template File
 
 Click the Upload a Template File radio button.
 
-In another browser window, go to [https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template.txt](https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template.txt).
+In another browser window, go to [https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template.txt](https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template.txt)
+if your custom image based on `ami-cbc59e8e` (RhoConnect-3.1.2). 
+
+If your custom image based on `ami-0dfca748` (RhoConnect-3.2.0), then to go
+[https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template-3.2.txt](https://s3-us-west-1.amazonaws.com/rhoconnect-ca-deploy/rhoconnect_template-3.2.txt).
 
 Save that text file to your computer.
 

data/doc/settings.txt

@@ -52,7 +52,13 @@ Typical source settings include:
 	:::yaml
 	:poll_interval: <secs> - source's sync poll interval.
 	:force_default: <true|false> - if specified, this setting forces to use 
-									 default application poll interval
-								     even if source has its own setting.
+								   default application poll interval
+								   even if source has its own setting.
     :partition_type: <app|user> - default partition type for the source
-	
+    :priority: <num> - these settings are used to determine the order the models 
+                       are processed and synchronized. They might be useful when 
+                       there are a set of linked together sources and client need
+                       to know in which order to process them. 
+                       Priority starts from lower value 1. If priorities are not
+                       specified, then there are no guarantee that models will be 
+                       listed and processed in natural order.  

data/examples/simple/Gemfile

@@ -7,6 +7,8 @@ gem 'rhoconnect', :path => '../../'
 gem 'SystemTimer', '~> 1.2.3', :platforms => :ruby_18
 gem 'win32-process', :platforms => [:mswin, :mingw]
 
+gem 'rack-parser', :require => 'rack/parser'
+
 # for Async, Eventful execution
 platforms :ruby_19 do
   gem 'rack-fiber_pool'
@@ -22,7 +24,7 @@ platforms :jruby do
   gem 'warbler'
 end
 
-gem 'sqlite3', ">= 1.3.3", :platforms => [:ruby, :mswin, :mingw]
+#gem 'sqlite3', ">= 1.3.3", :platforms => [:ruby, :mswin, :mingw]
 
 group :development do
   # FIXME: At this moment (01/10/2012) only pre release of 'eventmachine' is working on Windows

data/examples/simple/application.rb

@@ -21,6 +21,11 @@ class Application < Rhoconnect::Base
     def store_blob(obj,field_name,blob)
       super #=> returns blob[:tempfile]
     end
+
+    def ans_authenticate(username,password)
+      puts "ans_authenticate - user: #{username} password: #{password}"
+      true
+    end
   end
 end
 

data/examples/simple/config.ru

@@ -26,9 +26,10 @@ Rhoconnect::Server.use     Rack::Static, :urls => ['/data'], :root => Rhoconnect
 
 # Load our rhoconnect application
 require './application'
+require './my_server'
 
 # Setup the url map
 run Rack::URLMap.new \
-	'/'         	=> Rhoconnect::Server.new,
+	'/'         	=> MyServer.new,
 	'/resque'   	=> Resque::Server.new, # If you don't want resque frontend, disable it here
-	"/console"  => RhoconnectConsole::Server.new # If you don't want rhoconnect frontend, disable it here
+	'/console'  	=> RhoconnectConsole::Server.new # If you don't want rhoconnect frontend, disable it here

data/examples/simple/my_server.rb

@@ -0,0 +1,14 @@
+# FIXME: This is a temporary server to handle ans token registration
+class MyServer < Rhoconnect::Server
+  post '/ans/token' do
+  	user = "tuser"
+  	User.create(:login => user)
+  	current_app.users << user
+	fields = {:user_id => user}
+    fields[:app_id] = 'application'
+    fields[:device_type] = 'rhoconnect_push'
+    fields[:device_pin] = params['token']
+    Client.create(fields)
+  	status 200
+  end
+end