mxit-rails 0.0.8

data/app/assets/stylesheets/mxit_rails/emulator.css.scss

@@ -0,0 +1,173 @@
+html, body {
+  margin: 0;
+  padding: 0;
+  overflow: hidden;
+  font-family: 'HelveticaNeue';
+  font-weight: normal;
+}
+
+#phone {
+  width: 240px;
+  height: 320px;
+  padding: 133px 56px 351px 56px;
+  margin: 35px auto 0 auto;
+  position: relative;
+}
+#phone.collapse {
+  background: none;
+  position: absolute;
+  top: 37px;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  margin: 0;
+  padding: 0;
+  width: auto;
+  height: auto;
+}
+#screen {
+  width: 240px;
+  height: 320px;
+  position: relative;
+  overflow: hidden;
+}
+#phone.collapse #screen {
+  position: static;
+  width: 100%;
+  height: 100%;
+}
+
+iframe {
+  border: none;
+  margin: 0;
+  padding: 0;
+}
+
+.content {
+  width: 240px;
+  height: 320px;
+  position: absolute;
+  z-index: 1;
+}
+#phone.collapse .content {
+  width: 100%;
+  height: 100%;
+}
+
+#controls {
+  position: absolute;
+  top: 0;
+  left: 0;
+  right: 0;
+  height: 36px;
+  background-color: #eee;
+  border-bottom: 1px solid #999;
+  font-size: 14px;
+  line-height: 36px;
+  font-family: 'HelveticaNeue';
+  font-weight: normal;
+  text-align: center;
+  z-index: 1;
+}
+#not-registered, #registered {
+  float: left;
+  margin-left: 20px;
+}
+#registered {
+  display: none;
+}
+#mxit-id {
+  font-family: 'HelveticaNeue-Bold';
+  font-weight: normal;
+}
+#unlink, #link {
+  position: relative;
+  top: 0px;
+  float: right;
+  margin-right: 20px;
+  cursor: default;
+}
+#inputs {
+  display: none;
+}
+
+
+.link .icon {
+  width: 56px;
+  height: 56px;
+  border-radius: 56px;
+  border: 5px solid #fff;
+  box-shadow: 0 2px 2px rgba(64,64,64,0.4);
+  display: block;
+  background: -webkit-linear-gradient(-75deg, #f5a627 0%, #de6003 100%);
+}
+.link:active .icon { background: -webkit-linear-gradient(-75deg, #F58A27 0%, #CF3A00 100%); }
+.link.disabled .icon { background: -webkit-linear-gradient(-75deg, #c6c6c6 0%, #7a7a7a 100%); }
+.link .icon .image {
+  background-position: center;
+  background-repeat: no-repeat;
+  background-size: 50px;
+  width: 100%;
+  height: 100%;
+  display: block;
+}
+
+a.link {
+  padding: 0;
+  text-decoration: none;
+  font-family: 'HelveticaNeue-Medium';
+  font-weight: normal;
+  font-size: 14px;
+  color: #333;
+  position: relative;
+  top: 2px;
+}
+.link .icon {
+  width: 26px;
+  height: 26px;
+  border-radius: 26px;
+  border: 2px solid #fff;
+  display: inline-block;
+  vertical-align: middle;
+  position: relative;
+  top: -1px;
+  margin: 0 4px 4px 6px;
+}
+.link .icon .image {
+  background-size: 24px;
+}
+.in .icon .image, .out .icon .image {
+  background-size: 22px;
+}
+
+#expand {
+  position: absolute;
+  display: block;
+  right: 19px;
+  top: 27px;
+}
+
+#collapse {
+  position: absolute;
+  z-index: 10;
+  display: block;
+  right: 1px;
+  top: 5px;
+  display: none;
+}
+#phone.collapse #expand {
+  display: none;
+}
+#phone.collapse #collapse {
+  display: block;
+}
+
+#fadeout {
+  position: fixed;
+  height: 100px;
+  bottom: 0;
+  left: 0;
+  right: 0;
+  background: -webkit-linear-gradient(90deg, #fff 0%, #fff 5%, rgba(255,255,255,0.95) 15%, rgba(255,255,255,0) 100%);;
+  z-index: 10;
+}

data/app/assets/stylesheets/mxit_rails/included.css.scss

@@ -0,0 +1,6 @@
+html, body {
+  margin: 2px;
+  padding: 0;
+  font-family: Helvetica, Arial, sans-serif;
+  font-weight: normal;
+}

data/app/controllers/emulator_controller.rb

@@ -0,0 +1,6 @@
+class EmulatorController < ApplicationController
+  layout false
+
+  def index
+  end
+end

data/app/helpers/mxit_rails_helper.rb

@@ -0,0 +1,35 @@
+module MxitRailsHelper
+
+  def mxit_path route
+    MxitRails::Router.url route
+  end
+
+  def mxit_link route, label, variables=nil
+    unless variables.nil?
+      var_strings = []
+      #TODO: Use default Rails get encoding
+      variables.each do |key, value|
+        var_strings << "#{key}=#{value}"
+      end
+      route += "?#{var_strings.join('&')}"
+    end
+    output = "<a href=\"#{route}\">#{label}</a>".html_safe
+  end
+
+  def mxit_style *names
+    content = []
+    names.each do |name|
+      content << MxitRails::Styles.get(name) || ''
+    end
+    content.join(' ').html_safe
+  end
+
+  def mxit_nav_link target, label
+    "<p style=\"#{ mxit_style :right }\">#{ mxit_link target, label }</p>".html_safe
+  end
+
+  def mxit_proceed content
+    "<p><b style=\"#{ mxit_style :link }\">&gt; #{content}</b></p>".html_safe
+  end
+
+end

data/app/views/emulator/index.html.erb

@@ -0,0 +1,54 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <title>Mxit Emulator</title>
+    <meta charset="UTF-8" />
+
+    <%= stylesheet_link_tag "mxit_rails/emulator" %>
+    <%= javascript_include_tag "mxit_rails/emulator" %>
+
+    <link rel="icon" type="image/x-icon" href="<%= image_path("mxit_rails/favicon.ico");  %>" />
+
+    <script type="text/javascript">
+      MXIT_ROOT = '<%= Rails.application.config.mxit_root %>';
+    </script>
+
+    <!-- The asset image-path helper isn't working in scss files, so moving those to here. sigh. -->
+    <style type="text/css">
+      #phone { background: url(<%= image_path("mxit_rails/nokia-5310-frame.png") %>) no-repeat; }
+      .go > .icon .image  { background-image: url(<%= image_path("mxit_rails/go.png");  %>) }
+      .in > .icon .image  { background-image: url(<%= image_path("mxit_rails/in.png");  %>) }
+      .out > .icon .image { background-image: url(<%= image_path("mxit_rails/out.png"); %>) }
+    </style>
+</head>
+<body>
+
+  <div id="controls">
+    <div id="default">
+      <span id="not-registered">No credentials</span>
+      <span id="registered">Mxit ID: <span id="mxit-id"></span></span>
+
+      <a id="unlink" class="go link" onclick="Emulator.clearCredentials()">Clear Credentials <span class="icon"><span class="image"></span></span></a>
+      <a id="link" class="go link" onclick="Emulator.enterCredentials()">Set Credentials <span class="icon"><span class="image"></span></span></a>
+    </div>
+
+    <div id="inputs">
+      <input type="text" placeholder="Mxit ID" id="mxit-id-input" />
+      <input type="text" placeholder="MSISDN" id="msisdn-input" />
+
+      <a id="link" class="go link" onclick="Emulator.saveCredentials()">Save <span class="icon"><span class="image"></span></span></a>
+    </div>
+  </div>
+
+  <div id="phone">
+    <a id="expand" class="out link" onclick="Emulator.expand()"><span class="icon"><span class="image"></span></span></a>
+    <a id="collapse" class="in link" onclick="Emulator.collapse()"><span class="icon"><span class="image"></span></span></a>
+    <div id="screen">
+      <iframe id="center" class="content" onLoad="Emulator.updateIframe(this)"></iframe>
+    </div>
+  </div>
+
+  <div id="fadeout"></div>
+
+</body>
+</html>

data/app/views/layouts/mxit.html.erb

@@ -0,0 +1,53 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+  <title>Mxit App</title>
+
+  <meta name="mxit" content="no_prefix,show_progress,clear_on_new,no_heading" />
+
+  <% if request.headers['x-mxit-login'].nil? %>
+    <!-- Include a CSS file, but only in a browser/emulator, not on mxit -->
+    <%= stylesheet_link_tag "mxit_rails/included" %>
+  <% end %>
+
+  <style type="text/css">
+    a:hover { <%= mxit_style :link_hover %> }
+    a { <%= mxit_style :link %> }
+  </style>
+</head>
+
+<body style="<%= mxit_style :body %>">
+
+  <table title="mxit:table:full" style="width:100%" name="title_table" cellspacing="0" cellpadding="0">
+    <colgroup span="1" width="100%"></colgroup>
+    <tr>
+      <td style="<%= mxit_style :title %>">
+        <b><%= yield :title %></b>
+      </td>
+    </tr>
+  </table>
+
+  <%= yield :navigation %>
+
+  <% if !@_mxit_validated %>
+    <%= @_mxit_validation_messages.first %>
+
+  <% else %>
+    <%= yield %>
+  <% end %>
+
+  <% if @_mxit.input %>
+    <%= mxit_proceed @_mxit.input_label %>
+    <form method="POST" action="<%= @_mxit.url %>">
+        <input type="text" name="<%= @_mxit.input %>" />
+        <input type="submit" name="_mxit_rails_submit" value="Proceed" />
+    </form>
+
+  <% elsif @_mxit.proceed %>
+    <%= mxit_proceed mxit_link(@_mxit.url, @_mxit.proceed.to_s.capitalize, {_mxit_rails_submit: 'Proceed'}) %>
+  <% end %>
+
+</body>
+</html>

data/app/views/mxit_rails/error.html.erb

@@ -0,0 +1,2 @@
+<p><%= @_mxit_error_message %></p>
+

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+
+  match '/emulator', :controller => 'emulator', :action => 'index'
+
+end

data/lib/mxit-rails.rb

@@ -0,0 +1,13 @@
+require "mxit_rails/railtie"
+require "mxit_rails/exception"
+require "mxit_rails/redirect_exception"
+require "mxit_rails/descriptor"
+require "mxit_rails/engine"
+require "mxit_rails/styles"
+require "mxit_rails/controller_extensions"
+require "mxit_rails/validations"
+require "mxit_rails/router"
+require "mxit_rails/page"
+
+module MxitRails
+end

data/lib/mxit_rails/controller_extensions.rb

@@ -0,0 +1,8 @@
+module MxitRails
+  module ControllerExtensions
+    def mxit_style name, content
+      MxitRails::Styles.add name, content
+    end
+  end
+end
+ActionController::Base.extend(MxitRails::ControllerExtensions)

data/lib/mxit_rails/descriptor.rb

@@ -0,0 +1,54 @@
+module MxitRails
+  class Descriptor
+    def self.descr_accessor variable
+      # Custom accessor macro that will look in a parent descriptor if a value isn't found (i.e. is nil)
+      attr_writer variable
+      define_method "#{variable}" do
+        value = instance_variable_get("@#{variable}")
+        if value.nil? && !parent_descriptor.nil?
+          value = parent_descriptor.send("#{variable}")
+        end
+        value
+      end
+    end
+
+    attr_accessor :parent_descriptor
+
+    attr_accessor :name
+    attr_accessor :type
+
+    descr_accessor :proceed
+
+    attr_accessor :input
+    attr_accessor :input_label
+
+    attr_accessor :validations
+
+    def initialize name, parent=nil
+      @parent_descriptor = parent
+      self.name = name.to_sym
+      @validations = []
+      @steps = []
+    end
+
+    def add_validation type, message, parameter
+      @validations << {type: type, message: message, parameter: parameter}
+    end
+
+    def url
+      MxitRails::Router.url name
+    end
+
+    def view
+      view = MxitRails::Router.url name
+      unless step.nil?
+        view += "/#{step}"
+      end
+      view
+    end
+
+    def form?
+      type == :form
+    end
+  end
+end

data/lib/mxit_rails/engine.rb

@@ -0,0 +1,4 @@
+module MxitRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/mxit_rails/exception.rb

@@ -0,0 +1,10 @@
+module MxitRails
+  class Exception < Exception
+    attr_reader :message
+    attr_reader :code
+    def initialize message, code
+      @message = message
+      @code = code
+    end
+  end
+end

data/lib/mxit_rails/page.rb

@@ -0,0 +1,187 @@
+module MxitRails
+  module Page
+    extend ActiveSupport::Concern
+
+    def mxit_params
+      @_mxit_params
+    end
+
+    def set_descriptor name, parent_name=:default
+      @descriptors ||= {}
+      @descriptors[name] ||= MxitRails::Descriptor.new controller_name, @descriptors[parent_name]
+      @descriptor_name = name
+    end
+    def descriptor
+      @descriptors[@descriptor_name]
+    end
+
+    included do
+      if self.ancestors.include? ApplicationController
+        send :rescue_from, MxitRails::Exception, :with => :handle_mxit_exception
+        send :layout, 'mxit'
+        send :before_filter, :setup
+      end
+    end
+
+    def redirect! route
+      exception = MxitRails::RedirectException.new('', :redirect)
+      exception.route = route
+      raise exception
+    end
+
+    def validate! input
+      descriptor.validations.each do |validation|
+        method = validation[:type].to_s + '?' #All validations are defined with a trailing question mark
+        parameter = validation[:parameter]
+        # Call with/out a parameter, depending on whether one is specified
+        valid = parameter ? MxitRails::Validations.send(method, input, parameter) : MxitRails::Validations.send(method, input)
+        if !valid
+          @_mxit_validated = false
+          @_mxit_validation_messages << validation[:message]
+        end
+      end
+    end
+
+    def get_mxit_header_field key
+      request.headers[key] || cookies[key.downcase]
+    end
+
+    def get_mxit_info
+      @_mxit_params = {}
+      @_mxit_params[:m_id] = get_mxit_header_field 'X-Mxit-UserId-R'
+      @_mxit_params[:username] = get_mxit_header_field 'x-mxit-login'
+
+      device_info = get_mxit_header_field('X-Mxit-Device-Info')
+      unless device_info.blank?
+        device_info.split(',')
+        @_mxit_params[:distribution_code] = device_info.first
+        @_mxit_params[:mobile_number] = device_info[1] if device_info.length == 2
+      end
+    end
+
+
+    # Rails controller stuff
+    #========================
+
+    def setup
+      set_descriptor :default 
+
+      get_mxit_info
+
+      @_mxit = descriptor
+      @_mxit_validated = true
+      @_mxit_validation_messages = []
+
+      clean_session
+    end
+
+    def clean_session
+      # Drop all mxit items from session if the page doesn't match the current one
+      if session[:_mxit_rails_page] != "#{controller_name}##{action_name}"
+        session.each do |key, value|
+          if key.to_s.match(/_mxit_rails_/)
+            session[key] = nil
+          end
+        end
+        session[:_mxit_rails_page] = "#{controller_name}##{action_name}"
+      end
+    end
+
+    def handle_mxit_exception exception
+      if exception.kind_of? MxitRails::RedirectException 
+        redirect_to(exception.route) and return
+      end
+    end
+
+    def input input_name, input_label
+      descriptor.input = input_name
+      descriptor.input_label = input_label
+    end
+    def proceed label
+      descriptor.proceed = label
+    end
+
+    def validate *arguments
+      type = arguments[0]
+      message = arguments[-1]
+      parameter = arguments[1..-2][0] # Will return nil if there isn't an argument
+      descriptor.add_validation type, message, parameter
+    end
+
+    def submit &block
+      set_descriptor :default
+
+      if descriptor.form? && next_step?
+        instance_eval &block
+
+      elsif params.include?(:_mxit_rails_submit)
+        unless descriptor.input.nil?
+          input = descriptor.input.to_sym
+          validate! params[input]
+        end
+        
+        instance_eval &block if @_mxit_validated
+      end
+    end
+
+
+    def current_step
+      return nil if session[:_mxit_rails_step].nil?
+      session[:_mxit_rails_step].to_sym
+    end
+    def current_step= new_step
+      session[:_mxit_rails_step] = new_step.to_sym
+    end
+    def next_step?
+      @next_step
+    end
+
+    def step step_name, &block
+      # Is the current step blank
+      if next_step?
+        self.current_step = step_name
+        @next_step = false
+      end
+
+      set_descriptor step_name
+      instance_eval &block
+
+      # Process the form if it is the current step
+      if current_step == step_name
+        if params.include?(:_mxit_rails_submit)
+          # Validate the current input if present
+          unless descriptor.input.nil?
+            input = descriptor.input.to_sym
+            validate! params[input]
+            session[:_mxit_rails_params][input] = params[input] if @_mxit_validated
+          end
+
+          if @_mxit_validated
+            params.delete :_mxit_rails_submit
+            @next_step = true
+            return
+          end
+        end
+
+        # Render the form if appropriate
+        @_mxit = descriptor
+        render "#{controller_name}/#{action_name}/#{current_step}"
+      end
+    end
+
+    def form &block
+      descriptor.type = :form
+      session[:_mxit_rails_params] ||= {}
+
+      # Ensure previous inputs are in the params hash
+      session[:_mxit_rails_params].each do |key, value|
+        params[key.to_sym] = value
+      end
+
+      # Proceed to the (first) step if no step is in the session
+      @next_step = true if session[:_mxit_rails_step].nil?
+
+      instance_eval &block
+    end
+  end
+end

data/lib/mxit_rails/railtie.rb

@@ -0,0 +1,5 @@
+module MxitRails
+  class Railtie < Rails::Railtie
+    config.mxit_root = 'mxit'
+  end
+end

data/lib/mxit_rails/redirect_exception.rb

@@ -0,0 +1,5 @@
+module MxitRails
+  class RedirectException < MxitRails::Exception
+    attr_accessor :route
+  end
+end

data/lib/mxit_rails/router.rb

@@ -0,0 +1,11 @@
+module MxitRails
+  class Router
+    def self.url route
+      path = []
+      root = Rails.application.config.mxit_root
+      path << root unless root.blank?
+      path << route.to_s
+      path = '/' + path.join('/')
+    end
+  end
+end

data/lib/mxit_rails/styles.rb

@@ -0,0 +1,25 @@
+module MxitRails
+  module Styles
+
+    # Not sure whether a Constant is the neatest/nicest way of storing these?
+    StyleList = {}
+
+    def self.get name
+      StyleList[name.to_sym]
+    end
+
+    def self.add name, content
+      content.strip!
+      if content[-1] != ';'
+        content += ';'
+      end
+      StyleList[name.to_sym] = content
+    end
+
+    # Default styles
+    add :left, 'text-align:left;'
+    add :center, 'text-align:center;'
+    add :right, 'text-align:right;'
+
+  end
+end

data/lib/mxit_rails/validations.rb

@@ -0,0 +1,21 @@
+module MxitRails
+  class Validations
+
+    def self.not_blank? input
+      return !input.blank?
+    end
+
+    def self.numeric? input
+      return !input.blank? && input.match(/^[0-9]+$/)
+    end
+
+    def self.min_length? input, max
+      return !input.blank? && (input.length >= max)
+    end
+
+    def self.max_length? input, max
+      return input.blank? || (input.length <= max)
+    end
+
+  end
+end