lorkhan 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b8c3fb041b617f47b7301f48c86f41b06c0db14a
+  data.tar.gz: 56a83e2fff46bbf4499ec092bc8f367d2ec3f602
+SHA512:
+  metadata.gz: 869f5ce31fb9c8a52ff2b7cfbe851073072a04bf32aa3b02723d4a4779624bfdc97742a93b51e281d195ab824897f8497b3468f1c19826bce266444c5c4a4733
+  data.tar.gz: 214eecef306334378480d276d184b9e896072b356f9cc8e58c86d02bf8d93ffe8c2903ccb4d39edb04e0d225be86ab2b1ec03af2fb8bc75d6af29f78e705dfcc

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+Gemfile.lock
+.DS_Store

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - spec/**/*
+
+Metrics/AbcSize:
+  Max: 30
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 16
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 0.0.4
+
+- Added `Lorkhan::Notification::DEFAULT_SOUND_NAME`
+
+### 0.0.3
+
+- Sending a `content_available` push, now excludes the `alert`, `badge`, `sound` keys.
+
+### 0.0.2
+
+- Calling `Lorkan::Connection#push` will automatically check when the auth token was generated and refresh the token if needed.

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,3 @@
+# THIS IS DEPRECATED
+
+`gem 'lorkhan', '~> 1.0'`

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lorkhan'
+require 'pry'
+
+DEVICE_TOKEN = ENV['LORKHAN_TEST_DEVICE_TOKEN']
+AUTH_TOKEN_PATH = File.expand_path(ENV['LORKHAN_TEST_AUTH_KEY_PATH'])
+TEAM_ID = ENV['LORKHAN_TEST_TEAM_ID']
+KEY_ID = ENV['LORKHAN_TEST_AUTH_KEY_ID']
+
+raise "Missing device token ENV['LORKHAN_TEST_DEVICE_TOKEN']" if DEVICE_TOKEN.nil?
+raise "Missing device token ENV['LORKHAN_TEST_AUTH_KEY_PATH']" if AUTH_TOKEN_PATH.nil?
+raise 'Missing auth token file' unless File.exist?(AUTH_TOKEN_PATH)
+raise "Missing device token ENV['LORKHAN_TEST_TEAM_ID']" if TEAM_ID.nil?
+raise "Missing device token ENV['LORKHAN_TEST_AUTH_KEY_ID']" if KEY_ID.nil?
+
+Pry.start

data/lib/lorkhan/connection.rb

@@ -0,0 +1,73 @@
+require 'net-http2'
+require 'openssl'
+
+module Lorkhan
+  APNS_PRODUCTION_HOST  = 'api.push.apple.com'.freeze
+  APNS_DEVELOPMENT_HOST = 'api.development.push.apple.com'.freeze
+  TOKEN_EXPIRE_TIME_SEC = 3300 # 55 minutes (Apple timeout in 60)
+
+  class Connection
+    attr_reader :host, :token
+
+    def initialize(token:, production: true, timeout: 30)
+      @host    = production ? APNS_PRODUCTION_HOST : APNS_DEVELOPMENT_HOST
+      @timeout = timeout
+      @token   = token
+      @client  = NetHttp2::Client.new(url, connect_timeout: @connect_timeout)
+    end
+
+    def close
+      @client.close
+    end
+
+    def join
+      @client.join
+    end
+
+    def refresh_token
+      @auth_token = nil
+      close
+    end
+
+    def push(notification)
+      check_token_should_refresh
+      request = Request.new(notification)
+      request.validate!
+      headers = request.headers
+      headers['authorization'] = "bearer #{auth_token}"
+      raw_response = @client.call(:post, request.path, body: request.body, headers: headers, timeout: 5)
+      raise Errors::TimeoutError if raw_response.nil?
+      response = Response.new(raw_response)
+      handle_http_error(response) unless response.ok?
+      response
+    end
+
+    private
+
+    def auth_token
+      @auth_token ||= begin
+        @refresh_token_at = Time.now.to_i + TOKEN_EXPIRE_TIME_SEC
+        token.encode
+      end
+    end
+
+    def url
+      "https://#{host}:443"
+    end
+
+    def handle_http_error(response)
+      if response.body
+        if (reason = response.body['reason'])
+          klass = Lorkhan::Errors::Apple::MAPPINGS[reason]
+          raise klass, response if klass
+        end
+      end
+      raise Errors::HTTPError, response
+    end
+
+    def check_token_should_refresh
+      return if @refresh_token_at.nil?
+      refresh_token if Time.now.to_i >= @refresh_token_at
+    end
+  end
+end

data/lib/lorkhan/connection_pool.rb

@@ -0,0 +1,6 @@
+require 'connection_pool'
+
+module Lorkhan
+  class ConnectionPool < ::ConnectionPool
+  end
+end

data/lib/lorkhan/errors/apple_errors.rb

@@ -0,0 +1,64 @@
+require 'lorkhan/errors/base'
+require 'lorkhan/errors/http_error'
+
+module Lorkhan
+  module Errors
+    module Apple
+      class BadCollapseId < Errors::HTTPError; end
+      class BadDeviceToken < Errors::HTTPError; end
+      class BadExpirationDate < Errors::HTTPError; end
+      class BadMessageId < Errors::HTTPError; end
+      class BadPriority < Errors::HTTPError; end
+      class BadTopic < Errors::HTTPError; end
+      class DeviceTokenNotForTopic < Errors::HTTPError; end
+      class DuplicateHeaders < Errors::HTTPError; end
+      class IdleTimeout < Errors::HTTPError; end
+      class MissingDeviceToken < Errors::HTTPError; end
+      class MissingTopic < Errors::HTTPError; end
+      class PayloadEmpty < Errors::HTTPError; end
+      class TopicDisallowed < Errors::HTTPError; end
+      class ExpiredProviderToken < Errors::HTTPError; end
+      class Forbidden < Errors::HTTPError; end
+      class InvalidProviderToken < Errors::HTTPError; end
+      class MissingProviderToken < Errors::HTTPError; end
+      class BadPath < Errors::HTTPError; end
+      class MethodNotAllowed < Errors::HTTPError; end
+      class Unregistered < Errors::HTTPError; end
+      class PayloadTooLarge < Errors::HTTPError; end
+      class TooManyProviderTokenUpdates < Errors::HTTPError; end
+      class TooManyRequests < Errors::HTTPError; end
+      class InternalServerError < Errors::HTTPError; end
+      class ServiceUnavailable < Errors::HTTPError; end
+      class Shutdown < Errors::HTTPError; end
+
+      MAPPINGS = {
+        'BadCollapseId' => BadCollapseId,
+        'BadDeviceToken' => BadDeviceToken,
+        'BadExpirationDate' => BadExpirationDate,
+        'BadMessageId' => BadMessageId,
+        'BadPriority' => BadPriority,
+        'BadTopic' => BadTopic,
+        'DeviceTokenNotForTopic' => DeviceTokenNotForTopic,
+        'DuplicateHeaders' => DuplicateHeaders,
+        'IdleTimeout' => IdleTimeout,
+        'MissingDeviceToken' => MissingDeviceToken,
+        'MissingTopic' => MissingTopic,
+        'PayloadEmpty' => PayloadEmpty,
+        'TopicDisallowed' => TopicDisallowed,
+        'ExpiredProviderToken' => ExpiredProviderToken,
+        'Forbidden' => Forbidden,
+        'InvalidProviderToken' => InvalidProviderToken,
+        'MissingProviderToken' => MissingProviderToken,
+        'BadPath' => BadPath,
+        'MethodNotAllowed' => MethodNotAllowed,
+        'Unregistered' => Unregistered,
+        'PayloadTooLarge' => PayloadTooLarge,
+        'TooManyProviderTokenUpdates' => TooManyProviderTokenUpdates,
+        'TooManyRequests' => TooManyRequests,
+        'InternalServerError' => InternalServerError,
+        'ServiceUnavailable' => ServiceUnavailable,
+        'Shutdown' => Shutdown
+      }.freeze
+    end
+  end
+end

data/lib/lorkhan/errors/base.rb

@@ -0,0 +1,6 @@
+module Lorkhan
+  module Errors
+    class Base < StandardError
+    end
+  end
+end

data/lib/lorkhan/errors/http_error.rb

@@ -0,0 +1,13 @@
+module Lorkhan
+  module Errors
+    class HTTPError < Base
+      attr_reader :status, :response
+
+      def initialize(response)
+        super("http_error/#{response.status}")
+        @response = response
+        @status = response.status
+      end
+    end
+  end
+end

data/lib/lorkhan/errors/missing_topic_error.rb

@@ -0,0 +1,6 @@
+module Lorkhan
+  module Errors
+    class MissingTopicError < Base
+    end
+  end
+end

data/lib/lorkhan/errors/timeout_error.rb

@@ -0,0 +1,6 @@
+module Lorkhan
+  module Errors
+    class TimeoutError < Base
+    end
+  end
+end

data/lib/lorkhan/errors.rb

@@ -0,0 +1,5 @@
+require 'lorkhan/errors/apple_errors'
+require 'lorkhan/errors/base'
+require 'lorkhan/errors/http_error'
+require 'lorkhan/errors/missing_topic_error'
+require 'lorkhan/errors/timeout_error'

data/lib/lorkhan/notification.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'securerandom'
+
+module Lorkhan
+  class Notification
+    DEFAULT_SOUND_NAME = 'default'.freeze
+
+    attr_reader :token, :apns_id
+    attr_accessor :custom_payload, :alert, :badge, :sound, :category, :content_available, :url_args, :mutable_content
+    attr_accessor :expiration, :priority, :topic, :collapse_id
+
+    def initialize(token)
+      @token      = token
+      @apns_id    = SecureRandom.uuid
+      @expiration = 0
+      @priority   = 10
+    end
+
+    def body
+      JSON.dump(to_h).force_encoding(Encoding::BINARY)
+    end
+
+    def to_h
+      {}.tap do |root|
+        root[:aps] = {}.tap do |aps|
+          if content_available
+            aps['content-available'] = 1
+          else
+            aps[:alert] = alert if alert
+            aps[:badge] = badge if badge
+            aps[:sound] = sound if sound
+          end
+          aps[:category] = category if category
+          aps['url-args'] = url_args if url_args
+          aps['mutable-content'] = mutable_content if mutable_content
+        end
+        root.merge!(custom_payload) if custom_payload
+      end
+    end
+  end
+end

data/lib/lorkhan/provider_token.rb

@@ -0,0 +1,41 @@
+require 'jwt'
+require 'openssl'
+
+module Lorkhan
+  class ProviderToken
+    ALGORITHM = 'ES256'.freeze
+
+    def initialize(key_id:, team_id:, secret:)
+      @key_id  = key_id
+      @team_id = team_id
+      @secret  = secret
+    end
+
+    def encode
+      JWT.encode(payload, p_key, ALGORITHM, headers)
+    end
+
+    private
+
+    def p_key
+      @p_key ||= begin
+        sec = OpenSSL::PKey::EC.new(@secret)
+        sec.check_key
+        sec
+      end
+    end
+
+    def payload
+      {
+        iss: @team_id,
+        iat: Time.now.utc.to_i
+      }
+    end
+
+    def headers
+      {
+        kid: @key_id
+      }
+    end
+  end
+end

data/lib/lorkhan/request.rb

@@ -0,0 +1,27 @@
+module Lorkhan
+  class Request
+    attr_reader :path, :headers, :body
+
+    def initialize(notification)
+      @path    = "/3/device/#{notification.token}"
+      @body    = notification.body
+      @headers = build_headers(notification)
+    end
+
+    def validate!
+      raise Errors::MissingTopicError if headers['apns-topic'].nil?
+    end
+
+    private
+
+    def build_headers(notif)
+      {}.tap do |head|
+        head['apns-id']          = notif.apns_id if notif.apns_id
+        head['apns-expiration']  = notif.expiration.to_s if notif.expiration
+        head['apns-priority']    = notif.priority.to_s if notif.priority
+        head['apns-topic']       = notif.topic if notif.topic
+        head['apns-collapse-id'] = notif.collapse_id if notif.collapse_id
+      end
+    end
+  end
+end

data/lib/lorkhan/response.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module Lorkhan
+  class Response
+    attr_reader :headers, :body
+
+    def initialize(raw)
+      @headers = raw.headers
+      @body    = JSON.parse(raw.body)
+    rescue JSON::ParserError
+      @body = nil
+    end
+
+    def ok?
+      status == 200
+    end
+
+    def status
+      headers[':status'].to_i
+    end
+
+    def apns_id
+      headers['apns-id']
+    end
+  end
+end

data/lib/lorkhan/version.rb

@@ -0,0 +1,3 @@
+module Lorkhan
+  VERSION = '0.0.4'.freeze
+end

data/lib/lorkhan.rb

@@ -0,0 +1,11 @@
+require 'lorkhan/connection_pool'
+require 'lorkhan/connection'
+require 'lorkhan/errors'
+require 'lorkhan/notification'
+require 'lorkhan/provider_token'
+require 'lorkhan/request'
+require 'lorkhan/response'
+require 'lorkhan/version'
+
+module Lorkhan
+end

data/lorkhan.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lorkhan/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'lorkhan'
+  spec.version               = Lorkhan::VERSION
+  spec.licenses              = ['MIT']
+  spec.authors               = ['Skylar Schipper']
+  spec.email                 = ['skylar@pco.bz']
+  spec.summary               = 'APNS HTTP/2 Client'
+  spec.homepage              = 'http://github.com/ministrycentered/lorkhan'
+  spec.required_ruby_version = '>=2.3.0'
+
+  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 = %w(lib)
+
+  spec.add_dependency 'net-http2',       '>= 0.14.1', '< 2'
+  spec.add_dependency 'connection_pool', '>= 2.0'
+  spec.add_dependency 'jwt',             '>= 1.5.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.5'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: lorkhan
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Skylar Schipper
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: 
+email:
+- skylar@pco.bz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- lib/lorkhan.rb
+- lib/lorkhan/connection.rb
+- lib/lorkhan/connection_pool.rb
+- lib/lorkhan/errors.rb
+- lib/lorkhan/errors/apple_errors.rb
+- lib/lorkhan/errors/base.rb
+- lib/lorkhan/errors/http_error.rb
+- lib/lorkhan/errors/missing_topic_error.rb
+- lib/lorkhan/errors/timeout_error.rb
+- lib/lorkhan/notification.rb
+- lib/lorkhan/provider_token.rb
+- lib/lorkhan/request.rb
+- lib/lorkhan/response.rb
+- lib/lorkhan/version.rb
+- lorkhan.gemspec
+homepage: http://github.com/ministrycentered/lorkhan
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: APNS HTTP/2 Client
+test_files: []