magicbell 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e077cbab9516c5f39de74e8d751cb7f4c02535d20e607c7a1f114b4871d4162
-  data.tar.gz: 2178667f6c4a195fabc1b18088de577890b44318b0503d8ab22ac99b03fdccaf
+  metadata.gz: 76d91ee7dd27c175853dff9ff3dcf5a296dbf58c5151f1a228841a23beb57cc3
+  data.tar.gz: dd40c6308d20d6219ef0d5a7962d4a70f5e0f381bf8911c76eec1d9d3dbcd439
 SHA512:
-  metadata.gz: 9115a61e4752213c1a8fa196bfeec81dfbd0238f9f6726f7aa8d6b8298150883388fed947938bf7208b503c5828dce30d0976b27d2b607bd0fad3e6a2018d365
-  data.tar.gz: 412d96624b8c875f2ebbf422d6891d444ea933ed891ad8fe51bd39dfead821599a87f5a5bcd0bb18f8e63cb7cc68be2638fc6bda085eec1b6a325dbed3c20625
+  metadata.gz: 2eb10d824cc3228716ef4e1f0c4f392d44528e6b961352e382bb8dc8790ec12cafccdb9a9210a4211dc459a436930a5ec1901bdf8fa58ee17bc63cc041c779ab
+  data.tar.gz: 1895cbe977bcd395598963545f057fb2e5bb614faa5b6d57eed185d1892dbef0a90e9aa736a59ac601c6b26478718f1b52a289bb23c3566bd0f0e2126c77652b

data/README.md

@@ -1,18 +1,22 @@
 # magicbell-ruby
 
-[MagicBell](https://magicbell.io) is an embeddable Notification Inbox for web applications.
+[MagicBell](https://magicbell.io) is an embeddable Notification Inbox for web & mobile applications.
+
+Please familiarlize yourself with the [core concepts of MagicBell](https://developer.magicbell.io/docs/core-concepts) before using this gem.
 
 This gem
 
 1. Makes it easy to interact with [MagicBell's REST API](https://developer.magicbell.io/reference) from Ruby.
 
    You can use it to create a notification in your MagicBell project etc.
-3. Can BCC your ActionMailer email notifications to MagicBell if you rather not use MagicBell's API in your Rails application.
-  
-    MagicBell will create an in-app notification from any email notification that's blind copied to it.
-3.  Helps you calculate the HMAC for a user's email when you turn on HMAC Authentication for your MagicBell project
 
-<img width="415" alt="MagicBell Notification Inbox" src="https://user-images.githubusercontent.com/1789832/28327736-f3503f44-6c01-11e7-9a72-c15023db18c6.png">
+2. Can BCC your ActionMailer email notifications to MagicBell if you rather not use MagicBell's API in your Rails application.
+
+   MagicBell will create an in-app notification from any email notification that's blind copied to it.
+
+3. Helps you calculate the HMAC for a user's email or external_id when you turn on [HMAC Authentication](https://developer.magicbell.io/docs/turn-on-hmac-authentication) for your MagicBell project
+
+<img width="415" alt="MagicBell Notification Inbox" src="https://files.readme.io/c09b21a-image1.png">
 
 ## Installation
 
@@ -51,7 +55,7 @@ This gem makes it easy to interact with MagicBell's REST API https://developer.m
 
 ### Create a notification
 
-Send a notification to one or many users
+Send a notification to one or many users by identifying them with their email address
 
 ```ruby
 magicbell = MagicBell::Client.new
@@ -65,6 +69,17 @@ magicbell.create_notification(
 )
 ```
 
+You can also identify users with their `external_id`, which is their ID in your database. That way, if their email address changes, they'd still have access to their notifications. You'll need to make sure you identify them with their `externalID` [in your frontend](https://developer.magicbell.io/docs/browser-js#identifying-users).
+
+```ruby
+     magicbell.create_notification(
+          title: "Welcome to Muziboo",
+          recipients: [{
+            external_id: "id_in_your_database"
+          }]
+        )
+```
+
 You can even provide content for the notification and a URL to redirect the user to when they click on the notification the MagicBell Notification Inbox
 
 ```ruby
@@ -162,7 +177,7 @@ class NotificationMailer < ActionMailer::Base
   def new_comment
     # ...
   end
-  
+
   # This is another email notification in your app
   def mentioned
     # ...
@@ -233,7 +248,14 @@ hmac = MagicBell.hmac(user_email)
 
 See https://developer.magicbell.io/docs/turn-on-hmac-authentication for more information on turning on HMAC Authentication for your MagicBell Project
 
+## API docs
+
+Please visit our website https://magicbell.io and our API docs https://developer.magicbell.io for more information MagicBell's embeddable notification inbox and MagicBell's REST API
+
+## Contact Us
 
-## Developer Hub
+Have a query or hit upon a problem? Create a post in our Developer Community https://community.magicbell.io or contact us at hello@magicbell.io
 
-Please visit our [Developer Hub](https://developer.magicbell.io) for documentation on MagicBell's API and MagicBell's embeddable Notification Inbox
+```
+
+```

data/lib/magicbell/api_operations.rb

@@ -1,44 +1,56 @@
+require 'json'
+require 'colorize'
 module MagicBell
   module ApiOperations
     def get(url, options = {})
-      response = HTTParty.get(
-        url,
-        options.merge(headers: authentication_headers)
-      )
+      defaults = { headers: default_headers }
+      response = HTTParty.get(url, options.merge(defaults))
       raise_http_error_unless_2xx_response(response)
 
       response
     end
 
     def post(url, options = {})
-      response = HTTParty.post(
-        url,
-        options.merge(headers: authentication_headers)
-      )
+      defaults = { headers: default_headers }
+      response = HTTParty.post(url, options.merge(defaults))
       raise_http_error_unless_2xx_response(response)
 
       response
     end
 
     def put(url, options = {})
-      response = HTTParty.put(
-        url,
-        options.merge(headers: authentication_headers)
-      )
+      defaults = { headers: default_headers }
+      response = HTTParty.put(url, options.merge(defaults))
       raise_http_error_unless_2xx_response(response)
 
       response
     end
 
+    protected
+
+    def default_headers
+      authentication_headers.merge({ "Content-Type" => "application/json", "Accept"=> "application/json" })
+    end
+
     private
 
     def raise_http_error_unless_2xx_response(response)
       return if response.success?
+      
       e = MagicBell::Client::HTTPError.new
       e.response_status = response.code
       e.response_headers = response.headers.to_h
       e.response_body = response.body
+      e.errors = []
+      unless e.response_body.nil? || e.response_body.empty?
+        body = JSON.parse(response.body)
+        e.errors = body["errors"]
+        e.errors.each do |error, index|
+          puts "#{error["suggestion"].red}"
+          puts "#{error["help_link"].blue.on_white}"
+        end
+      end
       raise e
     end
   end
-end
+end

data/lib/magicbell/api_resource.rb

@@ -1,4 +1,5 @@
 require "active_support/inflector"
+require "active_support/core_ext/object/blank"
 require "json"
 
 module MagicBell
@@ -8,6 +9,12 @@ module MagicBell
         new(client, attributes).create
       end
 
+      def find(client, id)
+        api_resource = new(client, "id" => id)
+        api_resource.retrieve
+        api_resource
+      end
+
       def name
         to_s.demodulize.underscore
       end
@@ -72,7 +79,7 @@ module MagicBell
       response = @client.post(
         create_url,
         body: { name => attributes }.to_json,
-        headers: authentication_headers
+        headers: extra_headers
       )
       parse_response(response)
 
@@ -83,7 +90,7 @@ module MagicBell
       response = @client.put(
         url,
         body: new_attributes.to_json,
-        headers: authentication_headers
+        headers: extra_headers
       )
       parse_response(response)
 
@@ -92,8 +99,8 @@ module MagicBell
 
     protected
 
-    def authentication_headers
-      MagicBell.authentication_headers
+    def extra_headers
+      {}
     end
 
     private
@@ -109,7 +116,7 @@ module MagicBell
 
     def parse_response(response)
       @response = response
-      unless response.body.empty?
+      unless response.body.blank?
         @response_hash = JSON.parse(@response.body)
         @attributes = @response_hash[name]
       end

data/lib/magicbell/api_resources/user.rb

@@ -15,6 +15,11 @@ module MagicBell
       MagicBell::UserNotifications.new(client, query_params)
     end
 
+    def find_notification(notification_id)
+      client = self
+      MagicBell::UserNotification.find(client, notification_id)
+    end
+
     def mark_all_notifications_as_read
       client = self
       MagicBell::UserNotificationsRead.new(client).create

data/lib/magicbell/api_resources/user_notification_unread.rb

@@ -1,5 +1,5 @@
 module MagicBell
-  class UserNotificationRead < SingletonApiResource
+  class UserNotificationUnread < SingletonApiResource
     attr_reader :user_notification
 
     def initialize(client, attributes)

data/lib/magicbell/client.rb

@@ -3,7 +3,8 @@ module MagicBell
     class HTTPError < StandardError
       attr_accessor :response_status,
                     :response_headers,
-                    :response_body
+                    :response_body,
+                    :errors
     end
 
     include ApiOperations

data/lib/magicbell/version.rb

@@ -1,3 +1,3 @@
 module MagicBell
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicbell
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Hana Mohan
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-03 00:00:00.000000000 Z
+date: 2021-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement