igetui-ruby 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bead0733943449a4bbcd17ec0bda3707c5ba2c2d
-  data.tar.gz: 949f835131885144e35c30a4721c424a4c4b57e5
+  metadata.gz: 3035d4d4c94322549376457acbe615abc7b67c98
+  data.tar.gz: 51e6782e963c61b1956fea8b1c46d5316c5872c9
 SHA512:
-  metadata.gz: 591720b17a8d38540f8831faeeff83b4980873ac7b74c8373979cc2b52e6a64e9cf2929ef0e7de86c9a74df801df5d15a43be1319813cc3f6524cbdbeb951fb6
-  data.tar.gz: a13b2d75cd7a6e8c34d4693cd89aa642e830101d3888a929c03e3c660d9a26cde50d7e65e2fa036abc0beef3358422adec60ef0b90e0cdbd1e41762af8298e5e
+  metadata.gz: 7df6aa78d90fa7a906a1e60ea0fa1914cbe8111059d275623cde13ca404a09687e387b4ccee3e9ca0a7f6e5583afc6d785fbab9314f7cf3d450cf24ba6d6b824
+  data.tar.gz: f82c3a064264ce66e33d52ba9d2720d0a1f28d3012d82bc5c478dc872aeaf21ae5efd9a57839d2ecdae631d91fdd385ad089ae47d098cbb9de9612331463b3ca

data/README.md

@@ -108,7 +108,7 @@ require 'rubygems'
 require 'igetui'
 
 @pusher = IGeTui.pusher(your_app_id, your_app_key, your_master_secret)
-ret = @pusher.get_client_id_status(@cid_1)
+ret = @pusher.get_client_id_status(your_client_id)
 p ret
 ```
 

data/lib/igetui.rb

@@ -30,6 +30,7 @@ end
 require "igetui/version"
 require 'protobuf/GtReq.pb'
 require "igetui/template"
+require "igetui/validate"
 require "igetui/message"
 require "igetui/pusher"
 require "igetui/client"

data/lib/igetui/message.rb

@@ -16,11 +16,11 @@ module IGeTui
     attr_accessor :app_id_list, :phone_type_list, :province_list, :tag_list
 
     def initialize
+      super
       @app_id_list = []
       @phone_type_list = []
       @province_list = []
       @tag_list = []
-      super
     end
   end
 end

data/lib/igetui/pusher.rb

@@ -14,7 +14,7 @@ module IGeTui
       data = {
         'action' => 'pushMessageToSingleAction',
         'appkey' => app_key,
-        'clientData' => base64Str(template),
+        'clientData' => template.get_client_data(self),
         'transmissionContent' => template.transmission_content,
         'isOffline' => message.is_offline,
         'offlineExpireTime' => message.offline_expire_time,
@@ -50,7 +50,7 @@ module IGeTui
       data = {
         'action' => 'pushMessageToAppAction',
         'appkey' => app_key,
-        'clientData' => base64Str(template),
+        'clientData' => template.get_client_data(self),
         'transmissionContent' => template.transmission_content,
         'isOffline' => message.is_offline,
         'offlineExpireTime' => message.offline_expire_time,
@@ -91,7 +91,7 @@ module IGeTui
       data = {
         'action' => 'getContentIdAction',
         'appkey' => app_key,
-        'clientData' => base64Str(template),
+        'clientData' => template.get_client_data(self),
         'transmissionContent' => template.transmission_content,
         'isOffline' => message.is_offline,
         'offlineExpireTime' => message.offline_expire_time,
@@ -113,11 +113,6 @@ module IGeTui
 
     private
 
-    def base64Str(template)
-      string = template.get_transparent(self).serialize_to_string
-      Base64.strict_encode64 string
-    end
-
     def connect
       time_stamp = Time.now.to_i
       sign = Digest::MD5.hexdigest(app_key + time_stamp.to_s + master_secret)

data/lib/igetui/template/base_template.rb

@@ -1,9 +1,10 @@
 module IGeTui
   class BaseTemplate
-    attr_accessor :transmission_type, :transmission_content
+    attr_accessor :transmission_type, :transmission_content, :push_info
 
     def initialize
-      @push_info = nil
+      @transmission_type = 0
+      @transmission_content = ''
     end
 
     def get_transparent(pusher)
@@ -19,47 +20,49 @@ module IGeTui
       transparent
     end
 
-    def get_action_chain; end
-    def get_push_type; end
+    def get_action_chain
+      raise NotImplementedError, 'Must be implemented by subtypes.'
+    end
 
-    def get_push_info
-      unless @push_info
-        @push_info = GtReq::PushInfo.new
-        @push_info.actionKey = ''
-        @push_info.badge = ''
-        @push_info.message = ''
-        @push_info.sound = ''
-      end
-      @push_info
+    def get_push_type
+      raise NotImplementedError, 'Must be implemented by subtypes.'
     end
 
-    # Need TEST:
-    #   iOS Pusher need the top three fields of 'push_info' are required.
-    #   the others can be blank string.
-    def set_push_info(action_loc_key, badge, message, sound, payload, loc_key, loc_args, launch_image)
+    def get_client_data(pusher)
+      string = self.get_transparent(pusher).serialize_to_string
+      Base64.strict_encode64 string
+    end
 
-      @push_info = GtReq::PushInfo.new
+    def get_push_info
+      @push_info || init_push_info
+    end
+
+    # NOTE:
+    # iOS Pusher need the top four fields of 'push_info' are required.
+    # options can be includes [:payload, :loc_key, :loc_args, :launch_image]
+    # http://docs.igetui.com/pages/viewpage.action?pageId=590588
+    def set_push_info(action_loc_key, badge, message, sound, options = {})
+      init_push_info
       @push_info.actionLocKey = action_loc_key
-      @push_info.badge = badge
+      @push_info.badge = badge.to_s
       @push_info.message = message
-      @push_info.sound = sound if sound
-      @push_info.payload = payload if payload
-      @push_info.locKey = loc_key if loc_key
-      @push_info.locArgs = loc_args if loc_args
-      @push_info.launchImage = launch_image if launch_image
+      @push_info.sound = sound
+      @push_info.payload = options[:payload]
+      @push_info.locKey = options[:loc_key]
+      @push_info.locArgs = options[:loc_args]
+      @push_info.launchImage = options[:launch_image]
+      # validate method need refactoring.
+      # Validate.new.validate(args)
+    end
 
-      args = {
-        loc_key: loc_key,
-        loc_args: locArgs,
-        message: message,
-        action_loc_key: action_loc_key,
-        launch_image: launch_image,
-        badge: badge,
-        sound: sound,
-        payload: payload
-      }
+    private
 
-      Validate.new.validate(args)
+    def init_push_info
+      @push_info = GtReq::PushInfo.new
+      @push_info.message = ''
+      @push_info.actionKey = ''
+      @push_info.sound = ''
+      @push_info.badge = ''
       @push_info
     end
 

data/lib/igetui/template/link_template.rb

@@ -1,19 +1,15 @@
 module IGeTui
   class LinkTemplate < BaseTemplate
-    attr_accessor :title, :text, :logo, :logo_url, :url
-    attr_accessor :is_ring, :is_vibrate, :is_clearable
+    STRING_ATTRIBUTES = %i(title text logo logo_url url).freeze
+    BOOLEAN_ATTRIBUTES = %i(is_ring is_vibrate is_clearable).freeze
+
+    attr_accessor *STRING_ATTRIBUTES, *BOOLEAN_ATTRIBUTES
 
     def initialize
-      @title = ''
-      @text = ''
-      @logo = ''
-      @logo_url = ''
-      @transmission_type = 0
-      @transmission_content = ''
-      @is_ring = true
-      @is_vibrate = true
-      @is_clearable = true
       super
+
+      STRING_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", '') }
+      BOOLEAN_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", true) }
     end
 
     def get_action_chain

data/lib/igetui/template/notification_template.rb

@@ -1,19 +1,15 @@
 module IGeTui
   class NotificationTemplate < BaseTemplate
-    attr_accessor :title, :text, :logo, :logo_url
-    attr_accessor :is_ring, :is_vibrate, :is_clearable
+    STRING_ATTRIBUTES = %i(title text logo logo_url).freeze
+    BOOLEAN_ATTRIBUTES = %i(is_ring is_vibrate is_clearable).freeze
+
+    attr_accessor *STRING_ATTRIBUTES, *BOOLEAN_ATTRIBUTES
 
     def initialize
-      @title = ''
-      @text = ''
-      @logo = ''
-      @logo_url = ''
-      @transmission_type = 0
-      @transmission_content = ''
-      @is_ring = true
-      @is_vibrate = true
-      @is_clearable = true
       super
+
+      STRING_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", '') }
+      BOOLEAN_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", true) }
     end
 
     def get_action_chain

data/lib/igetui/template/noty_pop_load_template.rb

@@ -1,37 +1,23 @@
 module IGeTui
   class NotyPopLoadTemplate < BaseTemplate
-    attr_accessor :title, :text, :logo, :logo_url
-    attr_accessor :is_ring, :is_vibrate, :is_clearable
-    attr_accessor :pop_title, :pop_text, :pop_image
-    attr_accessor :pop_button_1, :pop_button_2
-    attr_accessor :load_icon, :load_title, :load_url
-    attr_accessor :android_mask, :symbia_mask, :ios_mask
-    attr_accessor :is_auto_install, :is_active
+    STRING_ATTRIBUTES = %i(
+      title text logo logo_url
+      pop_title pop_text pop_image
+      pop_button_1 pop_button_2
+      load_icon load_title load_url
+      android_mask symbia_mask ios_mask
+    ).freeze
+    BOOLEAN_ATTRIBUTES_OF_TRUE = %i(is_ring is_vibrate is_clearable).freeze
+    BOOLEAN_ATTRIBUTES_OF_FALSE = %i(is_auto_install is_active).freeze
+
+    attr_accessor *STRING_ATTRIBUTES, *BOOLEAN_ATTRIBUTES_OF_TRUE, *BOOLEAN_ATTRIBUTES_OF_FALSE
 
     def initialize
-      @title = ''
-      @text = ''
-      @logo = ''
-      @logo_url = ''
-      @pop_title = ''
-      @pop_text = ''
-      @pop_image = ''
-      @pop_button_1 = ''
-      @pop_button_2 = ''
-      @load_icon = ''
-      @load_title = ''
-      @load_url = ''
-      @transmission_type = 0
-      @transmission_content = ''
-      @is_ring = true
-      @is_vibrate = true
-      @is_clearable = true
-      @android_mask = ''
-      @symbia_mask = ''
-      @ios_mask = ''
-      @is_auto_install = false
-      @is_active = false
       super
+
+      STRING_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", '') }
+      BOOLEAN_ATTRIBUTES_OF_TRUE.each { |attr| instance_variable_set("@#{attr}", true) }
+      BOOLEAN_ATTRIBUTES_OF_FALSE.each { |attr| instance_variable_set("@#{attr}", false) }
     end
 
     def get_action_chain

data/lib/igetui/template/transmission_template.rb

@@ -1,8 +1,6 @@
 module IGeTui
   class TransmissionTemplate < BaseTemplate
     def initialize
-      @transmission_type = 0
-      @transmission_content = ''
       super
     end
 

data/lib/igetui/validate.rb

@@ -1,13 +1,82 @@
-require 'json'
 module IGeTui
   class Validate
     def validate(args = {})
-      payload_map = get_payload(args)
+      # payload_map = get_payload(args)
 
-      json = JSON.generate payload_map
-      if (json.length > 256)
-        raise ArgumentError.new("PushInfo length over limit: #{json.length}. Allowed: 256.")
+      # json = JSON.generate payload_map
+      # if (json.length > 256)
+      #   raise ArgumentError.new("PushInfo length over limit: #{json.length}. Allowed: 256.")
+      # end
+
+      is_validate = validate_payload(args)
+      unless is_validate
+        payload_len = validate_payload_length(args)
+        raise ArgumentError.new("PushInfo length over limit: #{payload_len.length}. Allowed: 256.")
+      end
+    end
+
+    def validate_payload(args)
+      length = validate_payload_length(args)
+      length <= 256
+    end
+
+    def validate_payload_length(args)
+      json = process_payload(args)
+      json.length
+    end
+
+    def process_payload(args)
+      is_valid = false
+      pb = Payload.new
+      if !args[:loc_key].nil? && args[:loc_key].length > 0
+        pb.alert_loc_key = args[:loc_key]
+        if !args[:loc_args].nil? && args[:loc_args].length > 0
+          pb.alert_loc_args = args[:loc_args].split(",")
+        end
+        is_valid = true
+      end
+
+      if !args[:message].nil? && args[:message].length > 0
+        pb.alert_body = args[:message]
+        is_valid = true
+      end
+
+      if !args[:action_loc_key].nil? && args[:action_loc_key].length > 0
+        pb.alert_action_loc_key = args[:action_loc_key]
+      end
+
+      if !args[:launch_image].nil? && args[:launch_image].length > 0
+        pb.alert_launch_image = args[:launch_image]
       end
+
+      badge_num = args[:badge].to_i
+
+      if badge_num >= 0
+        pb.badge = badge_num
+        is_valid = true
+      end
+
+      if !args[:sound].nil? && args[:sound].length > 0
+        pb.sound = args[:sound]
+      end
+
+      if !args[:payload].nil? && args[:payload].length > 0
+        pb.add_param("payload", payload)
+      end
+
+      unless is_valid
+        puts "one of the params(locKey,message,badge) must not be null"
+      end
+
+      json = pb.to_s
+
+      if json.nil?
+        puts "payload json is null"
+      end
+
+      json
+
+      # do something
     end
 
     def get_payload(args = {})
@@ -26,8 +95,8 @@ module IGeTui
         if validate_length(args, :loc_args)
           alertMap["loc-args"] = args[:loc_args].split(", ")
         end
-      elsif validate_length(nil, message)
-        alertMap["body"] = message
+      elsif validate_length(nil, args[:message])
+        alertMap["body"] = args[:message]
       end
 
       apnsMap["alert"] = alertMap
@@ -35,11 +104,11 @@ module IGeTui
         apnsMap["action-loc-key"] = args[:action_loc_key]
       end
 
-      apnsMap["badge"] = badge
+      apnsMap["badge"] = args[:badge]
 
       h = Hash.new
       h["aps"] = apnsMap
-      h["payload"] = payload if validate_length(nil, payload)
+      h["payload"] = args[:payload] if validate_length(nil, args[:payload])
 
       return h
     end

data/lib/igetui/version.rb

@@ -1,3 +1,3 @@
 module IGeTui
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/test/pusher_test.rb

@@ -81,12 +81,14 @@ class PusherTest < MiniTest::Unit::TestCase
     template = IGeTui::LinkTemplate.new
     set_template_base_info(template)
     template.url = "http://www.baidu.com"
+    template.set_push_info("open", 4, "message", "")
     template
   end
 
   def notification_template
     template = IGeTui::NotificationTemplate.new
     set_template_base_info(template)
+    template.set_push_info("open", 4, "message", "")
     template
   end
 
@@ -94,14 +96,17 @@ class PusherTest < MiniTest::Unit::TestCase
     template = IGeTui::TransmissionTemplate.new
     # Notice: content should be string.
     content = {
-                action: "notification",
-                title: "标题aaa",
-                content: "内容",
-                type: "article",
-                id: "4274"
+                "action" => "notification",
+                "title" => "标题aaa",
+                "content" => "内容",
+                "type" => "Article",
+                "id" => "1234"
               }
+
     content = content.to_s.gsub(":", "").gsub("=>", ":")
     template.transmission_content = content
+    puts template.transmission_content
+    template.set_push_info("test", 1, "test1", "")
     template
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: igetui-ruby
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Victor Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json