magicbell 2.1.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a080e99c355e6781a4387124238f7e02e738cd5a0bb4a7a5c71856f079e70f9d
-  data.tar.gz: 26811279e07a4952a4ec17f3e02d84f7d845b4abd0137545df04a5efeeb58fe2
+  metadata.gz: 205676a39e21a70f18682b926501b0d8c67ea674df273cbda92fe838f21b0750
+  data.tar.gz: 9d0e2fbf7661d9cd6f4f910fa2d0dd89e2ee6d230798015cabe606202627ca53
 SHA512:
-  metadata.gz: 25de345e29db78e48e568d43f86df7c1165eeed5f239ae6ec135073012489a1f9c31b966bc05c8fa4265926c37eae288c2c77a801b265e99219fa6c3332e80f6
-  data.tar.gz: 178dc4d58a27803ab5af948dcfc89d70eceeb6dd5bb6fc08fae998004af8a4ecfa0a611a222657b38c95a03999b418f44bd626557571c9cfd9fb63cae6291cad
+  metadata.gz: 524d8ed46c49c90e295974547b72b05db01a80ce3215070f48348a846ddcada01f07368846f4bbd5baca680a3ff8127e43abe5915bf1c85dfcb423270e72a8b9
+  data.tar.gz: 0d3d21452e55687032910556225db73a2f95d933d6a6f54edc9897c3499326ce8d9b527fa1226f9853352157cfb3c1cdbe1634dbbb58910078dd822c264e3512

data/README.md

@@ -1,14 +1,20 @@
 # MagicBell Ruby Library
 
-This library provides convenient access to the [MagicBell REST API](https://magicbell.com/docs/rest-api/overview) from applications written in Ruby. It includes helpers for creating notifications, fetching them, and calculating the HMAC for a user.
+This library provides convenient access to the [MagicBell REST API](https://magicbell.com/docs/rest-api/overview)
+from applications written in Ruby. It includes helpers for creating
+notifications, fetching them, and calculating the HMAC for a user.
 
-[MagicBell](https://magicbell.com) is the notification inbox for your web and mobile applications. You may find it helpful to familiarize yourself with the [core concepts of MagicBell](https://magicbell.com/docs/core-concepts).
+[MagicBell](https://magicbell.com) is the notification inbox for your web and
+mobile applications. You may find it helpful to familiarize yourself with the
+[core concepts of MagicBell](https://magicbell.com/docs/core-concepts).
 
 <img width="415" alt="MagicBell Notification Inbox" src="https://files.readme.io/c09b21a-image1.png">
 
 ## Installation
 
-First, [sign up for a MagicBell account](https://magicbell.com) and grab your MagicBell project's API key and secret from the "Settings" section of your MagicBell dashboard.
+First, [sign up for a MagicBell account](https://magicbell.com) and grab your
+MagicBell project's API key and secret from the "Settings" section of your
+MagicBell dashboard.
 
 If you just want to use the package, run:
 
@@ -31,13 +37,18 @@ and run `bundle install` a usual.
 
 ## Configuration
 
-The library needs to be configured with your MagicBell project's API key and secret.
+The library needs to be configured with your MagicBell project's API key and
+secret.
 
 ### Global configuration
 
-By default, this library will automatically pick your MagicBell project's API key and secret from the `MAGICBELL_API_KEY` and `MAGICBELL_API_SECRET` environment variables, respectively.
+By default, this library will automatically pick your MagicBell project's API
+key and secret from the `MAGICBELL_API_KEY` and `MAGICBELL_API_SECRET`
+environment variables, respectively.
 
-Alternatively, you can configure your MagicBell manually. For example, for a rails project, create an initializer file for MagicBell and set your project's keys:
+Alternatively, you can configure your MagicBell manually. For example, for a
+rails project, create an initializer file for MagicBell and set your project's
+keys:
 
 ```ruby
 # config/initializers/magicbell.rb
@@ -50,7 +61,8 @@ end
 
 ### Per-request configuration
 
-For apps that need to use multiple keys during the lifetime of a process, provide the specific keys when you create instances of `MagicBell::Client`:
+For apps that need to use multiple keys during the lifetime of a process,
+provide the specific keys when you create instances of `MagicBell::Client`:
 
 ```ruby
 require 'magicbell'
@@ -61,13 +73,15 @@ magicbell = MagicBell::Client.new(
 )
 ```
 
-Please keep in mind that any instance of `MagicBell::Client` will default to the global configuration unless an API key and secret are provided.
+Please keep in mind that any instance of `MagicBell::Client` will default to the
+global configuration unless an API key and secret are provided.
 
 ## Usage
 
 ### Create a notification
 
-You can send a notification to one or many users by identifying them by their email address:
+You can send a notification to one or many users by identifying them by their
+email address:
 
 ```ruby
 require 'magicbell'
@@ -97,7 +111,9 @@ magicbell.create_notification(
 )
 ```
 
-This method has the benefit of allowing users to access their notifications when their email address changes. Make sure you identify users by their `externalID` when you [initialize the notification inbox](https://magicbell.com/docs/react/identifying-users), too.
+This method has the benefit of allowing users to access their notifications when
+their email address changes. Make sure you identify users by their `externalID`
+when you [initialize the notification inbox](https://magicbell.com/docs/react/identifying-users), too.
 
 You can also provide other data accepted by [our API](https://magicbell.com/docs/rest-api/reference):
 
@@ -141,7 +157,12 @@ user = magicbell.user_with_email('joe@example.com')
 user.notifications.each { |notification| puts notification.attribute('title') }
 ```
 
-Please note that the example above fetches the user's 15 most recent notifications (the default number per page). If you'd like to fetch subsequent pages, use the `each_page` method instead:
+If you identify a user by an ID, you can use the
+`magicbell.user_with_external_id` method instead.
+
+Please note that the example above fetches the user's 15 most recent
+notifications (the default number per page). If you'd like to fetch subsequent
+pages, use the `each_page` method instead:
 
 ```ruby
 require 'magicbell'
@@ -194,7 +215,8 @@ user.mark_all_notifications_as_seen
 
 ### Error handling
 
-This gem raises a `MagicBell::Client::HTTPError` if the MagicBell API returns a non-2xx response.
+This gem raises a `MagicBell::Client::HTTPError` if the MagicBell API returns a
+non-2xx response.
 
 ```ruby
 require 'magicbell'
@@ -218,7 +240,9 @@ end
 
 ### Calculate the HMAC secret for a user
 
-You can use the `MagicBell.hmac` method. Note that in this case, the API secret, which is used to generate the HMAC, will be fetched from the global configuration.
+You can use the `MagicBell.hmac` method. Note that in this case, the API secret,
+which is used to generate the HMAC, will be fetched from the global
+configuration.
 
 ```ruby
 require 'magicbell'
@@ -226,7 +250,8 @@ require 'magicbell'
 hmac = MagicBell.hmac('joe@example.com')
 ```
 
-You can also use the API secret of a specific client instance to calculate the HMAC:
+You can also use the API secret of a specific client instance to calculate the
+HMAC:
 
 ```ruby
 require 'magicbell'
@@ -239,12 +264,15 @@ magicbell = MagicBell::Client.new(
 hmac = magicbell.hmac('joe@example.com')
 ```
 
-Please refer to our docs to know [how to turn on HMAC authentication](https://magicbell.com/docs/turn-on-hmac-authentication) for your MagicBell project.
+Please refer to our docs to know [how to turn on HMAC authentication](https://magicbell.com/docs/turn-on-hmac-authentication)
+for your MagicBell project.
 
 ## API docs
 
-Please visit [our website](https://magicbell.com) and [our docs](https://magicbell.com/docs) for more information.
+Please visit [our website](https://magicbell.com) and
+[our docs](https://magicbell.com/docs) for more information.
 
 ## Contact Us
 
-Have a query or hit upon a problem? Feel free to contact us at [hello@magicbell.io](mailto:hello@magicbell.io).
+Have a query or hit upon a problem? Feel free to contact us at
+[hello@magicbell.io](mailto:hello@magicbell.io).

data/lib/magicbell/api_resources/user.rb

@@ -2,11 +2,13 @@ module MagicBell
   class User < ApiResource
     include ApiOperations
 
-    attr_reader :email
+    attr_reader :email, :external_id
 
     def initialize(client, attributes)
       @client = client
       @email = attributes["email"]
+      @external_id = attributes["external_id"]
+
       super(client, attributes)
     end
 
@@ -38,13 +40,19 @@ module MagicBell
     def path
       if id
         self.class.path + "/#{id}"
+      elsif external_id
+        self.class.path + "/external_id:#{external_id}"
       elsif email
         self.class.path + "/email:#{email}"
       end
     end
 
     def authentication_headers
-      MagicBell.authentication_headers.merge("X-MAGICBELL-USER-EMAIL" => email)
+      if external_id
+        MagicBell.authentication_headers.merge("X-MAGICBELL-USER-EXTERNAL-ID" => external_id)
+      elsif email
+        MagicBell.authentication_headers.merge("X-MAGICBELL-USER-EMAIL" => email)
+      end
     end
   end
 end

data/lib/magicbell/client.rb

@@ -18,15 +18,16 @@ module MagicBell
       MagicBell::Notification.create(self, notification_attributes)
     end
 
-    # def user(user_id)
-    #   MagicBell::User.find(user_id)
-    # end
-
     def user_with_email(email)
       client = self
       MagicBell::User.new(client, "email" => email)
     end
 
+    def user_with_external_id(external_id)
+      client = self
+      MagicBell::User.new(client, "external_id" => external_id)
+    end
+
     def authentication_headers
       MagicBell.authentication_headers(client_api_key: @api_key, client_api_secret: @api_secret)
     end

data/lib/magicbell/version.rb

@@ -1,3 +1,3 @@
 module MagicBell
-  VERSION = '2.1.2'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicbell
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Hana Mohan
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty