magicbell 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 227b2cb36060dcd39e520a0bb39da83c26c51dace5628654e53f6183de9d4f1f
-  data.tar.gz: 8831c5e2e1ecbfb92571274fa2c88ffa5f69e31f584056bbbbd45ba516a40a0e
+  metadata.gz: eedaf7b8daa059db2c0477a2603219d6e5aa4b35d70e6ea53a8054916789952e
+  data.tar.gz: a37230ec4507798ee0399c104d3b7a910619d608bcd68356be3c88c374e4c778
 SHA512:
-  metadata.gz: 9cf7e78a7f15536638a6689c65b1fc2c87138c708c062b6b28744838df205cb2e0f72f6350bba502d57ad12300911bb485e61f54b03fe6e2c6d6b12597ff0f11
-  data.tar.gz: a498534bed9613ec8dbd0c04641fee9a657fd60468a0db903799933665450279e30ffcb13afeaf41b49f3933876b3efb321e1ab3dc6d5f0c834d2d7bb49a0528
+  metadata.gz: 117c76b63a947597ca6eaf21b1c08cd77f718b94aef7c1ecac0ed8def997efee414fb7c2fbabf6e5435cde5678c14bd335ec7b4ff61426e5628af018a500a894
+  data.tar.gz: 7a1103309ed1672be22535373d59ea9c5083e856022008ce4b4078088a704277f70f77267c707c081fe07273074fb6797ede8a252c13775a3bb3dc53c258823d

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_operations.rb

@@ -46,10 +46,14 @@ module MagicBell
         body = JSON.parse(response.body)
         e.errors = body["errors"].is_a?(Array) ? body["errors"] : []
         e.errors.each do |error, index|
-          puts "#{error["suggestion"].red}"
-          puts "#{error["help_link"].blue.on_white}"
+          suggestion = error["suggestion"]
+          help_link = error["help_link"]
+
+          puts "#{suggestion.red}" if suggestion
+          puts "#{help_link.blue.on_white}" if help_link
         end
       end
+
       raise e
     end
   end

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
@@ -40,7 +41,7 @@ module MagicBell
     private
 
     def sha256_digest
-      OpenSSL::Digest::Digest.new('sha256')
+      OpenSSL::Digest.new('sha256')
     end
   end
 end

data/lib/magicbell/version.rb

@@ -1,3 +1,3 @@
 module MagicBell
-  VERSION = '2.1.1'
+  VERSION = '2.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicbell
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 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: 2022-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty