rhoconnect 3.3.6 → 3.4.2

data/doc/source-adapters.txt

@@ -62,44 +62,44 @@ Generating a source adapter named "product" will generate a new ruby class calle
 	  def initialize(source)
 	    super(source)
 	  end
- 
+
 	  def login
 	    # TODO: Login to your data source here if necessary
 	  end
- 
+
 	  def query
-	    # TODO: Query your backend data source and assign the records 
+	    # TODO: Query your backend data source and assign the records
 	    # to a nested hash structure called @result. For example:
-	    # @result = { 
+	    # @result = {
 	    #   "1"=>{"name"=>"Acme", "industry"=>"Electronics"},
 	    #   "2"=>{"name"=>"Best", "industry"=>"Software"}
 	    # }
 	    raise SourceAdapterException.new("Please provide some code to read records from the backend data source")
 	  end
- 
+
 	  def sync
 	    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 
+	    # 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
@@ -108,8 +108,8 @@ Generating a source adapter named "product" will generate a new ruby class calle
 It also adds a corresponding [rspec](http://rspec.info/) file `spec/sources/product_spec.rb` and updates `settings/settings.yml` with the product adapter to the sources section with some default options:
 
  	:::yaml
-	:sources: 
-  	  Product: 
+	:sources:
+  	  Product:
     	:poll_interval: 300
 
 ## Source Adapter API
@@ -162,7 +162,7 @@ Search your backend based on params and build a hash of hashes (optional).  Simi
 	end
 
 Next, you will need to add search to your Rhodes application. For details, see the [Rhodes search section](/rhodes/synchronization#filtering-datasets-with-search).
-	
+
 ### `create(create_hash)`
 Create a new record in the backend (optional).
 
@@ -190,7 +190,7 @@ Delete an existing record in the backend (optional).
 	def delete(delete_hash)
 	  MyWebService.delete(delete_hash['id'])
 	end
-	
+
 ### `current_user`
 Returns the current user which called the adapter.  For example, you could filter results for a specific user in  your query method:
 
@@ -198,7 +198,7 @@ Returns the current user which called the adapter.  For example, you could filte
 	def query
 	  @result = MyWebService.get_records_for_user(current_user.login)
 	end
-	
+
 ### `stash_result`
 Saves the current state of `@result` to redis and assigns it to `nil`.  Typically this is used when your adapter has to paginate through backend service data.
 
@@ -208,14 +208,14 @@ Saves the current state of `@result` to redis and assigns it to `nil`.  Typicall
 	  ('a'..'z').each_with_index do |letter,i|
 		@result ||= {}
 	    @result.merge!( DictionaryService.get_records_for(letter) )
-		stash_result if i % 2
+		stash_result if i % 2 == 0
 	  end
 	end
 
 ## Data Partitioning
-Data is stored in RhoConnect using [redis sets](http://redis.io/commands#set).  The `@result` hash from the `query` method is stored in redis and referred to as the Master Document or MD.  
+Data is stored in RhoConnect using [redis sets](http://redis.io/commands#set).  The `@result` hash from the `query` method is stored in redis and referred to as the Master Document or MD.
 
-The MD is referenced in RhoConnect by a corresponding partition.  Source adapters can partition data in two ways: user and app.  As you might have guessed, user partitioning stores a copy of the source adapter MD for each user (one copy shared across all devices for a user).  
+The MD is referenced in RhoConnect by a corresponding partition.  Source adapters can partition data in two ways: user and app.  As you might have guessed, user partitioning stores a copy of the source adapter MD for each user (one copy shared across all devices for a user).
 
 Likewise, app partitioning stores one copy of the source adapter MD for the entire application (all users and devices share the same data).  App partitioning can be particularly useful if you have source adapters which retrieve large amounts of data that is fixed from user to user, for example a global product catalog.  Using app partitioning wherever possible ***greatly reduces*** the amount of data in redis.
 
@@ -223,17 +223,17 @@ Likewise, app partitioning stores one copy of the source adapter MD for the enti
 User partitioning is the default scheme for source adapters, however you can explicitly define it in `settings/settings.yml` with:
 
 	:::yaml
-	:sources: 
-  	  Product: 
+	:sources:
+  	  Product:
     	:poll_interval: 300
     	:partition_type: user
 
 ### App Partition
 Enable app partitioning the same way:
-	
+
 	:::yaml
-	:sources: 
-  	  Product: 
+	:sources:
+  	  Product:
     	:poll_interval: 300
     	:partition_type: app
 
@@ -241,10 +241,10 @@ Now you have a single copy of the `Product` source adapter dataset for all users
 
 ## Pass Through
 RhoConnect provides a simple way to keep data out of redis.  If you have sensitive data that you do not want saved in redis, add the pass_through option in settings/settings.yml for each source:
- 
+
 	:::yaml
-	:sources: 
-  	  Product: 
+	:sources:
+  	  Product:
     	:pass_through: true
 
 **NOTE: When running query or search the entire data set will be returned from your backend service. **
@@ -266,7 +266,7 @@ RhoConnect provides a simple redis interface for saving/retrieving arbitrary dat
 	)
 
 	Store.get_data('mydata') #=> { '1' => { 'hello' => 'world' } }
-	
+
 ## Handling Exceptions
 If your source adapter raises an instance of `SourceAdapterException`, the resulting message will be sent to the client's sync callback(in `@params['error_message']`).  See the rhodes [sync exception handling docs](/rhodes/synchronization#handling-exceptions) for more details.
 
@@ -275,7 +275,7 @@ You can use `SourceAdapterException` as a convenient way to notify your applicat
 For example, your delete method might check the web service HTTP response code was 200 to make sure the record was deleted:
 
 	:::ruby
-	def delete(delete_hash)   
+	def delete(delete_hash)
 	  rest_result = RestClient.delete("#{@base}/#{delete_hash['id']}")
 	  if rest_result.code != 200
 	    raise SourceAdapterException.new("Error deleting record.")
@@ -307,9 +307,9 @@ Handling conflicts in RhoConnect follows the same pattern as handling exceptions
 Raise this if your adapter has detected a conflict.
 
 	:::ruby
-	def update(update_hash) 
+	def update(update_hash)
       obj_id = update_hash['id']
-      update_hash.delete('id')   
+      update_hash.delete('id')
       rest_result = RestClient.put("#{@base}/#{obj_id}",:product => update_hash)
 	  if rest_result.code != 200
 	    raise SourceAdapterObjectConflictError.new("Conflict detected updating the object.")
@@ -324,12 +324,12 @@ Here's a complete example of how the completed [product adapter might look](http
 	require 'rest_client'
 
 	class Product < SourceAdapter
-  
+
 	  def initialize(source)
-	    @base = 'http://rhostore.heroku.com/products'
+	    @base = 'http://rhostore.herokuapp.com/products'
 	    super(source)
 	  end
- 
+
 	  def query(params=nil)
     	rest_result = RestClient.get("#{@base}.json").body
 
@@ -341,29 +341,29 @@ Here's a complete example of how the completed [product adapter might look](http
 	    @result={}
 	    parsed.each do |item|
 	      @result[item["product"]["id"].to_s] = item["product"]
-	    end if parsed   
+	    end if parsed
 	  end
- 
+
 	  def create(create_hash)
 	    res = RestClient.post(@base,:product => create_hash)
-    
-	    # After create we are redirected to the new record. 
-	    # We need to get the id of that record and return 
-		# it as part of create so rhoconnect can establish a link 
-		# from its temporary object on the client to this newly 
+
+	    # After create we are redirected to the new record.
+	    # We need to get the id of that record and return
+		# it as part of create so rhoconnect can establish a link
+		# from its temporary object on the client to this newly
 		# created object on the server
 	    JSON.parse(
 		  RestClient.get("#{res.headers[:location]}.json").body
 		)["product"]["id"]
 	  end
- 
-	  def update(update_hash) 
+
+	  def update(update_hash)
 	    obj_id = update_hash['id']
-	    update_hash.delete('id')   
+	    update_hash.delete('id')
 	    RestClient.put("#{@base}/#{obj_id}",:product => update_hash)
 	  end
- 
-	  def delete(delete_hash)   
+
+	  def delete(delete_hash)
 	    RestClient.delete("#{@base}/#{delete_hash['id']}")
 	  end
 	end

data/doc/stats-middleware.txt

@@ -46,12 +46,12 @@ A complete config.ru might look like:
 Now just restart your rhoconnect application:
 
 	:::term
-  	$ rake rhoconnect:restart
+  	$ rhoconnect restart
 
 And navigate to the 'Statistics' tab in your RhoConnect console:
 
 	:::term
-  	$ rake rhoconnect:web
+  	$ rhoconnect web
 
 ## Stats Console
 You should see graphs, organized by categories:

data/doc/supported-platforms.txt

@@ -19,7 +19,7 @@ Supported Platforms
     <td> ruby-1.8.7-p370 </td>
     <td> ree-1.8.7-2012.02 </td>
     <td> ruby-1.9.2-p320 </td>
-    <td> ruby-1.9.3-p194 </td>
+    <td> ruby-1.9.3-p286 </td>
     <td> jruby-1.6.7 </td>
     <td>Development &<br/>Production</td>
   </tr>
@@ -29,7 +29,7 @@ Supported Platforms
     <td> ruby-1.8.7-p370 </td>
     <td> ree-1.8.7-2012.02 </td>
     <td> ruby-1.9.2-p320 </td>
-    <td> ruby-1.9.3-p194 </td>
+    <td> ruby-1.9.3-p286 </td>
     <td> jruby-1.6.7 </td>
     <td>Development &<br/>Production</td>
   </tr>
@@ -39,7 +39,7 @@ Supported Platforms
     <td> ruby-1.8.7-p370 </td>
     <td class='tbd'> TBD </td>
     <td class='tbd'> TBD </td>
-    <td> ruby-1.9.3-p194 </td>
+    <td> ruby-1.9.3-p286 </td>
     <td class='tbd'> TBD </td>
     <td>Development</td>
   </tr>
@@ -60,14 +60,14 @@ RhoConnect for Windows is supported only in development environments. The compon
 
 RhoConnect for Linux and Mac OS X is supported for both development and production environments. The components you should have for this environment are:
 
-* Ruby 1.9.3-p194
-* Nginx HTTP server (1.2.x)
+* Ruby 1.9.3
+* Nginx HTTP server (1.3.x)
 * Redis data store (2.4.x)
 * Thin application server
 * RhoConnect gem with all required dependencies
 
+
 ## Known Issues
 
-* Windows platform: only pre-release (~> 1.0.0.beta) of <b>eventmachine</b> is working on Windows  
 * 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/testing.txt

@@ -20,8 +20,8 @@ The full code listing for this product_spec is available [on github](http://gith
 From your application's root folder:
 	
 	:::term
-  	$ rake rhoconnect:spec
-	[05:51:48 PM 2011-04-19] Rhoconnect Server v3.0.0 started...
+  	$ rhoconnect spec
+	[05:51:48 PM 2012-04-19] Rhoconnect Server v3.2.0 started...
 	Product
 	  it should behave like SpecHelper
 	    should process Product query (PENDING: No reason given)

data/doc/tutorial.txt

@@ -10,7 +10,7 @@ Full documentation of all capabilities of RhoConnect is in the [RhoConnect Devel
 
 ## Installing the RhoConnect Dependencies
 
-* Install RhoConnect as described [here](/rhoconnect/install).
+* Install RhoConnect [from the command line](/rhoconnect/install) or by installing [RhoMobile Suite](/rhomobile-install).
 
 * If you have a RhoConnect license that has been sent to you, you can replace the settings/license.yml file as described [here](/rhoconnect/licensing).
 
@@ -33,7 +33,7 @@ Enter the name for your RhoConnect application in Project name; in this case, "s
 	:::term
 	$ rhoconnect app storeserver
 	$ cd storeserver
-	
+
 Next, install the application's dependencies. RhoConnect applications use [bundler](http://gembundler.com/) to manage dependencies, so you can install them with:
 
 	:::term
@@ -42,21 +42,21 @@ Next, install the application's dependencies. RhoConnect applications use [bundl
 **If you are running this for the first time on Mac or Linux**, you will need to install [dtach](http://dtach.sourceforge.net/):
 
 	:::term
-	$ [sudo] rake dtach:install  
+	$ [sudo] rhoconnect dtach-install
 
 Now you can run redis and your RhoConnect app:
 
 	:::term
-	$ rake redis:start
-	$ rake rhoconnect:start
+	$ rhoconnect redis-start
+	$ rhoconnect start
 
 If everything went well you should see:
 
-	[07:01:15 PM 2010-05-04] Rhoconnect Server v3.0.0 started...
+	[01:48:15 PM 2012-08-04] Rhoconnect Server v3.3.4 started...
 
 ## Defining RhoConnect Source Adapters
 
-Once RhoConnect is installed we're ready to build a RhoConnect source to integrate with our backend application. To define a RhoConnect source you just need to identify a handful of operations to interact with your backend data source: login, query, sync, create, update, delete and logoff. For more information please see the [RhoConnect source adapter](/rhoconnect/source-adapters) documentation.  
+Once RhoConnect is installed we're ready to build a RhoConnect source to integrate with our backend application. To define a RhoConnect source you just need to identify a handful of operations to interact with your backend data source: login, query, sync, create, update, delete and logoff. For more information please see the [RhoConnect source adapter](/rhoconnect/source-adapters) documentation.
 
 ### Generating the Source Adapter from RhoStudio
 
@@ -83,7 +83,7 @@ You can open these files for editing by clicking on them in the Project Explorer
 
 ### Generating the Source Adapter from the Command Line
 
-From the command line, navigate to the main folder for your RhoConnect app: in this case, storeserver. 
+From the command line, navigate to the main folder for your RhoConnect app: in this case, storeserver.
 
 Then run the command to generate a source adapter for the product model. The product model is used as an example for a Rhodes storemanager in the [RhoStudio tutorial](/rhostudio.tutorial) and the [documentation to generate a Rhodes application](/rhodes/generator).
 
@@ -107,47 +107,47 @@ The generated source adapter file (in this case, product.rb) is similar to the c
 	  def initialize(source)
 	    super(source)
 	  end
- 
+
 	  def login
 	    # TODO: Login to your data source here if necessary
 	  end
- 
+
 	  def query
-	    # TODO: Query your backend data source and assign the records 
+	    # TODO: Query your backend data source and assign the records
 	    # to a nested hash structure called @result. For example:
-	    # @result = { 
+	    # @result = {
 	    #   "1"=>{"name"=>"Acme", "industry"=>"Electronics"},
 	    #   "2"=>{"name"=>"Best", "industry"=>"Software"}
 	    # }
 	    raise SourceAdapterException.new("Please provide some code to read records from the backend data source")
 	  end
- 
+
 	  def sync
-	    # Manipulate @result before it is saved, or save it 
+	    # 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 
+	    # 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
@@ -156,44 +156,44 @@ The generated source adapter file (in this case, product.rb) is similar to the c
 The generator will also edit settings/settings.yml and add the product adapter to the sources section with some default options:
 
 	:::ruby
-	#Sources 
-	:sources: 
-  	  Product: 
+	#Sources
+	:sources:
+  	  Product:
         :poll_interval: 300
 
-The next step is for you to fill in the login, query, create, update, delete and logoff methods with your own code to call a backend service.  
+The next step is for you to fill in the login, query, create, update, delete and logoff methods with your own code to call a backend service.
 
 ## A RhoConnect Query
 
-If you're doing a readonly non-authenticated source adapter, you can just write one method, query, to retrieve records as we describe here. The following is a sample query method to interact with a simple product catalog (available at http://rhostore.heroku.com) that exposes a REST interface.  Note that RhoConnect can work with any protocol. This example shows JSON over HTTP with a REST interface, since that is common. The RhoConnect source adapter is Ruby code and there are ruby libraries (aka gems) that will make it easy to connect to and parse whatever you need -- the query code would just be slightly different.
+If you're doing a readonly non-authenticated source adapter, you can just write one method, query, to retrieve records as we describe here. The following is a sample query method to interact with a simple product catalog (available at http://rhostore.herokuapp.com) that exposes a REST interface.  Note that RhoConnect can work with any protocol. This example shows JSON over HTTP with a REST interface, since that is common. The RhoConnect source adapter is Ruby code and there are ruby libraries (aka gems) that will make it easy to connect to and parse whatever you need -- the query code would just be slightly different.
 
 For a more complete example of rewriting the source adapter methods (such as create, update, and delete), refer to the [source adapter example](/rhoconnect/source-adapters#sample-adapter) in the RhoConnect Developer Reference.
 
-Our sample web service for returning all products in the catalog (http://rhostore.heroku.com/products.json) returns data like this:
-	
+Our sample web service for returning all products in the catalog (http://rhostore.herokuapp.com/products.json) returns data like this:
+
 	:::json
 	[
   	  {
 		"product": {
-		  "name": "iPhone", 
-		  "brand": "Apple", 
-		  "updated_at": "2010-05-11T02:04:57Z", 
-		  "price": "$299.99", 
-		  "quantity": "5", 
-		  "id": 649, 
-		  "sku": "1234", 
+		  "name": "iPhone",
+		  "brand": "Apple",
+		  "updated_at": "2010-05-11T02:04:57Z",
+		  "price": "$299.99",
+		  "quantity": "5",
+		  "id": 649,
+		  "sku": "1234",
 		  "created_at": "2010-05-11T02:04:57Z"
 		}
-	  }, 
+	  },
   	  {
 	    "product": {
-		  "name": "Accord", 
-		  "brand": "Honda", 
-		  "updated_at": "2010-05-13T22:24:48Z", 
-		  "price": "$6000", 
-		  "quantity": "", 
-		  "id": 648, 
-		  "sku": "123", 
+		  "name": "Accord",
+		  "brand": "Honda",
+		  "updated_at": "2010-05-13T22:24:48Z",
+		  "price": "$6000",
+		  "quantity": "",
+		  "id": 648,
+		  "sku": "123",
 		  "created_at": "2010-05-11T02:04:53Z"
 		}
 	  }
@@ -213,33 +213,33 @@ For convenience, we'll add an instance variable @base which contains the base UR
 
 	:::ruby
   	def initialize(source)
-      @base = 'http://rhostore.heroku.com/products'
+      @base = 'http://rhostore.herokuapp.com/products'
       super(source)
     end
 
 Then fill in the query method:
-	
+
 	:::ruby
   	def query
       parsed=JSON.parse(RestClient.get("#{@base}.json").body)
 
       @result={}
       if parsed
-        parsed.each do |item| 
+        parsed.each do |item|
           key = item["product"]["id"].to_s
           @result[key]=item["product"]
         end
-      end 
+      end
     end
 
-**NOTE: The code above could be much more concise, but it is written to be easily readable by programmers who are unfamiliar with the Ruby language. If you are new to Ruby, you can read [Ruby from other languages](http://www.ruby-lang.org/en/documentation/ruby-from-other-languages/) for a good introduction.  
+**NOTE: The code above could be much more concise, but it is written to be easily readable by programmers who are unfamiliar with the Ruby language. If you are new to Ruby, you can read [Ruby from other languages](http://www.ruby-lang.org/en/documentation/ruby-from-other-languages/) for a good introduction.
 Each hash key in the inner hash represents an attribute of an individual object.  All datatypes must be strings (so the hash values need to all be strings, not integers).**
 
 For example:
-	
+
 	:::ruby
   	@result = {
-	  "1" => { 
+	  "1" => {
 	    "name" => "inner tube",
 	    "brand" => "Michelin"
 	  },
@@ -247,19 +247,19 @@ For example:
 		"name" => "tire",
 		"brand" => "Michelin"
 	  }
-	}	
+	}
 
 ## Testing Sync from the Client
 
 Make sure you are running redis. From the folder in which you app is located, run this command.
 
 	:::term
-	$ rake redis:start
-	
+	$ rhoconnect redis-start
+
 Then start (or restart) your server:
-	
+
 	:::term
-   	$ rake rhoconnect:start
+   	$ rhoconnect start
 
 **Note: The RhoConnect application must be run from the command line. It does not run from RhoStudio.**
 
@@ -280,7 +280,7 @@ Enable sync in your corresponding Rhodes app, storemanager/app/Product/product.r
   	  enable :sync
 	end
 
-To get a feel for what is happening, it is helpful to watch the server log (the output of rake rhoconnect:start) in one window, and tail the client log in another window. For example, on the iPhone, display the end of the client log with:
+To get a feel for what is happening, it is helpful to watch the server log (the output of `rhoconnect start`) in one window, and tail the client log in another window. For example, on the iPhone, display the end of the client log with:
 
 	:::term
    	$ tail -f rholog-User.txt
@@ -293,7 +293,7 @@ To sync with the RhoConnect server, the Rhodes client must log in. The Rhodes ge
 2. Login using any name & password. The generated code allows any login, but you can modify that in application.rb.
 <img src="http://rhodocs.s3.amazonaws.com/rhoconnect-tutorial/rhosimulator-login.png"/>
 
-3. If login is successful, you will see a Client ID in the settings screen. The ClientID is generated the first time you log in and is stored in the client database.  It serves as a unique identifier which is required for rhoconnect. (Note: this value will persist across logins, but if you reset the client database or the user re-installs the app, a new ClientID will be generated.)   
+3. If login is successful, you will see a Client ID in the settings screen. The ClientID is generated the first time you log in and is stored in the client database.  It serves as a unique identifier which is required for rhoconnect. (Note: this value will persist across logins, but if you reset the client database or the user re-installs the app, a new ClientID will be generated.)
 4. Sync is triggered automatically. Click on the home icon and then select "Products" and you should see the list of product records from the server.
 
 This example shows a couple of iPhone products.
@@ -303,19 +303,19 @@ This example shows a couple of iPhone products.
 ## Creating Objects with RhoConnect
 
 For your create method, the RhoConnect server will pass you a hash containing the new record, called "create_hash". For example, it might be:
-	
+
 	:::ruby
 	{
 	  "name" => "Hovercraft",
 	  "brand" => "Acme"
 	}
 
-The RhoConnect sources/product.rb create method will be called once for every object that has been created on the client since the last sync.  Your code for create (or edit or delete) needs to use this populated array to do its work.  Below is an example of a create method against the [rhostore](http://rhostore.heroku.com), which accepts an HTTP POST to perform a create action. The create method should return a unique id string for the object for it to be later modifiable by the client. If no id is returned, then you should treat the client object as read only, because it will not be able to be synchronized.
+The RhoConnect sources/product.rb create method will be called once for every object that has been created on the client since the last sync.  Your code for create (or edit or delete) needs to use this populated array to do its work.  Below is an example of a create method against the [rhostore](http://rhostore.herokuapp.com), which accepts an HTTP POST to perform a create action. The create method should return a unique id string for the object for it to be later modifiable by the client. If no id is returned, then you should treat the client object as read only, because it will not be able to be synchronized.
 
 	:::ruby
 	def create(create_hash)
       result = RestClient.post(@base, :product => create_hash)
-    
+
       # after create we are redirected to the new record.
       # The URL of the new record is given in the location header
       location = "#{result.headers[:location]}.json"
@@ -323,7 +323,7 @@ The RhoConnect sources/product.rb create method will be called once for every ob
       # We need to get the id of that record and return it as part of create
       # so rhoconnect can establish a link from its temporary object on the
       # client to this newly created object on the server
-    
+
       new_record = RestClient.get(location).body
       JSON.parse(new_record)["product"]["id"].to_s
     end
@@ -340,18 +340,18 @@ The generated RhoConnect application code includes a file at the root of the dir
         def authenticate(username,password,session)
       	  true # do some interesting authentication here...
         end
-    
+
         # Add hooks for application startup here
         # Don't forget to call super at the end!
         def initializer(path)
           super
         end
-    
+
         # Calling super here returns rack tempfile path:
         # i.e. /var/folders/J4/J4wGJ-r6H7S313GEZ-Xx5E+++TI
         # Note: This tempfile is removed when server stops or crashes...
         # See http://rack.rubyforge.org/doc/Multipart.html for more info
-        # 
+        #
         # Override this by creating a copy of the file somewhere
         # and returning the path to that file (then don't call super!):
         # i.e. /mnt/myimages/soccer.png
@@ -367,7 +367,7 @@ If your back end web service requires authentication, add code to the authentica
 
 	:::ruby
 	def authenticate(username, password, session)
-  	  # ... connect to backend using API and authenticate ... 
+  	  # ... connect to backend using API and authenticate ...
   	  if success
         # save the data for later use in the source adapter
         Store.put_value("username:#{username}:token",username)