fcmpush 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1d606a6d62730fa14527ad867232572409cc0ab91588afef463bde484d3cc67
+  data.tar.gz: a8e8ff06445e412e845be30f39e5cd041f01b1140feb4b6d34c858ff541066c0
+SHA512:
+  metadata.gz: c164d0dd6c2f2500568cb25947a37bae806792ce49f18d9c7c861fbffe1047cd5210b3fef39cb371d8fcf46813fcdbf66dfd5a16e57aadf77e508cd23f424e24
+  data.tar.gz: 7541a889589bab2b5dba22acf7e29c4dcdac4b761846a5aa8a693278cce1ab16ab924ec9c6a90aaa2088827fc308a4b5703d8b2bb2461333d3bfd9260f6ad666

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+/vendor/bundle

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.4
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fcmpush.gemspec
+gemspec
+
+gem 'pry-byebug'

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    fcmpush (0.1.1)
+      googleauth (>= 0.10.0)
+      net-http-persistent (>= 3.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    connection_pool (2.2.2)
+    diff-lcs (1.3)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    googleauth (0.10.0)
+      faraday (~> 0.12)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (~> 0.12)
+    jwt (2.2.1)
+    memoist (0.16.0)
+    method_source (0.9.2)
+    multi_json (1.13.1)
+    multipart-post (2.1.1)
+    net-http-persistent (3.1.0)
+      connection_pool (~> 2.2)
+    os (1.0.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    public_suffix (4.0.1)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    signet (0.12.0)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  fcmpush!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Takayuki Miyahara
+
+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,76 @@
+# Fcmpush
+
+Fcmpush is an Firebase Cloud Messaging(FCM) Client. It implements [FCM HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages).
+This gem supports HTTP v1 API only, **NOT supported [legacy HTTP protocol](https://firebase.google.com/docs/cloud-messaging/http-server-ref)**, because both authentication method is different.
+
+fcmpush is highly inspired by [andpush gem](https://github.com/yuki24/andpush).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fcmpush'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fcmpush
+
+## Usage
+
+on Rails, config/initializers/fcmpush.rb
+```ruby
+Fcmpush.configure do |config|
+  # firebase web console => project settings => service account => firebase admin sdk => generate new private key
+  config.json_key_io = "#{Rails.root}/path/to/service_account_credentials.json"
+
+  # Or set environment variables
+  # ENV['GOOGLE_ACCOUNT_TYPE'] = 'service_account'
+  # ENV['GOOGLE_CLIENT_ID'] = '000000000000000000000'
+  # ENV['GOOGLE_CLIENT_EMAIL'] = 'xxxx@xxxx.iam.gserviceaccount.com'
+  # ENV['GOOGLE_PRIVATE_KEY'] = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n\
+end
+```
+
+for more detail. see [here](https://github.com/googleapis/google-auth-library-ruby#example-service-account).
+
+```ruby
+require 'fcmpush'
+
+project_id   = "..." # Your project_id
+device_token = "..." # The device token of the device you'd like to push a message to
+
+client  = Fcmpush.new(project_id)
+payload = { # ref. https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages
+  message: {
+    token: device_token,
+    notification: {
+      title: "this is title",
+      body: "this is message body"
+   }
+  }
+}
+
+response = client.push(payload)
+
+json = response.json
+json[:name] # => "projects/[your_project_id]/messages/0:1571037134532751%31bd1c9631bd1c96"
+```
+
+## Future Work
+- topic subscribe/unsubscribe
+- auto refresh access_token before expiry
+- [DEV] compare other gems
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/miyataka/fcmpush.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fcmpush"
+
+# 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/fcmpush.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fcmpush/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fcmpush'
+  spec.version       = Fcmpush::VERSION
+  spec.authors       = ['Takayuki Miyahara']
+  spec.email         = ['voyager.3taka28@gmail.com']
+
+  spec.summary       = 'Firebase Cloud Messaging API wrapper for ruby, supports HTTP v1 only.'
+  spec.homepage      = 'https://github.com/miyataka/fcmpush'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/miyataka/fcmpush'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) 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']
+
+  spec.add_dependency 'googleauth', '>= 0.10.0'
+  spec.add_dependency 'net-http-persistent', '>= 3.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/fcmpush.rb

@@ -0,0 +1,206 @@
+require 'fcmpush/configuration'
+require 'fcmpush/version'
+
+require 'net/http/persistent'
+require 'json'
+require 'googleauth'
+
+module Fcmpush
+  class Error < StandardError; end
+  DOMAIN = 'https://fcm.googleapis.com'.freeze
+  V1_ENDPOINT_PREFIX = '/v1/projects/'.freeze
+  V1_ENDPOINT_SUFFIX = '/messages:send'.freeze
+
+  class << self
+    def build(project_id, domain: nil)
+      ::Fcmpush::Client.new(domain || DOMAIN, project_id, configuration)
+    end
+    alias new build
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure(&block)
+    yield(configuration(&block))
+  end
+
+  class Client
+    attr_reader :domain, :path, :connection, :access_token, :configuration
+
+    def initialize(domain, project_id, configuration, **options)
+      @domain = domain
+      @project_id = project_id
+      @path = V1_ENDPOINT_PREFIX + project_id.to_s + V1_ENDPOINT_SUFFIX
+      @options = {}.merge(options)
+      @configuration = configuration
+      @access_token = authorize
+      @connection = Net::HTTP::Persistent.new
+    end
+
+    def authorize
+      @auth ||= if configuration.json_key_io
+                  Google::Auth::ServiceAccountCredentials.make_creds(
+                    json_key_io: File.open(configuration.json_key_io),
+                    scope: configuration.scope
+                  )
+                else
+                  # from ENV
+                  Google::Auth::ServiceAccountCredentials.make_creds(
+                    scope: configuration.scope
+                  )
+                end
+      @auth.fetch_access_token!['access_token']
+    end
+
+    def push(body, query: {}, headers: {})
+      uri = URI.join(domain, path)
+      uri.query = URI.encode_www_form(query) unless query.empty?
+
+      headers = authorized_header(headers)
+      post = Net::HTTP::Post.new(uri, headers)
+      post.body = body.is_a?(String) ? body : body.to_json
+
+      response = exception_handler(connection.request(uri, post))
+      JsonResponse.new(response)
+    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
+
+    def authorized_header(headers)
+      headers.merge('Content-Type' => 'application/json',
+                    'Accept' => 'application/json',
+                    'Authorization' => "Bearer #{access_token}")
+    end
+
+    def exception_handler(response)
+      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
+
+  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.nil? && !body.empty?
+    end
+  end
+
+  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
+end

data/lib/fcmpush/configuration.rb

@@ -0,0 +1,18 @@
+module Fcmpush
+  class Configuration
+    attr_accessor :scope, :json_key_io
+
+    def initialize
+      @scope = ['https://www.googleapis.com/auth/firebase.messaging']
+
+      # set file path
+      @json_key_io = nil
+
+      # Or Environment Variable
+      # ENV['GOOGLE_ACCOUNT_TYPE'] = 'service_account'
+      # ENV['GOOGLE_CLIENT_ID'] = '000000000000000000000'
+      # ENV['GOOGLE_CLIENT_EMAIL'] = 'xxxx@xxxx.iam.gserviceaccount.com'
+      # ENV['GOOGLE_PRIVATE_KEY'] = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n'
+    end
+  end
+end

data/lib/fcmpush/version.rb

@@ -0,0 +1,3 @@
+module Fcmpush
+  VERSION = '0.1.1'.freeze
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: fcmpush
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Takayuki Miyahara
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: net-http-persistent
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- voyager.3taka28@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fcmpush.gemspec
+- lib/fcmpush.rb
+- lib/fcmpush/configuration.rb
+- lib/fcmpush/version.rb
+homepage: https://github.com/miyataka/fcmpush
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/miyataka/fcmpush
+  source_code_uri: https://github.com/miyataka/fcmpush
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Firebase Cloud Messaging API wrapper for ruby, supports HTTP v1 only.
+test_files: []