xmpush 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0eb9c801b8cccddda27ce474d7d3701f8a727d0e
+  data.tar.gz: 58524b2cea5b138d96bb6bf61c3c612d3cfb70f1
+SHA512:
+  metadata.gz: 8944f441646d4fae28152f1fb25d1363629dd98bac24f7b860163063b4e77dbde76edb9b6e5eed50506e7c61d9f682da53c8dac3d5182d4adf89b4b4858927e7
+  data.tar.gz: 07fec128fdf247a56eb22fca4eb979edaf750164d77cfdb1147c6760d7cfa349fdaf430953756e7c8f57371a3f1d8942fcb8734c8f13fd30ca149ca1362670b9

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+lib/.DS_Store
+lib/**/.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,37 @@
+## About
+
+[XiaoMi push](dev.xiaomi.com) Ruby SDK
+
+## Usage：
+
+```ruby
+@xm_service = Xmpush::Service.config do |s|
+  s.sandbox = true
+  s.ios_secret = "ios secret key"
+  s.bundle_id = "com.xxx.ios"
+  s.android_secret = 'android secret key'
+  s.package_name = "com.xxx.android"
+  s.connection_adapter = :net_http # default
+end
+
+# just iOS
+message1 = {description:  'hello'}
+@message1 = @xm_service.build(:ios, message1)
+@xm_service.push(:all, @message1)
+
+message2 = {description:  'hello alias'}
+@message2 = @xm_service.build(:ios, message2)
+
+@xm_service.push(:alias, @message2, alias: '1043478')
+
+# iOS and Android
+message3 = {description:  'push to iOS and Android client'}
+@message2 = @xm_service.build(message3)
+@xm_service.push(:all, @message3)
+
+```
+
+## TODO
+
+- Android push
+- feedback/ stats/ tracer/ targeted_message

data/Rakefile

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

data/lib/xmpush/android_builder.rb

@@ -0,0 +1,23 @@
+module Xmpush
+  class AndroidBuilder < Message
+
+    # 设置通知类型
+    NOTIFY_TYPE_DEFAULT_ALL     = -1
+    NOTIFY_TYPE_DEFAULT_SOUND   = 1 # 使用默认提示音提示
+    NOTIFY_TYPE_DEFAULT_VIBRATE = 2 # 使用默认震动提示
+    NOTIFY_TYPE_DEFAULT_LIGHTS  = 4 # 使用默认led灯光提示
+
+    NTF_CENTER_NTF   = 0 # 通知栏消息
+    PASS_THROUGH_NTF = 1 # 透传消息
+
+    attr_accessor :pass_through, :notify_id
+
+    def initialize(**message)
+      @pass_through = message.delete(:pass_through) || 0
+      @notify_id = message.delete(:notify_id) || 0
+      super(message)
+      # @extra = {sound_url: sound_url, badge: badge}
+    end
+
+  end
+end

data/lib/xmpush/feedback.rb

@@ -0,0 +1,5 @@
+module Xmpush
+  class Feedback < HttpBase
+
+  end
+end

data/lib/xmpush/http_base.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+require 'faraday'
+
+module Xmpush
+  class HttpBase
+    attr_accessor :secret_key, :url, :host
+
+    def initialize(host="", secret_key="", connection_adapter = :net_http, headers={})
+      @host = host
+      @secret_key = secret_key
+      @connection_adapter = connection_adapter
+      @headers = headers
+    end
+
+    def post(url, body={}); conn.post url, body end
+    def get(url, params={}); conn.get url, params end
+
+    def conn
+      headers = {authorization: "key=#{@secret_key}"}.merge(@headers)
+      Faraday.new(:url => @host, :headers => headers) do |faraday|
+        faraday.request  :url_encoded
+        faraday.response :logger
+        faraday.adapter  @connection_adapter
+      end
+    end
+
+  end
+end

data/lib/xmpush/ios_builder.rb

@@ -0,0 +1,25 @@
+module Xmpush
+  class IosBuilder < Message
+    attr_accessor :sound_url, :badge
+
+    def initialize(**message)
+      sound_url = message.delete(:sound_url) || ""
+      badge = message.delete(:badge) || 1
+      super(message)
+      @extra = {sound_url: sound_url, badge: badge}
+    end
+
+    def build
+      if @extra
+        extra_message = extra(@extra)
+      end
+      message = {
+        restricted_package_name: @restricted_package_name,
+        description: @description
+      }
+      message.merge!(extra_message)
+      return message
+    end
+
+  end
+end

data/lib/xmpush/message.rb

@@ -0,0 +1,23 @@
+module Xmpush
+  class Message
+    EXTRA_PREFIX = 'extra.'
+    attr_accessor :payload, :title, :description, :time_to_live, :time_to_send, :extra, :notify_type, :restricted_package_name
+
+    def initialize(payload: "", restricted_package_name: "", title: "", description: "", time_to_live: "", time_to_send: "", extra: "", notify_type: "")
+      @payload = payload
+      @restricted_package_name = restricted_package_name
+      @title = title
+      @description = description
+      @time_to_live = time_to_live
+      @time_to_send = time_to_send
+      @extra = extra
+      @notify_type = notify_type
+    end
+
+    def extra(options={})
+      options.keys.inject({}) do |h, key|
+        h["#{EXTRA_PREFIX}#{key}"] = options.delete(key); h
+      end
+    end
+  end
+end

data/lib/xmpush/stats.rb

@@ -0,0 +1,5 @@
+module Xmpush
+  class Stats < HttpBase
+
+  end
+end

data/lib/xmpush/subscription.rb

@@ -0,0 +1,5 @@
+module Xmpush
+  class Subscription < HttpBase
+
+  end
+end

data/lib/xmpush/targeted_message.rb

@@ -0,0 +1,5 @@
+module Xmpush
+  class TargetedMessage < Message
+
+  end
+end

data/lib/xmpush/tracer.rb

@@ -0,0 +1,5 @@
+module Xmpush
+  class Tracer < HttpBase
+
+  end
+end

data/lib/xmpush/version.rb

@@ -0,0 +1,3 @@
+module Xmpush
+  VERSION = "0.0.2"
+end

data/lib/xmpush/xm_resources.rb

@@ -0,0 +1,34 @@
+module Xmpush
+  class XmResource
+
+    # Xmpush::XmResource::OFFICIAL_DOMAIN
+
+    OFFICIAL_DOMAIN = "https://api.xmpush.xiaomi.com"
+    SANDBOX_DOMAIN = "https://sandbox.xmpush.xiaomi.com"
+    REG_URL = "/v2/message/regid"
+    ALIAS_URL = "/v2/message/alias"
+    TOPIC_URL = "/v2/message/topic"
+    MTOPIC_URL = "/v2/message/multi_topic"
+    ALL_URL = "/v2/message/all"
+
+    SUBSCRIBE_URL= "/v2/topic/subscribe"
+    UNSUBSCRIBE_URL = "/v2/topic/unsubscribe"
+
+    MMREG_URL = "/v2/multi_messages/regids"
+    MMALIAS_URL = "/v2/multi_messages/aliases"
+
+    STATS_URL = '/v1/stats/message/counters'
+    TRACE_URL = '/v1/trace/message/status'
+    TRACES_URL = '/v1/trace/messages/status'
+    VALIDATE_REGIDS = '/v1/validation/regids'
+
+
+    FETCH_INVALID_REGIDS_URL = "https://feedback.xmpush.xiaomi.com/v1/feedback/fetch_invalid_regids"
+
+    UNION = 'UNION'
+    INTERSECTION = 'INTERSECTION'
+    EXCEPT = 'EXCEPT'
+
+
+  end
+end

data/lib/xmpush.rb

@@ -0,0 +1,94 @@
+require 'xmpush/xm_resources'
+require 'xmpush/http_base'
+require 'xmpush/message'
+require 'xmpush/ios_builder'
+require 'xmpush/android_builder'
+require 'xmpush/targeted_message'
+require 'xmpush/result'
+require 'xmpush/stats'
+require 'xmpush/subscription'
+require 'xmpush/tracer'
+require 'xmpush/feedback'
+
+
+module Xmpush
+  class Service
+
+    attr_accessor :ios_secret, :android_secret, :bundle_id, :package_name, :sandbox
+
+    def initialize(ios_secret: "", android_secret: "", bundle_id: "", package_name: "", connection_adapter: :net_http, sandbox: false)
+      @sandbox = sandbox
+      @ios_secret = ios_secret
+      @bundle_id = bundle_id
+      @android_secret = android_secret
+      @package_name = package_name
+      @connection_adapter = connection_adapter
+    end
+
+    def self.config
+      yield service = new; service
+    end
+
+    def build(build_type, message={})
+      case build_type
+      when :ios
+        build_message = { ios: ios_builder(message)}
+      when :android
+        build_message = { android: android_builder(message) }
+      else
+        build_message = { ios: ios_builder(message),  android: android_builder(message)}
+      end
+      return build_message
+    end
+
+    def push(push_type, message, options={})
+      case push_type
+      when :alias
+        return "must input alias" unless options[:alias]
+        message.values.each{|v| v.merge!(alias: options[:alias])}
+        resource_post('alias', message)
+      when :regid
+        return "must input regid" unless options[:regid]
+        message.values.each{|v| v.merge!(regid: options[:regid])}
+        resource_post('regid', message)
+      when :topic
+        return "must input topic" unless options[:topic]
+        message.values.each{|v| v.merge!(topic: options[:topic])}
+        resource_post('topic', message)
+      else #:all
+        resource_post('all', message)
+      end
+    end
+
+private
+
+    def ios_builder(message={})
+      message[:restricted_package_name] = @bundle_id
+      IosBuilder.new(message).build
+    end
+
+    def android_builder(message={})
+      message[:restricted_package_name] = @bundle_id
+      AndroidBuilder.new(message).build
+    end
+
+    def ios_http
+      host = @sandbox ? Xmpush::XmResource::SANDBOX_DOMAIN : Xmpush::XmResource::OFFICIAL_DOMAIN
+      Xmpush::HttpBase.new(host, @ios_secret, @connection_adapter)
+    end
+
+    def android_http
+      return "android don't suppot sandbox" if @sandbox
+      host = @sandbox ? Xmpush::XmResource::SANDBOX_DOMAIN : Xmpush::XmResource::OFFICIAL_DOMAIN
+      Xmpush::HttpBase.new(host, @android_secret, @connection_adapter)
+    end
+
+    def resource_post(name, message)
+      ios_result = ios_http.post(Xmpush::XmResource.const_get("#{name.upcase}_URL"), message[:ios]) if message[:ios]
+      puts "====== ios_result: #{ios_result.inspect}"
+      android_result = android_http.post(Xmpush::XmResource.const_get("#{name.upcase}_URL"), message[:android]) if message[:android]
+      puts "====== android_result: #{android_result.inspect}"
+    end
+
+  end
+end

data/xmpush.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xmpush/version'
+
+Gem::Specification.new do |spec|
+  spec.platform      = Gem::Platform::RUBY
+  spec.name          = "xmpush"
+  spec.version       = Xmpush::VERSION
+  spec.authors       = ["blackanger"]
+  spec.email         = ["blackanger.z@gmail.com"]
+  spec.summary       = %q{XiaoMi push Ruby Server SDK.}
+  spec.description   = %q{XiaoMi push Ruby Server SDK}
+  spec.homepage      = ""
+  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.add_dependency "faraday"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: xmpush
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- blackanger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: XiaoMi push Ruby Server SDK
+email:
+- blackanger.z@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xmpush.rb
+- lib/xmpush/android_builder.rb
+- lib/xmpush/feedback.rb
+- lib/xmpush/http_base.rb
+- lib/xmpush/ios_builder.rb
+- lib/xmpush/message.rb
+- lib/xmpush/stats.rb
+- lib/xmpush/subscription.rb
+- lib/xmpush/targeted_message.rb
+- lib/xmpush/tracer.rb
+- lib/xmpush/version.rb
+- lib/xmpush/xm_resources.rb
+- xmpush.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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.2.2
+signing_key: 
+specification_version: 4
+summary: XiaoMi push Ruby Server SDK.
+test_files: []