xinge-for-ruby 0.1.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6175082406742b706120b1eedb0967fbd2765890
+  data.tar.gz: b17d8aa904fc23db6d19f5a1d8c1d95d6f52d051
+SHA512:
+  metadata.gz: 5357e2605c4210555fd45b0931e78dbbc93a66572b62688dd6706ac16432515cef897768c730f2735ecbc3cdab8480a882b7dfa539e5021adc3bc6695061dd66
+  data.tar.gz: 9055932664787c3ddea761d98a05d4a54f5cc9824b010e9ec336907926ca72b46fd919f4311a277e488088ca999c536eda581b8cd93a99832a24d3f738c71e15

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    xinge-for-ruby (0.1.13)
+
+GEM
+  remote: https://ruby.taobao.org/
+  specs:
+    diff-lcs (1.2.5)
+    httparty (0.13.3)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.2)
+    multi_xml (0.5.5)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.8)
+  httparty (~> 0.13.3)
+  rake (~> 10.0)
+  rspec
+  xinge-for-ruby!
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Robot Jiang
+
+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,51 @@
+# Ruby for Tencent Xinge
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/xinge`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby-for-xinge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-for-xinge
+
+## Usage
+
+Add below codes to your application.rb or a init file in config/initializers
+
+    require 'xinge'   
+    Xinge.configure do |config|    
+      config[:android_accessId] = Your android access id    
+      config[:android_secretKey] = 'Your secret key xxx'     
+      config[:ios_accessId] = Your ios access id    
+      config[:ios_secretKey] = 'Your secret key xxx'   
+      config[:logger] = Rails.logger
+      config[:env] = Rails.env # if you are not in a rails app, you can set it config[:env]='development' or config[:env]='production', it is 'development' default.
+    end   
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/xinge/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "xinge"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/xinge.rb

@@ -0,0 +1,9 @@
+require "xinge/version"
+require "xinge/base"
+require "xinge/ios"
+require "xinge/android"
+require "xinge/notification"
+
+module Xinge
+
+end

data/lib/xinge/android.rb

@@ -0,0 +1,27 @@
+require 'xinge/base'
+module Xinge
+  class Android < Base
+    def initialize(accessId = nil, secretKey = nil, options = {})
+      super
+    end
+    def pushToSingleDevice(token, title, content, params={}, custom_content={})
+      self.push_single_device(token, 1, build_simple_message(title, content, custom_content), params)
+    end
+
+    def pushToMultiDevices(tokens, title, content, params={}, custom_content={})
+      self.push_multi_device(tokens, 1, build_simple_message(title, content, custom_content), params)
+    end
+
+    def pushToAllDevice(title, content, params={}, custom_content={})
+      self.push_all_device(1, build_simple_message(title, content, custom_content), params)
+    end
+
+    protected
+
+    def build_simple_message(title, content, custom_content)
+      {
+        title: title, content: content, vibrate: 1
+      }.merge(custom_content).to_json
+    end
+  end
+end

data/lib/xinge/base.rb

@@ -0,0 +1,192 @@
+require 'httparty'
+require 'digest'
+require 'xinge/logger'
+
+module Xinge
+
+  @xinge_config = {env: 'development'}
+
+  class << self
+
+    def logger
+      @@logger = defined?(@@logger) ? @@logger : (config[:logger].nil? ? Xinge::Logging.new.logger : config[:logger])
+    end
+
+    def configure
+      yield @xinge_config if block_given?
+    end
+    def config
+      @xinge_config
+    end
+  end
+
+  class Base
+    include HTTParty
+    base_uri  'http://openapi.xg.qq.com'
+
+    DEFAULT_OPTIONS = {
+      api_version: 'v2'
+    }
+    HOST = "openapi.xg.qq.com"
+    HTTP_METHOD = :post
+
+    def initialize(accessId = nil, secretKey = nil, options = {})
+      raise 'accessId is invalid'  unless accessId.is_a? Integer
+      raise 'secretKey is invalid' if     !secretKey.is_a?(String) or secretKey.strip.size == 0
+      @accessId  =  accessId
+      @secretKey =  secretKey.strip
+      @options   =  DEFAULT_OPTIONS.merge options
+    end
+
+
+    #push消息（包括通知和透传消息）给单个设备
+    def push_single_device(device_token, message_type, message, params = {})
+      params.merge!({
+        device_token: device_token,
+        message:      message,
+        message_type: message_type
+        })
+      self.send_request('push','single_device',params)
+    end
+
+    # push到多个设备
+    def push_multi_device(device_list, message_type, message, params = {})
+      params1 = params.merge({
+        message:      message,
+        message_type: message_type
+        })
+      result = self.send_request('push','create_multipush', params1)
+      raise result.to_s if result['ret_code'] != 0
+
+      push_id = result['result']['push_id']
+      params.merge!({
+        device_list:  device_list.to_json,
+        push_id:      push_id
+      })
+
+      self.send_request('push', 'device_list_multiple', params)
+    end
+
+    #push消息（包括通知和透传消息）给单个账户或别名
+    def push_single_account(account, message_type, message, params = {})
+      params.merge!({
+        account: account,
+        message_type: message_type,
+        message: message
+        })
+      self.send_request('push','single_account',params)
+    end
+
+    #push消息（包括通知和透传消息）给app的所有设备
+    def push_all_device(message_type, message, params = {})
+      params.merge!({
+        message_type: message_type,
+        message: message
+        })
+      self.send_request('push','all_device',params)
+    end
+
+    #push消息（包括通知和透传消息）给tags指定的设备
+    def push_tags_device(message_type, message, tags_list, tags_op, params = {})
+      params.merge!({
+        message_type: message_type,
+        message: message,
+        tags_list: tags_list.to_json,
+        tags_op: tags_op
+        })
+      self.send_request('push','tags_device',params)
+    end
+
+    #查询群发消息发送状态
+    def push_get_msg_status(push_ids, params = {})
+      params.merge!({
+        push_ids: push_ids.to_json
+        })
+      self.send_request('push','get_msg_status',params)
+    end
+
+    #查询应用覆盖的设备数
+    def application_get_app_device_num(params = {})
+      self.send_request('application','get_app_device_num',params)
+    end
+
+    #查询应用的Tags
+    def tags_query_app_tags(params = {})
+      self.send_request('tags','query_app_tags',params)
+    end
+
+    #取消尚未触发的定时群发任务
+    def push_cancel_timing_task(push_id, params = {})
+      params.merge!({
+        push_id: push_id
+        })
+      @request.fetch(params)
+      self.send_request('push','cancel_timing_task',params)
+    end
+
+    #批量设置标签
+    def tags_batch_set(tag_token_list, params = {})
+      params.merge!({
+        tag_token_list: tag_token_list
+        })
+      self.send_request('tags','batch_set',params)
+    end
+
+    #批量删除标签
+    def tags_batch_del(tag_token_list, params = {})
+      params.merge!({
+        tag_token_list: tag_token_list
+        })
+      self.send_request('tags','batch_del',params)
+    end
+
+    #查询应用某token设置的标签
+    def tags_query_token_tags(device_token, params = {})
+      params.merge!({
+        device_token: device_token
+        })
+      self.send_request('tags','query_token_tags',params)
+    end
+
+    #查询应用某标签关联的设备数量
+    def tags_query_tag_token_num(tag, params = {})
+      params.merge!({
+        tag: tag
+        })
+      self.send_request('tags','query_tag_token_num',params)
+    end
+
+    protected
+
+    def send_request(type,method,params = {})
+      params.merge!({access_id: @accessId,
+                     timestamp: Time.now.to_i})
+      #sign params
+      params_string = params.sort.map{ |h| h.join('=') }.join
+      sign = Digest::MD5.hexdigest("#{HTTP_METHOD.to_s.upcase}#{HOST}#{self.get_request_url(type,method)}#{params_string}#{@secretKey}")
+
+      params.merge!({ sign: sign })
+      options = { body: params }
+
+      request_url = self.get_request_url(type, method)
+      response_txt = self.class.send(HTTP_METHOD, request_url, options)
+      begin
+        JSON.parse(response_txt.to_s.gsub(/\\r\\n/, ''))
+      rescue => e
+        Xinge.logger.error "REQ URL: #{request_url} \n #{e} \n #{response_txt}"
+        response_txt
+      end
+
+    end
+
+    def get_request_url(type,method)
+      "/#{@options[:api_version]}/#{type}/#{method}"
+    end
+
+    def build_simple_message(title, content)
+      raise 'let child class to implement it.'
+    end
+
+  end
+
+end

data/lib/xinge/ios.rb

@@ -0,0 +1,35 @@
+require 'xinge/base'
+module Xinge
+  class Ios < Base
+
+    ENV_MAP = {'production' => 1, 'development' => 2}
+
+    def initialize(accessId = nil, secretKey = nil, options = {})
+      super
+    end
+    def pushToSingleDevice(token, title, content, params={}, custom_content={})
+      self.push_single_device(token, 0, build_simple_message(title, content, custom_content), params.merge({environment: ENV_MAP[Xinge.config[:env]] || 2}))
+    end
+    def pushToMultiDevices(tokens, title, content, params={}, custom_content={})
+      self.push_multi_device(tokens, 0, build_simple_message(title, content, custom_content), params.merge({environment: ENV_MAP[Xinge.config[:env]] || 2}))
+    end
+    def pushToAllDevice(title, content, params={}, custom_content={})
+      self.push_all_device(0, build_simple_message(title, content, custom_content), params.merge({environment: ENV_MAP[Xinge.config[:env]] || 2}))
+    end
+
+    protected
+
+    def build_simple_message(title, content, custom_content)
+      {
+        aps: {
+          alert: {
+            title: title,
+            body: content
+          },
+          sound: 'default',
+          badge: 1
+        }
+      }.merge(custom_content).to_json
+    end
+  end
+end

data/lib/xinge/logger.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module Xinge
+  class Logging
+
+    def initialize(log_target = STDOUT)
+      @logger = Logger.new(log_target)
+      @logger.level = Logger::INFO
+      @logger
+    end
+
+    def logger
+      @logger
+    end
+
+
+  end
+end

data/lib/xinge/notification.rb

@@ -0,0 +1,27 @@
+require 'singleton'
+require 'xinge/base'
+require 'xinge/ios'
+require 'xinge/android'
+
+module Xinge
+
+  class Notification
+    include Singleton
+    attr_reader :android, :ios
+    def initialize
+      @android = Xinge::Android.new(Xinge.config[:android_accessId].to_i, Xinge.config[:android_secretKey])
+      @ios     = Xinge::Ios.new(Xinge.config[:ios_accessId].to_i, Xinge.config[:ios_secretKey])
+    end
+    #发送简单消息到所有 android , ios 设备
+    def send_simple_to_all(title, content)
+      result = []
+      [@android, @ios].each do |sender|
+        result << sender.pushToAllDevice(title,content)
+      end
+      result
+    end
+
+  end
+
+end
+

data/lib/xinge/version.rb

@@ -0,0 +1,3 @@
+module Xinge
+  VERSION = "0.1.13"
+end

data/xinge.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xinge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "xinge-for-ruby"
+  spec.version       = Xinge::VERSION
+  spec.authors       = ["ReYin Dev Team"]
+  spec.email         = ["rdteam@reyinapp.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  end
+
+  spec.summary       = %q{A Ruby portal for Tencent Xinge}
+  spec.description   = %q{腾讯 信鸽 Rest API for Ruby}
+  spec.homepage      = "https://github.com/DanielReYin/ruby-for-xinge"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "httparty", "~> 0.13.3"
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: xinge-for-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.13
+platform: ruby
+authors:
+- ReYin Dev Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "腾讯 信鸽 Rest API for Ruby"
+email:
+- rdteam@reyinapp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/xinge.rb
+- lib/xinge/android.rb
+- lib/xinge/base.rb
+- lib/xinge/ios.rb
+- lib/xinge/logger.rb
+- lib/xinge/notification.rb
+- lib/xinge/version.rb
+- xinge.gemspec
+homepage: https://github.com/DanielReYin/ruby-for-xinge
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A Ruby portal for Tencent Xinge
+test_files: []
+has_rdoc: