RubyGems - sads_xml - Versions diffs - 0.0.1 - Mend

sads_xml 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright 2012 InnoHub, Inc.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README ADDED Viewed

@@ -0,0 +1,8 @@
+SadsXml
+=======
+Rails plugin for Eyeline's SADS XML format.
+This is a work in progress.
+Copyright (c) 2012 [Andrew Angelo Ang], released under the MIT license

data/Rakefile ADDED Viewed

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SadsXml'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+Bundler::GemHelper.install_tasks
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+task :default => :test

data/app/views/layouts/sads_xml.html.erb ADDED Viewed

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>SADS Emulator</title>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/sads_xml/sads.html.erb ADDED Viewed

@@ -0,0 +1,126 @@
+<style type="text/css">
+  #ussd-info {
+    margin-top: 8px;
+    margin-bottom: 8px;
+    padding: 8px;
+    font-family: verdana;
+    background: green;
+    color: white;
+  }
+  #screen {
+    font-family: Menlo, Monaco, Consolas, Monospace;
+    font-size: 1em;
+    width: 360px;
+    background: #AAA;
+    padding: 8px;
+    float: left;
+  }
+  #sms {
+    font-family: Menlo, Monaco, Consolas, Monospace;
+    font-size: 1em;
+    width: 360px;
+    padding: 8px;
+    float: left;
+    float: left;
+    background: #DDD;
+  }
+  #forms {
+    margin-top: 8px;
+    margin-bottom: 8px;
+    padding: 8px;
+    font-family: verdana;
+    background: green;
+    color: white;
+  }
+  .clear { clear: both; }
+</style>
+<div id="ussd-info">
+  <table>
+    <tr>
+      <th>Length</th>
+      <th>Pages</th>
+    </tr>
+    <tr>
+      <td><%= @sads.ussd_length %></td>
+      <td>Not Implemented</td>
+    </tr>
+  </table>
+</div>
+<div id="phone-viewport">
+  <div id="screen">
+    <% unless @sads.title.blank? %>
+      <%= @sads.title %>:
+      <br />
+    <% end %>
+    <% if @sads.banner_position == :top and @sads.banner_targets.any? -%>
+      {Ad=[<%= @sads.banner_targets.join(',') %>]}
+      <br />
+    <% end -%>
+    <% @sads.messages.each do |key, message| -%>
+      <% if key != :bottom -%>
+        <%= raw message.gsub(/\r/, '<br />') -%>
+        <br />
+      <% end -%>
+    <% end -%>
+    <% @sads.navigations.each do |key,links| %>
+      <% links.each do |link| %>
+        <% link[:pageId] = link[:pageId] %>
+        <% if link[:pageId].index("?") %>
+          <% link[:pageId].sub!("?", "?abonent=#{CGI.escape(params[:abonent])}&") %>
+        <% else %>
+          <% link[:pageId] += "?abonent=#{CGI.escape(params[:abonent])}" %>
+        <% end %>
+        <%= link_to raw("#{link[:accesskey]}&gt;#{link[:title]}"), link[:pageId] %>
+        <br />
+      <% end %>
+    <% end %>
+    <% @sads.messages.each do |key, message| %>
+      <% if key == :bottom %>
+        <%= raw message.gsub(/\r/, '<br />') %>
+        <br />
+      <% end %>
+    <% end %>
+    <% @sads.inputs.each do |input| %>
+      <%= input[:title] %>&gt;<br />
+    <% end %>
+    <% if @sads.banner_position == :bottom and @sads.banner_targets.any? %>
+      {Ad=[<%= @sads.banner_targets.join(',') %>]}
+    <% end %>
+  </div>
+  <div id="sms">
+    <% if not @sads.sms_message.blank? %>
+      <%= raw @sads.sms_message.gsub(/\r/, '<br />') %>
+    <% end %>
+  </div>
+  <div class="clear"></div>
+  <div id="forms">
+    Emulated (Not shown on Phone)
+    <% @sads.inputs.each do |input| %>
+      <% submit_page = @sads.submit_page %>
+      <% if submit_page.index("?") %>
+        <% submit_page.sub!("?", "?abonent=#{CGI.escape(params[:abonent])}&") %>
+      <% else %>
+        <% submit_page += "?abonent=#{CGI.escape(params[:abonent])}" %>
+      <% end %>
+      <%= form_tag submit_page do |f| %>
+        <label><%= input[:title] %>:</label> <%= text_field_tag input[:name], '' %>
+        <%= submit_tag 'Submit' %>
+      <% end %>
+      <hr />
+    <% end %>
+  </div>
+</div>

data/lib/sads_xml/controller_additions.rb ADDED Viewed

@@ -0,0 +1,61 @@
+module SadsXml
+  module ControllerAdditions
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    module ClassMethods
+      def enable_sads
+        send :include, InstanceMethods
+        skip_before_filter :verify_authenticity_token
+        around_filter :process_sads_request
+      end
+    end
+    module InstanceMethods
+      def process_sads_request
+        setup_sads_request
+        yield
+        # Check ActionController::Responder
+        # This doesn't work for now, see how to implement this
+        # for DRYing the methods in the controller
+        # respond_with_sads
+      end
+      def setup_sads_request
+        # Get WHOISD Parameters
+        if params[:format] == 'sads'
+          @whoisd = {}
+          request.headers.each {|k,v| @whoisd[k] = v if k.match(/^HTTP_WHOISD/) }
+          logger.info "  WHOISD: #{@whoisd.inspect}"
+        end
+        # The code below tries to emulate a SADS request
+        # this assumes that both are blank
+        if params[:format] == 'html'
+          params[:abonent] = '639990000000' if params[:abonent].nil?
+          params[:protocol] = 'ussd' if params[:protocol].nil?
+        end
+        @sads = Sads.new
+      end
+      def respond_with_sads
+        respond_to do |format|
+          format.html { render :template => 'sads_xml/sads', :layout => 'sads_xml' }
+          format.sads { render :xml => @sads.to_sads }
+        end
+      end
+    end
+  end
+end
+if defined? ActionController
+  ActionController::Base.class_eval do
+    include SadsXml::ControllerAdditions
+  end
+end

data/lib/sads_xml/sads.rb ADDED Viewed

@@ -0,0 +1,166 @@
+require 'builder'
+# Examples
+#<?xml version="1.0" encoding="UTF-8"?>
+#<page version="2.0" xmlns:meta="http://whoisd.eyeline.com/sads/meta">
+#  <title id="">DPC Mobile: Search by Person</title>
+#  <div>Please enter name of Person</div>
+#  <navigation id="">
+#    <link accesskey="*" pageId="search_by_person_submit"></link>
+#  </navigation>
+#</page>
+#
+#<?xml version="1.0" encoding="UTF-8"?>
+#<page version="2.0" xmlns:meta="http://whoisd.eyeline.com/sads/meta">
+#<title id="">DPC Mobile: Search by Person</title>
+#  <div>
+#    <input navigationId="submit" name="name_of_person" title="Please enter name of Person" />
+#  </div>
+#  <navigation id="submit">
+#    <link accesskey="1" pageId="search_by_person_submit">Ok</link>
+#  </navigation>
+#</page>
+module SadsXml
+  class Sads
+    attr_accessor :title, :messages, :navigations, :inputs, :submit_page, :sms_message,
+      :banner_targets, :banner_position, :request_attributes
+    DEFAULTS = {
+      :navigation => {
+        :type => 'nav'
+      }
+    }
+    def initialize
+      @title = ''
+      @inputs = []
+      @navigations = { :default => [] }
+      @messages = {}
+      @banner_targets = []
+      @banner_position = :top
+      @request_attributes = []
+    end
+    def message=(message)
+      self.set_message(:default, message)
+    end
+    def submit_page=(page_link)
+      # workaround for SADS Absolute Path
+      #page_link.gsub!(/^\/yp_mobile\//, '') unless page_link.match(/\.html$/)
+      @submit_page = page_link
+    end
+    def ussd_length
+      counter = 0
+      counter += @title.length + 2 unless @title.blank?
+      @messages.each do |key, message|
+        counter += message.length + 1 unless message.blank?
+      end
+      @navigations.each do |key, links|
+        links.each do |link|
+          counter += link[:title].length + link[:accesskey].length + 2
+        end
+      end
+      @inputs.each do |input|
+        counter += input[:title].length + 2
+      end
+      counter -= 1
+      return counter
+    end
+    def one_ussd_message
+      ussd_length <= 160
+    end
+    def one_ussd_message_characters_left
+      160 - ussd_length
+    end
+    def add_navigation(link, navigation_id = :default)
+      @navigations[navigation_id] = [] if @navigations[navigation_id].nil?
+      # workaround for SADS Absolute Path
+      #link[:pageId].gsub!(/^\/yp_mobile\//, '') unless link[:pageId].match(/\.html$/)
+      @navigations[navigation_id]<< DEFAULTS[:navigation].merge(link)
+    end
+    def add_attribute(req_attribute)
+      @request_attributes<< req_attribute
+    end
+    def set_message(id, message)
+      @messages[id.to_sym] = message
+    end
+    def add_input(input)
+      @inputs<< input
+    end
+    def to_sads
+      xml = Builder::XmlMarkup.new
+      xml.instruct!
+      xml.page :version => "2.0", "xmlns:meta" => "http://whoisd.eyeline.com/sads/meta" do
+        xml.title @title, :id => ''
+        if @banner_position == :top and @banner_targets.any?
+          xml.meta :banner, :target => @banner_targets.join(',')
+        end
+        @messages.each do |key, message|
+          object_hash = {}
+          object_hash[:id] = key.to_s unless key == :default
+          xml.div message, object_hash
+        end
+        xml.div @sms_message, :type => 'sms' unless sms_message.blank?
+        if @inputs.any?
+          xml.div do
+            @inputs.each do |input|
+              xml.input input
+            end
+          end
+        end
+        navigations.each do |key, links|
+          if links.any?
+            object_hash = {}
+            object_hash[:id] = key.to_s unless key == :default
+            xml.navigation object_hash do
+              links.each do |link| xml.link link[:title].strip, link.except(:title) end
+            end
+          end # eo if links.any?
+          if @inputs.any?
+            xml.navigation :id => 'submit' do
+              xml.link :accesskey => '1', :pageId => @submit_page
+            end
+          end
+        end
+        if @request_attributes.any?
+          xml.attributes do
+            @request_attributes.each do |attribute|
+              xml.attribute attribute
+            end
+          end
+        end
+        if @banner_position == :bottom and @banner_targets.any?
+          xml.meta :banner, :target => @banner_targets.join(',')
+        end
+      end
+    end
+  end
+end

data/lib/sads_xml/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module SadsXml
+  VERSION = "0.0.1"
+end

data/lib/sads_xml.rb ADDED Viewed

@@ -0,0 +1,9 @@
+Mime::Type.register_alias "application/xml", :sads
+require 'sads_xml/sads'
+require 'sads_xml/controller_additions'
+module SadsXml
+  class SadsXmlEngine < Rails::Engine
+  end
+end