rhosync_api 0.0.4 → 0.0.5

data/History.txt

@@ -3,3 +3,4 @@ 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

data/LICENSE.txt

@@ -0,0 +1,10 @@
+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
+

data/lib/rhosync_api.rb

@@ -0,0 +1,452 @@
+#Based on the rhomobile documentation
+#http://docs.rhomobile.com/rhosync/rest-api
+
+require 'rest_client'
+require 'json'
+
+class RhosyncApi
+
+  def initialize
+    $server = ""
+    $username = ""
+    $password = ""
+    $token = ""
+  end
+
+  #login -- rhosync
+  def login(server,admin,password)
+    $server = server
+    $username = admin
+    $password = password
+    $token = get_api_token
+  end
+
+  #Before you can use RhoSync API you should get API token:
+  def get_api_token
+    uri = URI.parse($server)
+    http = Net::HTTP.new(uri.host,uri.port)
+    begin
+      res,data = http.post( '/login',
+        {:login => $username, :password => $password}.to_json,
+        {'Content-Type' => 'application/json'} )
+      cookie = res.response['set-cookie'].split('; ')[0].split('=')
+      cookie = {cookie[0] => URI.escape(cookie[1])}
+      token = RestClient.post("#{$server}/api/get_api_token",'',{:cookies => cookie})
+    rescue=>e
+      cant_connect_rhosync(e)
+    end
+  end
+
+  #Returns license information of the currently used license
+  def get_license_info
+    unless $token.nil?
+      begin
+        license_info = RestClient.post(
+          "#{$server}/api/get_license_info",
+          {:api_token => $token}.to_json, :content_type => :json
+        ).body
+        JSON.parse(license_info)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Reset the server: flush db and re-bootstrap server
+  def reset
+    unless $token.nil?
+      begin
+        RestClient.post("#{$server}/api/reset",
+          { :api_token => $token }.to_json,
+          :content_type => :json
+        )
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+  
+  # :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
+  def ping(user_id,ping_params)
+    unless $token.nil?
+      unless user_id.nil? 
+        begin
+          RestClient.post(
+            "#{$server}/api/ping",ping_params.to_json, 
+            :content_type => :json
+          ) 
+        rescue=>e
+          cant_connect_rhosync(e)
+        end
+      else
+        puts "the user's ID can't be null "
+        nil
+      end
+    else
+      access_denied
+    end
+  end
+
+  #List users registered with this RhoSync application.
+  def list_users
+    unless $token.nil?
+      begin
+        users = RestClient.post(
+          "#{$server}/api/list_users",
+          { :api_token => $token }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(users)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Create a user in this RhoSync application.
+  def create_user(login,password)
+    unless $token.nil?
+      unless login.nil?
+        begin
+          RestClient.post("#{$server}/api/create_user",
+            {
+              :api_token => $token,
+              :attributes => {
+                :login => login,
+                :password => password
+              }
+            }.to_json,
+            :content_type => :json
+          )
+        rescue=>e
+          cant_connect_rhosync(e)
+        end
+      else
+        puts "the user's ID can't be null "
+        nil
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Delete User and all associated devices from the RhoSync application.
+  def delete_user(user_id)
+    unless $token.nil?
+      unless user_id.nil?
+        begin
+          RestClient.post(
+            "#{$server}/api/delete_user",
+            {
+              :api_token => $token,
+              :user_id => user_id
+            }.to_json,
+            :content_type => :json
+          )
+        rescue=>e
+          cant_connect_rhosync(e)
+        end
+      else
+        puts "the user's ID can't be null "
+        nil
+      end
+    else
+      access_denied
+    end
+  end
+
+  #List clients (devices) associated with given user.
+  def list_clients(user_id)
+    unless $token.nil?
+      begin
+        clients = RestClient.post("#{$server}/api/list_clients",
+          {
+            :api_token => $token,
+            :user_id => user_id
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(clients)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Creates a client (device) for a given user.
+  def create_client(user_id)
+    unless $token.nil?
+      unless user_id.nil?
+        begin
+          RestClient.post(
+            "#{$server}/api/create_client",
+            {
+              :api_token => $token,
+              :user_id => user_id
+            }.to_json,
+            :content_type => :json
+          ).body
+        rescue=>e
+          cant_connect_rhosync(e)
+        end
+      else
+        puts "the user's ID can't be null "
+        nil
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Deletes the specified client (device).
+  def delete_client(user_id,client_id)
+    unless $token.nil?
+      unless user_id.nil? and client_id.nil?
+        begin
+          RestClient.post(
+            "#{$server}/api/delete_client",
+            {
+              :api_token => $token,
+              :user_id => user_id,
+              :client_id => client_id
+            }.to_json,
+            :content_type => :json
+          )
+        rescue=>e
+          cant_connect_rhosync(e)
+        end
+      else
+        puts "the user's ID  and client's ID can't be null "
+        nil
+      end
+    else
+      access_denied
+    end
+  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)
+    unless $token.nil?
+      begin
+        client_params = RestClient.post(
+          "#{$server}/api/get_client_params",
+          {
+            :api_token => $token,
+            :client_id => client_id
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(client_params)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Return list of source adapters for this RhoSync application.
+  def list_sources(partition = nil)
+    unless $token.nil?
+      partition = "user" if partition.nil?
+      begin
+        sources = RestClient.post("#{$server}/api/list_sources",
+          {
+            :api_token => $token,
+            :partition_type => partition
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(sources)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+
+  #Return attributes associated with a given source:
+
+  # name � name of the data source
+  # poll_interval � query poll interval; defines how often RhoSync will call source adapter to query for new data, set to -1 to disable polling, 0 to always poll
+  # partition_type � to share data across all users, set partition to :app; otherwise use :user partition (default)
+  # sync_type � set to :bulk_only to disable :incremental sync; regular sync is :incremental (default)
+  # 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)
+    unless $token.nil?
+      begin
+        attributes = RestClient.post("#{$server}/api/get_source_params",
+          {
+            :api_token => $token,
+            :source_id => source_id
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(attributes)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  # 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)
+    unless $token.nil?
+      begin
+        docs = RestClient.post(
+          "#{$server}/api/list_source_docs",
+          {
+            :api_token => $token,
+            :source_id => source_id,
+            :user_id => user_id
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(docs)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #Return content of a given document (client or source).
+  def get_db_doc(doc,data_type = nil)
+    unless $token.nil?
+      begin
+        res = RestClient.post(
+          "#{$server}/api/get_db_doc",
+          {
+            :api_token => $token,
+            :doc => doc,
+            :data_type => data_type
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(res)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+  
+  #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)
+    unless $token.nil?
+      begin
+        RestClient.post(
+          "#{$server}/api/set_db_doc", 
+          { 
+            :api_token => $token, 
+            :doc => doc, 
+            :data => data, 
+            :data_type => data_type 
+          }.to_json, 
+          :content_type => :json
+        )
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #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)
+    unless $token.nil?
+      begin
+        docs = RestClient.post(
+          "#{$server}/api/list_client_docs",
+          {
+            :api_token => $token,
+            :source_id => source_id,
+            :client_id => client_id
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(docs)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  #NEW METHODS IN THE GEM
+  #Return content of a given document
+  def get_db_doc_by_type(user_id,source_id,type_doc)
+    unless $token.nil?
+      begin
+        docs = list_source_docs(user_id,source_id)
+        res = RestClient.post(
+          "#{$server}/api/get_db_doc",
+          {
+            :api_token => $token,
+            :doc => docs["#{type_doc}"],
+            :data_type => nil
+          }.to_json,
+          :content_type => :json
+        ).body
+        JSON.parse(res)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+  
+  #set content of a given document
+  def set_db_doc_by_type(user_id,source_id,data,type_doc)
+    unless $token.nil?
+      begin
+        docs = list_source_docs(user_id,source_id)
+        set_db_doc(docs["#{type_doc}"],data)
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  def access_denied
+    puts "you don't have access, please login in"
+    nil
+  end
+
+  def cant_connect_rhosync(e)
+    puts "rhosync error : #{e.inspect}"
+    nil
+  end
+
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhosync_api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &21681648 !ruby/object:Gem::Requirement
+  requirement: &22531452 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.1
   type: :runtime
   prerelease: false
-  version_requirements: *21681648
+  version_requirements: *22531452
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &21681360 !ruby/object:Gem::Requirement
+  requirement: &22531164 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 1.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *21681360
+  version_requirements: *22531164
 description: ''
 email:
 - rmantilla26@hotmail.com
@@ -42,6 +42,8 @@ extra_rdoc_files:
 - History.txt
 files:
 - History.txt
+- LICENSE.txt
+- lib/rhosync_api.rb
 homepage: 
 licenses: []
 post_install_message: