notifications_opener 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 883f8b5c7c2d01571e1c0eab6304dce6be1b8b85
-  data.tar.gz: 50e31296b78f07f8735a3d1a674ae749f2fd0c9f
+  metadata.gz: cbe997acbef7f55540dfe1e8742d55924d090b0e
+  data.tar.gz: 477e395a0513975bb2c8d2ae34aec3a47ce9f1c8
 SHA512:
-  metadata.gz: 2ccef8872761f72855b4c71bc48e4b3c9986321ded79533eed8bbe81d9001efef09afc4918c3b9c63fc54ff54b3e3e6df134b7e1d1ef0dd687d8a7ebfbb4caac
-  data.tar.gz: c7496ad12e0bfa3762ee66ea7de660e2a28cecd9fc1789a2f214d8de6777744d19730e72e93cb9e16d96a40e71d820e0d1e33b6e709cc18baaeb9363e76009d0
+  metadata.gz: f2015ace7ef91a4ad247068a8ab3584f8bf84af5612b97a19b4b0ddb1e7a1f7a87573c427511fb3e253ac12d7e78d465fb13aa79cad4a12cc192936419fbe88f
+  data.tar.gz: 8b490c37b4d2579874adff4f07953c6c41bfef3088397fbe552aee7775e40589c8f773edff5580f100e9fb54c0d051b07bf9be60cb7a639c52fb22af65990e86

data/README.md

@@ -4,6 +4,9 @@
 
 Blocks SMSs from being delivered in development. Instead opens a preview in the browser by intercepting the request to the configured SMS API.
 
+<img src="https://s13.postimg.org/r6yadbbg7/Screen_Shot_2016_10_03_at_5_35_05_PM.png" width="350"/>
+<img src="https://s13.postimg.org/5w0q91tbr/Screen_Shot_2016_10_03_at_5_32_34_PM.png" width="350"/>
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -44,14 +47,91 @@ NotificationsOpener.configure do | c |
   # The SMS API call to intercept
   c[:url] = /.*alerts.springedge.com.*/
 end
+
+
+# For Android Notifications
+NotificationsOpener.configure(:android) do | c |
+  # The GCM API call to intercept
+  c[:url] = /.*android.googleapis.com\/gcm.*/
+  c[:location] = '/tmp'
+end
+
 ```
 
-## Development
+## Development and Experimentation
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### SMS Notifications
+Copy and paste the following lines of code after you run `bin/console` from the gem directory
+
+```ruby
+NotificationsOpener.configure(:sms) 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] = '/tmp'
+
+  # The SMS API call to intercept
+  c[:url] = /.*alerts.springedge.com.*/
+end
+Net::HTTP.get('alerts.springedge.com', '/?to=8095456768&sender=NSTWY&message=Hello')
+```
+
+### Android Notifications
+Copy and paste the following lines of code after you run `bin/console` from the gem directory
+
+```ruby
+NotificationsOpener.configure(:android) do | c |
+  # The GCM API call to intercept
+  c[:url] = /.*android.googleapis.com\/gcm.*/
+  c[:location] = '/tmp'
+end
+
+data = {
+  "to" => "111111111",
+  "data" => {
+    "type" => "10041",
+    "message" => "You are required to pay an amount of 2500.0 against Rent september. Click here to view & pay",
+    "img_link" => nil,
+    "title" => "Payment update",
+    "time" => "1475480496",
+    "deep_link_url" => nil,
+    "data_json" => nil,
+    "short_msg" => "You are required to pay an amount of 200.0",
+    "action_button" => [
+      {
+        "text" => "View details",
+        "screen" => "5",
+        "data_json" => nil,
+        "deep_link_url" => ""
+      }
+    ]
+  }
+}
+params = {
+  :body => data.to_json,
+  :headers => {
+    'Content-Type' => 'application/json',
+    'Authorization' => "key=#{@api_key}"
+  }
+}
+require 'httparty'
+include HTTParty
+
+self.class.post('http://android.googleapis.com/gcm', params)
+```
+
+
 ## Contributing
 
 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.rb

@@ -1,5 +1,5 @@
 require "notifications_opener/version"
-require "notifications_opener/message"
+require "notifications_opener/handler/handler"
 require "notifications_opener/response_handler"
 require "notifications_opener/interceptor"
 require 'fileutils'
@@ -14,11 +14,11 @@ module NotificationsOpener
   # * 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
+  def self.configure(type=:sms)
     c = { }
     yield(c)
     create_storage_directory(c)
-    ins = Interceptor.new(c)
+    ins = Interceptor.new(c, type)
     ins.intercept_and_redirect_to_rack_app
     ins
   end

data/lib/notifications_opener/handler/android.rb

@@ -0,0 +1,24 @@
+require 'json'
+
+module NotificationsOpener
+  module Handler
+    class Android < Base
+      attr_accessor :to,
+                    :message,
+                    :title,
+                    :params
+
+      def initialize(config, env)
+        super(config, env)
+        @params = JSON.parse(env["rack.input"].read)
+        @to = @params['to']
+        @message = @params['data']['message']
+        @title = @params['data']['title']
+      end
+
+      def notification_type
+        'android'
+      end
+    end
+  end
+end

data/lib/notifications_opener/handler/base.rb

@@ -0,0 +1,46 @@
+require 'erb'
+require 'launchy'
+
+module NotificationsOpener
+  module Handler
+    class Base
+      attr_accessor :config,
+                    :env,
+                    :file_path
+
+      def initialize(config, env)
+        @config = config
+        @env = env
+        @file_path = generate_file_path
+        @notification_type = notification_type.capitalize
+      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
+
+      # #
+      # 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("../../template/#{notification_type}.html.erb", __FILE__))
+      end
+
+      def generate_file_path
+        config[:location] + '/' + SecureRandom.hex + '.html'
+      end
+
+      def notification_type
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/notifications_opener/handler/handler.rb

@@ -0,0 +1,8 @@
+require_relative './base'
+require_relative './sms'
+require_relative './ios'
+require_relative './android'
+module NotificationsOpener
+  module Handler
+  end
+end

data/lib/notifications_opener/handler/ios.rb

@@ -0,0 +1,9 @@
+module NotificationsOpener
+  module Handler
+    class Ios < Base
+      def notification_type
+        'ios'
+      end
+    end
+  end
+end

data/lib/notifications_opener/handler/sms.rb

@@ -0,0 +1,39 @@
+module NotificationsOpener
+  module Handler
+    class Sms < Base
+      attr_accessor :from,
+                    :to,
+                    :message
+
+      def initialize(config, env)
+        super(config, env)
+        c = build_params(env['QUERY_STRING'])
+        @from = c[:from]
+        @to = c[:to]
+        @message = c[:message]
+      end
+
+      def notification_type
+        'sms'
+      end
+
+      private
+
+      def build_params(q)
+        p = { }
+
+        q.split('&').each do |kv|
+          kv = kv.split('=')
+          p[kv[0]] = kv[1]
+        end
+
+        {
+          from: p[config[:from_key_name]],
+          to: p[config[:to_key_name]],
+          message: URI.decode(p[config[:message_key_name]]),
+          location: config[:location]
+        }
+      end
+    end
+  end
+end

data/lib/notifications_opener/interceptor.rb

@@ -12,11 +12,13 @@ module NotificationsOpener
   # specified URL
   class Interceptor
     attr_accessor :config,
-                  :response_handler
+                  :response_handler,
+                  :type
 
-    def initialize(config)
+    def initialize(config, type)
       @config = config
-      @response_handler = ResponseHandler.new(config)
+      @type = type
+      @response_handler = ResponseHandler.new(config, type)
     end
 
     ##

data/lib/notifications_opener/response_handler.rb

@@ -4,39 +4,21 @@ module NotificationsOpener
   # Responsible to handle a stubbed request manually
   class ResponseHandler
     attr_accessor :config,
+                  :type,
                   :message
 
-    def initialize(config)
+    def initialize(config, type)
       @config = config
+      @type = type
     end
 
     def call(env)
-      message_params = get_required_params(env['QUERY_STRING'])
-      @message = NotificationsOpener::Message.new(message_params)
-      message.deliver
+      @message = Object
+                  .const_get("NotificationsOpener::Handler::#{type.capitalize}")
+                  .new(config, env)
 
+      message.deliver
       [200, {}, []]
     end
-
-    private
-
-    def get_required_params(q)
-      p = get_params_from_query_string(q)
-      {
-        from: p[config[:from_key_name]],
-        to: p[config[:to_key_name]],
-        message: URI.decode(p[config[:message_key_name]]),
-        location: config[:location]
-      }
-    end
-
-    def get_params_from_query_string(q)
-      p = {}
-      q.split('&').each do |kv|
-        kv = kv.split('=')
-        p[kv[0]] = kv[1]
-      end
-      p
-    end
   end
 end

data/lib/notifications_opener/template/android.html.erb

@@ -0,0 +1,84 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type">
+    <title>Notifications Opener</title>
+
+    <style type="text/css">
+      body {
+        font-family: Arial;
+        font-weight: 100;
+      }
+      #container {
+        margin: 10px auto;
+        position: relative;
+      }
+      #screen-head {
+        text-align: center;
+        font-weight: 100;
+        opacity: 0.5;
+      }
+      #phone {
+        width: 300px;
+        height: 530px;
+        border: 10px solid #333;
+        border-top-width: 50px;
+        border-bottom-width: 50px;
+        border-radius: 15px;
+        position: relative;
+        top: 10px;
+        margin-left: auto;
+        margin-right: auto;
+        background: #111;
+      }
+      #text-container {
+        color: white;
+        background: #111;
+        border-radius: 3px;
+        padding: 10px;
+        margin: 10px;
+        border-bottom: 1px solid #222;
+      }
+      #message-content {
+        font-size: 11px;
+      }
+      #title-content {
+        opacity: 0.5;
+        font-size: 13px;
+      }
+      .text-center {
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="container">
+      <h1 id="screen-head">Android/GCM Notification</h1>
+      <div id="phone">
+        <div id="text-container">
+          <div id="title-content">
+            <%= title %>
+          </div><br>
+          <div id="message-content">
+            <%= message %>
+          </div>
+        </div>
+      </div>
+      <br>
+      <div class="text-center">
+        <p><strong>Configuration Hash</strong></p>
+        <%= config %>
+      </div>
+      <div class="text-center">
+        <p><strong>Params Hash</strong></p>
+        <%= params %>
+      </div>
+    </div>
+
+    <script type="text/javascript">
+      /*! srcdoc-polyfill - v0.1.1 - 2013-03-01
+      * http://github.com/jugglinmike/srcdoc-polyfill/
+      * Copyright (c) 2013 Mike Pennisi; Licensed MIT */
+      (function(t,e){var c,n,o=t.srcDoc,r=!!("srcdoc"in e.createElement("iframe")),i={compliant:function(t,e){e&&t.setAttribute("srcdoc",e)},legacy:function(t,e){var c;t&&t.getAttribute&&(e?t.setAttribute("srcdoc",e):e=t.getAttribute("srcdoc"),e&&(c="javascript: window.frameElement.getAttribute('srcdoc');",t.setAttribute("src",c),t.contentWindow&&(t.contentWindow.location=c)))}},s=t.srcDoc={set:i.compliant,noConflict:function(){return t.srcDoc=o,s}};if(!r)for(s.set=i.legacy,n=e.getElementsByTagName("iframe"),c=n.length;c--;)s.set(n[c])})(this,this.document);
+    </script>
+  </body>
+</html>

data/lib/notifications_opener/template/sms.html.erb

@@ -0,0 +1,84 @@
+<html>
+  <head>
+    <meta http-equiv="Content-Type">
+    <title>Notifications Opener</title>
+
+    <style type="text/css">
+      body {
+        font-family: Arial;
+        font-weight: 100;
+      }
+      #screen-head {
+        text-align: center;
+        font-weight: 100;
+        opacity: 0.5;
+      }
+      #container {
+        margin: 10px auto;
+        position: relative;
+      }
+      #phone {
+        width: 300px;
+        height: 530px;
+        border: 10px solid #333;
+        border-top-width: 50px;
+        border-bottom-width: 50px;
+        border-radius: 15px;
+        position: relative;
+        top: 10px;
+        margin-left: auto;
+        margin-right: auto;
+      }
+      #phone-head {
+        color: #333;
+        border-bottom: 1px solid lightgray;
+        min-height: 30px;
+        background: #efefef;
+        padding: 10px;
+        font-size: 13px;
+      }
+      #text-container {
+        color: white;
+        background: #0e86fe;
+        border-radius: 3px;
+        padding: 10px;
+        margin: 10px;
+        font-size: 13px;
+      }
+      .text-center {
+        text-align: center;
+      }
+    </style>
+  </head>
+  <body>
+    <div id="container">
+      <h1 id="screen-head">SMS Notification</h1>
+      <div id="phone">
+        <div id="phone-head">
+          <span>From: <strong><%= from %></strong></span>
+          <br>
+          <span>To: <strong><%= to %></strong></span>
+        </div>
+        <div id="text-container">
+          <%= message %>
+        </div>
+      </div>
+      <br>
+      <div class="text-center">
+        <p><strong>Configuration Hash</strong></p>
+        <%= @config %>
+      </div>
+      <div class="text-center">
+        <p><strong>Params Hash</strong></p>
+        <%= { 'from'=>@from, 'to'=>@to, 'message'=>@message } %>
+      </div>
+    </div>
+
+    <script type="text/javascript">
+      /*! srcdoc-polyfill - v0.1.1 - 2013-03-01
+      * http://github.com/jugglinmike/srcdoc-polyfill/
+      * Copyright (c) 2013 Mike Pennisi; Licensed MIT */
+      (function(t,e){var c,n,o=t.srcDoc,r=!!("srcdoc"in e.createElement("iframe")),i={compliant:function(t,e){e&&t.setAttribute("srcdoc",e)},legacy:function(t,e){var c;t&&t.getAttribute&&(e?t.setAttribute("srcdoc",e):e=t.getAttribute("srcdoc"),e&&(c="javascript: window.frameElement.getAttribute('srcdoc');",t.setAttribute("src",c),t.contentWindow&&(t.contentWindow.location=c)))}},s=t.srcDoc={set:i.compliant,noConflict:function(){return t.srcDoc=o,s}};if(!r)for(s.set=i.legacy,n=e.getElementsByTagName("iframe"),c=n.length;c--;)s.set(n[c])})(this,this.document);
+    </script>
+  </body>
+</html>

data/lib/notifications_opener/version.rb

@@ -1,3 +1,3 @@
 module NotificationsOpener
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 end

data/notifications_opener.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'httparty'
 
   spec.add_dependency 'webmock', '>= 1.0'
   spec.add_dependency 'rack'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: notifications_opener
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - abhisheksarka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-08 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -110,10 +124,16 @@ files:
 - bin/console
 - bin/setup
 - lib/notifications_opener.rb
+- lib/notifications_opener/handler/android.rb
+- lib/notifications_opener/handler/base.rb
+- lib/notifications_opener/handler/handler.rb
+- lib/notifications_opener/handler/ios.rb
+- lib/notifications_opener/handler/sms.rb
 - lib/notifications_opener/interceptor.rb
-- lib/notifications_opener/message.html.erb
-- lib/notifications_opener/message.rb
 - lib/notifications_opener/response_handler.rb
+- lib/notifications_opener/template/android.html.erb
+- lib/notifications_opener/template/ios.html.erb
+- lib/notifications_opener/template/sms.html.erb
 - lib/notifications_opener/version.rb
 - notifications_opener.gemspec
 homepage: https://github.com/abhisheksarka/notifications_opener
@@ -140,4 +160,3 @@ signing_key:
 specification_version: 4
 summary: Preview notifications/SMS in browser instead of sending.
 test_files: []
-has_rdoc: 

data/lib/notifications_opener/message.rb

@@ -1,48 +0,0 @@
-require 'erb'
-require 'launchy'
-
-module NotificationsOpener
-  ##
-  # This class represents builds a usable message based on the parameters
-  class Message
-    attr_accessor :config,
-                  :from,
-                  :to,
-                  :message,
-                  :location,
-                  :file_path
-
-    def initialize(config)
-      @config = config
-      @from = config[:from]
-      @to = config[:to]
-      @message = config[:message]
-
-      @location = config[:location]
-      @file_path = generate_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
-
-    # #
-    # 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 generate_file_path
-      location + '/' + SecureRandom.hex + '.html'
-    end
-  end
-end