simplepush 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3f6d5879cdeeb658ce4b4b3dc7d08164c9295b62a525428303140b3325de225
-  data.tar.gz: 84cba61d1dede58df0e4b85d7d55779af272dc3998366cd3fdcbd7a1a7267e76
+  metadata.gz: 989b00a03ea614f2d48a5f3935950f7bab1746b8e01bc53c50f5852fe8d4e3bb
+  data.tar.gz: 4d3bc2f8436b014e20c3ee046fae76c1a9d37e2b7a978b85952b8e9487e53dfc
 SHA512:
-  metadata.gz: 86c8d97a10963067de04ef6ec756d0df1855cd18aa1ece60d6255e6ebf5b97292ac10caf8e3a1fbcd5de1f62d132faa74a9a9e1a6042761905aad1f06491e699
-  data.tar.gz: b9c2919cd5909f6b77ba83b97ef5f4bc9b1186fe51ba419aac5de7848463a2c26bbeb921acef954d0684065594b55f2cd8aad69e4297a0b80c2646655bdbe78b
+  metadata.gz: 6c188383fb492c3f951a11f2680799879309ad9ae49df09fb4db7dcb420afde9ce134fc6173b2900be0274187a4c6379de0b77d70705e3a9476269f10ffaed49
+  data.tar.gz: 8f0aaa8cb706bcb301a566ceb0a08d4f9157ec96ff49a21175f03dcaff2d53962f96f4c59e997d83741a5cf9ef3e42d515e64f8ba371ec87e3131bb3d873a0ec

data/.gitignore

@@ -6,5 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
-/example/push.sh
 /config.yml

data/README.md

@@ -1,6 +1,6 @@
 # Simplepush Gem for Ruby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/simplepush`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a simple httparty wrapper for [SimplePush.io](https://SimplePush.io).
 
 ## Installation
 
@@ -42,22 +42,58 @@ Simplepush.new('<your key>', "<pass>", "<salt>").send("Title", "Message") # Enry
 
 ## Asynchronous send
 
-The following does not work... `#TODO`
+See [example/async.rb](example/async.rb)
+
+## Usage in Rails
+
+To use in Rails, you need (should?) use a worker gem to avoid that notification calls are blocking your users.
+
+For instance using ActiveJob you could define:
 
 ```ruby
-require 'async' # gem 'async'
+class SimplepushJob < ApplicationJob
+  queue_as :default
 
-s = Simplepush.new('<your key>')
+  def perform(title, message, event=nil)
 
-Sync do
-  100.times do |i|
-    Async do
-      s.send("Title", i.to_s) # Unenrypted
+    simplepush = Rails.cache.fetch("simplepush", expires_in: 1.hour) do
+      cred = Rails.application.credentials.simplepush
+      Simplepush.new(cred[:key], cred[:pass], cred[:salt])
     end
+
+    simplepush.send(title, message, event)
   end
 end
 ```
 
+This takes credentials from Rails `credentials.yml.enc`, which you can edit using `rails credentials:edit`. Add the following:
+
+```yml
+simplepush:
+  key: <your key>
+  pass: <your password>
+  salt: <your salt>
+```
+
+In your code you can then dispatch messages to SimplePush using:
+
+```ruby
+SimplepushJob.perform_later("My app", "User #{current_user.email} perform admin action...")
+```
+
+## Usage with Encryption Notification Gem
+
+Since 0.7.0, this Gem provides an integration with the [Exception Notification Gem](https://github.com/smartinez87/exception_notification). To enable this, add the following to your `environment.rb`:
+
+```ruby
+# production.rb
+config.middleware.use ExceptionNotification::Rack, simplepush: {
+  title_prefix: "[Crash in #{Rails.application.class.module_parent.name}] "
+}
+```
+
+This depends on the credentials defined above. Exceptions which hit the production are then reported via Simplepush.
+
 ## Example of query
 
 The following is a sample of the query as it is produced:
@@ -93,12 +129,13 @@ The following is a sample of the query as it is produced:
  - [x] Encrypted Messages
  - [x] Processing responses
  - [x] Async calls
- - [ ] Example how to integrate into rails to notify of failures
+ - [x] Example how to integrate into rails to notify of failures
 
 ## Changelog
 
  - 0.5.0 Initial Commits
  - 0.6.0 Changing API to cache keys, better examples
+ - 0.7.0 Added support for [Exception Notification Gem](https://github.com/smartinez87/exception_notification)
 
 ## Contributing
 

data/lib/integrations/simplepush_notifier.rb

@@ -0,0 +1,131 @@
+# Only load this file if exception_notification Gem is bundled
+return unless Gem.loaded_specs.has_key? 'exception_notification'
+
+module ExceptionNotifier
+
+  class SimplepushNotifier < BaseNotifier
+
+    attr_reader :client, :default_options
+
+    def initialize(options)
+      cred = Rails.application.credentials.simplepush
+      @client = Simplepush.new(cred[:key], cred[:pass], cred[:salt])
+      @default_options = options
+    end
+
+    def call(exception, options = {})
+      event = SimplepushExceptionEvent.new(exception, options.reverse_merge(default_options))
+      @client.send(event.formatted_title, event.formatted_body)
+    end
+
+    #
+    # This class is responsible to format title and message from given exception and options.
+    #
+    # Adapted from https://github.com/smartinez87/exception_notification/blob/master/lib/exception_notifier/datadog_notifier.rb
+    #   Version: committed on 27 Dec 2019
+    #
+    # Released under MIT license: https://github.com/smartinez87/exception_notification/blob/master/MIT-LICENSE
+    #
+    class SimplepushExceptionEvent
+      include ExceptionNotifier::BacktraceCleaner
+
+      MAX_TITLE_LENGTH = 120
+      MAX_VALUE_LENGTH = 300
+      MAX_BACKTRACE_SIZE = 3
+
+      attr_reader :exception,
+                  :options
+
+      def initialize(exception, options)
+        @exception = exception
+        @options = options
+      end
+
+      def request
+        @request ||= ActionDispatch::Request.new(options[:env]) if options[:env]
+      end
+
+      def controller
+        @controller ||= options[:env] && options[:env]['action_controller.instance']
+      end
+
+      def backtrace
+        @backtrace ||= exception.backtrace ? clean_backtrace(exception) : []
+      end
+
+      def title_prefix
+        options[:title_prefix] || ''
+      end
+
+      def formatted_title
+        title =
+          "#{title_prefix}#{controller_subtitle} (#{exception.class}) #{exception.message.inspect}"
+
+        truncate(title, MAX_TITLE_LENGTH)
+      end
+
+      def formatted_body
+        text = []
+
+        text << formatted_backtrace
+        text << formatted_request if request
+        text << formatted_session if request
+
+        text.join("\n------------------\n")
+      end
+
+      def formatted_key_value(key, value)
+        "#{key}: #{value}"
+      end
+
+      def formatted_request
+        text = []
+        text << '# Request'
+        text << formatted_key_value('URL', request.url)
+        text << formatted_key_value('HTTP Method', request.request_method)
+        text << formatted_key_value('IP Address', request.remote_ip)
+        text << formatted_key_value('Parameters', request.filtered_parameters.inspect)
+        text << formatted_key_value('Timestamp', Time.current)
+        text << formatted_key_value('Server', Socket.gethostname)
+        text << formatted_key_value('Rails root', Rails.root) if defined?(Rails) && Rails.respond_to?(:root)
+        text << formatted_key_value('Process', $PROCESS_ID)
+        text.join("\n")
+      end
+
+      def formatted_session
+        text = []
+        text << '# Session'
+        text << formatted_key_value('Data', request.session.to_hash)
+        text.join("\n")
+      end
+
+      def formatted_backtrace
+        size = [backtrace.size, MAX_BACKTRACE_SIZE].min
+
+        text = []
+        text << '# Backtrace'
+        text << '````'
+        size.times { |i| text << backtrace[i] }
+        text << '````'
+        text.join("\n")
+      end
+
+      def truncate(string, max)
+        string.length > max ? "#{string[0...max]}..." : string
+      end
+
+      def inspect_object(object)
+        case object
+        when Hash, Array
+          truncate(object.inspect, MAX_VALUE_LENGTH)
+        else
+          object.to_s
+        end
+      end
+
+      def controller_subtitle
+        "#{controller.controller_name} #{controller.action_name}" if controller
+      end
+    end
+  end
+end

data/lib/simplepush/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Simplepush
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/lib/simplepush.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "simplepush/version"
+require_relative 'simplepush/version'
 require 'httparty'
+require_relative 'integrations/simplepush_notifier'
 
 class Simplepush
 
@@ -12,7 +13,7 @@ class Simplepush
   # base_uri 'https://httpbin.org'.freeze
   format :json
   default_timeout 5 # 5 seconds
-  # debug_output $stdout # Uncomment to get detailled httparty log output to stdout 
+  # debug_output $stdout # Uncomment to get detailled httparty log output to stdout
 
   # If password and salt are provided, then message and title will be encrypted.
   def initialize(key, password = nil, salt = '1789F0B8C4A051E5')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplepush
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Christopher Oezbek
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-31 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -41,6 +41,7 @@ files:
 - example/async.rb
 - example/config.rb
 - example/example.rb
+- lib/integrations/simplepush_notifier.rb
 - lib/simplepush.rb
 - lib/simplepush/version.rb
 - simplepush.gemspec
@@ -66,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby SimplePush.io API client (unofficial)