apns_gatling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7fcd01204b0843e249983f293fed891516c2b1ac
+  data.tar.gz: 93a44a765b925442c7a57b8ba45bee5f5038a2fb
+SHA512:
+  metadata.gz: cc6404cc32db0863b656084b2c0530cf768225e38f5b49e539151f84864799c0327ce7a49915747f12b5bfe2a144e6d7c7321565581326341bb43ae3c690c5f1
+  data.tar.gz: 632e7558e5ea4acdedb694c59f4ff1ae97870751ec4ee70e91587871eddab64354e2126b3f33c7f95d553015a7d8c0fda998c824afd8d9cab7cc2e51b7944572

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cloud
+
+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,61 @@
+# ApnsGatling
+
+ApnsGatling is a token based authenitcation APNs HTTP/2 gem. 
+[Communicating with APNs via HTTP2](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) is the specification.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apns_gatling'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apns_gatling
+
+## Usage
+
+```
+require 'apns_gatling'
+require 'openssl'
+
+team_id = '<Your team id>'
+auth_key_id = '<Your auth key id>'
+auth_key_file = '<Your p8 cert file>'
+ecdsa_key = OpenSSL::PKey::EC.new File.read auth_key_file
+
+def message(body)
+  msg = ApnsGatling::Message.new '<device token>'
+  msg.alert = {title: "test", body: body}
+  msg.topic = '<Your App bundle ID>'
+  msg
+end
+
+client = ApnsGatling::Client.new team_id, auth_key_id, ecdsa_key, true
+
+6.times do |i|
+  puts "num #{i}"
+  client.push(message("test #{i}")) do |r|
+    puts "num #{i} success: #{r.ok?}, error: #{r.error}"
+  end
+end
+
+client.join
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Codezerker/apns_gatling.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/apns_gatling.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apns_gatling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apns_gatling"
+  spec.version       = ApnsGatling::VERSION
+  spec.licenses      = ["MIT"]
+  spec.authors       = ["Cloud"]
+  spec.email         = ["cloudcry@gmail.com"]
+
+  spec.summary       = %q{A Ruby Token Based Authentication APNs HTTP/2 gem.}
+  spec.description   = %q{ApnsGatling is a token based authenitcation APNs HTTP/2 gem. }
+  spec.homepage      = "https://github.com/cloudorz/apns_gatling"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "http-2", "~> 0.8.3"
+  spec.add_dependency "jwt", "~> 1.5"
+  spec.add_dependency "json", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apns_gatling"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/push_message.rb

@@ -0,0 +1,25 @@
+require 'apns_gatling'
+require 'openssl'
+
+team_id = '8PJZBHFZQF'
+auth_key_id = 'AKE6P98TYE'
+auth_key_file = './APNSAuthKey_AKE6P98TYE.p8'
+ecdsa_key = OpenSSL::PKey::EC.new File.read auth_key_file
+
+def message(body)
+  msg = ApnsGatling::Message.new '4f078418a622070830f4a93d4fa2f53ae23f960cb6131888694de453abf5e694'
+  msg.alert = {title: "test", body: body}
+  msg.topic = 'com.liulishuo.PhonicsCourseDemo'
+  msg
+end
+
+client = ApnsGatling::Client.new team_id, auth_key_id, ecdsa_key, true
+
+6.times do |i|
+  puts "num #{i}"
+  client.push(message("test #{i}")) do |r|
+    puts "num #{i} success: #{r.ok?}, error: #{r.error}"
+  end
+end
+
+client.join

data/lib/apns_gatling.rb

@@ -0,0 +1,10 @@
+require "apns_gatling/version"
+require "apns_gatling/apns_client"
+require "apns_gatling/jwt_token"
+require "apns_gatling/message"
+require "apns_gatling/request"
+require "apns_gatling/response"
+
+module ApnsGatling
+  # Your code goes here...
+end

data/lib/apns_gatling/apns_client.rb

@@ -0,0 +1,185 @@
+require 'openssl'
+require 'http/2'
+require 'socket'
+
+module ApnsGatling
+  APPLE_DEVELOPMENT_SERVER = "api.development.push.apple.com"
+  APPLE_PRODUCTION_SERVER = "api.push.apple.com"
+
+  class Client
+    DRAFT = 'h2'.freeze
+
+    attr_reader :token_maker, :token, :sandbox
+
+    def initialize(team_id, auth_key_id, ecdsa_key, sandbox = false)
+      @token_maker = Token.new(team_id, auth_key_id, ecdsa_key)
+      @sandbox = sandbox
+      @mutex = Mutex.new
+      @cv = ConditionVariable.new
+      init_vars
+    end
+
+    def init_vars
+      @mutex.synchronize do 
+        @socket.close if @socket && !@socket.closed?
+        @socket = nil
+        @socket_thread = nil
+        @first_data_sent = false
+        @token_generated_at = 0
+        @blocking = true
+      end
+    end
+
+    def provider_token
+      timestamp = Time.new.to_i
+      if timestamp - @token_generated_at > 3550
+        @mutex.synchronize do 
+          @token_generated_at = timestamp
+          @token = @token_maker.new_token
+        end
+        @token
+      else
+        @token
+      end
+    end
+
+    def host
+      if sandbox
+        APPLE_DEVELOPMENT_SERVER
+      else
+        APPLE_PRODUCTION_SERVER
+      end
+    end
+
+    # push message
+    def push(message)
+      request = Request.new(message, provider_token, host)
+      response = Response.new
+      ensure_socket_open
+
+      begin
+        stream = connection.new_stream
+      rescue StandardError => e
+        close
+        raise e
+      end
+
+      stream.on(:close) do
+        @mutex.synchronize do 
+          @token_generated_at = 0 if response.status == '403' && response.error[:reason] == 'ExpiredProviderToken' 
+          if @blocking 
+            @blocking = false
+            @cv.signal
+          end
+        end
+        yield response
+      end
+
+      stream.on(:headers) do |h|
+        hs = Hash[*h.flatten]
+        response.headers.merge!(hs)
+      end
+
+      stream.on(:data) do |d|
+        response.data << d
+      end
+
+      stream.headers(request.headers, end_stream: false)
+      stream.data(request.data)
+      @mutex.synchronize { @cv.wait(@mutex, 60) } if @blocking
+    end
+    
+    # connection
+    def connection
+      @connection ||= HTTP2::Client.new.tap do |conn|
+        conn.on(:frame) do |bytes|
+          @mutex.synchronize do
+            @socket.write bytes
+            @socket.flush
+            @first_data_sent = true
+          end
+        end
+      end
+    end
+
+    # scoket 
+    def ensure_socket_open
+      @mutex.synchronize do 
+        return if @socket_thread
+        @socket = new_socket
+        @socket_thread = Thread.new do 
+          begin 
+            socket_loop
+          rescue EOFError
+            init_vars
+            raise SocketError.new('Socket was remotely closed')
+          rescue Exception => e
+            init_vars
+            raise e
+          end
+        end.tap { |t| t.abort_on_exception = true }
+      end
+    end
+
+    def new_socket
+      ctx = OpenSSL::SSL::SSLContext.new
+      ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      # For ALPN support, Ruby >= 2.3 and OpenSSL >= 1.0.2 are required
+      ctx.alpn_protocols = [DRAFT]
+      ctx.alpn_select_cb = lambda do |protocols|
+        DRAFT if protocols.include? DRAFT
+      end
+
+      tcp = TCPSocket.new(host, 443)
+      socket = OpenSSL::SSL::SSLSocket.new(tcp, ctx)
+      socket.sync_close = true
+      socket.hostname = host
+      socket.connect
+
+      if socket.alpn_protocol != DRAFT
+        puts "Failed to negotiate #{DRAFT} via ALPN"
+        exit
+      end
+      socket
+    end
+
+    def ensure_sent_before_receiving
+      while !@first_data_sent
+        sleep 0.01
+      end
+    end
+
+    def socket_loop
+      ensure_sent_before_receiving
+      loop do
+        begin
+          data = @socket.read_nonblock(1024)
+          connection << data # in
+        rescue IO::WaitReadable
+          IO.select([@socket])
+          retry
+        rescue IO::WaitWritable
+          IO.select(nil, [@socket])
+          retry
+        end
+      end
+    end
+
+    def close
+      exit_thread(@socket_thread)
+      init_vars
+    end
+
+    def exit_thread(thread)
+      return unless thread
+      thread.exit
+      thread.join
+    end
+
+    def join
+      @socket_thread.join if @socket_thread
+    end
+  end
+end
+

data/lib/apns_gatling/jwt_token.rb

@@ -0,0 +1,19 @@
+require 'jwt'
+
+module ApnsGatling
+  class Token
+    attr_reader :team_id, :auth_key_id, :ecdsa_key
+
+    def initialize(team_id, auth_key_id, ecdsa_key)
+      @team_id = team_id
+      @auth_key_id = auth_key_id
+      @ecdsa_key = ecdsa_key
+    end
+
+    def new_token
+      payload = {iss: @team_id, iat: Time.now.to_i}
+      header = {kid: @auth_key_id}
+      JWT.encode payload, @ecdsa_key, 'ES256', header
+    end
+  end
+end

data/lib/apns_gatling/message.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'securerandom'
+
+module ApnsGatling
+  class Message
+    # see: https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/PayloadKeyReference.html#//apple_ref/doc/uid/TP40008194-CH17-SW1
+    MAXIMUM_PAYLOAD_SIZE = 4096
+
+    attr_reader :token
+    attr_accessor :alert, :badge, :sound, :content_available, :category, :custom_payload, :thread_id
+    attr_accessor :apns_id, :expiration, :priority, :topic, :apns_collapse_id
+
+   def initialize(token)
+     @token = token
+     @apns_id = SecureRandom.uuid
+   end
+
+   def payload_data
+     payload.to_json.force_encoding(Encoding::BINARY)
+   end
+
+   def valid?
+     data.bytesize <= MAXIMUM_PAYLOAD_SIZE
+   end
+
+   def payload
+     aps = {}
+
+     aps.merge!(alert: alert) if alert
+     aps.merge!(badge: badge) if badge
+     aps.merge!(sound: sound) if sound
+     aps.merge!(category: category) if category
+     aps.merge!('content-available' => content_available) if content_available
+     aps.merge!('thread-id' => thread_id) if thread_id
+
+     message = {aps: aps}
+     message.merge!(custom_payload) if custom_payload
+     message
+   end
+  end
+end

data/lib/apns_gatling/request.rb

@@ -0,0 +1,28 @@
+module ApnsGatling
+  class Request
+    attr_reader :host, :path, :auth_token, :headers, :data
+
+    def initialize(message, auth_token, host)
+      path = "/3/device/#{message.token}"
+      @path = path
+      @auth_token = auth_token
+      @headers = headers_from message, auth_token, host, path
+      @data = message.payload_data
+    end
+
+    private
+    def headers_from(message, auth_token, host, path)
+      headers = {':scheme' => 'https',
+                 ':method' => 'POST',
+                 'host' => host,
+                 ':path' => path,
+                 'authorization' => "bearer #{auth_token}"}
+      headers.merge!('apns-id' => message.apns_id) if message.apns_id
+      headers.merge!('apns-expiration' => message.expiration.to_s) if message.expiration
+      headers.merge!('apqs-priority' => message.priority.to_s) if message.priority
+      headers.merge!('apns-topic' => message.topic) if message.topic
+      headers.merge!('apns-collapse-id' => message.apns_collapse_id) if message.apns_collapse_id
+      headers
+    end
+  end
+end

data/lib/apns_gatling/response.rb

@@ -0,0 +1,38 @@
+require 'json'
+
+module ApnsGatling
+  class Response
+    # See: https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html
+    attr_accessor :headers, :data
+
+    def initialize()
+      @headers = {}
+      @data = ''
+    end
+
+    def status
+      @headers[':status'] if @headers
+    end
+
+    def ok?
+      status == '200'
+    end
+
+    def parse_data
+      JSON.parse(@data) rescue @data
+    end
+
+    def error
+      if status != '200'
+        e = {}
+        e.merge!(status: @headers[':status']) if @headers[':status']
+        e.merge!('apns-id' => @headers['apns-id']) if @headers['apns-id']
+        data = parse_data
+        puts "data: #{data} raw #{@data}"
+        e.merge!(reason: data[:reason]) if data[:reason]
+        e.merge!(timestamp: data[:timestamp]) if data[:timestamp]
+        e
+      end
+    end
+  end
+end

data/lib/apns_gatling/version.rb

@@ -0,0 +1,3 @@
+module ApnsGatling
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: apns_gatling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cloud
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http-2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 'ApnsGatling is a token based authenitcation APNs HTTP/2 gem. '
+email:
+- cloudcry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- apns_gatling.gemspec
+- bin/console
+- bin/setup
+- examples/push_message.rb
+- lib/apns_gatling.rb
+- lib/apns_gatling/apns_client.rb
+- lib/apns_gatling/jwt_token.rb
+- lib/apns_gatling/message.rb
+- lib/apns_gatling/request.rb
+- lib/apns_gatling/response.rb
+- lib/apns_gatling/version.rb
+homepage: https://github.com/cloudorz/apns_gatling
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby Token Based Authentication APNs HTTP/2 gem.
+test_files: []