p8_pusher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87c3f31c09dfca44e94a45606117f1168bdb2de6504741dee88c7772e840bad6
+  data.tar.gz: f0e08b51de932a1d99202c6214d7af5033ce4ce50b5241bd933daa2e48823586
+SHA512:
+  metadata.gz: 257a7ab16c442fdf94d41a198ef31daf7474dea4ae941b9473c08d27ef2c3e93b01ca969f2ef5720e2904a6765e26769c83bf718a697d8f75fe644414bb2f26e
+  data.tar.gz: 51ba4f9a22cef9edcf27ff36daa475fb39e7fb47dd67322a4410fee6bd67a5efa20708f7be8a5f85f45aab3aa5ebc19ea4746521b26d7992b3cf3964049e67ee

data/.gitignore

@@ -0,0 +1,54 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/rdoc/
+
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.idea
+.rakeTasks

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ghulamjilanideveloper@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in p8_pusher.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    p8_pusher (0.1.0)
+      commander (~> 4.5)
+      json (~> 2.3)
+      jwt (~> 2.2)
+      net-http2 (~> 0.18.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    commander (4.5.2)
+      highline (~> 2.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    highline (2.0.3)
+    http-2 (0.10.2)
+    json (2.3.1)
+    jwt (2.2.2)
+    net-http2 (0.18.2)
+      http-2 (~> 0.10.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  p8_pusher!
+  rake (~> 12.0)
+  rspec (~> 3.9)
+  simplecov (~> 0.17.1)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 ghulamjilani
+
+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,60 @@
+# P8Pusher
+
+Ruby Gem for Apple push notifications using new p8 format instead of pem file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'p8_pusher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install p8_pusher
+
+## Usage
+
+# p8push
+
+Add the following to your `.env`
+```
+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
+```
+
+#### Basic Use
+
+```ruby
+CLIENT = P8Pusher::Client.development # use '.production' for production use
+devise_token = 'SOMEDEVISETOKEN'
+notification = P8Pusher::Notification.new(device: devise_token)
+notification.alert = 'Hello, World!'
+notification.topic = 'com.some.other.id' # default is ENV['APN_BUNDLE_ID']
+CLIENT.push(notification)
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/tiksomlimited/p8_pusher. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tiksomlimited/p8_pusher/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the P8Pusher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tiksomlimited/p8_pusher/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "p8_pusher"
+
+# 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(__FILE__)

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

@@ -0,0 +1,7 @@
+require 'p8_pusher/version'
+require 'p8_pusher/client'
+require 'p8_pusher/notification'
+
+module P8Pusher
+  class Error < StandardError; end
+end

data/lib/p8_pusher/client.rb

@@ -0,0 +1,82 @@
+require 'openssl'
+require 'jwt'
+require 'net-http2'
+
+module P8Pusher
+
+  APPLE_PRODUCTION_JWT_URI = 'https://api.push.apple.com'.freeze
+  APPLE_DEVELOPMENT_JWT_URI = 'https://api.development.push.apple.com'.freeze
+
+  class Client
+    attr_accessor :jwt_uri
+    class << self
+      def development
+        client = new
+        client.jwt_uri = APPLE_DEVELOPMENT_JWT_URI
+        client
+      end
+
+      def production
+        client = new
+        client.jwt_uri = APPLE_PRODUCTION_JWT_URI
+        client
+      end
+    end
+
+    def initialize
+      @private_key = File.read(ENV['APN_PRIVATE_KEY'])
+      @team_id = ENV['APN_TEAM_ID']
+      @key_id = ENV['APN_KEY_ID']
+      @timeout = Float(ENV['APN_TIMEOUT'] || 2.0)
+    rescue StandardError => e
+      raise "#{e.message}: invalid keys, make sure you have the required keys in .env file"
+    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['content-type'] = 'application/json'
+      h['apns-expiration'] = '0'
+      h['apns-priority'] = '10'
+      h['apns-topic'] = topic
+      h['authorization'] = "bearer #{jwt_token}"
+
+      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/p8_pusher/notification.rb

@@ -0,0 +1,122 @@
+require 'json'
+
+module P8Pusher
+  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'
+      }.freeze
+
+      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 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/p8_pusher/version.rb

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

data/p8_pusher.gemspec

@@ -0,0 +1,36 @@
+require_relative 'lib/p8_pusher/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'p8_pusher'
+  spec.version = P8Pusher::VERSION
+  spec.authors = ['sumar7']
+  spec.email = ['sajjadumardev@gmail.com']
+
+  spec.summary = 'Apple push notifications using the new p8 format instead of pemfile'
+  spec.homepage = 'https://github.com/SUMAR7/p8_pusher'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/SUMAR7/p8_pusher'
+  spec.metadata['changelog_uri'] = 'https://github.com/SUMAR7/p8_pusher'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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']
+
+  # Dependencies
+  spec.add_dependency 'commander', '~> 4.5'
+  spec.add_dependency 'json', '~> 2.3'
+  spec.add_dependency 'jwt', '~> 2.2'
+  spec.add_dependency 'net-http2', '~> 0.18.2'
+
+  # Development Dependencies
+  spec.add_development_dependency 'rspec', '~> 3.9'
+  spec.add_development_dependency 'simplecov', '~> 0.17.1'
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: p8_pusher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- sumar7
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !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
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: 
+email:
+- sajjadumardev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/p8_pusher.rb
+- lib/p8_pusher/client.rb
+- lib/p8_pusher/notification.rb
+- lib/p8_pusher/version.rb
+- p8_pusher.gemspec
+homepage: https://github.com/SUMAR7/p8_pusher
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SUMAR7/p8_pusher
+  source_code_uri: https://github.com/SUMAR7/p8_pusher
+  changelog_uri: https://github.com/SUMAR7/p8_pusher
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Apple push notifications using the new p8 format instead of pemfile
+test_files: []