andpush 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5906e62af1538446835164d870e6ad5208c273b8
+  data.tar.gz: 152292ea0800e0ea8b8ea5646fde079488f9a29e
+SHA512:
+  metadata.gz: 1388a7d47b11a593d3bf831be5f95a302aae5abae28c4edde8823575e263f89d7945089cf288d8ada21f88f3c39bfbcbf5089849b2edefa4940a05856b48ddc8
+  data.tar.gz: 8466478c030432ceeb73bdc59a2314bd5a09a964ccd355d92badc2792bdc76beb77a07ad9f9dbec3664e31956d11a88220878bdb3816dcf837caecab620001c3

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+cache:    bundler
+script:   bundle exec rake test
+sudo:     false
+
+rvm:
+  - 2.2.7
+  - 2.3.4
+  - 2.4.1
+  - ruby-head
+  - jruby-9.1.10.0
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-9.1.10.0
+    - rvm: jruby-head

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 mail@yukinishijima.net. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in andpush.gemspec
+gemspec
+
+gem 'oven', '0.1.0.rc1'
+gem 'rubocop'
+gem 'pry'
+gem 'http_logger'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuki Nishijima
+
+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,51 @@
+# Andpush
+
+Andpush is an HTTP client for FCM (Firebase Cloud Messaging). It implements [Firebase Cloud Messaging HTTP Protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'andpush'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install andpush
+
+## Usage
+
+You'll need your application's server key, whose value is available in the [Cloud Messaging](https://console.firebase.google.com/project/_/settings/cloudmessaging) tab of the Firebase console Settings pane.
+
+```ruby
+require 'andpush'
+
+server_key   = "..." # Your server key
+device_token = "..." # The device token of the device you'd like to push a message to
+
+client   = Andpush.build(server_key)
+response = client.push(to: device_token, notification: { title: "Update", body: "Your weekly summary is ready" }, data: { extra: "data" })
+
+json = response.json
+json[:canonical_ids] # => 0
+json[:failure]       # => 0
+json[:multicast_id]  # => 8478364278516813477
+
+result = json[:results].first
+result[:message_id]      # => "0:1489498959348701%3b8aef473b8aef47"
+result[:error]           # => nil, "InvalidRegistration" or something else
+result[:registration_id] # => nil
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/yuki24/andpush. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://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,15 @@
+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
+
+desc 'Generate an API client with the oven gem (the cmd overrides the client if it already exists)'
+task :generate do
+  sh "ruby -roven fcm.apispec && rubocop -a lib/"
+end
+
+task :default => :test

data/andpush.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'andpush/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "andpush"
+  spec.version       = Andpush::VERSION
+  spec.authors       = ["Yuki Nishijima"]
+  spec.email         = ["mail@yukinishijima.net"]
+  spec.summary       = %q{FCM HTTP client}
+  spec.description   = %q{Andpush is an HTTP client for Firebase Cloud Messaging.}
+  spec.homepage      = "https://github.com/yuki24/andpush"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject {|f| f.match(%r{^(test)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'net-http-persistent'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/bin/console

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

@@ -0,0 +1,7 @@
+require 'oven'
+
+Oven.bake :'Andpush::Client', destination: 'lib/andpush/' do
+  format :json
+
+  post :message, '/fcm/send', as: :push, class: 'Response'
+end

data/lib/andpush.rb

@@ -0,0 +1,43 @@
+require 'net/http/persistent'
+
+require 'andpush/version'
+require 'andpush/client'
+
+module Andpush
+  DOMAIN = 'https://fcm.googleapis.com'.freeze
+
+  def self.build(server_key, domain: nil, request_handler: ConnectionPool.new)
+    ::Andpush::Client
+      .new(domain || DOMAIN, request_handler: request_handler)
+      .register_interceptor(Authenticator.new(server_key))
+  end
+
+  class Authenticator
+    def initialize(server_key)
+      @server_key = server_key
+    end
+
+    def before_request(uri, body, headers, options)
+      headers['Authorization'] = "key=#{@server_key}"
+
+      [uri, body, headers, options]
+    end
+  end
+
+  class ConnectionPool
+    attr_reader :connection
+
+    def initialize(name: nil, proxy: nil, pool_size: Net::HTTP::Persistent::DEFAULT_POOL_SIZE)
+      @connection = Net::HTTP::Persistent.new(name: name, proxy: proxy, pool_size: pool_size)
+    end
+
+    def call(request_class, uri, headers, body, *_)
+      req = request_class.new(uri, headers)
+      req.set_body_internal(body)
+
+      connection.request(uri, req)
+    end
+  end
+
+  private_constant :Authenticator, :ConnectionPool
+end

data/lib/andpush/client.rb

@@ -0,0 +1,90 @@
+# frozen-string-literal: true
+require 'net/http'
+require 'andpush/exceptions'
+require 'andpush/json_handler'
+
+module Andpush
+  class Client
+    attr_reader :domain, :proxy_addr, :proxy_port, :proxy_user, :proxy_password, :request_handler
+
+    def initialize(domain, proxy_addr: nil, proxy_port: nil, proxy_user: nil, proxy_password: nil, request_handler: RequestHandler.new, **options)
+      @domain = domain
+      @proxy_addr = proxy_addr
+      @proxy_port = proxy_port
+      @proxy_user = proxy_user
+      @proxy_password = proxy_password
+      @interceptors = []
+      @observers = []
+      @request_handler = request_handler
+      @options = DEFAULT_OPTIONS.merge(options)
+
+      register_interceptor(JsonSerializer.new)
+      register_observer(ResponseHandler.new)
+      register_observer(JsonDeserializer.new)
+    end
+
+    def register_interceptor(interceptor)
+      @interceptors << interceptor
+      self
+    end
+
+    def register_observer(observer)
+      @observers << observer
+      self
+    end
+
+    def push(body, query: {}, headers: {}, **options)
+      request(Net::HTTP::Post, uri('/fcm/send', query), body, headers, method: :push, **options)
+    end
+
+    private
+
+    DEFAULT_OPTIONS = {
+      ca_file: nil,
+      ca_path: nil,
+      cert: nil,
+      cert_store: nil,
+      ciphers: nil,
+      close_on_empty_response: nil,
+      key: nil,
+      open_timeout: nil,
+      read_timeout: nil,
+      ssl_timeout: nil,
+      ssl_version: nil,
+      use_ssl: nil,
+      verify_callback: nil,
+      verify_depth: nil,
+      verify_mode: nil
+    }.freeze
+
+    HTTPS = 'https'.freeze
+
+    def request(request_class, uri, body, headers, options = {})
+      uri, body, headers, options = @interceptors.reduce([uri, body, headers, @options.merge(options)]) { |r, i| i.before_request(*r) }
+
+      response = begin
+        request_handler.call(request_class, uri, headers, body, proxy_addr, proxy_port, proxy_user, proxy_password, options)
+      rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+        raise NetworkError, "A network error occurred: #{e.class} (#{e.message})"
+      end
+
+      @observers.reduce(response) { |r, o| o.received_response(r, options) }
+    end
+
+    def uri(path, query = {})
+      uri = URI.join(domain, path)
+      uri.query = URI.encode_www_form(query) unless query.empty?
+      uri
+    end
+
+    class RequestHandler
+      def call(request_class, uri, headers, body, proxy_addr, proxy_port, proxy_user, proxy_password, options = {})
+        Net::HTTP.start(uri.host, uri.port, proxy_addr, proxy_port, proxy_user, proxy_password, options, use_ssl: (uri.scheme == HTTPS)) do |http|
+          http.request request_class.new(uri, headers), body
+        end
+      end
+    end
+
+    private_constant :RequestHandler
+  end
+end

data/lib/andpush/exceptions.rb

@@ -0,0 +1,110 @@
+module Andpush
+  class APIError < StandardError; end
+  class NetworkError < APIError; end
+
+  class HttpError < APIError
+    attr_reader :response
+
+    def initialize(message, response)
+      super(message)
+      @response = response
+    end
+  end
+
+  class ClientError < HttpError; end
+
+  class BadRequest                  < ClientError; end # status: 400
+  class Unauthorized                < ClientError; end # status: 401
+  class PaymentRequired             < ClientError; end # status: 402
+  class Forbidden                   < ClientError; end # status: 403
+  class NotFound                    < ClientError; end # status: 404
+  class MethodNotAllowed            < ClientError; end # status: 405
+  class NotAcceptable               < ClientError; end # status: 406
+  class ProxyAuthenticationRequired < ClientError; end # status: 407
+  class RequestTimeout              < ClientError; end # status: 408
+  class Conflict                    < ClientError; end # status: 409
+  class Gone                        < ClientError; end # status: 410
+  class LengthRequired              < ClientError; end # status: 411
+  class PreconditionFailed          < ClientError; end # status: 412
+  class PayloadTooLarge             < ClientError; end # status: 413
+  class URITooLong                  < ClientError; end # status: 414
+  class UnsupportedMediaType        < ClientError; end # status: 415
+  class RangeNotSatisfiable         < ClientError; end # status: 416
+  class ExpectationFailed           < ClientError; end # status: 417
+  class ImaTeapot                   < ClientError; end # status: 418
+  class MisdirectedRequest          < ClientError; end # status: 421
+  class UnprocessableEntity         < ClientError; end # status: 422
+  class Locked                      < ClientError; end # status: 423
+  class FailedDependency            < ClientError; end # status: 424
+  class UpgradeRequired             < ClientError; end # status: 426
+  class PreconditionRequired        < ClientError; end # status: 428
+  class TooManyRequests             < ClientError; end # status: 429
+  class RequestHeaderFieldsTooLarge < ClientError; end # status: 431
+  class UnavailableForLegalReasons  < ClientError; end # status: 451
+
+  class ServerError < HttpError; end
+
+  class InternalServerError           < ServerError; end # status: 500
+  class NotImplemented                < ServerError; end # status: 501
+  class BadGateway                    < ServerError; end # status: 502
+  class ServiceUnavailable            < ServerError; end # status: 503
+  class GatewayTimeout                < ServerError; end # status: 504
+  class HTTPVersionNotSupported       < ServerError; end # status: 505
+  class VariantAlsoNegotiates         < ServerError; end # status: 506
+  class InsufficientStorage           < ServerError; end # status: 507
+  class LoopDetected                  < ServerError; end # status: 508
+  class NotExtended                   < ServerError; end # status: 510
+  class NetworkAuthenticationRequired < ServerError; end # status: 511
+
+  STATUS_TO_EXCEPTION_MAPPING = {
+    '400' => BadRequest,
+    '401' => Unauthorized,
+    '402' => PaymentRequired,
+    '403' => Forbidden,
+    '404' => NotFound,
+    '405' => MethodNotAllowed,
+    '406' => NotAcceptable,
+    '407' => ProxyAuthenticationRequired,
+    '408' => RequestTimeout,
+    '409' => Conflict,
+    '410' => Gone,
+    '411' => LengthRequired,
+    '412' => PreconditionFailed,
+    '413' => PayloadTooLarge,
+    '414' => URITooLong,
+    '415' => UnsupportedMediaType,
+    '416' => RangeNotSatisfiable,
+    '417' => ExpectationFailed,
+    '418' => ImaTeapot,
+    '421' => MisdirectedRequest,
+    '422' => UnprocessableEntity,
+    '423' => Locked,
+    '424' => FailedDependency,
+    '426' => UpgradeRequired,
+    '428' => PreconditionRequired,
+    '429' => TooManyRequests,
+    '431' => RequestHeaderFieldsTooLarge,
+    '451' => UnavailableForLegalReasons,
+    '500' => InternalServerError,
+    '501' => NotImplemented,
+    '502' => BadGateway,
+    '503' => ServiceUnavailable,
+    '504' => GatewayTimeout,
+    '505' => HTTPVersionNotSupported,
+    '506' => VariantAlsoNegotiates,
+    '507' => InsufficientStorage,
+    '508' => LoopDetected,
+    '510' => NotExtended,
+    '511' => NetworkAuthenticationRequired
+  }.freeze
+
+  class ResponseHandler
+    def received_response(response, _options)
+      error = STATUS_TO_EXCEPTION_MAPPING[response.code]
+      raise error.new("Receieved an error response #{response.code} #{error.to_s.split('::').last}: #{response.body}", response) if error
+      response
+    end
+  end
+
+  private_constant :ResponseHandler
+end

data/lib/andpush/json_handler.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'delegate'
+
+module Andpush
+  class JsonResponse < DelegateClass(Net::HTTPResponse)
+    alias response __getobj__
+    alias headers to_hash
+    HAS_SYMBOL_GC = RUBY_VERSION > '2.2.0'
+
+    def json
+      parsable? ? JSON.parse(body, symbolize_names: HAS_SYMBOL_GC) : nil
+    end
+
+    def inspect
+      "#<JsonResponse response: #{response.inspect}, json: #{json}>"
+    end
+    alias to_s inspect
+
+    def parsable?
+      !!body && !body.empty?
+    end
+  end
+
+  class JsonSerializer
+    APPLICATION_JSON     = 'application/json'.freeze
+    JSON_REQUEST_HEADERS = {
+      'Content-Type' => APPLICATION_JSON,
+      'Accept'       => APPLICATION_JSON
+    }.freeze
+
+    def before_request(uri, body, headers, options)
+      headers = headers.merge(JSON_REQUEST_HEADERS)
+      body    = body.nil? || body.is_a?(String) ? body : body.to_json
+
+      [uri, body, headers, options]
+    end
+  end
+
+  class JsonDeserializer
+    def received_response(response, _options)
+      JsonResponse.new(response)
+    end
+  end
+
+  private_constant :JsonSerializer, :JsonDeserializer
+end

data/lib/andpush/version.rb

@@ -0,0 +1,3 @@
+module Andpush
+  VERSION = '0.1.0'.freeze
+end

data/response_types.yml

@@ -0,0 +1,17 @@
+Response:
+  multicast_id: Integer
+  success: Integer
+  failure: Integer
+  canonical_ids: Integer
+  results: Array(Result)
+
+Result:
+  message_id: String
+  registration_id: String
+  error: String
+
+ErrorResponse:
+  operation: String
+  notification_key_name: String
+  notification_key: String
+  registration_ids: Array(String)

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: andpush
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuki Nishijima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: Andpush is an HTTP client for Firebase Cloud Messaging.
+email:
+- mail@yukinishijima.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- andpush.gemspec
+- bin/console
+- bin/setup
+- fcm.apispec
+- lib/andpush.rb
+- lib/andpush/client.rb
+- lib/andpush/exceptions.rb
+- lib/andpush/json_handler.rb
+- lib/andpush/version.rb
+- response_types.yml
+homepage: https://github.com/yuki24/andpush
+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.6.12
+signing_key: 
+specification_version: 4
+summary: FCM HTTP client
+test_files: []