simple_fcm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f5835dfac2bd3ba0b04f1da11a401bc99f64660286418529a9a5050ed3ef236
+  data.tar.gz: 5c1114761715ecd29153cfebb6fbbeffe2dfce1968acc6a5aa4b2463eb1d53ea
+SHA512:
+  metadata.gz: 7579a0e9c42034965f92f384b1faa9778038e4536b9b7ddbb4964886eff0edd116530dfe126b974cc5c03d26a7643e263ad24d373cef0423f5f5f4104a76faf5
+  data.tar.gz: fc467f2fcb1f5005c2b7f5e8c29e6e36d72bfcde66e398afaa950055e77569ca56121d62dfe215028d46b239ad785f2b1a1d29cd4231087f88cc2b6a915e29c8

data/.rspec

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

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-06-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Chris Gaffney
+
+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,53 @@
+# SimpleFCM
+
+SimpleFCM is a minimalist client for Firebase Cloud Messaging to send Push
+Notifications.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add simple_fcm
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install simple_fcm
+
+## Usage
+
+```ruby
+# Initialize a new client for talking to Firebase Cloud Messaging. Client.new
+# takes an optional parameter which is either the path to a service account
+# config file or the raw config JSON. Not passing a config or passing nil will
+# pull the configuration from environment variables.
+client = SimpleFCM::Client.new("path/to/service_account.json")
+
+# See https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages/send
+client.push({
+  message: {
+    token: device.token,
+    data: {
+      message: "Jinkies! Something happened",
+      id: snitch.id,
+    }
+  }
+})
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 the created tag, 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/deadmanssnitch/simple_fcm. 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/deadmanssnitch/simple_fcm/blob/main/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 SimpleFCM project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/deadmanssnitch/simple_fcm/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/lib/simple_fcm/authorization_middleware.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module SimpleFCM
+  class AuthorizationMiddleware < Faraday::Middleware
+    # Automatically refresh the access token when it is due to expire within
+    # the next 3 minutes.
+    DEFAULT_EXPIRY_THRESHOLD = 180
+
+    def initialize(app, credentials, expiry_threshold: DEFAULT_EXPIRY_THRESHOLD)
+      @credentials = credentials
+      @expiry_threshold = expiry_threshold
+
+      if @expiry_threshold < 0
+        raise ArugmentError, "expiry_threshold must be greater than or equal to 0"
+      end
+
+      super(app)
+    end
+
+    # Force a refresh of the access token
+    def refresh!
+      fetched = @credentials.fetch_access_token!
+
+      @token = fetched["access_token"]
+      @type = fetched["token_type"]
+      @expires_at = Time.now.utc + fetched["expires_in"]
+    end
+
+    # Returns true when the access token should be fetched or refreshed.
+    def refresh?
+      @expires_at.nil? || @expires_at <= (Time.now.utc - @expiry_threshold)
+    end
+
+    def on_request(env)
+      if refresh?
+        refresh!
+      end
+
+      env.request_headers["Authorization"] = "#{@type} #{@token}"
+    end
+  end
+end
+
+Faraday::Request.register_middleware(simple_fcm_auth: SimpleFCM::AuthorizationMiddleware)

data/lib/simple_fcm/client.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "googleauth/service_account"
+
+require "simple_fcm/error"
+require "simple_fcm/authorization_middleware"
+
+module SimpleFCM
+  class Client
+    ENDPOINT = "https://fcm.googleapis.com"
+    private_constant :ENDPOINT
+
+    SCOPE = "https://www.googleapis.com/auth/firebase.messaging"
+    private_constant :SCOPE
+
+    # @param config [string, nil] Either the path to a service account json
+    #   config file, the contents of that file as a string, or nil to load
+    #   config options from environment configs.
+    #
+    # @yield [conn] Yields into the connection building process
+    # @yieldparam [Faraday::Connection] The backend connection used for requests
+    def initialize(config = nil)
+      @credentials = build_credentials(config)
+
+      @client = Faraday::Connection.new(ENDPOINT) do |conn|
+        conn.request :simple_fcm_auth, @credentials
+        conn.request :json
+        conn.response :json, parser_options: {symbolize_names: true}
+
+        if block_given?
+          yield conn
+        end
+      end
+    end
+
+    # Send a push notification to a device or topic through Firebase Cloud
+    # Messaging.
+    #
+    # @see https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages/send
+    #
+    # @param message [Hash] Message payload
+    #
+    # @raise [APIError]
+    # @return [string] Message ID returned by the API
+    def push(message)
+      resp = @client.post("/v1/projects/#{project_id}/messages:send", message)
+
+      if !resp.success?
+        raise ::SimpleFCM::APIError, resp
+      end
+
+      resp.body[:name]
+    end
+
+    private
+
+    def build_credentials(config = nil)
+      # Config options are pulled from environment variables.
+      if config.nil?
+        return Google::Auth::ServiceAccountCredentials.make_creds(scope: SCOPE)
+      end
+
+      if !config.is_a?(String)
+        raise ArgumentError, "config must be a string"
+      end
+
+      if File.exist?(config)
+        config = File.read(config)
+      end
+
+      ::Google::Auth::ServiceAccountCredentials.make_creds(
+        json_key_io: StringIO.new(config),
+        scope: SCOPE
+      )
+    end
+
+    def project_id
+      @credentials.project_id
+    end
+  end
+end

data/lib/simple_fcm/error.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module SimpleFCM
+  # Error is the root class for all errors generated by SimpleFCM.
+  class Error < StandardError; end
+
+  # API errors are raised when there is an issue making a request to the
+  # Firebase Cloud Messaging API.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class APIError < Error
+    attr_reader :code
+    attr_reader :status
+    attr_reader :details
+
+    def initialize(response)
+      if response.body.is_a?(String)
+        @code = response.status
+
+        super("FCM returned #{response.status}: #{response.body}")
+      else
+        payload = response.body[:error]
+
+        @code = payload[:code]
+        @status = payload[:status]
+        @details = payload[:details]
+
+        super(payload[:message])
+      end
+    end
+
+    def retriable?
+      true
+    end
+
+    # exception is called instead of `new` when using the form:
+    #   raise SimpleFCM::APIError, response
+    #
+    # @param response [Faraday::Response]
+    def self.exception(response)
+      klass =
+        case response.status
+        when 400 then InvalidArgumentError
+        when 401 then ThirdPartyAuthenticationError
+        when 403 then SenderMismatchError
+        when 404 then UnregisteredError
+        when 429 then QuotaExceededError
+        when 500 then InternalServerError
+        when 503 then ServiceUnavailableError
+        else
+          APIError
+        end
+
+      klass.new(response)
+    end
+  end
+
+  # InvalidArgumentError is raised when an invalid parameter or request payload
+  # was sent to Firebase Cloud Messaging.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages/send
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class InvalidArgumentError < APIError
+    def retriable?
+      false
+    end
+  end
+
+  # ThirdPartyAuthenticationError is raised when sending a message targeted at
+  # an iOS device or sending a web push registration and the third party
+  # credentials are incorrect.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class ThirdPartyAuthenticationError < APIError
+    def retriable?
+      false
+    end
+  end
+
+  # SenderMismatchError is raised when the given Sender ID is not tied to the
+  # registration token the message is being sent to.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class SenderMismatchError < APIError
+    def retriable?
+      false
+    end
+  end
+
+  # UnregisteredError is raised when the given device token is no longer valid.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class UnregisteredError < APIError
+    def retriable?
+      false
+    end
+  end
+
+  # QuotaExceededError is raised when the quota for sending push notifications
+  # to either a device or topic has been exceeded. Firebase recommends using an
+  # exponential backoff with a minimum delay of 1 minute before retrying the
+  # message.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class QuotaExceededError < APIError
+    def retriable?
+      true
+    end
+  end
+
+  # InternalServerError is raised when Firebase encountered an unknown internal
+  # error.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class InternalServerError < APIError
+    def retriable?
+      true
+    end
+  end
+
+  # ServiceUnavailableError is raised when Firebase's push notification
+  # services are overloaded in some way.
+  #
+  # @see https://firebase.google.com/docs/reference/fcm/rest/v1/ErrorCode
+  class ServiceUnavailableError < APIError
+    def retriable?
+      true
+    end
+  end
+end

data/lib/simple_fcm/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module SimpleFCM
+  VERSION = "0.1.0"
+end

data/lib/simple_fcm.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "simple_fcm/version"
+require "simple_fcm/error"
+require "simple_fcm/client"
+
+module SimpleFCM
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: simple_fcm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Gaffney
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: |
+  SimpleFCM is a minimal client for sending push notifications using the the
+  Firebase Cloud Messaging V1 API.
+email:
+- chris@collectiveidea.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_fcm.rb
+- lib/simple_fcm/authorization_middleware.rb
+- lib/simple_fcm/client.rb
+- lib/simple_fcm/error.rb
+- lib/simple_fcm/version.rb
+homepage: https://github.com/deadmanssnitch/simple_fcm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/deadmanssnitch/simple_fcm
+  source_code_uri: https://github.com/deadmanssnitch/simple_fcm
+  changelog_uri: https://github.com/deadmanssnitch/simple_fcm/blog/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: Firebase Cloud Messaging V1 API Client
+test_files: []