notifications_opener 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6cadc4fb66af2f831b90f3f7b19d2482160a56c
-  data.tar.gz: 276c9ec2a0998abe9ea187504ed1d0c517b702cf
+  metadata.gz: 73460d17fb8bd6f0f018b8fbfd7da6136adc50ea
+  data.tar.gz: 09bcb14762bfce0381b52c51779c51c5bda58079
 SHA512:
-  metadata.gz: 893b8ced489af284a16d2c0d459fc5b5cc3aadbb356660a5f810b6d2d7b648af00fb9749139b938939a48032773c0a94b223b8718cb0e325fb23c934e226f14e
-  data.tar.gz: b9babedc4ac5b7ecf4583cc2d42e171baec1cb08002559e3895d19c506192b0646bcc022b95a01f6b75e88bb0f8f79ed5bce341c3e3baf24bcc2fe5f395446cb
+  metadata.gz: 22ee94c4749f15356b7a60ba03670e49f47fb937b036ad51db7424d32e4af07269e2898d936563480ec7ab0354c0af7633753921903e732ae8bf9bfeb1623f7d
+  data.tar.gz: 8ec7c6309b5a80a6b8fa854a87e0c6779e8b090d1ca86fb15e1b3a85ed8ab963b1603ed821e1346cd371a1b9699c059311b41ad4c76f64e6109b4d344528d590

data/README.md

@@ -1,8 +1,6 @@
-# NotificationsOpener
+# Notifications Opener
 
-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/notifications_opener`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Blocks SMSs from being delivered in development. Instead opens a preview in the browser by intercepting the request to the configured SMS API.
 
 ## Installation
 
@@ -22,7 +20,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add the following configuration in your `development.rb`. The following is an example for springedge. It will probably differ based on your provider.
+
+```ruby
+# Blocks SMSs from being delivered in development
+# Instead opens a preview in the browser by intercepting the request to
+# the configured SMS API
+NotificationsOpener.configure do | c |
+  # Param name for the sender that will be passed to the SMS API
+  c[:from_key_name] = "sender"
+
+  # Param name for the receiver that will be passed to the SMS API
+  c[:to_key_name] = "to"
+
+  # Param name for the message that will be passed to the API
+  c[:message_key_name] = "message"
+
+  # Location to store the preview email files, usually tmp
+  c[:location] = Rails.root.join("tmp").to_s
+
+  # The SMS API call to intercept
+  c[:url] = /.*alerts.springedge.com.*/
+end
+```
 
 ## Development
 
@@ -32,4 +52,4 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/notifications_opener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhisheksarka/notifications_opener. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/notifications_opener/interceptor.rb

@@ -1,9 +1,14 @@
+##
+# This class represents as an interceptor for the HTTP requests to the
+# specified URL
+
 require 'webmock'
 require 'rack'
 
-
+##
 # On requiring webmock it disables HTTP connections by default
-# so we need to call this method after requiring it
+# so we need to call this method after requiring it, since we only
+# want stub the url that has been passed in the configuration
 WebMock.allow_net_connect!
 
 module NotificationsOpener
@@ -14,9 +19,13 @@ module NotificationsOpener
     def initialize(config)
       @config = config
       @response_handler = ResponseHandler.new(config)
-      intercept_and_redirect_to_rack_app
     end
 
+    ##
+    # Stubs all HTTP requests to the specified URL
+    # We also need to process the response to figure
+    # out the sender, receiver and the message so we
+    # pass it on a rack application
     def intercept_and_redirect_to_rack_app
       WebMock.stub_request(:any, config[:url]).to_rack(response_handler)
     end

data/lib/notifications_opener/message.rb

@@ -1,3 +1,6 @@
+##
+# This class represents builds a usable message based on the parameters
+
 require 'erb'
 require 'launchy'
 
@@ -20,19 +23,25 @@ module NotificationsOpener
       @file_path = get_file_path
     end
 
+    # #
+    # Creates the file with the interpolated content in the specified location
+    # Opens it up in a browser from preview
     def deliver
       File.open(file_path, 'w') { | file | file.write(rendered_content) }
       Launchy.open("file:///#{URI.parse(file_path)}")
     end
 
-    def template
-      File.read(File.expand_path("../message.html.erb", __FILE__))
-    end
-
+    # #
+    # Uses the message template and binds the instance variable to the template
+    # to generate the final markup
     def rendered_content
       ERB.new(template).result(binding)
     end
 
+    def template
+      File.read(File.expand_path("../message.html.erb", __FILE__))
+    end
+    
     def get_file_path
       location + '/' + SecureRandom.hex + '.html'
     end

data/lib/notifications_opener/response_handler.rb

@@ -1,3 +1,7 @@
+##
+# The (instance of)class represents a Rack application
+# Responsible to handle a stubbed request manually
+
 module NotificationsOpener
   class ResponseHandler
     attr_accessor :config,

data/lib/notifications_opener/version.rb

@@ -1,3 +1,3 @@
 module NotificationsOpener
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/notifications_opener.rb

@@ -5,11 +5,22 @@ require "notifications_opener/interceptor"
 require 'fileutils'
 
 module NotificationsOpener
+
+  # #
+  # Configure the module by passing required options
+  #
+  # * url - The SMS API URL
+  # * location - Generated preview files will stored here, usually tmp
+  # * from_key_name - The parameter name you pass to the SMS API that identifies the sender
+  # * to_key_name - The parameter name you pass to the SMS API that identifies the receiver
+  # * message_key_name - The parameter name you pass to the SMS API that identifies the message
   def self.configure
     c = { }
     yield(c)
     create_storage_directory(c)
     ins = Interceptor.new(c)
+    ins.intercept_and_redirect_to_rack_app
+    ins
   end
 
   private

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications_opener
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - abhisheksarka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-07 00:00:00.000000000 Z
+date: 2016-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler