igetui-ruby-nolock 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 438de2034bbfccc1e7df723a33ba0b9e14c522f8
+  data.tar.gz: 20b624128b9effb9546e1434883b73223ac216f3
+SHA512:
+  metadata.gz: b39d77f5891a796412386209d559441b12d168a230b943c4e886426f7aaf4d679fbcdde207f2cb2296945609954adcf72d1d04453aa663bddaa24c533452d355
+  data.tar.gz: 9821d6b37970f1507e5b9ab7684c0249c5fd68fd8d1d68dbe3e941265a107b182631e12608f2264a523315c31ad2f0ba625b5461cdf51df11016ccdc89be5769

data/.gitignore

@@ -0,0 +1,46 @@
+.DS_Store
+.rvmrc
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/public
+spec/test.log
+spec/tmp
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in igetui-ruby.gemspec
+gemspec

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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Victor Wang
+
+MIT License
+
+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

@@ -0,0 +1,136 @@
+# IGeTui::Ruby
+
+[个推](http://www.igetui.com/)服务端 ruby-sdk
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'igetui-ruby', require: 'igetui'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install igetui-ruby
+```
+
+## Usage
+
+### 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
+# 设置iOS的推送参数，如果只有安卓 App，可以忽略下面一行
+# template.set_push_info("", 1, "这里是iOS推送的显示信息", "")
+
+# 创建群发消息
+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(your_client_id)
+p ret
+```
+
+### Auto Test
+
+运行测试之前，请先修改 test/pusher_test.rb 中的相关配置。
+
+```ruby
+rake test
+```
+
+## Documents
+
+* [参数说明](https://github.com/wjp2013/igetui-ruby/wiki/%E5%8F%82%E6%95%B0%E8%AF%B4%E6%98%8E)
+* [模板类型说明](https://github.com/wjp2013/igetui-ruby/wiki/%E6%A8%A1%E6%9D%BF%E7%B1%BB%E5%9E%8B%E8%AF%B4%E6%98%8E)
+
+## Contributing
+
+1. Fork it ( http://github.com/wjp2013/igetui-ruby/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end

data/igetui-ruby.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'igetui/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "igetui-ruby-nolock"
+  spec.version       = IGeTui::VERSION
+  spec.authors       = ["yone hsiung"]
+  spec.email         = ["QQ: 171842474"]
+  spec.summary       = "igetui.com ruby sdk"
+  spec.description   = "ruby-sdk of igetui.com push notification service"
+  spec.homepage      = "https://github.com/YoneHsiung/igetui-ruby.git"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = ["README.md"]
+
+  
+end

data/lib/igetui/client.rb

@@ -0,0 +1,9 @@
+module IGeTui
+  class Client
+    attr_accessor :client_id
+
+    def initialize(client_id)
+      @client_id = client_id
+    end
+  end
+end

data/lib/igetui/message.rb

@@ -0,0 +1,26 @@
+module IGeTui
+  class Message
+    attr_accessor :is_offline, :offline_expire_time, :data
+
+    def initialize
+      @is_offline = true
+      @offline_expire_time = 1000 * 3600 * 12
+      @data = BaseTemplate.new
+    end
+  end
+
+  SingleMessage = Class.new(Message)
+  ListMessage = Class.new(Message)
+
+  class AppMessage < Message
+    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 = []
+    end
+  end
+end

data/lib/igetui/pusher.rb

@@ -0,0 +1,163 @@
+module IGeTui
+  class Pusher
+    attr_reader :host, :app_id, :app_key, :master_secret
+
+    def initialize(host, app_id, app_key, master_secret)
+      @host = host
+      @app_id = app_id
+      @app_key = app_key
+      @master_secret = master_secret
+    end
+
+    def push_message_to_single(message, client)
+      template = message.data
+      data = {
+        'action' => 'pushMessageToSingleAction',
+        'appkey' => app_key,
+        'clientData' => template.get_client_data(self),
+        'transmissionContent' => template.transmission_content,
+        'isOffline' => message.is_offline,
+        'offlineExpireTime' => message.offline_expire_time,
+        'appId' => app_id,
+        'clientId' => client.client_id,
+        'type' => 2, #default is message
+        'pushType' => template.get_push_type
+      }
+
+      http_post_json(data)
+    end
+
+    def push_message_to_list(content_id, clients)
+      target_list = clients.inject([]) do |list, cilent|
+        list << { 'appId' => app_id, 'clientId' => cilent.client_id }
+      end
+
+      # seems that we miss 'pushType'
+      data = {
+        'action' => 'pushMessageToListAction',
+        'appkey' => app_key,
+        'contentId' => content_id,
+        'needDetails' => true,
+        'targetList' => target_list,
+        'type' => 2
+      }
+
+      http_post_json(data)
+    end
+
+    def push_message_to_app(message)
+      template = message.data
+      data = {
+        'action' => 'pushMessageToAppAction',
+        'appkey' => app_key,
+        'clientData' => template.get_client_data(self),
+        'transmissionContent' => template.transmission_content,
+        'isOffline' => message.is_offline,
+        'offlineExpireTime' => message.offline_expire_time,
+        'appIdList' => message.app_id_list,
+        'phoneTypeList' => message.phone_type_list,
+        'provinceList' => message.province_list,
+        'tagList' => message.tag_list,
+        'type' => 2,
+        'pushType' => template.get_push_type
+      }
+      http_post_json(data)
+    end
+
+    def stop(content_id)
+      data = {
+        'action' => 'stopTaskAction',
+        'appkey' => @appKey,
+        'contentId' => content_id
+      }
+
+      ret = http_post_json(data)
+      ret['result'] == 'ok'
+    end
+
+    def get_client_id_status(client_id)
+      data = {
+        'action' => 'getClientIdStatusAction',
+        'appkey' => app_key,
+        'appId' => app_id,
+        'clientId' => client_id
+      }
+      http_post_json(data)
+    end
+
+
+    def get_content_id(message)
+      template = message.data
+      data = {
+        'action' => 'getContentIdAction',
+        'appkey' => app_key,
+        'clientData' => template.get_client_data(self),
+        'transmissionContent' => template.transmission_content,
+        'isOffline' => message.is_offline,
+        'offlineExpireTime' => message.offline_expire_time,
+        'pushType' => template.get_push_type
+      }
+      ret = http_post_json(data)
+      ret['result'] == 'ok' ? ret['contentId'] : ''
+    end
+
+    def cancel_content_id(content_id)
+      data = {
+        'action' => 'cancleContentIdAction',
+        'contentId' => content_id,
+      }
+      ret = http_post_json(data)
+      ret['result'] == 'ok'
+    end
+
+
+    private
+
+    def connect
+      time_stamp = Time.now.to_i
+      sign = Digest::MD5.hexdigest(app_key + time_stamp.to_s + master_secret)
+      data = {
+        action: 'connect',
+        appkey: app_key,
+        timeStamp: time_stamp,
+        sign: sign
+      }
+      ret = http_post(data)
+      ret['result'] == 'success'
+    end
+
+    def http_post_json(params)
+      params['version'] = '3.0.0.0'
+      ret = http_post(params)
+
+      if ret && ret['result'] == 'sign_error'
+        connect
+        ret = http_post(params)
+      end
+      ret
+    end
+
+    def http_post(params)
+      params['version'] = '3.0.0.0'
+      data = params.to_json
+
+      url = URI.parse(host)
+      req = Net::HTTP::Post.new(url.path, initheader = { 'Content-Type' => 'application/json' })
+      req.body = data
+
+      try_time = 0
+      begin
+        res = Net::HTTP.new(url.host, url.port).start { |http| http.request(req) }
+      rescue => e
+        try_time += 1
+        if try_time >= 3 
+          raise e
+        else
+          retry
+        end
+      end
+
+      JSON.parse res.body
+    end
+  end
+end

data/lib/igetui/template/base_template.rb

@@ -0,0 +1,70 @@
+module IGeTui
+  class BaseTemplate
+    attr_accessor :transmission_type, :transmission_content, :push_info
+
+    def initialize
+      @transmission_type = 0
+      @transmission_content = ''
+    end
+
+    def get_transparent(pusher)
+      transparent = GtReq::Transparent.new
+      transparent.id = ''
+      transparent.messageId = ''
+      transparent.taskId = ''
+      transparent.action = 'pushmessage'
+      transparent.actionChain = get_action_chain
+      transparent.pushInfo = get_push_info
+      transparent.appId = pusher.app_id
+      transparent.appKey = pusher.app_key
+      transparent
+    end
+
+    def get_action_chain
+      raise NotImplementedError, 'Must be implemented by subtypes.'
+    end
+
+    def get_push_type
+      raise NotImplementedError, 'Must be implemented by subtypes.'
+    end
+
+    def get_client_data(pusher)
+      string = self.get_transparent(pusher).serialize_to_string
+      Base64.strict_encode64 string
+    end
+
+    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.to_s
+      @push_info.message = message
+      @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
+
+    private
+
+    def init_push_info
+      @push_info = GtReq::PushInfo.new
+      @push_info.message = ''
+      @push_info.actionKey = ''
+      @push_info.sound = ''
+      @push_info.badge = '-1'
+      @push_info
+    end
+
+  end
+end

data/lib/igetui/template/link_template.rb

@@ -0,0 +1,60 @@
+module IGeTui
+  class LinkTemplate < BaseTemplate
+    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
+      super
+
+      STRING_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", '') }
+      BOOLEAN_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", true) }
+    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

@@ -0,0 +1,66 @@
+module IGeTui
+  class NotificationTemplate < BaseTemplate
+    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
+      super
+
+      STRING_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", '') }
+      BOOLEAN_ATTRIBUTES.each { |attr| instance_variable_set("@#{attr}", true) }
+    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
+
+      # appStartUp
+      app_start_up = GtReq::AppStartUp.new(android: '', symbia: '', ios: '')
+
+      # start web
+      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
+      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