rhosync_api 0.0.6 → 0.1.3

data/History.txt

@@ -2,6 +2,10 @@
 version 0.0.1  - 5 August 2011 - firts test of the gem
 version 0.0.2  - 5 August 2011 - fixing methods
 version 0.0.3  - 5 August 2011 - added new api methods 
-version 0.0.4  - 6 August 2011 - error
+version 0.0.4  - 6 August 2011 - error, this version is not working at all.
 version 0.0.5  - 6 August 2011 - firts stable release
-varsion 0.0.6  - 7 August 2001 - added README file and changed class RhosyncApi to module RhosyncApi 
+version 0.0.6  - 7 August 2001 - added README file and changed class RhosyncApi to module RhosyncApi 
+
+version 0.1.0  - 27 August 2011 - Gem name was changed from Rhosync_Api to RhoApi due conflicts with RhosyncApi module
+                                - Added methods find, create, delete, delete_all
+                                - Added methods push_objects and push_deletes, update_user

data/LICENSE

@@ -1,8 +1,8 @@
-Created by Raul Mantilla Assia (2011)
+Created by Raul Mantilla Assia (2011)  
+Any comments or questions to rmantilla26@hotmail.com
 
-Based on the rhomobile documentation
 
-All the comments in this gem was copied from the Rhomobile web page, and doesn't belong to the author.
+Based on the rhomobile documentation
 
 http://docs.rhomobile.com/rhosync/rest-api
 

data/README

@@ -1,4 +1,11 @@
-= Rhosync_api
+Created by Raul Mantilla Assia (2011)  
+Any comments or questions to rmantilla26@hotmail.com
+
+Based on the rhomobile documentation
+
+http://docs.rhomobile.com/rhosync/rest-api
+
+=rhosync_api
 
 With this gem you can connect to the rhosync API very easy.
 
@@ -8,10 +15,60 @@ With this gem you can connect to the rhosync API very easy.
 
 =HOW TO
 
-require "rubygems"
-require "rhosync_api"
+    require "rubygems"
+    require "rhosync_api"
+
+    RhoApi."method"
+
+
+
+=SIMULATING ACTIVERECORD (Beta version, not completed)
+    A new feature was added to this gem,  after the login method, the gem will get all the source adapters
+    and simulate a rails active record.
+    that means that we can do simples find, create, delete methods like:
+    
+    RhoApi.Contacts.find("Test_user",:conditions=>{:object=>"0001"})
+    RhoApi.Contacts.create("Test_user",{ "0001"=>{"name"=>"Raul","lastname"=>"Mantilla"} } )
+    RhoApi.Contacts.delete("Test_user","0003")
+    RhoApi.Contacts.delete_all("Test_user")
+
+
+=FIND
+    with this method you can search data inside a source adapter, right now is only avaliable to search by "object id"
+    or using AND conditionals,  in the future will be OR, ORDER, and more conditions.
+    <source_name> =  is the Source name, should be the same name in the rhosync setting.yml file
+    <user_id> = is the User name or login ID.
+
+    RhoApi.<source_name>.find("<user_id>",:conditions=>{:object=>"0001"})
+    RhoApi.<source_name>.find("<user_id>",:conditions=>{"field1"=>"value1","field2"=>"value2"})
+   
+    
+=CREATE
+    with the create method you can insert new records into a given source adapter. and user id
+    <source_name> =  is the Source name, should be the same name in the rhosync setting.yml file
+    <user_id> = is the User name or login ID.
+    DATA :  Data should be a hash of hashes.   {"0001"=>{"field1"=>"value","field2"=>"value2"},.....}
+    you can insert multiple record in the same query.
+
+    RhoApi.<source_name>.create("<user_id>",data)
+
+=DELETE
+    with the delete method you can delete records from a given source adapter and user id
+    <source_name> =  is the Source name, should be the same name in the rhosync setting.yml file
+    <user_id> = is the User name or login ID.
+    OBJECTS ID :  Data should be an Array of objects IDs  ["0001","0002"]
+    could be also a string "0001" if you want to delete only one value 
+    
+    RhoApi.<source_name>.delete("<user_id>",objects)
+
+=DELETE_ALL
+    with this method you can delete all the data in a given source adapter and user id
+    <source_name> =  is the Source name, should be the same name in the rhosync setting.yml file
+    <user_id> = is the User name or login ID.
+
+    RhoApi.<source_name>.delete_all("<user_id>")
+
 
-RhosyncApi."method"
 
 =METHODS
 
@@ -23,6 +80,7 @@ RhosyncApi."method"
     - ping  
     - list_users
     - create_user
+    - update_user
     - delete_user
     - list_clients
     - create_client
@@ -41,7 +99,7 @@ RhosyncApi."method"
 =LOGIN
   this method is used to authenticate with rhosync server
   
-  RhosyncApi.login("http://localhost:3000","rhoadmin","")
+  RhoApi.login("http://localhost:3000","rhoadmin","")
 
   params:
     - RHOSYNC URL 
@@ -53,12 +111,12 @@ RhosyncApi."method"
 
 =LOGOUT
     This method set token variable to nil
-    RhosyncApi.logout
+    RhoApi.logout
 
 
 =GET_API_TOKEN
 
-    RhosyncApi.get_api_token
+    RhoApi.get_api_token
     
     return:
     this method returns the rhosync token,  with this token you can authenticate to rhosync
@@ -66,21 +124,21 @@ RhosyncApi."method"
 
 =GET_LICENSE_INFO
 
-    RhosyncApi.get_license_info
+    RhoApi.get_license_info
     
     return:
     this method returns all the information about the rhosync license
 
 =RESET
 
-    RhosyncApi.reset
+    RhoApi.reset
     
     this method will reset all the redis information in rhosync
 
 =PING
     this method is used to send alerts to devices using rhosync settings
     
-    RhosyncApi.ping(user_id,ping_params)
+    RhoApi.ping(user_id,ping_params)
     
     params
     - USER_ID 
@@ -96,7 +154,7 @@ RhosyncApi."method"
 
 =LIST_USERS
     
-    RhosyncApi.list_users
+    RhoApi.list_users
     
     return:
     this method returns an ARRAY of users ID.
@@ -104,7 +162,7 @@ RhosyncApi."method"
 =CREATE_USER
     with this method you can create a new user in rhosync
     
-    RhosyncApi.create_user("username","password")
+    RhoApi.create_user("username","password")
 
     params:
     - USERNAME
@@ -112,10 +170,23 @@ RhosyncApi."method"
     return:
      this method will return nil if it fails   
 
+=UPDATE_USER
+    with this method you can update the user password, be careful this method will change the Admin password, so keep it in mind.
+    tested in rhosync 2.1.6: for some reason went i changed the password the admin password was changed too, i think is a bug in this rhosync version.
+
+    RhoApi.update_user("username","new password")
+
+    params:
+    - USERNAME : any user ID
+    - NEW PASSWORD : thi will be the new password
+    return:
+     this method will return nil if it fails   
+
+
 =DELETE_USER
     with this method you can delete an existing user in rhosync
     
-    RhosyncApi.delete_user("user_id")
+    RhoApi.delete_user("user_id")
 
     params:
     - USERID
@@ -125,7 +196,7 @@ RhosyncApi."method"
 =LIST_CLIENTS
     this method returns a list of devices for a given user ID
     
-    RhosyncApi.list_clients("user_id")
+    RhoApi.list_clients("user_id")
 
     params:
     - USERID
@@ -135,7 +206,7 @@ RhosyncApi."method"
 =CREATE_CLIENT
     this method create a device for a given user ID
     
-    RhosyncApi.create_client("user_id")
+    RhoApi.create_client("user_id")
 
     params:
     - USERID
@@ -145,7 +216,7 @@ RhosyncApi."method"
 =DELETE_CLIENT
     this method deletes a device for a given user ID and device ID
     
-    RhosyncApi.delete_client("user_id","device_id")
+    RhoApi.delete_client("user_id","device_id")
 
     params:
     - USERID
@@ -156,7 +227,7 @@ RhosyncApi."method"
 =GET_CLIENT_PARAMS
     this method returns the attributes of a given device ID, such as device_type, device_pin, device_port.
     
-    RhosyncApi.get_client_params("device_id")
+    RhoApi.get_client_params("device_id")
 
     params:
     - DEVICE_ID
@@ -167,8 +238,8 @@ RhosyncApi."method"
 =LIST_SOURCES
     this method returns a list rhosync source adapters for a given partition
     
-    RhosyncApi.list_sources("partition")
-    RhosyncApi.list_sources
+    RhoApi.list_sources("partition")
+    RhoApi.list_sources
 
     params:
     - PARTITION :  this could be "user" or "app" by default if use "user" partition
@@ -179,7 +250,7 @@ RhosyncApi."method"
     this method returns the attributes of a given source adapter
     such as name, poll_interval, partition_type, sync_type, queue, query_queue, cud_queue
 
-    RhosyncApi.get_source_params("source name")
+    RhoApi.get_source_params("source name")
 
     params:
     - SOURCE NAME
@@ -190,7 +261,7 @@ RhosyncApi."method"
     this method returns a list of document keys associated with given source and user.
     such as md, md_size, md_copy,  errors 
 
-    RhosyncApi.list_source_docs("user_id","source_name")
+    RhoApi.list_source_docs("user_id","source_name")
 
     params:
     - USER ID
@@ -201,8 +272,8 @@ RhosyncApi."method"
 =GET_DB_DOC
     this method returns the content of a given document key.
     
-    RhosyncApi.get_db_doc("document key","data_type")
-    RhosyncApi.get_db_doc("document key")
+    RhoApi.get_db_doc("document key","data_type")
+    RhoApi.get_db_doc("document key")
 
     params:
     - DOCUMENT KEY :  this is the document key listed in the LIST_SOURCE_DOCS method
@@ -213,8 +284,8 @@ RhosyncApi."method"
 =SET_DB_DOC
     this method set content of a given document key
     
-    RhosyncApi.set_db_doc("document key","data","data_type")
-    RhosyncApi.set_db_doc("document key","data")
+    RhoApi.set_db_doc("document key","data","data_type")
+    RhoApi.set_db_doc("document key","data")
 
     params:
     - DOCUMENT KEY :  this is the document key listed in the LIST_SOURCE_DOCS method
@@ -226,7 +297,7 @@ RhosyncApi."method"
 =LIST_CLIENT_DOC
     this method returns a list of document keys associated with particular device.
     
-    RhosyncApi.list_client_docs("device_id","source_name")
+    RhoApi.list_client_docs("device_id","source_name")
 
     params:
     - DEVICE_ID : 
@@ -237,7 +308,7 @@ RhosyncApi."method"
 =GET_DB_DOC_BY_TYPE
     this method returns the content of a given document user and source name.
     
-    RhosyncApi.get_db_doc("user_id","source_name","type_doc")
+    RhoApi.get_db_doc_by_type("user_id","source_name","type_doc")
 
     params:
     - USER ID :  
@@ -249,7 +320,7 @@ RhosyncApi."method"
 =SET_DB_DOC_BY_TYPE
     this method set content of a given user id and source name
     
-    RhosyncApi.set_db_doc_by_type("user_id","source_name","data","type_doc")
+    RhoApi.set_db_doc_by_type("user_id","source_name","data","type_doc")
 
     params:
     - USER ID :  
@@ -258,4 +329,29 @@ RhosyncApi."method"
     - TYPE DOC :  such as md, md_size, md_copy,  errors 
     return:
      this method will return nil if it fails
-    - set_db_doc_by_type
+   
+
+=PUSH_OBJECTS
+    this method save data into a given user id and source name
+    
+    RhoApi.push_objects("user_id","source_name","data")
+    
+    params:
+    - USER ID :  
+    - SOURCE NAME: 
+    - DATA :  Data should be a hash of hashes.   {"0001"=>{"field1"=>"value","field2"=>"value2"},.....}
+    return:
+     this method will return nil if it fails
+
+=PUSH_DELETES
+    this method deletes records in a given user id and source name
+    
+    RhoApi.push_deletes("user_id","source_name","data")
+    
+    params:
+    - USER ID :  
+    - SOURCE NAME: 
+    - DATA :  Data should be an Array of objects IDs  ["0001","0002"],  could be also a string   "0001"
+    return:
+     this method will return nil if it fails
+