rhoconnect 3.3.6 → 3.4.2

data/doc/push-client-setup.txt

@@ -1,7 +1,7 @@
 Setting Up for RhoConnect Push on Client Application
 ===
 
-Push notification support (receiving push notifications from the RhoConnect server/backend) is currently available for Android, Blackberry and iPhone. 
+Push notification support (receiving push notifications from the RhoConnect server/backend) is currently available for Android, Blackberry and iPhone.
 
 ## Configuring a Rhodes Application to Receive Push
 
@@ -30,7 +30,7 @@ To handle a push message from a Rhodes application, you must register push callb
 
 Push callback is set up in the form of a local application URL and called as callback whether or not rho_callback=1 is specified in its parameters list.
 
-The parameters trigger certain operations in the Rhodes client when the callback returns "rho_push". (When the callback retuens an empty string, this automatic handling is not performed.) The operations are to show an alert, vibrate the device, play a sound, and perform a sync.
+The parameters trigger certain operations in the Rhodes client when the callback returns "rho_push". (When the callback returns an empty string, this automatic handling is not performed.) The operations are to show an alert, vibrate the device, play a sound, and perform a sync.
 
 To have your Rhodes app automatically perform the operations listed in the push message, you can write the callback as follows.
 
@@ -59,3 +59,73 @@ To set up your Rhodes client for push, refer to these links for your respective
 * [Setting up iPhone Client for Push](/rhodes/device-caps#iphone-push-setup)
 * [Setting up Android Client for Push](/rhodes/device-caps#android-push-setup)
 * [Setting up Blackberry Client for Push](/rhodes/device-caps#blackberry-push-setup)
+
+## Configuring a Rhodes Application to Receive Push with RhoConnect Push Service
+
+RhoConnect Push Service is a separate process that will run on your machine and broker push messages between your RhoConnect server and registered Android and Windows Mobile/CE devices.
+
+NOTE: You do not perform the setup steps in the Rhodes Device Capabilities chapter when you use the RhoConnect Server Push Service. That setup is for regular RhoConnect push, not for the RhoConnect Server Push Service.
+
+### Installing the rhoconnect-push-service Runtime Apps
+
+To use the RhoConnect Push Service in your client application, you must install the rhoconnect-push-service runtime app(s) on your mobile device.
+
+On the Macintosh, the rhoconnect-push-service runtime apps for Android and for Windows Mobile are located in the Motorola RhoMobile Suite installation package, in a folder called rhoconnect-push-service.
+
+On Windows, the rhoconnect-push-service runtime apps for Android and for Windows Mobile are located in the Motorola RhoMobile Suite installation, in a directory called rhoconnect-push-service.
+
+If you are using an Android device, install `rhoconnect_push_service.apk` to your device.
+
+If you are using a Windows Mobile or CE device, install the following runtime apps on your device.
+
+* `rhoconnect-push-service.CAB`
+* `NETCFv35.Messages.EN.wm.cab`
+* `NETCFv35.Messages.EN.cab`
+
+### Configuring rhoconfig.txt
+
+In your client application `rhoconfig.txt` file, set the following options to configure your RhoConnect Push Service.
+
+    syncserver = 'http://<hostname>:<port>/application'
+    rhoconnect_push_server = 'http://<hostname>:<port>'
+    rhoconnect_push_appname = 'someappname'
+
+Next, your RhoConnect application should be running on a network that is accessible to your device. For example, you might have your RhoConnect application running on a LAN with IP 192.168.1.10, PORT 9292. Then make sure your device is connected to the same LAN and set up your application rhoconfig.txt syncserver as follows:
+
+Here is an example of setting `rhoconfig.txt` for the RhoConnect Push Service. The URLs used for the RhoConnect Push Service (rhoconnect_push_server) and the RhoConnect server running on the same host.
+
+    syncserver = 'http://192.168.1.10:9292/application'
+  	rhoconnect_push_server = 'http://192.168.1.10:8675'
+  	rhoconnect_push_appname = 'someappname'
+
+### Configuring build.yml
+
+When you configure your application `build.yml` file for RhoConnect Server Push Service, you do not add `push` under `capabilities` for RhoConnect Server Push Service. Instead, you add rhoconnect-push to extensions.
+
+	extensions: ["rhoconnect-push"]
+
+You can still enable vibrate in `build.yml` capabilities.
+
+	capabilities:
+	  - vibrate #=> if you want to enable vibrate in your push messages
+
+### Registering a Push Callback in your Client Application with RhoConnect Server Push Service
+
+To handle a RhoConnect Server Push Service push message from your Rhodes/RhoElements application, you must register callback with the set_push_notification method.
+
+To get push messages from RhoConnect server, the user must be logged into the RhoConnect server.
+
+In application.rb:
+
+  	:::ruby
+    if SyncEngine::logged_in > 0
+      System.set_push_notification("/app/Settings/your_rhoconnect_callback",'')
+    end
+
+[Understanding the Rhodes Push Message Payload](/rhoconnect/push-client-setup#understanding-the-rhodes-push-message-payload) shows the structure of the hash for the callback push message. You can write the push callback to automatically perform some of the operations in the hash by using "rho_push", as shown in [Registering a Push Callback in the Rhodes Application](/rhoconnect/push-client-setup#registering-a-push-callback-in-the-rhodes-application).
+
+### Push Callback, Push Payload
+
+Refer to [Rhodes Device Capabilities - Push Notifications - Push Callback](/rhodes/device-caps#push-callback) for more information about setting up a push callback.
+
+Refer to [Rhodes Device Capabilities - Push Notifications - Push Payload](/rhodes/device-caps#push-payload) for more information about setting up the push payload.

data/doc/push-server-setup.txt

@@ -8,7 +8,7 @@ To set up your RhoConnect server application for delivering push messages, you n
 To set up your RhoConnect application for pushing to an iOS client, you will need to update `settings/settings.yml` to include the following:
 
 	:::yaml
-	:development: 
+	:development:
 	  :redis: localhost:6379
 	  :iphonecertfile: settings/apple_push_cert.pem
 	  :iphonepassphrase: #=> empty or put password for your certificate
@@ -27,7 +27,7 @@ This is for running your application in development mode; for production, you wi
 To set up your RhoConnect application for pushing to a BlackBerry client, you will need to update `settings/settings.yml` to include the following:
 
 	:::yaml
-	:development: 
+	:development:
 	  :redis: localhost:6379
 	  :mdsserver: 192.168.1.110
 	  :mdsserverport: 8080
@@ -36,9 +36,30 @@ To set up your RhoConnect application for pushing to a BlackBerry client, you wi
 
 Replace `:mdsserver:` and `:mdsserverport:` with the hostname/IP and port of your machine (default port is 8080).
 
-## Setting up RhoConnect Server Push for Android
+## Setting up RhoConnect Server Push for Android (GCM)
+
+To set up your RhoConnect application for Android Google Cloud Messaging (GCM), you need to obtain a GCM API key.
 
-To set up your RhoConnect application for Android push, you will need to update `settings/settings.yml` to include the following:
+To do so, set up GCM developer access. Follow the [Getting Started instructions in the GCM documentation](http://developer.android.com/guide/google/gcm/gs.html#create-proj). You can optionally stop in these instructions once you complete the [Obtaining an API Key](http://developer.android.com/guide/google/gcm/gs.html#access-key) section.
+
+Your GCM API key will be found in your [Google apis dashboard](https://code.google.com/apis/console).
+
+Update `settings/settings.yml` to include your GCM API key:
+
+	:::yaml
+	:development:
+	  :redis: localhost:6379
+	  :syncserver: http://localhost:9292/application/
+	  :licensefile: settings/license.key
+	  :gcm_api_key: your_gcm_api_key_here
+
+Start up your RhoConnect application and setup [push notifications](/rhodes/device-caps#push-notifications) in your Rhodes application.
+
+## Setting up RhoConnect Server Push for Android (C2DM)
+
+**NOTE: Google has officially deprecated the C2DM service and requires that you now use Google Cloud Messaging (GCM). Please see [Google's announcement](https://developers.google.com/android/c2dm/) for more details. Follow the instructions at [Setting up RhoConnect Server Push for Android (GCM)](/rhoconnect/push-server-setup#setting-up-rhoconnect-server-push-for-android-gcm) to set up your RhoConnect Application for GCM push.**
+
+To set up your RhoConnect application for Android C2DM push, you will need to update `settings/settings.yml` to include the following:
 
 	:::yaml
 	:development:
@@ -49,7 +70,7 @@ To set up your RhoConnect application for Android push, you will need to update
 	  :c2dm_passwd: passwd
 	  :authtoken: authtoken
 
-In order to push messages to the Android device, your server needs to obtain Google's C2DM authentication token associated with the trusted google account.
+In order to push messages to an Android device, your server needs to obtain Google's C2DM authentication token associated with the trusted google account.
 For this purpose, you can specify C2DM Google account's username/password combo via the `:c2dm_username` and `:c2dm_passwd` settings.
 At run-time, the system will use these credentials to obtain the C2DM token and store it in the Redis for the future use.
 Once the token is expired, the system will automatically connect to the Google C2DM service to renew the token.
@@ -61,13 +82,113 @@ For those who interested in what this token means, the description is [here](htt
 
 Now start up your RhoConnect application and setup [push notifications](/rhodes/device-caps#push-notifications) in your Rhodes application.
 
+## Setting up RhoConnect Server Push Service
+
+**NOTE: This option is still a _beta_ feature.  You may encounter issues using this service.**
+
+RhoConnect v3.3 introduces the RhoConnect Push Service (RPS) which supports efficient messaging for both Android and Windows Mobile. This service can be used instead of Google C2DM on Android.
+
+The typical flow of a message using RPS:
+
+	Device      RPS       	 RhoConnect        Backend App
+	+           +            +                 +
+	|           |            |                 |
+	|           |            | POST            |
+	|           | POST       |/rc/v1/users/ping|
+	|           |/instanceId |<----------------+
+	|           |<-----------+                 |
+	|<----------+            |                 |
+	|{"content"}|            |                 |
+	|           |            |                 |
+	+           +            +                 +
+
+### Download and Install Nodejs
+
+If you are using a Macintosh, go to the [Node.js website](http://nodejs.org/#), and download and install Node.js. (Motorola RhoMobile Suite for Windows includes Node.js in its installation.)
+
+### Starting the Push Service
+
+RhoConnect Push Service is a separate process that will run on your machine and broker push messages between your RhoConnect server and registered devices.
+
+First, create a file called "config.json" with the following content:
+
+	:::json
+	{
+		"httpSecure": "n",
+		"devAuthHost": "localhost",
+		"devAuthUrl": "/rc/v1/app/ans_login",
+		"devAuthPort": "9292",
+		"userAuthHost": "localhost",
+		"userAuthUrl": "/rc/v1/app/ans_login",
+		"userAuthPort": "9292",
+		"appAuthHost": "localhost",
+		"appAuthUrl": "/rc/v1/app/ans_login",
+		"appAuthPort": "9292",
+		"ansResponseTimeout": "300000",
+		"ansServerPort": "8675",
+		"registrationTimeout": "2592000",
+		"clearDataBase": "n",
+		"socketPoolSize": 1,
+		"debugLevel": "3"
+	}
+
+The JSON file has the following parameters.
+
+* `httpSecure` - Specify whether the push server will be an https or http server (y/n).
+* `devAuthHost` - RhoConnect instance used to handle device credentials.
+* `devAuthUrl` - Path used on the RhoConnect instance to handle device credentials.
+* `devAuthPort` - Port used on the RhoConnect instance to handle device credentials.
+* `userAuthHost` - RhoConnect instance used to handle user credentials.
+* `userAuthUrl` - Path used on the RhoConnect instance to handle user credentials.
+* `userAuthPort` - Port used on the RhoConnect instance to handle user credentials.
+* `appAuthHost` - RhoConnect instance used to handle application credentials.
+* `appAuthUrl` - Path used on the RhoConnect instance to handle application credentials.
+* `appAuthPort` - Port used on the RhoConnect instance to handle application credentials.
+* `ansResponseTimeout` -  Time (in ms) that the push server will allow a message request from the client to go without a response. Upon expiration of this time, a 204 response will be issued and the request will be considered satisfied. If this parameter is set to 0, then this time limit will not be in effect - there is no limit to how long a client request will go without a response.
+* `ansServerPort` - Push server listening port
+* `registrationTimeout` - Expiration limit for registration tokens (in seconds), the client-side application is automatically unregistered if there is no activity related to its token for the registrationTimeout period. Activity related to its token consists of either attempted fetches of messages on its behalf by the push client or messages sent to the push server by RhoConnect.
+* `clearDataBase` - Clear the redis database containing tokens, instanceIds, etc. at the start of the push server (y/n).
+* `socketPoolSize` - The maximum number of sockets the push server will use when connecting to each of the authorization servers. This essentially caps the number of http requests to each authorization server that the push server can have outstanding at any given time.
+* `debugLevel` -  Print additional information to console to aid in debugging:
+  * 0 - print only error & warning info
+  * 1 - print error & warning info and message for each invoked ANS operation
+  * 2 - reserved for future use
+  * 3 - print everything
+
+
+Assuming you've installed the latest [RhoMobile Suite](http://www.motorola.com/Business/US-EN/RhoMobile%20Suite/Downloads), start redis.
+
+	:::term
+	$ rhoconnect redis-start
+
+Now start RhoConnect Push by running the following in a command line:
+
+	:::term
+	$ rhoconnect-push -c /path/to/your/config.json
+
+For example:
+
+	:::term
+	$ rhoconnect-push -c C:/dev/config.json
+
+Next, make sure you have the following option in your RhoConnect application's `settings/settings.yml` file in the `:development:`, `:production:` and `:test:` sections:
+
+	:::yaml
+	:push_server: http://someappname@localhost:8675/
+
+Where `someappname` is a shared secret between your RhoConnect application and your mobile application.
+
+**NOTE: This ensures that only your RhoConnect application can send push messages to the RPS instance you started up in the previous step.  Use this in your [mobile app's 'rhoconnect_push_appname' setting](/rhoconnect/push-client-setup#configuring-a-rhodes-application-to-receive-push-with-rhoconnect-push-service). **
+
+Now setup [push notifications](/rhoconnect/push-client-setup#configuring-a-rhodes-application-to-receive-push-with-rhoconnect-push-service) in your Android or Windows Mobile RhoElements application, then start up your RhoConnect application.
+
 ## Testing Push in the RhoConnect Web Console
 
-The [RhoConnect Web Console](/rhoconnect/web-console) includes a utility for testing push to make sure everything is wired up correctly.  
+The [RhoConnect Web Console](/rhoconnect/web-console) includes a utility for testing push to make sure everything is wired up correctly.
 
-First, make sure you've logged in and performed a sync on the device/simulator you are going to test. 
+First, make sure you've logged in and performed a sync on the device/simulator you are going to test.
 
-Next, once you've logged into the web console, navigate to the user's page you used to login in the Rhodes application.  For example, if you logged in as user 't', the url would be: 
+Next, once you've logged into the web console, navigate to the user's page you used to login in the Rhodes application. For example, if you logged in as user 't', the url would be:
 
 	http://localhost:9292/console/user?user_id=t
 

data/doc/rails-plugin.txt

@@ -1,4 +1,4 @@
-rhoconnect-rb
+rhoconnect-rb [![Build Status](https://secure.travis-ci.org/rhomobile/rhoconnect-rb.png)](http://travis-ci.org/rhomobile/rhoconnect-rb)
 ===
 
 A ruby library for the [RhoConnect](http://rhomobile.com/products/rhoconnect) App Integration Server.
@@ -12,23 +12,23 @@ Load the `rhoconnect-rb` library:
 	require 'rhoconnect-rb'
 
 Note, if you are using datamapper, install the `dm-serializer` library and require it in your application.  `rhoconnect-rb` depends on this utility to interact with Rhoconnect applications using JSON.
-	
+
 ## Setup the Model
-Now include Rhoconnect::Resource in a model that you want to synchronize with your mobile application:
+Now include Rhoconnectrb::Resource in a model that you want to synchronize with your mobile application:
 
 	class Product < ActiveRecord::Base
-	  include Rhoconnect::Resource
+	  include Rhoconnectrb::Resource
 	end
-	
+
 Or, if you are using DataMapper:
 
 	class Product
 	  include DataMapper::Resource
-	  include Rhoconnect::Resource
+	  include Rhoconnectrb::Resource
 	end
 
 ## Partitioning Datasets
-	
+
 Next, your models will need to declare a partition key for `rhoconnect-rb`.  This partition key is used by `rhoconnect-rb` to uniquely identify the model dataset when it is stored in a rhoconnect instance.  It is typically an attribute on the model or related model.  `rhoconnect-rb` supports two types of partitions:
 
 * :app - No unique key will be used, a shared dataset is synchronized for all users.
@@ -37,21 +37,21 @@ Next, your models will need to declare a partition key for `rhoconnect-rb`.  Thi
 For example, the `Product` model above might have a `belongs_to :user` relationship.  This provides us a simple way to organize the `Product` dataset for rhoconnect by reusing this relationship.  The partition identifying a username would be declared as:
 
 	class Product < ActiveRecord::Base
-	  include Rhoconnect::Resource
-	  
+	  include Rhoconnectrb::Resource
+
 	  belongs_to :user
-	
-	  def partition 
-		lambda { self.user.username }
+
+	  def partition
+			lambda { self.user.username }
 	  end
 	end
-	
+
 Now all of the `Product` data synchronized by rhoconnect will organized by `self.user.username`.  Note: You can also used a fixed key if the dataset doesn't require a dynamic value:
 
 	def partition
 	  :app
 	end
-	
+
 For more information about Rhoconnect partitions, please refer to the [Rhoconnect docs](http://docs.rhomobile.com/rhoconnect/source-adapters#data-partitioning).
 
 ## Querying Datasets
@@ -59,20 +59,20 @@ For more information about Rhoconnect partitions, please refer to the [Rhoconnec
 `rhoconnect-rb` installs a `/rhoconnect/query` route in your application which the Rhoconnect instance invokes to query the dataset for the dataset you want to synchronize.  This route is mapped to a `rhoconnect_query` method in your model.  This method should return a collection of objects:
 
 	class Product < ActiveRecord::Base
-	  include Rhoconnect::Resource
-	  
+	  include Rhoconnectrb::Resource
+
 	  belongs_to :user
-	
-	  def partition 
-		lambda { self.user.username }
+
+	  def partition
+			lambda { self.user.username }
 	  end
-	
-	  def self.rhoconnect_query(partition)
-	    Product.includes(:user).where("users.username = ?",partition)
+
+	  def self.rhoconnect_query(partition, attributes = nil)
+	    Product.includes(:user).where("users.username = ?", partition)
 	  end
 	end
 
-In this example, `self.rhoconnect_query` returns a list of products where the partition string (provided by the rhoconnect instance) matches the `user_id` field in the products table.  
+In this example, `self.rhoconnect_query` returns a list of products where the partition string (provided by the rhoconnect instance) matches the `user_id` field in the products table.
 
 ## Configuration and Authentication
 
@@ -83,41 +83,246 @@ Configure RhoConnect in an initializer like `config/initializers/rhoconnect.rb`
 	config.uri   = "http://myrhoconnect.com"
 	config.token = "secrettoken"
 	config.app_endpoint = "http://myapp.heroku.com"
-	
+
 If `app_endpoint` is defined, your Rhoconnect instance will be configured to query data from the endpoint using the rhoconnect_query method in your model.  For example, if your `app_endpoint` is defined as "http://myapp.heroku.com", RhoConnect will query data with:
 
 	POST http://myapp.heroku.com/rhoconnect/query
 
-Example: 
+Example:
 
-   	Rhoconnect.configure do |config|
-      config.uri   		  = "http://myrhoconnect-server.com"
-      config.token 		  = "secrettoken"
-	  config.app_endpoint = "http://myapp.heroku.com"
+	Rhoconnectrb.configure do |config|
+		config.uri    = "http://localhost:8675"
+		config.token  = "mydevtoken"
+		config.app_endpoint = "http://localhost:3000"
 	end
-	
+
 Example with authentication:
 
 `rhoconnect-rb` installs a `/rhoconnect/authenticate` route into your application which will receive credentials from the client.  Add block which handles the credentials:
 
-	Rhoconnect.configure do |config|
-      config.uri   = "http://myrhoconnect-server.com"
-      config.token = "secrettoken"
-	  config.authenticate = lambda { |credentials| 
-        User.authenticate(credentials['login'], credentials['password']) 
+	Rhoconnectrb.configure do |config|
+		config.uri    = "http://localhost:8675"
+		config.token  = "mydevtoken"
+		config.app_endpoint = "http://localhost:3000"
+	  config.authenticate = lambda { |credentials|
+	  	User.authenticate(credentials[:login], credentials[:password])
 	  }
 	end
-	
+
 ### Using the [RhoConnect Heroku Addon](http://docs.rhomobile.com/rhoconnect/heroku-addon)
 
 If you're using the [RhoConnect Heroku Addon](http://docs.rhomobile.com/rhoconnect/heroku-addon), then you can omit the config.uri and config.token (they are managed for you):
 
-	Rhoconnect.configure do |config|
-	  config.authenticate = lambda { |credentials| 
-	    User.authenticate(credentials['login'], credentials['password']) 
+	Rhoconnectrb.configure do |config|
+		config.app_endpoint = "http://myapp.heroku.com"
+	  config.authenticate = lambda { |credentials|
+	    User.authenticate(credentials[:login], credentials[:password])
 	  }
 	end
-	
+
+## Rhoconnect-rb API
+
+### Overview of the API
+
+The Rhoconnectrb::API module contains routes to all the resources available in <a href='http://docs.rhomobile.com/rhoconnect/rest-api'>Rhoconnect</a>.  At a high level the API calls take on the following syntax:
+
+	Namespace::Resource.verb_action1_action2_...([resource_id,action1_id,action2_id],data)
+
+Some of these values are not used for every API call such as resource_id and data.
+
+### System Resource
+
+#### `POST /rc/v1/system/login`
+
+
+	data = {:login=>'username',:password=>'password'}
+	Rhoconnectrb::API::System.post_login(data)
+
+#### `GET /rc/v1/system/license`
+
+
+	Rhoconnectrb::API::System.get_license
+
+#### `POST /rc/v1/system/reset`
+
+
+	Rhoconnectrb::API::System.post_reset({})
+
+#### `GET /rc/v1/system/appserver`
+
+
+	Rhoconnectrb::API::System.get_appserver
+
+#### `POST /rc/v1/system/appserver`
+
+
+	data = {:adapter_url=>'http://test.com'}
+	Rhoconnectrb::API::System.post_appserver(data)
+
+#### `GET /rc/v1/system/stats`
+
+
+	data ={:names=>"*sources*"}
+	Rhoconnectrb::API::System.get_stats(data)
+
+### Store Resource
+
+#### `GET /rc/v1/store/:doc`
+
+
+	Rhoconnectrb::API::Store.get('docname')
+
+#### `POST /rc/v1/store/:doc`
+
+
+	data = {:data=>{:id=3},:append=>false}
+	Rhoconnectrb::API::Store.post('docname',data)
+
+### User Resource
+
+#### `POST /rc/v1/users`
+
+
+	data = {:attributes=>{:login=>'login',:password=>'password'}}
+	Rhoconnectrb::API::Users.post(data)
+
+#### `DELETE /rc/v1/users/:user_id`
+
+
+	Rhoconnectrb::API::Users.delete('user_id')
+
+#### `PUT /rc/v1/users/:user_id`
+
+
+	data = {:attributes=>{:a_user_specific_attribute => a_user_specific_attribute_value}}
+	Rhoconnectrb::API::Users.put('user_id',data)
+
+#### `GET /rc/v1/users`
+
+
+	Rhoconnectrb::API::Users.get
+
+#### `Get /rc/v1/users/:user_id`
+
+	Rhoconnectrb::API::Users.get('user_id')
+
+#### `Get /rc/v1/users/:user_id/clients`
+
+
+	Rhoconnectrb::API::Users.get_clients(['user_id','client_id'])
+
+#### `DELETE /rc/v1/users/:user_id/clients/:client_id`
+
+
+	Rhoconnectrb::API::Users.delete_clients(['user_id','client_id'])
+
+#### `GET /rc/v1/users/:user_id/sources/:source_id/docnames`
+
+
+	Rhoconnectrb::API::Users.get_sources_docnames(['user_id','source_id'])
+
+#### `POST /rc/v1/users/ping`
+
+
+	data = {
+	  :api_token => token,
+	  :user_id => [array_of_users],
+	  :sources => source_name,
+	  :message => 'hello world',
+	  :vibrate => 2000,
+	  :sound => 'hello.mp3'
+	}
+	Rhoconnectrb::API::Users.post_ping(data)
+
+#### `GET /rc/v1/users/:user_id/sources/:source_id/docs/:doc`
+
+
+	Rhoconnectrb::API::Users.get_sources_docs(['user_id','source_id','docname'])
+
+#### `POST /rc/v1/users/:user_id/sources/:source_id/docs/:doc`
+
+
+	data = {:data=>data,:append=>false}
+	Rhoconnectrb::API::Users.post_sources_docs(['user_id','source_id','docname'],data)
+
+### Read State Resource
+
+#### `POST /rc/v1/read_state/users/:user_id/sources/:source_id`
+
+
+	data = {:refresh_time => 100}
+	Rhconnectrb::API::ReadState.post_users_sources(['user_id','source_id'])
+
+### Source Resource
+
+#### `GET /rc/v1/sources/type/:partition_type`
+
+
+	Rhoconnectrb::API::Sources.get_type('parition_type')
+
+#### `GET /rc/v1/sources/:source_id`
+
+
+	Rhoconnectrb::API::Sources.get('source_id')
+
+#### `PUT /rc/v1/sources/:source_id`
+
+
+	data = {:user_name=>'username',:data=>{:poll_interval=>25}}
+	Rhoconnectrb::API::Sources.put('source_id',data)
+
+### Client Resource
+
+#### `GET /rc/v1/clients/:client_id`
+
+
+	Rhoconnectrb::API::Clients.get('client_id')
+
+#### `GET /rc/v1/clients/:client_id/sources/:source_id/docnames`
+
+
+	Rhoconnectrb::API::Clients.get_sources_docnames(['client_id','source_id'])
+
+#### `POST /rc/v1/clients/:client_id/sources/:source_id/docnames`
+
+
+	data = {:data=>data,:append=>false}
+	Rhoconnectrb::API::Clients.post_sources_docnames(['client_id','source_id'],data)
+
+### Resource Resource
+
+The Resource class is used for API calls to user defined dynamic or source adapters.  The resource name is passed in as a parameter.
+
+#### `POST /app/v1/:source_name/push_objects`
+
+
+	data = {:user_id=>'user_id',:objects=>data}
+	Rhoconnectrb::API::Resource.post_push_objects('source_name',data)
+
+#### `POST /app/v1/:source_name/push_deletes`
+
+
+	data = {:user_id => 'user_id',:objects=>'object_ids'}
+	Rhoconnectrb::API::Resource.post_push_deletes('source_name',data)
+
+#### `POST /app/v1/:source_name/fast_insert`
+
+
+	data = {:user_id=>'user_id',:objects=>data}
+	Rhoconnectrb::API::Resource.post_fast_insert('source_name',data)
+
+#### `POST /app/v1/:source_name/fast_update`
+
+
+	data = {:user_id=>'user_id',:objects=>data}
+	Rhoconnectrb::API::Resource.post_fast_update('source_name',data)
+
+#### `POST /app/v1/:source_name/fast_delete`
+
+
+	data = {:user_id=>'user_id',:objects=>data}
+	Rhoconnectrb::API::Resource.post_fast_delete('source_name',data)
+
 
 ## Meta
 Created and maintained by Lucas Campbell-Rossen, Vladimir Tarasov and Lars Burgess.