igetui-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c99084dc071b82bced2d791b76b564f28786be7c
-  data.tar.gz: 8061bca4c3e0fad40e4a364f4f8aae582831e214
+  metadata.gz: 0a319bd46f4da1cc9a7f7353fafa089593d4bbcc
+  data.tar.gz: bdbec6bddecbac031c233557805ebc07895b8c61
 SHA512:
-  metadata.gz: f6bb4a7b695936bc590c8cebad51fd3c82260c2e0de29149d9cf60ca6c10cca377f5a2aa8264ef7078d2d0a797f4cbdbd5570da86a98e6460fdb97e2e2fb8864
-  data.tar.gz: dd9c7d27fa24d99e3f3348bc3db8ecde67976e0e808d4fcb13e9dda8afe8863a926b60e72115f24511a6eebb24bb307be6d607ab6ce760e65dc131856a6f4e1c
+  metadata.gz: 990a289e47e41c0e2b7b67823ffa5f393b55c04193f0e7cb64bc84fea6a4dbfe9b09ec82ce27ca258dbd4df22454dd0ecd2c42f587e2aaf24d6e5aa0c2491308
+  data.tar.gz: 1594b11228b9d46a888ca3da086c58c0ce387a69cbe510cdce0e8400c50f7ec5a10ddbb0eff72ecbfdda810eb821fef6dd3db27a2ff777855f65fd7d854589da

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Victor Wang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,24 +1,124 @@
-# Igetui::Ruby
+# IGeTui::Ruby
 
-TODO: Write a gem description
+[个推](http://www.igetui.com/)服务端 ruby-sdk
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'igetui-ruby'
+```ruby
+gem 'igetui-ruby', require: 'IGeTui'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install igetui-ruby
+```bash
+$ gem install igetui-ruby
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Push Message To Single
+
+```ruby
+pusher = IGeTui.pusher(your_app_id, your_app_key, your_master_secret)
+
+# 创建通知模板
+template = IGeTui::NotificationTemplate.new
+template.logo = 'push.png'
+template.logo_url = 'http://www.igetui.com/wp-content/uploads/2013/08/logo_getui1.png'
+template.title = '测试标题'
+template.text = '测试文本'
+
+# 创建单体消息
+single_message = IGeTui::SingleMessage.new
+single_message.data = template
+
+# 创建客户端对象
+client = IGeTui::Client.new(your_client_id)
+
+# 发送一条通知到指定的客户端
+ret = pusher.push_message_to_single(single_message, client)
+p ret
+```
+
+### Push Message To List
+
+```ruby
+pusher = IGeTui.pusher(your_app_id, your_app_key, your_master_secret)
+
+# 创建一条透传消息
+template = IGeTui::TransmissionTemplate.new
+# Notice: content should be string.
+content = {
+            action: "notification",
+            title: "标题aaa",
+            content: "内容",
+            type: "article",
+            id: "4274"
+          }
+content = content.to_s.gsub(":", "").gsub("=>", ":")
+template.transmission_content = content
+
+# 创建群发消息
+list_message = IGeTui::ListMessage.new
+list_message.data = template
+
+# 创建客户端对象
+client_1 = IGeTui::Client.new(your_client_id_1)
+client_2 = IGeTui::Client.new(your_client_id_2)
+client_list = [client_1, client_2]
+
+content_id = pusher.get_content_id(list_message)
+ret = pusher.push_message_to_list(content_id, client_list)
+```
+
+### Push Message To App
+
+```ruby
+pusher = IGeTui.pusher(your_app_id, your_app_key, your_master_secret)
+
+# 创建通知模板
+template = IGeTui::NotificationTemplate.new
+template.logo = 'push.png'
+template.logo_url = 'http://www.igetui.com/wp-content/uploads/2013/08/logo_getui1.png'
+template.title = '测试标题'
+template.text = '测试文本'
+
+# 创建APP群发消息
+app_message = IGeTui::AppMessage.new
+app_message.data = template
+app_message.app_id_list = [your_app_id]
+
+# 发送一条通知到程序
+ret = pusher.push_message_to_app(app_message)
+p ret
+```
+
+### Custom Test
+
+```ruby
+require 'rubygems'
+require 'IGeTui'
+
+@pusher = IGeTui.pusher(your_app_id, your_app_key, your_master_secret)
+ret = @pusher.get_client_id_status(@cid_1)
+p ret
+```
+
+### Auto Test
+
+运行测试之前，请先修改 test/pusher_test.rb 中的相关配置。
+
+```ruby
+rake test
+```
 
 ## Contributing
 

data/lib/igetui/template/link_template.rb

@@ -0,0 +1,64 @@
+module IGeTui
+  class LinkTemplate < BaseTemplate
+    attr_accessor :title, :text, :logo, :logo_url, :url
+    attr_accessor :is_ring, :is_vibrate, :is_clearable
+
+    def initialize
+      @title = ''
+      @text = ''
+      @logo = ''
+      @logo_url = ''
+      @transmission_type = 0
+      @transmission_content = ''
+      @is_ring = true
+      @is_vibrate = true
+      @is_clearable = false
+      super
+    end
+
+    def get_action_chain
+      # set actionchain
+      action_chain_1 = GtReq::ActionChain.new
+      action_chain_1.actionId = 1
+      action_chain_1.type = GtReq::ActionChain::Type::Goto
+      action_chain_1.next = 10000
+
+      # notification
+      action_chain_2 = GtReq::ActionChain.new
+      action_chain_2.actionId = 10000
+      action_chain_2.type = GtReq::ActionChain::Type::Notification
+      action_chain_2.title = title
+      action_chain_2.text = text
+      action_chain_2.logo = logo
+      action_chain_2.logoURL = logo_url
+      action_chain_2.ring = is_ring
+      action_chain_2.clearable = is_clearable
+      action_chain_2.buzz = is_vibrate
+      action_chain_2.next = 10010
+
+      # goto
+      action_chain_3 = GtReq::ActionChain.new
+      action_chain_3.actionId = 10010
+      action_chain_3.type = GtReq::ActionChain::Type::Goto
+      action_chain_3.next = 10030
+
+      # start web
+      action_chain_4 = GtReq::ActionChain.new
+      action_chain_4.actionId = 10030
+      action_chain_4.type = GtReq::ActionChain::Type::Startweb
+      action_chain_4.url = url
+      action_chain_4.next = 100
+
+      # end
+      action_chain_5 = GtReq::ActionChain.new
+      action_chain_5.actionId = 100
+      action_chain_5.type = GtReq::ActionChain::Type::Eoa
+
+      [action_chain_1, action_chain_2, action_chain_3, action_chain_4, action_chain_5]
+    end
+
+    def get_push_type
+      "NotifyMsg"
+    end
+  end
+end

data/lib/igetui/template/notification_template.rb

@@ -18,49 +18,49 @@ module IGeTui
 
     def get_action_chain
       # set actionchain
-      actionChain1 = GtReq::ActionChain.new
-      actionChain1.actionId = 1
-      actionChain1.type = GtReq::ActionChain::Type::Goto
-      actionChain1.next = 10000
+      action_chain_1 = GtReq::ActionChain.new
+      action_chain_1.actionId = 1
+      action_chain_1.type = GtReq::ActionChain::Type::Goto
+      action_chain_1.next = 10000
 
       # notification
-      actionChain2 = GtReq::ActionChain.new
-      actionChain2.actionId = 10000
-      actionChain2.type = GtReq::ActionChain::Type::Notification
-      actionChain2.title = title
-      actionChain2.text = text
-      actionChain2.logo = logo
-      actionChain2.logoURL = logo_url
-      actionChain2.ring = is_ring
-      actionChain2.clearable = is_clearable
-      actionChain2.buzz = is_vibrate
-      actionChain2.next = 10010
+      action_chain_2 = GtReq::ActionChain.new
+      action_chain_2.actionId = 10000
+      action_chain_2.type = GtReq::ActionChain::Type::Notification
+      action_chain_2.title = title
+      action_chain_2.text = text
+      action_chain_2.logo = logo
+      action_chain_2.logoURL = logo_url
+      action_chain_2.ring = is_ring
+      action_chain_2.clearable = is_clearable
+      action_chain_2.buzz = is_vibrate
+      action_chain_2.next = 10010
 
       # goto
-      actionChain3 = GtReq::ActionChain.new
-      actionChain3.actionId = 10010
-      actionChain3.type = GtReq::ActionChain::Type::Goto
-      actionChain3.next = 10030
+      action_chain_3 = GtReq::ActionChain.new
+      action_chain_3.actionId = 10010
+      action_chain_3.type = GtReq::ActionChain::Type::Goto
+      action_chain_3.next = 10030
 
       # appStartUp
-      appStartUp = GtReq::AppStartUp.new(android: '', symbia: '', ios: '')
+      app_start_up = GtReq::AppStartUp.new(android: '', symbia: '', ios: '')
 
       # start web
-      actionChain4 = GtReq::ActionChain.new
-      actionChain4.actionId = 10030
-      actionChain4.type = GtReq::ActionChain::Type::Startapp
-      actionChain4.appid = ''
-      actionChain4.autostart = @transmission_type == 1
-      actionChain4.appstartupid = appStartUp
-      actionChain4.failedAction = 100
-      actionChain4.next = 100
+      action_chain_4 = GtReq::ActionChain.new
+      action_chain_4.actionId = 10030
+      action_chain_4.type = GtReq::ActionChain::Type::Startapp
+      action_chain_4.appid = ''
+      action_chain_4.autostart = @transmission_type == 1
+      action_chain_4.appstartupid = app_start_up
+      action_chain_4.failedAction = 100
+      action_chain_4.next = 100
 
       # end
-      actionChain5 = GtReq::ActionChain.new
-      actionChain5.actionId = 100
-      actionChain5.type = GtReq::ActionChain::Type::Eoa
+      action_chain_5 = GtReq::ActionChain.new
+      action_chain_5.actionId = 100
+      action_chain_5.type = GtReq::ActionChain::Type::Eoa
 
-      [actionChain1, actionChain2, actionChain3, actionChain4, actionChain5]
+      [action_chain_1, action_chain_2, action_chain_3, action_chain_4, action_chain_5]
     end
 
     def get_push_type

data/lib/igetui/template/transmission_template.rb

@@ -8,30 +8,30 @@ module IGeTui
 
     def get_action_chain
       # set actionChain
-      actionChain1 = GtReq::ActionChain.new
-      actionChain1.actionId = 1
-      actionChain1.type = GtReq::ActionChain::Type::Goto
-      actionChain1.next = 10030
+      action_chain_1 = GtReq::ActionChain.new
+      action_chain_1.actionId = 1
+      action_chain_1.type = GtReq::ActionChain::Type::Goto
+      action_chain_1.next = 10030
 
       # appStartUp
-      appStartUp = GtReq::AppStartUp.new(android: '', symbia: '', ios: '')
+      app_start_up = GtReq::AppStartUp.new(android: '', symbia: '', ios: '')
 
       # start up app
-      actionChain2 = GtReq::ActionChain.new
-      actionChain2.actionId = 10030
-      actionChain2.type = GtReq::ActionChain::Type::Startapp
-      actionChain2.appid = ''
-      actionChain2.autostart = transmission_type == 1
-      actionChain2.appstartupid = appStartUp
-      actionChain2.failedAction = 100
-      actionChain2.next = 100
+      action_chain_2 = GtReq::ActionChain.new
+      action_chain_2.actionId = 10030
+      action_chain_2.type = GtReq::ActionChain::Type::Startapp
+      action_chain_2.appid = ''
+      action_chain_2.autostart = transmission_type == 1
+      action_chain_2.appstartupid = app_start_up
+      action_chain_2.failedAction = 100
+      action_chain_2.next = 100
 
       # end
-      actionChain3 = GtReq::ActionChain.new
-      actionChain3.actionId = 100
-      actionChain3.type = GtReq::ActionChain::Type::Eoa
+      action_chain_3 = GtReq::ActionChain.new
+      action_chain_3.actionId = 100
+      action_chain_3.type = GtReq::ActionChain::Type::Eoa
 
-      [actionChain1, actionChain2, actionChain3]
+      [action_chain_1, action_chain_2, action_chain_3]
     end
 
     def get_push_type

data/lib/igetui/template.rb

@@ -1,3 +1,4 @@
 require 'igetui/template/base_template'
 require 'igetui/template/transmission_template'
+require 'igetui/template/link_template'
 require 'igetui/template/notification_template'

data/lib/igetui/version.rb

@@ -1,3 +1,3 @@
 module IGeTui
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/pusher_test.rb

@@ -28,6 +28,13 @@ class PusherTest < MiniTest::Unit::TestCase
     assert_equal ret["result"], "ok"
   end
 
+  def test_to_single_link_notification
+    single_message = IGeTui::SingleMessage.new
+    single_message.data = link_template
+    ret = @pusher.push_message_to_single(single_message, @client_1)
+    assert_equal ret["result"], "ok"
+  end
+
   def test_to_single_transmission
     single_message = IGeTui::SingleMessage.new
     single_message.data = transmission_template
@@ -56,12 +63,23 @@ class PusherTest < MiniTest::Unit::TestCase
 
   private
 
-  def notification_template
-    template = IGeTui::NotificationTemplate.new
+  def set_template_base_info(template)
     template.logo = 'push.png'
     template.logo_url = 'http://www.igetui.com/wp-content/uploads/2013/08/logo_getui1.png'
     template.title = '测试标题'
     template.text = '测试文本'
+  end
+
+  def link_template
+    template = IGeTui::LinkTemplate.new
+    set_template_base_info(template)
+    template.url = "http://www.baidu.com"
+    template
+  end
+
+  def notification_template
+    template = IGeTui::NotificationTemplate.new
+    set_template_base_info(template)
     template
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: igetui-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Victor Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-08 00:00:00.000000000 Z
+date: 2014-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -114,6 +114,7 @@ extra_rdoc_files:
 files:
 - ".gitignore"
 - Gemfile
+- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -124,6 +125,7 @@ files:
 - lib/igetui/pusher.rb
 - lib/igetui/template.rb
 - lib/igetui/template/base_template.rb
+- lib/igetui/template/link_template.rb
 - lib/igetui/template/notification_template.rb
 - lib/igetui/template/transmission_template.rb
 - lib/igetui/validate.rb