App42_Ruby_API 0.8.4

data/lib/push/DeviceType.rb

@@ -0,0 +1,56 @@
+# -----------------------------------------------------------------------
+#  Copyright © 2012 ShepHertz Technologies Pvt Ltd. All rights reserved.
+# -----------------------------------------------------------------------
+
+require 'App42_Ruby_API/App42Response'
+
+#
+# An enum that defines the type of the device to be uploaded on cloud.
+#
+
+module App42
+  module Push
+    class DeviceType < App42Response
+      unless (const_defined?(:ANDROID))
+        ANDROID = "ANDROID"
+      end
+      unless (const_defined?(:IOS))
+        IOS = "iOS"
+      end
+      unless (const_defined?(:WP7))
+        WP7 = "WP7"
+      end
+
+      #
+      # Sets the value of the DeviceType.
+      #
+      # @param string
+      #      - the string of DeviceType.
+      #
+      def enum(string)
+        return DeviceType.const_get(string)
+      end
+
+      #
+      # Returns the value of the DeviceType.
+      #
+      # @return the value of DeviceType.
+      #
+
+      def isAvailable(string)
+        if(string == "ANDROID")
+          return "ANDROID"
+        elsif(string == "iOS")
+          return "iOS"
+        elsif(string == "WP7")
+          return "WP7"
+        elsif(string == "OTHER")
+          return "OTHER";
+        else
+          return nil
+        end
+      end
+
+    end
+  end
+end

data/lib/push/PushNotification.rb

@@ -0,0 +1,38 @@
+# -----------------------------------------------------------------------
+#  Copyright © 2012 ShepHertz Technologies Pvt Ltd. All rights reserved.
+# -----------------------------------------------------------------------
+
+require 'App42_Ruby_API/App42Response'
+
+#
+#
+# This Push Notification object is the value object which contains the properties of
+# Push Notification.
+#
+#
+
+module App42
+  module Push
+    class PushNotification < App42Response
+      attr_accessor  :message, :userName, :deviceToken, :channelList ,:type
+      @channelList = Array.new
+      @message
+      @userName
+      @deviceToken
+      @type
+    end
+
+    class Channel
+      attr_accessor  :channelName, :description
+      @channelName
+      @description
+
+      #
+      # This is a constructor that takes no parameter
+      #
+      def initialize(pushNotification)
+        pushNotification.channelList.push(self)
+      end
+    end
+  end
+end

data/lib/push/PushNotificationResposneBuilder.rb

@@ -0,0 +1,74 @@
+# -----------------------------------------------------------------------
+#  Copyright © 2012 ShepHertz Technologies Pvt Ltd. All rights reserved.
+# -----------------------------------------------------------------------
+
+require 'json/pure'
+require 'App42_Ruby_API/App42ResponseBuilder'
+require 'push/PushNotification'
+require 'push/DeviceType'
+
+module App42
+  module Push
+    #
+    #
+    # PushNotificationResponseBuilder class converts the JSON response retrieved from
+    # the server to the value object i.e Push Notification
+    #
+    #
+    class PushNotificationResponseBuilder < App42ResponseBuilder
+      #
+      # Converts the response in JSON format to the value object i.e Push Notification
+      #
+      # @param json
+      #      - response in JSON format
+      #
+      # @return Push Notification object filled with json data
+      #
+      #
+      def buildResponse(json)
+        pushObj = PushNotification.new()
+        channelList = Array.new
+        pushObj.channelList=(channelList)
+
+        pushObj.strResponse=json
+
+        jsonObj = JSON.parse(json)
+        jsonObjApp42 = jsonObj.fetch("app42");
+        jsonObjResponse = jsonObjApp42.fetch("response");
+        pushObj.isResponseSuccess=(jsonObjResponse.fetch("success"));
+        jsonObjPush= jsonObjResponse.fetch("push");
+
+        buildObjectFromJSONTree(pushObj, jsonObjPush);
+
+        if jsonObjPush.key?("channels") == false
+          return pushObj
+        end
+
+        jsonObjChannels = jsonObjPush.fetch("channels");
+
+        if jsonObjChannels.key?("channel") == false
+          return pushObj;
+        end
+
+        if jsonObjChannels.fetch("channel").instance_of?(Hash)
+          jsonObjChannel = jsonObjChannels.fetch("channel");
+          channelObject = App42::Push::Channel.new(pushObj)
+          buildObjectFromJSONTree(channelObject,jsonObjChannel);
+
+        else
+
+          jsonObjChannelArray= jsonObjChannels.fetch("channel");
+
+          jsonObjChannelArray.length.times do |i|
+            jsonObjChannel = jsonObjChannelArray.fetch(i);
+            channelObject = App42::Push::Channel.new(pushObj)
+            buildObjectFromJSONTree(channelObject,jsonObjChannel);
+          end
+        end
+
+        return pushObj;
+      end
+
+    end
+  end
+end

data/lib/push/PushNotificationService.rb

@@ -0,0 +1,458 @@
+# -----------------------------------------------------------------------
+#  Copyright © 2012 ShepHertz Technologies Pvt Ltd. All rights reserved.
+# -----------------------------------------------------------------------
+
+require 'rubygems'
+require 'connection/RESTConnection'
+require 'util/util'
+require 'json/pure'
+require 'App42_Ruby_API/App42Response'
+require 'push/PushNotificationResposneBuilder'
+require 'push/PushNotification'
+require 'push/DeviceType'
+
+module App42
+  module Push
+    #
+    #
+    # The service is for pushing the notifications to any device using GCM(Google Cloud Messaging).
+    # You have to upload your apikey that you received while registering for GCM and you have to store your
+    # device token with particular username. This service allows you the feature of sending message to
+    # particular channel, particular user or to all your users.For sending message to any channel, you have to
+    # create the channel and send the message to channel. The users which have subscribed to that channel will receive
+    # all the notification for that channel. For sending message to particular user, you have to pass username and
+    # message. Notification will sent to the device of registered user. The most important feature you can send your message
+    # to all your device whether it is iphone, android or blackberry.
+    #
+    #
+    class PushNotificationService
+      #
+      # this is a constructor that takes
+      #
+      # @param apiKey
+      # @param secretKey
+      # @param baseURL
+      #
+      def initialize(api_key, secret_key, base_url)
+        puts "PushNotificationService->initialize"
+        @api_key = api_key
+        @secret_key = secret_key
+        @base_url = base_url
+        @resource = "push"
+        @version = "1.0"
+      end
+
+      # Stores your device token on server with particular username
+      #
+      # @param Username
+      #      - username with which you want your device to be registered
+      # @param deviceToken
+      #      - device id for android phones
+      # @param type
+      #      - 
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def store_device_token(userName, deviceToken, type)
+        puts "storeDeviceToken Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "Username");
+        util.throwExceptionIfNullOrBlank(deviceToken, "deviceToken");
+        util.throwExceptionIfNullOrBlank(type, "Device Type");
+        begin
+          if (DeviceType.new.isAvailable(type) == nil)
+            raise App42NotFoundException.new("Device Type #{type} does not Exist ");
+          end
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'app42' => {"push" => {
+            "userName" => userName,
+            "deviceToken" => deviceToken,
+            "type" => type
+            }}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/storeDeviceToken/#{userName}"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      # Create Channel for app on which user can subscribe and get the notification for that
+      # channel
+      #
+      # @param channel
+      #      - channel name which you want to create
+      # @param description
+      #      - description for that channel
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def create_channel_for_app(channel, description)
+        puts "createChannelForApp Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(channel, "Channel Name");
+        util.throwExceptionIfNullOrBlank(description, "Description");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'app42' => {"push" => {"channel" => {
+            "name" => channel,
+            "description" => description
+            }}}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/createAppChannel"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      #
+      # Subscribe to the channel
+      #
+      # @param channel
+      #      - the channel name which you want to subscribe
+      # @param userName
+      #      - username which want to subscribe
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def subscribe_to_channel(channel, userName)
+        puts "subscribeToChannel Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(channel, "Channel Name");
+        util.throwExceptionIfNullOrBlank(userName, "userName");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'push' => {"channel" => {
+            "name" => channel,
+            "userName" => userName
+            }}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/subscribeToChannel/#{userName}"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      # Unsubscribe from particular channel
+      #
+      # @param channel
+      #      - channel name which you want to unsubscribe
+      # @param userName
+      #      - username which want to unsubscribe
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def unsubscribe_from_channel(channel, userName)
+        puts "unsubscribeFromChannel Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(channel, "Channel Name");
+        util.throwExceptionIfNullOrBlank(userName, "userName");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'push' => {"channel" => {
+            "userName" => userName,
+            "name" => channel
+            }}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/unsubscribeToChannel/#{userName}"
+          response = connection.put(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      #
+      # send push message to channel containing string
+      #
+      # @param channel
+      #      - channel name which you want to send the message
+      # @param message
+      #      - push message in string format
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def send_push_message_to_channel(channel, message)
+        puts "sendPushMessageToChannel Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(channel, "channel");
+        util.throwExceptionIfNullOrBlank(message, "message");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'app42' => {"push" => {"message" => {
+            "channel" => channel,
+            "expiry" => util.get_timestamp_utc,
+            "payload" => message
+            }}}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/sendPushMessageToChannel/#{channel}"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      #
+      # Send push message to all your users
+      #
+      # @param message
+      #      - push message
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def send_push_message_to_all(message)
+        puts "sendPushMessageToAll Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(message, "message");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'app42' => {"push" => {"message" => {
+            "expiry" => util.get_timestamp_utc,
+            "payload" => message
+            }}}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/sendPushMessageToAll"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      #
+      # Send Push Message To paticular user in string format
+      #
+      # @param username
+      #      - username which you want to send the message
+      # @param message
+      #      - push message
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def send_push_message_to_user(userName, message)
+        puts "sendPushMessageToUser Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(userName, "userName");
+        util.throwExceptionIfNullOrBlank(message, "message");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'app42' => {"push" => {"message" => {
+            "userName" => userName,
+            "expiry" => util.get_timestamp_utc,
+            "payload" => message
+            }}}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/sendMessage/#{userName}"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+      #
+      # Send push message to all by type
+      #
+      # @param message
+      #      - push message
+      #
+      # @return PushNotification Object
+      #
+      # @raise App42Exception
+      #
+
+      def send_push_message_to_all_by_type(message, type)
+        puts "sendPushMessageToAll Called "
+        puts "Base url #{@base_url}"
+        response = nil;
+        pushObj = nil;
+        pushObj = PushNotification.new
+        util = Util.new
+        util.throwExceptionIfNullOrBlank(message, "message");
+        util.throwExceptionIfNullOrBlank(type, "type");
+        begin
+          connection = App42::Connection::RESTConnection.new(@base_url)
+          body = {'app42' => {"push" => {"message" => {
+            "payload" => message,
+            "expiry" => util.get_timestamp_utc,
+            "type" => type
+            }}}}.to_json
+          puts "Body #{body}"
+          query_params = Hash.new
+          params = {
+            'apiKey'=> @api_key,
+            'version' => @version,
+            'timeStamp' => util.get_timestamp_utc,
+          }
+          query_params = params.clone
+          params.store("body", body)
+          puts query_params
+          signature = util.sign(@secret_key, params)
+          resource_url = "#{@version}/#{@resource}/sendMessageToAllByType"
+          response = connection.post(signature, resource_url, query_params, body)
+          push = PushNotificationResponseBuilder.new()
+          pushObj = push.buildResponse(response)
+        rescue  App42Exception =>e
+          raise e
+        rescue  Exception => e
+          raise App42Exception.new(e)
+        end
+        return pushObj
+      end
+
+    end
+  end
+end