ts_p8push 1.0.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d32a8f34ba8a667ee1b4d736c82e1731b2bcb82e0a7f93383e7d67912092475
+  data.tar.gz: d7ddaa9a8f768298966d4e33ed7d3cbba6a2185fe0b21745e4453004d1670930
+SHA512:
+  metadata.gz: 268abdeba968f435a6da77fe8e2a4b15f273617c94341f7dead9b6b1d11fad7a77554f94a63dd8dec6019726d0f2ead72ee8880df1b0e0d9263d40faf1fbd338
+  data.tar.gz: f4d4431dfeb4fe65d575ae0eac03e12d5222a1a518dd2e8638c7931637d352716d4be4aaa1d93a981694039ebc31a35a27a74ecda926bbdb16e0c72cab4cc62a

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2012–2015 Mattt Thompson (http://mattt.me/)
+Copyright (c) 2017 Andrew Arrow
+
+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,29 @@
+# p8push
+ruby gem for apple push notifications using only the new p8 format not the older pem format
+
+add to Gemfile: `gem 'ts_p8push'`
+
+```
+[OPTIONAL]
+export APN_PRIVATE_KEY=/path/APNsAuthKey_ABCDE12345.p8
+export APN_TEAM_ID=XYZDE99911
+export APN_KEY_ID=ABCDE12345
+export APN_BUNDLE_ID=com.bundle.id
+```
+
+```
+Environment can be intiated either via exports and use below
+APN = P8push::Client.development
+
+OR
+Environment can be intiated by providing the configs on the go
+APN = P8push::Client.development(private_key: 'YOUR_PRIVATE_KEY_P8_CONTENTS', team_id: 'YOUR_TEAM_ID', key_id: 'YOUR_KEY_ID', timeout: 2.0)
+
+token = 'GETREALTOKENFROMADEVICE'
+notification = P8push::Notification.new(device: token)
+notification.alert = 'Hello, World!'
+notification.topic = 'com.some.other.id' # if you do not want default ENV['APN_BUNDLE_ID'] one
+APN.push(notification)
+```
+
+The gem with pem format this came from is https://github.com/nomad/houston

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/lib/klap_p8push.rb

@@ -0,0 +1,3 @@
+require 'p8push/version'
+require 'p8push/client'
+require 'p8push/notification'

data/lib/p8push/client.rb

@@ -0,0 +1,73 @@
+require 'openssl'
+require 'jwt'
+require 'net-http2'
+
+module P8push
+
+  APPLE_PRODUCTION_JWT_URI = 'https://api.push.apple.com'
+  APPLE_DEVELOPMENT_JWT_URI = 'https://api.sandbox.push.apple.com'
+
+  class Client
+    attr_accessor :jwt_uri
+    class << self
+      def development(private_key: nil, team_id: nil, key_id: nil, timeout: nil)
+        client = self.new(private_key: private_key, team_id: team_id, key_id: key_id, timeout: timeout)
+        client.jwt_uri = APPLE_DEVELOPMENT_JWT_URI
+        client
+      end
+
+      def production(private_key: nil, team_id: nil, key_id: nil, timeout: nil)
+        client = self.new(private_key: private_key, team_id: team_id, key_id: key_id, timeout: timeout)
+        client.jwt_uri = APPLE_PRODUCTION_JWT_URI
+        client
+      end
+    end
+
+    def initialize(private_key: nil, team_id: nil, key_id: nil, timeout: nil)
+      @private_key = private_key || File.read(ENV['APN_PRIVATE_KEY'])
+      @team_id = team_id || ENV['APN_TEAM_ID']
+      @key_id = key_id || ENV['APN_KEY_ID']
+      @timeout = timeout || Float(ENV['APN_TIMEOUT'] || 2.0)
+    end
+
+    def jwt_http2_post(topic, payload, token)
+      ec_key = OpenSSL::PKey::EC.new(@private_key)
+      jwt_token = JWT.encode({iss: @team_id, iat: Time.now.to_i}, ec_key, 'ES256', {kid: @key_id})
+      client = NetHttp2::Client.new(@jwt_uri)
+      h = {}
+      h['apns-expiration'] = '0'
+      h['apns-priority'] = '10'
+      h['apns-topic'] = topic
+      h['authorization'] = "bearer #{jwt_token}"
+      h['content-type'] = 'application/json'
+      res = client.call(:post, '/3/device/'+token, body: payload.to_json, timeout: @timeout,
+                        headers: h)
+      client.close
+      return nil if res.status.to_i == 200
+      res.body
+    end
+
+    def push(*notifications)
+      return if notifications.empty?
+
+      notifications.flatten!
+
+      notifications.each_with_index do |notification, index|
+        next unless notification.kind_of?(Notification)
+        next if notification.sent?
+        next unless notification.valid?
+
+        notification.id = index
+
+        err = jwt_http2_post(notification.topic, notification.payload, notification.token)
+        if err == nil
+          notification.mark_as_sent!
+        else
+          puts err
+          notification.apns_error_code = err
+          notification.mark_as_unsent!
+        end
+      end
+    end
+  end
+end

data/lib/p8push/notification.rb

@@ -0,0 +1,121 @@
+require 'json'
+
+module P8push
+  class Notification
+    class APNSError < RuntimeError
+      CODES = {
+        0 => 'No errors encountered',
+        1 => 'Processing error',
+        2 => 'Missing device token',
+        3 => 'Missing topic',
+        4 => 'Missing payload',
+        5 => 'Invalid token size',
+        6 => 'Invalid topic size',
+        7 => 'Invalid payload size',
+        8 => 'Invalid token',
+        10 => 'Shutdown',
+        255 => 'Unknown error'
+      }
+
+      attr_reader :code
+
+      def initialize(code)
+        raise ArgumentError unless CODES.include?(code)
+        super(CODES[code])
+        @code = code
+      end
+    end
+
+    MAXIMUM_PAYLOAD_SIZE = 2048
+
+    attr_accessor :topic, :token, :alert, :badge, :sound, :category, :content_available, :mutable_content,
+                  :custom_data, :id, :expiry, :priority
+    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)
+      @alert = options.delete(:alert)
+      @topic = options.delete(:topic) || ENV['APN_BUNDLE_ID']
+      @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)
+      @mutable_content = options.delete(:mutable_content)
+
+      @custom_data = options
+    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['aps']['mutable-content'] = 1 if @mutable_content
+
+      json
+    end
+
+    def message
+      data = [device_token_item,
+              payload_item,
+              identifier_item,
+              expiration_item,
+              priority_item].compact.join
+      [2, data.bytes.count, data].pack('cNa*')
+    end
+
+    def mark_as_sent!
+      @sent_at = Time.now
+    end
+
+    def mark_as_unsent!
+      @sent_at = nil
+    end
+
+    def sent?
+      !!@sent_at
+    end
+
+    def valid?
+      payload.to_json.bytesize <= MAXIMUM_PAYLOAD_SIZE
+    end
+
+    def error
+      APNSError.new(@apns_error_code) if @apns_error_code && @apns_error_code.nonzero?
+    end
+
+    private
+
+      def device_token_item
+        [1, 32, @token.gsub(/[<\s>]/, '')].pack('cnH64')
+      end
+
+      def payload_item
+        json = payload.to_json
+        [2, json.bytes.count, json].pack('cna*')
+      end
+
+      def identifier_item
+        [3, 4, @id].pack('cnN') unless @id.nil?
+      end
+
+      def expiration_item
+        [4, 4, @expiry.to_i].pack('cnN') unless @expiry.nil?
+      end
+
+      def priority_item
+        [5, 1, @priority].pack('cnc') unless @priority.nil?
+      end
+  end
+end

data/lib/p8push/version.rb

@@ -0,0 +1,3 @@
+module P8push
+    VERSION = '1.0.7'
+end

data/p8push.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'p8push/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'ts_p8push'
+  s.authors     = ['Andrew Arrow','Mattt Thompson', 'Kim Laplume', 'Talha Shoaib']
+  s.email       = 'talhashoaib27@gmail.com'
+  s.license     = 'MIT'
+  s.homepage    = 'https://talhashoaib.me'
+  s.version     = P8push::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = 'Send Apple Push Notifications'
+  s.description = 'apple push notifications using only the new p8 format not the older pem format. fork from 1klap/p8push'
+
+  s.add_dependency 'jwt', '1.5.6'
+  s.add_dependency 'commander', '4.4'
+  s.add_dependency 'json', '2.1.0'
+  s.add_dependency 'net-http2', '0.18.2'
+
+  s.files         = Dir['./**/*'].reject { |file| file =~ /\.\/(bin|log|pkg|script|spec|test|vendor)/ }
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: ts_p8push
+version: !ruby/object:Gem::Version
+  version: 1.0.7
+platform: ruby
+authors:
+- Andrew Arrow
+- Mattt Thompson
+- Kim Laplume
+- Talha Shoaib
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: net-http2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.18.2
+description: apple push notifications using only the new p8 format not the older pem
+  format. fork from 1klap/p8push
+email: talhashoaib27@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- "./Gemfile"
+- "./LICENSE"
+- "./README.md"
+- "./Rakefile"
+- "./lib/klap_p8push.rb"
+- "./lib/p8push/client.rb"
+- "./lib/p8push/notification.rb"
+- "./lib/p8push/version.rb"
+- "./p8push.gemspec"
+homepage: https://talhashoaib.me
+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.7.8
+signing_key:
+specification_version: 4
+summary: Send Apple Push Notifications
+test_files: []