Ffccmmx

Ffccmmx is a Firebase Cloud Messaging (FCM) client for Ruby, built on top of the httpx. It is based on the original fcmpush gem.

By leveraging httpx, this gem enables HTTP/2 communication while maintaining an interface that is almost identical to fcmpush.

Install the gem and add to the application's Gemfile by executing:

bundle add ffccmmx

If bundler is not being used to manage dependencies, install the gem by executing:

gem install ffccmmx

Ffccmmx.configure do |config|
  config.scope = ["https://www.googleapis.com/auth/cloud-platform"]
  config.json_key_io = StringIO.new('{"key": "value"}')
  config.proxy = "http://proxy.example.com"
  config.httpx_options = {
    timeout: {
      connect_timeout:  5,  
    },
  }
end

or You can use environment variables:

export GOOGLE_ACCOUNT_TYPE = 'service_account'
export GOOGLE_CLIENT_ID = '000000000000000000000'
export GOOGLE_CLIENT_EMAIL = 'xxxx@xxxx.iam.gserviceaccount.com'
export GOOGLE_PRIVATE_KEY = '-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n'

or You can use a JSON key file:

Ffccmmx.configure do |config|
  config.json_key_io = File.open('/path/to/your/service_account_credentials.json')
end

@client = Ffccmmx.new(project_id)
notification_message = { 
  message: {
    token: device_token,
    notification: {
      title: "test title",
      body: "test body"
    }
  }
}
response = @client.push(notification_message)
response.json

response is an instance of HTTPX::Response, which contains the response from the FCM server. You can access the JSON response using response.json. The Fcmpush response uses symbols for its keys, while the Ffccmmx response uses strings.

@client = Ffccmmx.new(project_id)
notification_messages = [ 
  {
    message: {
      token: device_token,
      notification: {
        title: "test title",
        body: "test body"
      }
    }
  },
  {
    message: {
      token: other_device_token,
      notification: {
        title: "test title",
        body: "test body"
      }
    }
  },
]
responses = @client.concurrent_push(notification_messages)
responses.each do |response|
  httpx_response = response.value
end

The concurrent_push method sends requests using HTTP/2 multiplexing. The response is wrapped in an Ffccmmx::Response object. you can get the HTTPX::Response with #value, or an Ffccmmx::Error will be raised.

@client = Ffccmmx.new(project_id)
response = @client.subscribe('/topics/test_topic', device_token)

@client = Ffccmmx.new(project_id)
response = @client.subscribe('/topics/test_topic', *device_tokens)

@client = Ffccmmx.new(project_id)
response = @client.unsubscribe('/topics/test_topic', device_token)

@client = Ffccmmx.new(project_id)
response = @client.unsubscribe('/topics/test_topic', *device_tokens)

Ffccmmx::HTTPXRetryableError is returned, you can use the retry_time method to get a Time object indicating when the next request can be executed. If the request has already been attempted multiple times, you can pass the attempt count as an argument, and it will be taken into account even if the Retry-After header is not present in the response.

begin
  @client.push(notification_message)
rescue Ffccmmx::HTTPXRetryableError => e
    puts "Retry after: #{e.retry_time}"
end

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.

Bug reports and pull requests are welcome on GitHub at https://github.com/AnaTofuZ/ffccmmx. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Ffccmmx project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.