rhoconnect 3.1.2 → 3.2.0.beta1

data/doc/rest-api.txt

@@ -142,6 +142,86 @@ documents, `push_deletes` method can be optimized by invoking only the necessary
 the number of transactions with Redis. To force the optimization, user can use the `:rebuild_md => false` flag
 in the `push_deletes` parameters hash.
 
+### `fast_insert`
+Push new objects to RhoConnect. Changes are inserted into the Redis set without any checking for previous existence.
+This way, the insert is very fast, but user must ensure that the object didn't exist before. No safeguards are implemented. 
+Use this method only when you can ensure the integrity of the data.
+
+**NOTE: you may use [ping](/rhoconnect/push) to notify client after the insert and trigger sync.**
+
+	:::ruby
+	# list of objects in the canonical hash of hashes structure
+	data = {
+	  '5' => {
+	    'name' => 'iPhone'  
+	  }
+	}
+	RestClient.post(
+	  "#{server}/api/fast_insert", 
+	  { 
+		:api_token => token, 
+        :user_id => user_id, 
+	    :source_id => source_name, 
+	    :data => data 
+	  }.to_json, 
+	  :content_type => :json
+	)
+	
+### `fast_update`
+Push object updates to RhoConnect. This method doesn't involve pulling the existing data out of Redis. Instead it required user to provide the previous state of the data. This way, this method allows for very fast updates (since it just removes the previous data from set and adds new ones). However, no data integrity checks are performed. Therefore, this method must be used only if user can ensure the integrity of the data (i.e. previous state must exist, otherwise it won't be properly deleted). Also, this method can be used to perform fast appends and deletes for any of the object's attributes (However, you shoudn't use this method to remove all of the attributes, `fast_delete` should be used instead.)
+
+**NOTE: you may use [ping](/rhoconnect/push) to notify client after the update and trigger sync.**
+
+	:::ruby
+	# list of objects in the canonical hash of hashes structure
+	# delete_data contains previous state of the object (to be deleted)
+	delete_data = {
+	  '5' => {
+	    'name' => 'iPhone'  
+	  }
+	}
+	# data contains new state of the object
+	# to be inserted
+	data = {
+	  '5' => {
+	    'name' => 'HTC'  
+	  }
+	}
+	RestClient.post(
+	  "#{server}/api/fast_update", 
+	  { 
+		:api_token => token, 
+        :user_id => user_id, 
+	    :source_id => source_name,
+	 	:delete_data => delete_data,
+	    :data => data 
+	  }.to_json, 
+	  :content_type => :json
+	)
+
+### `fast_delete`
+Push object deletes to RhoConnect. This method doesn't involve pulling the existing data out of Redis and removing all of its attributes. Instead it required user to provide all of the object's data in the hash to be removed. This way, this method allows for very fast deletes (since it just removes the object's data from set). However, no data integrity checks are performed. Therefore, this method must be used only if user can ensure the integrity of the data (i.e. supply all of the object's data to be removed, otherwise some object's data will remain in Redis).
+
+**NOTE: you may use [ping](/rhoconnect/push) to notify client after the delete and trigger sync.**
+
+	:::ruby
+	# list of objects in the canonical hash of hashes structure
+	# data contains all of the object's data (to be deleted)
+	data = {
+	  '5' => {
+	    'name' => 'iPhone'  
+	  }
+	}
+	RestClient.post(
+	  "#{server}/api/fast_delete", 
+	  { 
+		:api_token => token, 
+        :user_id => user_id, 
+	    :source_id => source_name,
+	    :data => data 
+	  }.to_json, 
+	  :content_type => :json
+	)
 
 ### `list_users`
 List users registered with this RhoConnect application.
@@ -284,6 +364,22 @@ Return attributes associated with a given source:
 	  :content_type => :json
 	).body
 
+### `update_source_params`
+Updates attributes associated with a given source:
+
+* `poll_interval` - query poll interval; defines how often RhoConnect will call source adapter to query for new data, set to -1 to disable polling, 0 to always poll
+
+	:::ruby
+	attributes = RestClient.post("#{server}/api/update_source_params", 
+	  { 
+		:api_token => token, 
+		:source_name => source_name,
+		:user_name => user,
+		:data => {:poll_interval => 25} 
+	  }.to_json, 
+	  :content_type => :json
+	).body
+
 ### `set_refresh_time`
 Sets source poll interval to "current time plus x seconds".
 

data/doc/settings.txt

@@ -21,7 +21,7 @@ In addition, the following settings can be specified:
 									 This setting is used as a default if source doesn't specify
 									 its own value. Also, it is applied to dynamic adapters
 									 as a default sync poll interval.
-	:bulk_data_poll_interval: <secs> - poll interval setting for bulk data sync
+	:bulk_sync_poll_interval: <secs> - poll interval setting for bulk data sync
 	
 	:c2dm_username: <google's email>
 	:c2dm_passwd: <passwd>                       

data/doc/supported-platforms.txt

@@ -71,4 +71,5 @@ RhoConnect for Linux and Mac OS X is supported for both development and producti
 * Windows platform: only pre-release (~> 1.0.0.beta) of <b>eventmachine</b> is working on Windows  
 * Examples for <b>RSpec</b> (~> 2.8.0) fail for Ruby 1.8.7, gemset locked to ver. >= 2.6.0. <b>Issue is fixed in v. 3.1.2.</b>
 * Rack is locked to version 1.3.6 due to issues with RhoConnect applications deployed on Heroku (502 server error if rhoconnect bundled with rake 1.4.1). <b>Fixed in v. 3.1.2.</b>
-  
+* If you deploy your RhoConnect application deploy on <b>Heroku</b>, then use new [Cedar](http://devcenter.heroku.com/articles/cedar) stack. The Bamboo stack is older than the widespread adoption of bundler, 
+so on Bamboo your application is not invoked in the context of your bundle and might not works properly.

data/doc/tutorial.txt

@@ -251,10 +251,10 @@ For example:
 
 ## Testing Sync from the Client
 
-Make sure you are running redis.
+Make sure you are running redis. From the folder in which you app is located, run this command.
 
 	:::term
-	rake redis:start
+	$ rake redis:start
 	
 Then start (or restart) your server:
 	
@@ -265,9 +265,11 @@ Then start (or restart) your server:
 
 The code for the source adapter loads when the server starts. If you have a syntax error in your Ruby code, it will be reported and the server will not start; however, if you have a runtime error, that will not be reported until the source adapter is called.
 
-Make sure your server URL is configured in the Rhodes app. If your server is running on localhost with the default port, the following line should be at the bottom of your corresponding Rhodes app, storemanager/rhoconfig.txt:
+Make sure your server URL is configured in the Rhodes app. If your server is running on YourIPAddress with the port 9292, the following line should be at the bottom of your corresponding Rhodes app, storemanager/rhoconfig.txt:
+
+	syncserver = 'http://YourIPAddress:9292/application'
 
-	syncserver = 'http://localhost:9292/application'
+**NOTE: If you are using Android, syncserver cannot be set to localhost.**
 
 Enable sync in your corresponding Rhodes app, storemanager/app/Product/product.rb model:
 

data/examples/simple/Gemfile

@@ -0,0 +1,39 @@
+source 'http://rubygems.org'
+
+# load rhoconnect from relative path
+gem 'rhoconnect', :path => '../../'
+
+# Helps with some of the limitations of green threads, not needed in ruby 1.9.x
+gem 'SystemTimer', '~> 1.2.3', :platforms => :ruby_18
+gem 'win32-process', :platforms => [:mswin, :mingw]
+
+# for Async, Eventful execution
+platforms :ruby_19 do
+  gem 'rack-fiber_pool'
+  gem 'async-rack'
+end
+
+platforms :jruby do
+  gem 'jdbc-sqlite3', ">= 3.7.2"
+  gem 'dbi', ">= 0.4.5"
+  gem 'dbd-jdbc', ">= 0.1.4"
+  gem 'jruby-openssl', ">= 0.7.4"
+  gem 'trinidad'
+  gem 'warbler'
+end
+
+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
+  gem 'eventmachine', '~> 1.0.0.beta', :platforms => [:mswin, :mingw]
+  # By default to run application thin web server is used
+  gem 'thin', :platforms => [:ruby, :mswin, :mingw]
+  gem 'rhomobile-debug', ">= 1.0.2"
+end
+
+group :test do
+  gem 'rack-test', '>= 0.5.3', :require => "rack/test"
+  gem 'rspec', '~> 2.6.0'
+  gem 'rhomobile-debug', ">= 1.0.2"
+end

data/examples/simple/Rakefile

@@ -1,14 +1,9 @@
-$:.unshift File.join(File.dirname(__FILE__),'..','..','lib')
+require 'rubygems'
+require 'bundler/setup'
 require 'rhoconnect/tasks'
+require 'rhoconnect'
+require 'resque/tasks'
 
-ROOT_PATH = File.expand_path(File.dirname(__FILE__))
-
-begin
-  require 'resque/tasks'
-  task "resque:setup" do
-    require 'application'
-  end
-rescue LoadError
-  puts "Resque not available. Install it with: "
-  puts "gem install resque\n\n"
-end
+task 'resque:setup' do
+  require './application'
+end

data/examples/simple/config.ru

@@ -1,49 +1,34 @@
 #!/usr/bin/env ruby
+require 'rubygems'
+require 'bundler'
+Bundler.require
 
-path = File.join(File.dirname(__FILE__),'..','..','lib')
-$:.unshift path
+ROOT_PATH = File.expand_path(File.dirname(__FILE__))
 
-# Try to load vendor-ed rhoconnect, otherwise load the gem
-begin
-  require 'vendor/rhoconnect/lib/rhoconnect/server'
-  require 'vendor/rhoconnect/lib/rhoconnect/console/server'
-rescue LoadError
-  require 'rhoconnect/server'
-  require 'rhoconnect/console/server'
+if ENV['DEBUG'] == 'yes'
+  ENV['APP_TYPE'] = 'rhosync'
+  ENV['ROOT_PATH'] = ROOT_PATH
+  require 'debugger'
 end
 
-require 'x_domain_session_wrapper'
-use XDomainSessionWrapper
-
-# By default, turn on the resque web console
+require 'rhoconnect/server'
+require 'rhoconnect/console/server'
 require 'resque/server'
 
-ROOT_PATH = File.expand_path(File.dirname(__FILE__))
-
 # Rhoconnect server flags
 Rhoconnect::Server.disable :run
+Rhoconnect::Server.enable  :stats
 Rhoconnect::Server.disable :clean_trace
 Rhoconnect::Server.enable  :raise_errors
+Rhoconnect::Server.set     :secret,      '3ddaa72a36466bae3fc5e54c09324db50cfc30588d8dee1a2700e61195bdbbb5eeb65da2a184d274ce644b20b0e986046c2447730c85555ce18a4eb2fce7ebf5'
 Rhoconnect::Server.set     :root,        ROOT_PATH
-#Rhoconnect::Server.enable  :stats
-Rhoconnect::Server.set     :secret, '3ddaa72a36466bae3fc5e54c09324db50cfc30588d8dee1a2700e61195bdbbb5eeb65da2a184d274ce644b20b0e986046c2447730c85555ce18a4eb2fce7ebf5'
-Rhoconnect::Server.use     Rack::Static, :urls => ["/data"], :root => Rhoconnect::Server.root
-                     
-# configure Cross-Domain Resource Sharing
-require 'cors'
-use Rack::Cors do |cfg|
-  cfg.allow do |allow|
-    allow.origins /.*/
-    allow.resource '/application',   :headers => :any, :methods => [:get, :post, :put, :delete], :credentials => true
-    allow.resource '/application/*', :headers => :any, :methods => [:get, :post, :put, :delete], :credentials => true
-  end
-end                     
-                           
+Rhoconnect::Server.use     Rack::Static, :urls => ['/data'], :root => Rhoconnect::Server.root
+
 # Load our rhoconnect application
 require './application'
 
 # Setup the url map
 run Rack::URLMap.new \
-	"/"         => Rhoconnect::Server.new,
-	"/resque"   => Resque::Server.new, # If you don't want resque frontend, disable it here
+	'/'         	=> Rhoconnect::Server.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

data/examples/simple/settings/settings.yml

@@ -4,20 +4,21 @@
   SampleAdapter:
     :partition_type: app    
     :poll_interval: 500
+  Product:
+   :partition_type: user    
+   :poll_interval: 500
 
 :development:
   :licensefile: settings/license.key
   :redis: localhost:6379
   :syncserver: http://localhost:9292/api/application/
-  :api_token: sometokenforme
-:test: 
+:test:
   :licensefile: settings/license.key
   :redis: localhost:6379
   :syncserver: http://localhost:9292/api/application/
-  :api_token: sometokenforme
 :production: 
   :licensefile: settings/license.key
   :redis: localhost:6379
   :syncserver: http://localhost:9292/api/application/
-  :api_token: sometokenforme
+
   

data/examples/simple/sources/product.rb

@@ -0,0 +1,51 @@
+require 'json'
+require 'rest_client'
+
+class Product < SourceAdapter
+  def initialize(source)
+    @base = 'http://rhostore.heroku.com/products'
+    super(source)
+  end
+  
+  def query
+    parsed=JSON.parse(RestClient.get("#{@base}.json").body)
+
+    @result={}
+    if parsed
+      parsed.each do |item| 
+        key = item["product"]["id"].to_s
+        @result[key]=item["product"]
+      end
+    end 
+  end
+
+    def sync
+      # Manipulate @result before it is saved, or save it 
+      # yourself using the Rhoconnect::Store interface.
+      # By default, super is called below which simply saves @result
+      super
+    end
+
+    def create(create_hash)
+      # TODO: Create a new record in your backend data source
+      # If your rhodes rhom object contains image/binary data 
+      # (has the image_uri attribute), then a blob will be provided
+      raise "Please provide some code to create a single record in the backend data source using the create_hash"
+    end
+
+    def update(update_hash)
+      # TODO: Update an existing record in your backend data source
+      raise "Please provide some code to update a single record in the backend data source using the update_hash"
+    end
+
+    def delete(delete_hash)
+      # TODO: write some code here if applicable
+      # be sure to have a hash key and value for "object"
+      # for now, we'll say that its OK to not have a delete operation
+      # raise "Please provide some code to delete a single object in the backend application using the object_id"
+    end
+
+    def logoff
+      # TODO: Logout from the data source if necessary
+    end
+  end

data/generators/templates/application/Gemfile

@@ -6,6 +6,13 @@ gem 'rhoconnect', '<%=gem_version%>'
 gem 'SystemTimer', '~> 1.2.3', :platforms => :ruby_18
 gem 'win32-process', :platforms => [:mswin, :mingw]
 
+# for Async, Eventful execution
+platforms :ruby_19 do
+  gem 'thin'
+  gem 'rack-fiber_pool'
+  gem 'async-rack'
+end
+
 platforms :jruby do
   gem 'jdbc-sqlite3', ">= 3.7.2"
   gem 'dbi', ">= 0.4.5"

data/generators/templates/application/Rakefile

@@ -1,22 +1,9 @@
 require 'rubygems'
 require 'bundler/setup'
+require 'rhoconnect/tasks'
+require 'rhoconnect'
+require 'resque/tasks'
 
-begin
-  require 'vendor/rhoconnect/lib/rhoconnect/tasks'
-  require 'vendor/rhoconnect/lib/rhoconnect'
-rescue LoadError
-  require 'rhoconnect/tasks'
-  require 'rhoconnect'
+task 'resque:setup' do
+  require './application'
 end
-
-ROOT_PATH = File.expand_path(File.dirname(__FILE__))
-
-begin
-  require 'resque/tasks'
-  task "resque:setup" do
-    require 'application'
-  end
-rescue LoadError
-  puts "Resque not available. Install it with: "
-  puts "gem install resque\n\n"
-end

data/generators/templates/application/config.ru

@@ -6,37 +6,29 @@ Bundler.require
 ROOT_PATH = File.expand_path(File.dirname(__FILE__))
 
 if ENV['DEBUG'] == 'yes'
- ENV['APP_TYPE'] = 'rhosync'
- ENV['ROOT_PATH'] = ROOT_PATH
- require 'debugger'
+  ENV['APP_TYPE'] = 'rhosync'
+  ENV['ROOT_PATH'] = ROOT_PATH
+  require 'debugger'
 end
 
-# Try to load vendor-ed rhoconnect, otherwise load the gem
-begin
-  require 'vendor/rhoconnect/lib/rhoconnect/server'
-  require 'vendor/rhoconnect/lib/rhoconnect/console/server'
-rescue LoadError
-  require 'rhoconnect/server'
-  require 'rhoconnect/console/server'
-end
-
-# By default, turn on the resque web console
+require 'rhoconnect/server'
+require 'rhoconnect/web-console/server'
 require 'resque/server'
 
-
 # Rhoconnect server flags
+#Rhoconnect::Server.enable  :stats
 Rhoconnect::Server.disable :run
 Rhoconnect::Server.disable :clean_trace
 Rhoconnect::Server.enable  :raise_errors
 Rhoconnect::Server.set     :secret,      '<%= @secret %>'
 Rhoconnect::Server.set     :root,        ROOT_PATH
-Rhoconnect::Server.use     Rack::Static, :urls => ["/data"], :root => Rhoconnect::Server.root
+Rhoconnect::Server.use     Rack::Static, :urls => ['/data'], :root => Rhoconnect::Server.root
 
 # Load our rhoconnect application
-require "#{ROOT_PATH}/application"
+require './application'
 
 # Setup the url map
 run Rack::URLMap.new \
-	"/"         => Rhoconnect::Server.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
+	'/'         => Rhoconnect::Server.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

data/install.sh

@@ -200,10 +200,11 @@ logAndPrint ()
 setRubyVars ()
 {
   if [[ $rubyVersion == "" || $rubyVersion =~ ruby'ee'|'enterprise' ]]; then
-    rubyVersion="rubyee"
-    rubyDir="ruby-enterprise-1.8.7-2012.02"
+    rubyVersion="ruby-1.9.3-p125"
+    rubyDir="ruby-1.9.3-p125"
     rubyTar="${rubyDir}.tar.gz"
-    rubyURL="http://rubyenterpriseedition.googlecode.com/files/${rubyTar}"
+    # http://ftp.ruby-lang.org/pub/ruby/1.9/ruby-1.9.3-p125.tar.gz
+    rubyURL="http://ftp.ruby-lang.org/pub/ruby/1.9/${rubyTar}"
   elif [$rubyVersion == "ruby187"]; then
     rubyDir="ruby-1.8.7"
     rubyTar="${rubyDir}.tar.gz"
@@ -223,15 +224,26 @@ installRuby ()
   if [[ ! -d "${prefix}${rubyDir}" ]]; then
     echo "Downloading ${rubyURL} ..." | tee -a $log
     echo "wget -P ${prefix} ${rubyURL}" >> $log
-    wget -P ${prefix} ${rubyURL} > $log 2>&1
+    wget -P ${prefix} ${rubyURL} -o /dev/null
     echo "tar -xzf ${prefix}/${rubyTar} -C ${prefix}" >> $log
-    tar -xzf ${prefix}/${rubyTar} -C ${prefix} > $log 2>&1
+    tar -xzf ${prefix}/${rubyTar} -C ${prefix} > /dev/null 2>&1
   fi
   echo "Installing ruby. This may take some time..." | tee -a $log
 
   case $rubyVersion in
-  rubyee)
-    logAndPrint "${prefix}/${rubyDir}/installer --dont-install-useful-gems --no-dev-docs --auto ${prefix}"
+#  rubyee)
+#    logAndPrint "${prefix}/${rubyDir}/installer --dont-install-useful-gems --no-dev-docs --auto ${prefix}"
+#    ;;
+  ruby-1.9.3-p125)
+    (
+      echo "cd ${prefix}/${rubyDir}" | tee -a $log
+      cd ${prefix}/${rubyDir}	 
+      echo "./configure --prefix=${prefix} --enable-shared --disable-install-doc" | tee -a $log
+      ./configure --prefix=${prefix} --enable-shared --disable-install-doc >> $log 2>&1
+      echo "make && make install" | tee -a $log
+      make >> $log 2>&1
+      make install >> $log 2>&1
+    )
     ;;
   ruby187)
     logAndPrint "${prefix}/${rubyDir}/configure --prefix=\"${prefix}\""
@@ -247,50 +259,15 @@ installRuby ()
     ;;
   esac
 
-  if [[ $exitStatus != 0 ]]; then
+  if [[ $? != 0 ]]; then
     echo "Some dependencies not installed..." | tee -a $log
     echo "Please install them and then re-run the installation script." | tee -a $log
     echo "For troubleshooting see file $log ..." | tee -a $log
     exit
   fi
   
-  echo "Ruby $rubyDir is successfully installed." | tee -a $log
-} #end installRuby
-
-getTime ()
-{
-  timeDiff=$(( $1 - $timeInitial ))
-  timeSec=$(( $timeDiff % 100 ))
-  timeDiff=$(( $timeDiff / 100 ))
-  
-  if [ $timeSec -gt 1 ]; then
-    timeSec=$timeSec" seconds"
-  else
-    timeSec=$timeSec" second" 
-  fi
-  
-  if [ $timeDiff -gt 0 ]; then
-    timeMin=$(( $timeDiff % 100 ))
-    timeDiff=$(( $timeDiff / 100 ))
-    if [ $timeMin -gt 1 ]; then
-      timeMin=$timeMin" minutes and "
-    else
-      timeMin=$timeMin" minute and "
-    fi
-  fi
-  
-  if [ $timeDiff -gt 0 ]; then
-    timeHour=$(( $timeDiff % 100 ))
-    timeDiff=$(( $timeDiff / 100 ))
-    if [ $timeHour -gt 1 ]; then
-      timeHour=$timeHour" hours, "
-    else
-      timeHour=$timeHour" hour, "
-    fi
-  fi
-
-  echo "\nInstallation completed in ${timeHour}${timeMin}${timeSec}."
-} #end getTime
+  echo -e "$rubyDir is successfully installed.\n" | tee -a $log
+}
 
 # SCRIPT
 
@@ -369,11 +346,9 @@ if [[ $installedSoftware -eq ${#INSTALL_ARRAY[@]} ]]; then
   fi
 
   if (( $rho_status )) ; then 
-    echo "Installation failed. For troubleshooting see file $log ..." | tee -a $log    
+    echo "Installation failed. For troubleshooting see file $log ..." | tee -a $log
   else
-    opts=" -d $dist"  
+    opts=" -d $dist -l $log"
     ${prefix}/bin/ruby ${INSTALL_DIR}/unix-like/create_texts.rb ${opts}
   fi
-  #  timeFinal=`date +%H%M%S`
-  #  getTime $timeFinal
 fi