firebase_cloud_messenger 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df760f55ce074ae2ec5f8e45d43ba2f0446e94f2
-  data.tar.gz: f7aef2b712e689775f41d30d55897d27dc9ce3a6
+  metadata.gz: f35bac5160121441e8b66065922a0a54374fbaa4
+  data.tar.gz: 41711425b6d678ad592eda312944834a62ff86a3
 SHA512:
-  metadata.gz: 71ae814f893ee647dc1149219787ba06481e536b35134e94f24ad82f86100e2833da1d5c789c1e70c31bf7080795ed0cb0c336c46ab2e75fedba7635c1ddcfd1
-  data.tar.gz: b12035cc991df505d0a7196a01e37a18a0574e88a2bd9a823910f54b3937861aefee4830dd9cb1bc279127391f2b2e5020835a666d3627f20a19442edce81c0f
+  metadata.gz: c563c3cbb78512e98c4f5a12233531da0318fba0a801c0faf4aa712f87bd8c133c9be520f46ba10d727f9d8bbe27df550f332c0637c3e26866d612fdaf341503
+  data.tar.gz: 8af53e10b25c15767a8cf2f35a1a27e2efdb76c085272bfdbd2eb7be4e0fa84e7b65fa160224e46784e7cf5df3bc3d599226aee33d021b679b7391d6bb3236b9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## Version 0.2.0 - December 12, 2017
+
+* Allows Google service account credentials to be set either via environment variables or a path to
+  a json file. Previously only the json file option was available.
+

data/README.md

@@ -1,6 +1,6 @@
-# firebase-cloud-messenger
+# firebase_cloud_messenger
 
-firebase-cloud-messenger wraps Google's API to make sending push notifications to iOS, android, and
+firebase_cloud_messenger wraps Google's API to make sending push notifications to iOS, android, and
 web push notifications from your server easy.
 
 NB: Google released the [FCM HTTP v1 API](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages)
@@ -24,19 +24,37 @@ Or install it yourself as:
 
     $ gem install firebase_cloud_messenger
 
-In order for google to authenticate requests to Firebase Cloud Messenger, you must have your
-credentials file in a place that's accessible. You can tell firebase-cloud-messenger where it is in
-two ways:
+## Setup
+In order for google to authenticate requests to Firebase Cloud Messenger, you must either have your
+service account credentials file in a place that's accessible, or provide credentials as env vars.
 
-1. `FirebaseCloudMessenger.credentials_path = "path/to/credentials/file.json"`
-2. `export GOOGLE_APPLICATION_CREDENTIALS = "path/to/credentials/file.json"`
+#### Setup Method 1: Service Account JSON Path Supplied As Env Var
+```bash
+$ export GOOGLE_APPLICATION_CREDENTIALS = "path/to/credentials/file.json"`
+```
+
+#### Setup Method 2: Service Account JSON Path Supplied To FirebaseCloudMessenger
+```ruby
+FirebaseCloudMessenger.credentials_path = "path/to/credentials/file.json"
+```
+
+#### Setup Method 3: Service Account Credentials Set as Env Vars
+``` bash
+$ export GOOGLE_PRIVATE_KEY = "-----BEGIN PRIVATE KEY-----..."
+$ export GOOGLE_CLIENT_EMAIL = "firebase-admin-sdk...@iam.gserviceaccount.com"
+```
+Also set the `project_id`, which is otherwise read from the json service account file:
+
+```ruby
+FirebaseCloudMessenger.project_id = "1234567"
+```
 
 ## Usage
 
 ### Sending a Message
 
 You can see how your message should be structured [here](https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages)
-firebase-cloud-messenger provides built-in data classes for each json object type in the FCM API
+firebase_cloud_messenger provides built-in data classes for each json object type in the FCM API
 specification, but you can also build up a hash message on your own, or use some combination of the
 two.
 

data/lib/firebase_cloud_messenger/auth_client.rb

@@ -4,9 +4,12 @@ module FirebaseCloudMessenger
 
     AUTH_SCOPE = "https://www.googleapis.com/auth/firebase.messaging".freeze
 
-    def initialize(credentials_path)
+    def initialize(credentials_path = nil)
       @credentials_path = credentials_path
-      @authorizer = get_authorizer
+
+      raise_credentials_not_supplied if !credentials_supplied?
+
+      @authorizer = Google::Auth::ServiceAccountCredentials.make_creds(cred_args)
     end
 
     def fetch_access_token_info
@@ -17,10 +20,24 @@ module FirebaseCloudMessenger
 
     attr_reader :authorizer
 
-    def get_authorizer
+    def credentials_supplied?
+      credentials_path || (ENV['GOOGLE_CLIENT_EMAIL'] && ENV['GOOGLE_PRIVATE_KEY'])
+    end
+
+    def raise_credentials_not_supplied
+      msg = "Either a path to a service account credentials json must be supplied, "\
+            "or the `GOOGLE_CLIENT_EMAIL` and `GOOGLE_PRIVATE_KEY` env vars must be set."
+
+      raise ArgumentError, msg
+    end
+
+    def cred_args
+      args = { scope: AUTH_SCOPE }
+      return args unless credentials_path
+
       begin
         file = File.open(credentials_path)
-        Google::Auth::ServiceAccountCredentials.make_creds(json_key_io: file, scope: AUTH_SCOPE)
+        args.merge(json_key_io: file)
       ensure
         file.close
       end

data/lib/firebase_cloud_messenger/client.rb

@@ -5,8 +5,13 @@ module FirebaseCloudMessenger
     attr_writer :max_retry_count, :project_id, :access_token
     attr_accessor :credentials_path
 
-    def initialize(credentials_path = nil)
+    def initialize(credentials_path = nil, project_id = nil)
       @credentials_path = credentials_path || ENV['GOOGLE_APPLICATION_CREDENTIALS']
+      @project_id = project_id
+
+      if !(@credentials_path || @project_id)
+        raise ArgumentError, "Either a project_id or a credentials_path must be supplied"
+      end
     end
 
     def send(message, validate_only, conn)

data/lib/firebase_cloud_messenger/error.rb

@@ -1,4 +1,6 @@
 module FirebaseCloudMessenger
+  class SetupError < StandardError; end
+
   class Error < StandardError
     attr_reader :response
 

data/lib/firebase_cloud_messenger/version.rb

@@ -1,3 +1,3 @@
 module FirebaseCloudMessenger
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/firebase_cloud_messenger.rb

@@ -15,11 +15,13 @@ require 'firebase_cloud_messenger/webpush'
 
 module FirebaseCloudMessenger
   class << self
-    attr_accessor :credentials_path
+    attr_accessor :credentials_path, :project_id
   end
 
   def self.send(message: {}, validate_only: false, conn: nil)
-    Client.new(credentials_path).send(message, validate_only, conn)
+    check_setup_complete!
+
+    Client.new(credentials_path, project_id).send(message, validate_only, conn)
   end
 
   def self.validate_message(message, conn = nil, against_api: false)
@@ -27,4 +29,22 @@ module FirebaseCloudMessenger
 
     message.valid?(conn, against_api: against_api)
   end
+
+  private
+
+  def self.check_setup_complete!
+    if !(credentials_path || project_id)
+      msg = <<-ERROR_MSG
+Either a credentials_path or project_id must be supplied. Add one of them like this:
+
+`FirebaseCloudMessenger.credentials_path = "path/to/credentials.json"`
+
+or:
+
+`FirebaseCloudMessenger.project_id = "12345678"`
+     ERROR_MSG
+
+     raise FirebaseCloudMessenger::SetupError, msg
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase_cloud_messenger
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Vince DeVendra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-07 00:00:00.000000000 Z
+date: 2017-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md