rhosync_api 0.0.6 → 0.1.3

data/lib/rho-api-connect.rb

@@ -0,0 +1,535 @@
+#Based on the rhomobile documentation
+#http://docs.rhomobile.com/rhosync/rest-api
+
+require 'rest_client'
+require 'json'
+
+module RhoApiConnect
+
+  #login -- rhosync
+  def self.login(server,admin,password)
+    @server = server
+    @username = admin
+    @password = password
+    @token = get_api_token
+  end
+  
+  def self.set_token(token)
+    @token = token
+  end
+
+  #logout -- rhosync
+  def self.logout
+    @server = nil
+    @username = nil
+    @password = nil
+    @token = nil
+    @sources = []
+    true
+  end
+
+  #Before you can use RhoSync API you should get API token:
+  def self.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 self.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 self.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 self.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 self.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 self.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
+  
+  #Update a user in the RhoSync application.
+  def self.update_user(login,password)
+    unless @token.nil?
+      unless login.nil?
+        begin
+          RestClient.post("#{@server}/api/update_user",
+            {
+              :api_token => @token,
+              :attributes => {
+                :login => login,
+                :new_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 self.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 self.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 self.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 self.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 self.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 self.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 self.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 self.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 self.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 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",
+          {
+            :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 self.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 self.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 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)
+        set_db_doc(docs["#{type_doc}"],data)
+      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 self.push_objects(user_id,source_id,data)
+    unless @token.nil?
+      begin
+        RestClient.post(
+          "#{@server}/api/push_objects",
+          {
+            :api_token => @token,
+            :user_id  => user_id,
+            :source_id => source_id,
+            :objects => data
+          }.to_json,
+          :content_type => :json
+        )
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+  
+  def self.push_deletes(user_id,source_id,data)
+    unless @token.nil?
+      begin
+        RestClient.post(
+          "#{@server}/api/push_deletes",
+          {
+            :api_token => @token,
+            :user_id  => user_id,
+            :source_id => source_id,
+            :objects => data
+          }.to_json,
+          :content_type => :json
+        )
+      rescue=>e
+        cant_connect_rhosync(e)
+      end
+    else
+      access_denied
+    end
+  end
+
+  def self.access_denied
+    puts "you don't have access, please login in"
+    nil
+  end
+
+  def self.cant_connect_rhosync(e)
+    puts "rhosync error : #{e.inspect}"
+    nil
+  end
+
+
+end

data/lib/rho-sources.rb

@@ -0,0 +1,97 @@
+#Based on the rhomobile documentation
+#http://docs.rhomobile.com/rhosync/rest-api
+
+
+class RhoSources
+
+  def initialize(source_name,token)
+    @name = source_name
+    @token = token
+    RhoApiConnect.set_token(token)
+  end
+
+  def name
+    @name
+  end
+  
+  def find(user, *args)
+    
+    new_result = {}
+    
+    unless user.nil? or user.empty?
+      result = RhoApiConnect.get_db_doc_by_type(user,@name,"md")
+      unless args.empty?
+        if args[0][:conditions].nil?
+          undefined_arg
+          return nil
+        end
+        result.each do |object,content|
+          content[:object] = object
+          if evalue_condition(content,args[0][:conditions])
+            new_result[object] = content
+          end
+        end
+        result = nil
+        new_result
+      else
+        result
+      end
+    else
+      user_not_nil
+    end
+  end
+  
+  def create(user, data = nil)
+    unless user.nil? or user.empty?
+      result = RhoApiConnect.push_objects(user,@name,data)
+    else
+      user_not_nil
+    end
+  end
+  
+  def delete(user, data = nil)
+    unless user.nil? or user.empty?
+      result = RhoApiConnect.push_deletes(user,@name,data)
+    else
+      user_not_nil
+    end
+  end
+  
+  def delete_all(user)
+    truncate(user)
+  end
+  
+  def truncate(user)
+    unless user.nil? or user.empty?
+      result = RhoApiConnect.set_db_doc_by_type(user,@name,"","md")
+    else
+      user_not_nil
+    end
+  end
+  
+  def get_key(key)
+    return key if key == :object
+    return key.to_s
+  end
+  
+  def evalue_condition(content,conditions) 
+    return true if conditions.nil?
+    sw = true
+    conditions.each do |key,value|
+      if content[get_key(key)] != value
+        sw = false
+      end
+    end if conditions.class == Hash
+    sw
+  end
+  
+  def user_not_nil
+    puts "user name can not be nil or empty"
+    nil
+  end
+  
+  def undefined_arg
+    puts "undefined argument !!"
+    nil
+  end
+end