rhosync_api 0.0.5 → 0.0.6

data/History.txt

@@ -1,6 +1,7 @@
 
-version 0.0.1  - 5 August 2011
-version 0.0.2  - 5 August 2011
-version 0.0.3  - 5 August 2011
-version 0.0.4  - 6 August 2011
-version 0.0.5  - 6 August 2011
+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.5  - 6 August 2011 - firts stable release
+varsion 0.0.6  - 7 August 2001 - added README file and changed class RhosyncApi to module RhosyncApi 

data/{LICENSE.txt → LICENSE}

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

data/README

@@ -0,0 +1,261 @@
+= Rhosync_api
+
+With this gem you can connect to the rhosync API very easy.
+
+=INTALLATION
+
+    gem install rhosync_api
+
+=HOW TO
+
+require "rubygems"
+require "rhosync_api"
+
+RhosyncApi."method"
+
+=METHODS
+
+    - login
+    - logout
+    - get_api_token
+    - get_license_info
+    - reset
+    - ping  
+    - list_users
+    - create_user
+    - delete_user
+    - list_clients
+    - create_client
+    - delete_client
+    - get_client_params
+    - list_sources
+    - get_source_params
+    - list_source_docs
+    - get_db_doc
+    - set_db_doc
+    - list_client_docs
+    - get_db_doc_by_type
+    - set_db_doc_by_type
+
+
+=LOGIN
+  this method is used to authenticate with rhosync server
+  
+  RhosyncApi.login("http://localhost:3000","rhoadmin","")
+
+  params:
+    - RHOSYNC URL 
+    - USERNAME
+    - PASSWORD
+  return:
+     this method will return a token is the authentication is correct
+     this method will return nil if the authentication is incorrect
+
+=LOGOUT
+    This method set token variable to nil
+    RhosyncApi.logout
+
+
+=GET_API_TOKEN
+
+    RhosyncApi.get_api_token
+    
+    return:
+    this method returns the rhosync token,  with this token you can authenticate to rhosync
+
+
+=GET_LICENSE_INFO
+
+    RhosyncApi.get_license_info
+    
+    return:
+    this method returns all the information about the rhosync license
+
+=RESET
+
+    RhosyncApi.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)
+    
+    params
+    - USER_ID 
+          the rhosync user id
+    - PING_PARAMS
+          ping_params => { :message => "this is a test", :sound=>"hello.mp3" }
+          # :message - message which will be used to display notification popup dialog on the device
+          # :badge - iphone specific badge
+          # :sound - name of the sound file to play upon receiving PUSH notification
+          # :vibrate - number of seconds to vibrate upon receiving PUSH notification
+          # :sources - list of data source names to be synced upon receiving PUSH notification
+
+
+=LIST_USERS
+    
+    RhosyncApi.list_users
+    
+    return:
+    this method returns an ARRAY of users ID.
+
+=CREATE_USER
+    with this method you can create a new user in rhosync
+    
+    RhosyncApi.create_user("username","password")
+
+    params:
+    - USERNAME
+    - 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")
+
+    params:
+    - USERID
+    return:
+     this method will return nil if it fails
+
+=LIST_CLIENTS
+    this method returns a list of devices for a given user ID
+    
+    RhosyncApi.list_clients("user_id")
+
+    params:
+    - USERID
+    return:
+     this method will return nil if it fails
+
+=CREATE_CLIENT
+    this method create a device for a given user ID
+    
+    RhosyncApi.create_client("user_id")
+
+    params:
+    - USERID
+    return:
+     this method will return nil if it fails
+
+=DELETE_CLIENT
+    this method deletes a device for a given user ID and device ID
+    
+    RhosyncApi.delete_client("user_id","device_id")
+
+    params:
+    - USERID
+    - DEVICE_ID
+    return:
+     this method will return nil if it fails
+
+=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")
+
+    params:
+    - DEVICE_ID
+    return:
+     this method will return nil if it fails
+
+
+=LIST_SOURCES
+    this method returns a list rhosync source adapters for a given partition
+    
+    RhosyncApi.list_sources("partition")
+    RhosyncApi.list_sources
+
+    params:
+    - PARTITION :  this could be "user" or "app" by default if use "user" partition
+    return:
+     this method will return nil if it fails    
+   
+=GET_SOURCE_PARAMS
+    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")
+
+    params:
+    - SOURCE NAME
+    return:
+     this method will return nil if it fails    
+
+=LIST_SOURCE_DOCS
+    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")
+
+    params:
+    - USER ID
+    - SOURCE NAME
+    return:
+     this method will return nil if it fails    
+
+=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")
+
+    params:
+    - DOCUMENT KEY :  this is the document key listed in the LIST_SOURCE_DOCS method
+    - DATA TYPE: could be "string" or nil
+    return:
+     this method will return nil if it fails  
+   
+=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")
+
+    params:
+    - DOCUMENT KEY :  this is the document key listed in the LIST_SOURCE_DOCS method
+    - DATA :  Data should be either a string or hash of hashes.
+    - DATA TYPE: could be type "string" or nil
+    return:
+     this method will return nil if it fails  
+   
+=LIST_CLIENT_DOC
+    this method returns a list of document keys associated with particular device.
+    
+    RhosyncApi.list_client_docs("device_id","source_name")
+
+    params:
+    - DEVICE_ID : 
+    - SOURCE NAME:
+    return:
+     this method will return nil if it fails 
+     
+=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")
+
+    params:
+    - USER ID :  
+    - SOURCE NAME: 
+    - TYPE DOC :  such as md, md_size, md_copy,  errors 
+    return:
+     this method will return nil if it fails
+
+=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")
+
+    params:
+    - USER ID :  
+    - SOURCE NAME: 
+    - DATA :  Data should be a hash of hashes.
+    - TYPE DOC :  such as md, md_size, md_copy,  errors 
+    return:
+     this method will return nil if it fails
+    - set_db_doc_by_type

data/lib/rhosync_api.rb

@@ -4,25 +4,27 @@
 require 'rest_client'
 require 'json'
 
-class RhosyncApi
-
-  def initialize
-    $server = ""
-    $username = ""
-    $password = ""
-    $token = ""
-  end
+module RhosyncApi
 
   #login -- rhosync
-  def login(server,admin,password)
+  def self.login(server,admin,password)
     $server = server
     $username = admin
     $password = password
     $token = get_api_token
   end
+  
+  #logout -- rhosync
+  def self.logout
+    $server = nil
+    $username = nil
+    $password = nil
+    $token = nil
+    true
+  end
 
   #Before you can use RhoSync API you should get API token:
-  def get_api_token
+  def self.get_api_token
     uri = URI.parse($server)
     http = Net::HTTP.new(uri.host,uri.port)
     begin
@@ -38,7 +40,7 @@ class RhosyncApi
   end
 
   #Returns license information of the currently used license
-  def get_license_info
+  def self.get_license_info
     unless $token.nil?
       begin
         license_info = RestClient.post(
@@ -55,7 +57,7 @@ class RhosyncApi
   end
 
   #Reset the server: flush db and re-bootstrap server
-  def reset
+  def self.reset
     unless $token.nil?
       begin
         RestClient.post("#{$server}/api/reset",
@@ -75,7 +77,7 @@ class RhosyncApi
   # :sound - name of the sound file to play upon receiving PUSH notification
   # :vibrate - number of seconds to vibrate upon receiving PUSH notification
   # :sources - list of data source names to be synced upon receiving PUSH notification
-  def ping(user_id,ping_params)
+  def self.ping(user_id,ping_params)
     unless $token.nil?
       unless user_id.nil? 
         begin
@@ -96,7 +98,7 @@ class RhosyncApi
   end
 
   #List users registered with this RhoSync application.
-  def list_users
+  def self.list_users
     unless $token.nil?
       begin
         users = RestClient.post(
@@ -114,7 +116,7 @@ class RhosyncApi
   end
 
   #Create a user in this RhoSync application.
-  def create_user(login,password)
+  def self.create_user(login,password)
     unless $token.nil?
       unless login.nil?
         begin
@@ -141,7 +143,7 @@ class RhosyncApi
   end
 
   #Delete User and all associated devices from the RhoSync application.
-  def delete_user(user_id)
+  def self.delete_user(user_id)
     unless $token.nil?
       unless user_id.nil?
         begin
@@ -166,7 +168,7 @@ class RhosyncApi
   end
 
   #List clients (devices) associated with given user.
-  def list_clients(user_id)
+  def self.list_clients(user_id)
     unless $token.nil?
       begin
         clients = RestClient.post("#{$server}/api/list_clients",
@@ -186,7 +188,7 @@ class RhosyncApi
   end
 
   #Creates a client (device) for a given user.
-  def create_client(user_id)
+  def self.create_client(user_id)
     unless $token.nil?
       unless user_id.nil?
         begin
@@ -211,7 +213,7 @@ class RhosyncApi
   end
 
   #Deletes the specified client (device).
-  def delete_client(user_id,client_id)
+  def self.delete_client(user_id,client_id)
     unless $token.nil?
       unless user_id.nil? and client_id.nil?
         begin
@@ -237,7 +239,7 @@ class RhosyncApi
   end
 
   #Returns client (device) attributes, such as device_type, device_pin, device_port. These attributes used by RhoSync push.
-  def get_client_params(client_id)
+  def self.get_client_params(client_id)
     unless $token.nil?
       begin
         client_params = RestClient.post(
@@ -258,7 +260,7 @@ class RhosyncApi
   end
 
   #Return list of source adapters for this RhoSync application.
-  def list_sources(partition = nil)
+  def self.list_sources(partition = nil)
     unless $token.nil?
       partition = "user" if partition.nil?
       begin
@@ -288,7 +290,7 @@ class RhosyncApi
   # queue � name of the queue for both query and create/update/delete (CUD) jobs (used if no specific queues not specified)
   # query_queue � name of query queue
   # cud_queue � name of CUD queue
-  def get_source_params(source_id)
+  def self.get_source_params(source_id)
     unless $token.nil?
       begin
         attributes = RestClient.post("#{$server}/api/get_source_params",
@@ -310,7 +312,7 @@ class RhosyncApi
   # Return list of document keys associated with given source and user.
   # If :user_id set to �*�, this call will return list of keys for �shared� documents.
   # MD(:md) � master document; represents state of the backend (set of all objects for the given app/user/source on the backend service).
-  def list_source_docs(user_id,source_id)
+  def self.list_source_docs(user_id,source_id)
     unless $token.nil?
       begin
         docs = RestClient.post(
@@ -332,7 +334,7 @@ class RhosyncApi
   end
 
   #Return content of a given document (client or source).
-  def get_db_doc(doc,data_type = nil)
+  def self.get_db_doc(doc,data_type = nil)
     unless $token.nil?
       begin
         res = RestClient.post(
@@ -355,8 +357,13 @@ class RhosyncApi
   
   #Sets the content of the specified server document. 
   #Data should be either a string or hash of hashes. Data type should be set accordingly.
-  def set_db_doc(doc,data,data_type = nil)
+  def self.set_db_doc(doc,data)
     unless $token.nil?
+      if data.class == "String"
+        data_type = "string"
+      else
+        data_type = nil
+      end
       begin
         RestClient.post(
           "#{$server}/api/set_db_doc", 
@@ -379,7 +386,7 @@ class RhosyncApi
   #Returns list of document keys associated with particular client.
   #These documents are used by the server to sync data with the client.
   #CD (:cd) � client document; represents the state of the client (set of all objects on the given client).
-  def list_client_docs(client_id,source_id)
+  def self.list_client_docs(client_id,source_id)
     unless $token.nil?
       begin
         docs = RestClient.post(
@@ -402,7 +409,7 @@ class RhosyncApi
 
   #NEW METHODS IN THE GEM
   #Return content of a given document
-  def get_db_doc_by_type(user_id,source_id,type_doc)
+  def self.get_db_doc_by_type(user_id,source_id,type_doc)
     unless $token.nil?
       begin
         docs = list_source_docs(user_id,source_id)
@@ -425,7 +432,7 @@ class RhosyncApi
   end
   
   #set content of a given document
-  def set_db_doc_by_type(user_id,source_id,data,type_doc)
+  def self.set_db_doc_by_type(user_id,source_id,data,type_doc)
     unless $token.nil?
       begin
         docs = list_source_docs(user_id,source_id)
@@ -438,12 +445,12 @@ class RhosyncApi
     end
   end
 
-  def access_denied
+  def self.access_denied
     puts "you don't have access, please login in"
     nil
   end
 
-  def cant_connect_rhosync(e)
+  def self.cant_connect_rhosync(e)
     puts "rhosync error : #{e.inspect}"
     nil
   end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: rhosync_api
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
-- Raul Mantilla
+- Raul Mantilla Assia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-06 00:00:00.000000000Z
+date: 2011-08-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &22531452 !ruby/object:Gem::Requirement
+  requirement: &21336504 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *22531452
+  version_requirements: *21336504
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &22531164 !ruby/object:Gem::Requirement
+  requirement: &21336216 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 1.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *22531164
+  version_requirements: *21336216
 description: ''
 email:
 - rmantilla26@hotmail.com
@@ -41,15 +41,16 @@ extensions: []
 extra_rdoc_files:
 - History.txt
 files:
+- README
 - History.txt
-- LICENSE.txt
+- LICENSE
 - lib/rhosync_api.rb
 homepage: 
 licenses: []
 post_install_message: 
 rdoc_options:
 - --main
-- README.txt
+- README
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -69,5 +70,5 @@ rubyforge_project: rhosync_api
 rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
-summary: RhosyncApi
+summary: Rhosync Api helps you connect to Rhosync Server
 test_files: []