apns_provider_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 513dac1f43bcb7d41e2c9dbd6f0cdf9035886b3a
+  data.tar.gz: 9f37404cff7df5f8ab8d84a9a887928f6ef79f83
+SHA512:
+  metadata.gz: 5ab7f04d0fd860c0b4551006bb2ced6791b694ad37320e48d50ca192ea613068c2a9965bb403ab525ff36c8a1de05ae53ea8865646337f58f4568f1287a0f32b
+  data.tar.gz: 520552af055c0f8185057e31f1a1b7318e1228c3c69c09cc4ac7f32f729027eb53c532fe1dae35942817f1884ac1c23fc49880a9753598eea680f3a99a79ac7a

data/.gitignore

@@ -0,0 +1,67 @@
+Skip to content
+This repository  
+Search
+Pull requests
+Issues
+Gist
+ @mieps
+ Watch 1,409
+  Star 31,103
+ Fork 11,688 github/gitignore
+ Code  Pull requests 160  Pulse  Graphs
+Branch: master Find file Copy pathgitignore/Global/JetBrains.gitignore
+38d6cac  on Oct 29, 2015
+@tsteinholz tsteinholz Update JetBrains.gitignore
+16 contributors @samskiter @thunsaker @arcresu @victorhaggqvist @yatskevich @quadroid @jturmel @ssinss @GingerGeek @Fuhrmann @ergl @drothmaler @Nainterceptor @cemmersb @tsteinholz @shiftkey
+RawBlameHistory     49 lines (36 sloc)  905 Bytes
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+# .idea/shelf
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+Status API Training Shop Blog About Pricing
+© 2016 GitHub, Inc. Terms Privacy Security Contact Help
+ Save Copy Share

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

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, ethnicity, 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://rubygems.org'
+
+# Specify your gem's dependencies in apns_provider_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    apns_provider_api (1.0.0)
+      http-2 (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    http-2 (0.7.0)
+    rake (10.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  apns_provider_api!
+  bundler (~> 1.10)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michel Epsztejn
+
+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,41 @@
+# ApnsProviderApi
+
+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/apns_provider_api`. 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 'apns_provider_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apns_provider_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` 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/[USERNAME]/apns_provider_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/apns_provider_api.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apns_provider_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apns_provider_api"
+  spec.version       = ApnsProviderApi::VERSION
+  spec.authors       = ["Michel Epsztejn"]
+  spec.email         = ["michel.epsz@gmail.com"]
+
+  spec.summary       = %q{Apple Push Notifications using the HTTP/2 Provider API}
+  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_dependency 'http-2', '~> 0.7.0'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apns_provider_api"
+
+# 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/apns_provider_api/client.rb

@@ -0,0 +1,129 @@
+require 'http/2'
+require 'uri'
+require 'socket'
+require 'openssl'
+
+module ApnsProviderApi
+
+  APPLE_DEVELOPMENT_GATEWAY_URI = "https://api.development.push.apple.com:443"
+  APPLE_PRODUCTION_GATEWAY_URI = "https://api.push.apple.com:443"
+
+  class Client
+    attr_accessor :gateway_uri, :feedback_uri, :certificate, :passphrase, :timeout, :split_size
+
+    class << self
+      def development
+        client = self.new
+        client.gateway_uri = APPLE_DEVELOPMENT_GATEWAY_URI
+        client
+      end
+
+      def production
+        client = self.new
+        client.gateway_uri = APPLE_PRODUCTION_GATEWAY_URI
+        client
+      end
+
+      def mock
+        client = self.new
+        client.gateway_uri = "apn://127.0.0.1:2195"
+        client
+      end
+    end
+
+    def initialize
+      @gateway_uri = ENV['APN_GATEWAY_URI']
+      @certificate = File.read(ENV['APN_CERTIFICATE']) if ENV['APN_CERTIFICATE']
+      @passphrase = ENV['APN_CERTIFICATE_PASSPHRASE']
+      @pid = Process.pid
+      @failed_notifications, @failed_streams, @notifications = [], [], []
+    end
+
+    def enqueue(notifications)
+     @split_size ||= 500
+      notifications.each_slice(@split_size) do |group|
+        push(group)
+      end
+      @failed_notifications
+    end
+
+    def push(notifications)
+      return if notifications.empty?
+
+      @notifications = notifications.flatten
+      @counter = 0
+
+      head = {
+        ':scheme' => 'https',
+        ':method' => 'POST'
+        # ':apns-expiration' => 0 #do not store for sending late
+        #'content-length' => notification.message.size
+      }
+
+      Connection.open(@gateway_uri, @certificate, @passphrase) do |connection|
+        ssl_sock = connection.ssl
+        # events(connection.http2client, ssl_sock)
+
+        @notifications.each_with_index do |notification, index|
+          connection.open?
+          head[':path'] = "/3/device/#{notification.token}"
+          head[':apns-id'] = notification.uuid
+
+          stream = connection.new_stream
+
+          # because apple is not returning the uuid when push fails,
+          # i'm replacing uuid to stream id
+          notification.uuid = stream.id
+
+          stream.on(:headers) do |h|
+           # puts "headers: #{h} - stream_id: #{stream.id}"
+            read_headers(Hash[*h.flatten], stream)
+          end
+          stream.on(:data) do |d|
+            # puts "data: #{d}"
+            # puts "#{JSON.parse(d)} - #{stream.id.to_s}"
+            read_body(JSON.parse(d), stream)
+          end
+          stream.headers(head, end_stream: false)
+          stream.data(notification.payload.to_json)
+        end
+
+        # keep_reading = true
+
+        while !ssl_sock.closed? && !ssl_sock.eof?
+          data = ssl_sock.read_nonblock(1024)
+          # puts "Received bytes: #{data.unpack("H*").first}"
+          begin
+            connection.http2client << data
+            return if @counter == @notifications.size
+          rescue => e
+            puts "Exception: #{e}, #{e.message} - closing socket."
+            ssl_sock.close
+          end
+        end
+      end
+    end
+
+    def read_headers(headers, stream)
+      # puts headers[':status']
+      if headers[':status'].to_i == 200
+        # when notification succeeds, we wont receive body
+        increase_counter
+      else
+        @failed_streams << stream
+      end
+    end
+
+    def read_body(response, stream)
+      increase_counter
+      return unless @failed_streams.include?(stream)
+      notification = @notifications.select{|n| n.uuid == stream.id}[0]
+      notification.error_message = response['reason']
+      @failed_notifications << notification
+    end
+
+    def increase_counter
+      @counter += 1
+    end
+  end
+end

data/lib/apns_provider_api/connection.rb

@@ -0,0 +1,79 @@
+require 'http/2'
+require 'forwardable'
+
+module ApnsProviderApi
+  class Connection
+    extend Forwardable
+    def_delegators :@ssl, :read, :write
+    def_delegators :@uri, :scheme, :host, :port
+    # def_delegators :@stream, :headers, :data
+
+    attr_reader :ssl, :socket, :certificate, :passphrase, :http2client
+
+    class << self
+      def open(uri, certificate, passphrase)
+        return unless block_given?
+
+        connection = new(uri, certificate, passphrase)
+        connection.open
+
+        yield connection
+
+        connection.close
+      end
+    end
+
+    def initialize(uri, certificate, passphrase)
+      @uri = URI(uri)
+      @certificate = certificate
+      @passphrase = passphrase
+      @http2client = HTTP2::Client.new
+      events
+      @http2client
+    end
+
+    def open
+      return false if open?
+
+      @socket = TCPSocket.new(@uri.host, @uri.port)
+      context = OpenSSL::SSL::SSLContext.new
+      context.key = OpenSSL::PKey::RSA.new(@certificate, @passphrase)
+      context.cert = OpenSSL::X509::Certificate.new(certificate)
+
+      @ssl = OpenSSL::SSL::SSLSocket.new(@socket, context)
+      @ssl.sync_close = true
+      @ssl.hostname = @uri.hostname
+      @ssl.connect
+    end
+
+    def open?
+      not (@ssl and @socket).nil?
+    end
+
+    def close
+      return false if closed?
+      @socket.close
+      @socket = nil
+
+      @ssl.close
+      @ssl = nil
+
+    end
+
+    def closed?
+      not open?
+    end
+
+    def new_stream
+      @http2client.new_stream
+    end
+
+    def events
+      @http2client.on(:frame) do |bytes|
+        # puts "Sending bytes: #{bytes.unpack("H*").first}"
+        ssl.print bytes
+        ssl.flush
+      end
+    end
+  end
+end

data/lib/apns_provider_api/example.rb

@@ -0,0 +1,21 @@
+require_relative 'client'
+require_relative 'connection'
+require_relative 'notification'
+
+APN = ApnsProviderApi::Client.development
+TOKEN_ARRAY = ["1234", "4321"]
+APN.certificate = File.read("/development.pem")
+APN.passphrase = Filre.read("/passphrase.txt")
+
+notification_array = []
+
+TOKEN_ARRAY.each do |token|
+  notification = ApnsProviderApi::Notification.new(badge: 1,
+                                                   device: token,
+                                                   alert: "TEST #{token}",
+                                                   sound: "sosumi.aiff")
+  notification_array << notification
+end
+
+failed_notifications = APN.enqueue(notification_array)
+puts failed_notifications

data/lib/apns_provider_api/notification.rb

@@ -0,0 +1,108 @@
+require 'json'
+require 'securerandom'
+
+module ApnsProviderApi
+  class Notification
+    class APNSError < RuntimeError
+      # See: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/APNsProviderAPI.html
+      CODES = {
+        200 => "Success",
+        400 => "Bad request",
+        403 => "There was an error with the certificate",
+        405 => "The request used a bad :method value. Only POST requests are supported",
+        410 => "The device token is no longer active for the topic",
+        413 => "The notification payload was too large",
+        429 => "The server received too many requests for the same device token",
+        500 => "Internal server error",
+        503 => "The server is shutting down and unavailable"
+      }
+
+      attr_reader :code
+
+      def initialize(code)
+        raise ArgumentError unless CODES.include?(code)
+        super(CODES[code])
+        @code = code
+      end
+    end
+
+    # MAXIMUM_PAYLOAD_SIZE = 4096 already accepted by provider API but not for iOS apps
+    MAXIMUM_PAYLOAD_SIZE = 2048
+
+    attr_accessor :token, :alert, :badge, :sound, :category, :content_available, :custom_data, :id, :expiry, :priority, :uuid, :error_message
+    attr_reader :sent_at
+    # attr_writer :apns_error_code
+
+    alias :device :token
+    alias :device= :token=
+
+    def initialize(options = {})
+      @token = options.delete(:token) || options.delete(:device)
+      raise 'invalid token' if @token && @token.empty?
+      @badge = options.delete(:badge)
+      @sound = options.delete(:sound)
+      @category = options.delete(:category)
+      @expiry = options.delete(:expiry)
+      @id = options.delete(:id)
+      @priority = options.delete(:priority)
+      @content_available = options.delete(:content_available)
+      dottize = options.delete(:dottize)
+      @custom_data = options
+      alert = options.delete(:alert)
+      available_bytes = MAXIMUM_PAYLOAD_SIZE - payload.to_s.bytesize
+      @alert = trim_alert(alert, available_bytes, dottize)
+      generate_uuid(options.delete(:uuid))
+    end
+
+    def payload
+      json = {}.merge(@custom_data || {}).inject({}){|h,(k,v)| h[k.to_s] = v; h}
+
+      json['aps'] ||= {}
+      json['aps']['alert'] = @alert if @alert
+      json['aps']['badge'] = @badge.to_i rescue 0 if @badge
+      json['aps']['sound'] = @sound if @sound
+      json['aps']['category'] = @category if @category
+      json['aps']['content-available'] = 1 if @content_available
+
+      json
+    end
+
+    def mark_as_sent!
+      @sent_at = Time.now
+    end
+
+    def mark_as_unsent!
+      @sent_at = nil
+    end
+
+    def sent?
+      !!@sent_at
+    end
+
+    def trim_alert(alert, available_bytes, dottize)
+      if alert.size > available_bytes
+        raise "the notification payload was too large \nTip: use dottize option to auto trim the notification alert" unless dottize
+        chars_to_delete = alert.size - available_bytes
+        alert =  dottize_no_broken_words(alert, alert.size - chars_to_delete)
+      end
+      alert
+    end
+
+    # def error
+    #   APNSError.new(@apns_error_code) if @apns_error_code and @apns_error_code.nonzero?
+    # end
+
+    private
+
+    def generate_uuid(uuid=nil)
+      uuid = SecureRandom.uuid unless uuid
+      @uuid = uuid
+    end
+
+    def dottize_no_broken_words(string, limit=3)
+      size = string.size
+      size > limit ? "#{string[0,string[0,limit-3].rindex(" ") || limit-3]}..." : string
+    end
+
+  end
+end

data/lib/apns_provider_api/version.rb

@@ -0,0 +1,3 @@
+module ApnsProviderApi
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: apns_provider_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michel Epsztejn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-06 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.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+description: 
+email:
+- michel.epsz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- apns_provider_api.gemspec
+- bin/console
+- bin/setup
+- lib/apns_provider_api/client.rb
+- lib/apns_provider_api/connection.rb
+- lib/apns_provider_api/example.rb
+- lib/apns_provider_api/notification.rb
+- lib/apns_provider_api/version.rb
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Apple Push Notifications using the HTTP/2 Provider API
+test_files: []