magicbell 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 489e38783982ec38f0044781f6bfdb156d7feb782a4bf51d624659fb35accd25
-  data.tar.gz: 3283ccf989b48e59448386d6471e31bd0e34fb5ef3a33e2ed9df9ec78e11545b
+  metadata.gz: b556f6bac34d0deac121d7b456b3322f918e3f77b4e82f0cdcbd8cef395d32d1
+  data.tar.gz: 6a56c2b7331c5f3296293f8d2a4bbef8b785bdb762e694b506cab3ac28f21b79
 SHA512:
-  metadata.gz: 1c463bee03db65cbde34bc722a5ee368965e56342e0207426daf61337eb1f4fc56b3a394ef4133407beb641b36434085936a81669b9a4f48d78c162453aebee8
-  data.tar.gz: 26906f1128c18a296bd0478682e79c0151bccbf9b21e809ac07a22840e0cf9e79d52c1f1b97c54078c84386c14a9d789793494856d1d65f1630e95c66693a253
+  metadata.gz: a6139d8789a33f4f5cb45216106d86d7f78c9b1fb9743af3115d4ff9f193035a6c3565ebca3195a130529f81d7110ee8fecbbf5790004642b13c4c56887ba53c
+  data.tar.gz: 5f2f592ea6a3f13500a084a468118e2bc6ad68a7d0e48a5a087e728b052fa20bd1b6e17a09faa37fe5ddaf5b55f5b4975a231f330a98421de5fdb0f806937367

data/README.md

@@ -6,10 +6,10 @@ Convert your email notifications to an in-app notification center. This gem make
 
 ## Installation
 
-Add the magicbell-rails gem to your app's Gemfile
+Add the magicbell gem to your app's Gemfile
 
 ```ruby
-gem "magicbell-rails"
+gem "magicbell"
 ```
 
 Run
@@ -18,10 +18,10 @@ Run
 bundle install
 ```
 
-Create the initializer file `config/initializers/magicbell-rails.rb` and add your MagicBell credentials there.
+Create the initializer file `config/initializers/magicbell.rb` and add your MagicBell credentials there.
 
 ```
-vim config/initializers/magicbell-rails.rb
+vim config/initializers/magicbell.rb
 ```
 
 ```ruby
@@ -51,11 +51,11 @@ Create the partial file `config/layouts/_magicbell.html.erb` and copy paste the
   $('<link/>', {
     rel: 'stylesheet',
     type: 'text/css',
-    href: "<%= MagicBell.extras_css_url %>"
+    href: "<%= MagicBell::EXTRAS_CSS_URL %>"
   }).appendTo('head');
   $(document).ready(function () {
     // Initialize the widget after fetching its javascript
-    $.getScript("<%= MagicBell.widget_javascript_url %>", initializeMagicBell);
+    $.getScript("<%= MagicBell::WIDGET_JAVASCRIPT_URL %>", initializeMagicBell);
   });
   function initializeMagicBell() {
     MagicBell.initialize({
@@ -186,8 +186,32 @@ function initializeMagicBell() {
 }
 ```
 
-If you'd like us to add more callbacks to the widget, reach out to us at hana@supportbee.com
+
+## Managing notifications
+
+### Creating a notification
+
+You can create notifications for users. Once `MagicBell` is configured, you can
+call `create_notification` method to create a notification for a given project.
+
+```
+params = {
+  to: "user@example.com",
+  title: "Your download is ready",
+  content: "Zip file to download is here",
+  action_url: "https://example.com/notifications/1"
+}
+
+client = MagicBell::Client.new()
+client.create_notification(params)
+```
+
+The response will be a Faraday response object, and methods like `status` and
+`body` will be available for further inspection.
+
+
+If you'd like us to add more callbacks to the widget, reach out to us at hana@magicbell.io
 
 ## Documentation
 
-Visit our [Docs Site](https://magicbell.supportbee.com/149-magicbell-s-help-docs) for more information on MagicBell, MagicBell's widget and Advanced Features.
+Visit our [Docs Site](https://docs.magicbell.io) for more information on MagicBell, MagicBell's widget and Advanced Features.

data/lib/magicbell.rb

@@ -1,12 +1,21 @@
 require "magicbell/config"
 require "magicbell/hmac"
 require "magicbell/user"
+require "magicbell/railtie" if defined?(Rails)
+require "magicbell/client"
+
+require 'forwardable'
 
 
 module MagicBell
-  CLOUDFRONT_DOMAIN = "dxd8ma9fvw6e2.cloudfront.net"
+  WIDGET_JAVASCRIPT_URL = "https://assets.magicbell.io/widget.magicbell.js"
+  EXTRAS_CSS_URL = "https://assets.magicbell.io/extras.magicbell.css"
 
   class << self
+    extend Forwardable
+
+    def_delegators :@config, :api_key, :api_secret, :project_id, :magic_address, :api_host
+
     def configure
       yield(config)
     end
@@ -19,35 +28,6 @@ module MagicBell
       @config = nil
     end
 
-    def extras_css_url
-      "//#{CLOUDFRONT_DOMAIN}/extras.magicbell.css"
-    end
-    alias_method :host_page_css_url, :extras_css_url # Backward compatibility
-
-    def api_host
-      config.api_host
-    end
-
-    def widget_javascript_url
-      "//#{CLOUDFRONT_DOMAIN}/widget.magicbell.js"
-    end
-
-    def api_key
-      config.api_key
-    end
-
-    def api_secret
-      config.api_secret
-    end
-
-    def project_id
-      config.project_id
-    end
-
-    def magic_address
-      config.magic_address
-    end
-
     def project_specific_headers
       {
         'X-MAGICBELL-API-KEY' => config.api_key,
@@ -61,5 +41,3 @@ module MagicBell
     end
   end
 end
-
-require "magicbell/railtie"

data/lib/magicbell/client.rb

@@ -0,0 +1,13 @@
+require "magicbell/client/notifications"
+
+module MagicBell
+  class Client
+    include MagicBell::Client::Notifications
+
+    # Returns an authenticated connection object which can be
+    # used to make requests
+    def connection
+      @connection ||= Faraday.new(url: MagicBell.api_host)
+    end
+  end
+end

data/lib/magicbell/client/notifications.rb

@@ -0,0 +1,20 @@
+module MagicBell
+  class Client
+    module Notifications
+      # Creates a notification for a given project
+      #
+      # @param to [String] Email of a user for this notification
+      # @param title [String] Title of the notification
+      # @param content [String] Content of the notification
+      # @param action_url [String] Url to redirect to from widget
+      def create_notification(to, title, content, action_url)
+        params = {to: to, title: title, content: content, action_url: action_url}
+
+        connection.post("/notifications.json") do |req|
+          req.headers = {"X-MAGICBELL-API-SECRET" => MagicBell.api_secret}
+          req.body = {notification: params}
+        end
+      end
+    end
+  end
+end

data/lib/magicbell/user.rb

@@ -1,4 +1,5 @@
 require 'faraday'
+require 'json'
 
 module MagicBell
   class User
@@ -37,4 +38,4 @@ module MagicBell
     end
     
   end
-end
+end

data/lib/magicbell/version.rb

@@ -1,3 +1,3 @@
 module MagicBell
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: magicbell
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Hana Mohan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-22 00:00:00.000000000 Z
+date: 2020-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,9 +80,10 @@ files:
 - Rakefile
 - lib/magicbell.rb
 - lib/magicbell/action_mailer_extension.rb
+- lib/magicbell/client.rb
+- lib/magicbell/client/notifications.rb
 - lib/magicbell/config.rb
 - lib/magicbell/hmac.rb
-- lib/magicbell/init/rails.rb
 - lib/magicbell/railtie.rb
 - lib/magicbell/user.rb
 - lib/magicbell/version.rb

data/lib/magicbell/init/rails.rb

@@ -1,27 +0,0 @@
-require 'rails'
-require 'yaml'
-
-module MagicBell
-  module Init
-    module Rails
-      class Railtie < ::Rails::Railtie
-        #rake_tasks do
-        #  load 'magicbell/tasks.rb'
-        #end
-
-        config.after_initialize do
-          MagicBell.init!({
-            :root           => ::Rails.root.to_s,
-            :env            => ::Rails.env,
-            :'config.path'  => ::Rails.root.join('config', 'magicbell.yml'),
-            :logger         => Logging::FormattedLogger.new(::Rails.logger),
-            :framework      => :rails
-          })
-          MagicBell.load_plugins!
-        end
-      end
-    end
-  end
-end
-
-MagicBell.install_at_exit_callback