rmobio 1.1.0

data/lib/rmobio/client_info.rb

@@ -0,0 +1,194 @@
+#
+# Copyright (C) 2007 Mobio Networks, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+=begin
+Some summary should go here
+=end
+ 
+#require 'rexml/document'
+require 'open-uri' 
+require 'hpricot'
+
+module Rmobio
+  module ClientInfo
+
+    #== checkClient
+    #=== The method checks the client type, version and family by analyzing the request header. 
+    #=== HTTP_ACCEPT
+    #* If header contains application/pxml                            => 'xf' (xforms client)
+    #* If header contains wml or wap                                  => 'wap'
+    #* If header contains applicaton/html                             => 'html'
+    #* Otherwise, default to html                                    => 'html'
+    # If xf cient, the "POST" parameters are parsed to name/value pairs in params 
+    # 
+    #=== HTTP_CLIENT_INFO_URL
+    # 
+    #* If header exists => 0.8 client
+    #* If header doesn't exist => 0.6 client
+    # Samle of what HTTP_CLIENT_INFO_URL returns:
+    # http://homer.mobiolabs.com/gateway/public/clientServices/getCapability?id=1.0.5:Motorola:V3
+    # 
+    #=== HTTP_MOBIO_AGENT
+    #* If header contains WM5 => Window Mobile family
+    #
+    #== Return Codes
+    # The method returns the following instance varables:
+    # @client     => 'xf' or 'html' or 'wap'
+    # params[]   => array contains name/value pairs of all parameters from POST request
+    # @paramsdoc  => POST request in xml (parsed by hpricot)
+    # 
+    # @client_version => '0.6' or '0.8'
+    # 
+    def checkClient
+      logger.debug('checkClient http_accept header:')
+      logger.debug(request.env['HTTP_ACCEPT'])
+       
+      if request.env['HTTP_MOBIO_AGENT'] or request.env['HTTP_ACCEPT']=~/application\/pxml/
+        @client="xf" 
+      elsif ((request.env['HTTP_ACCEPT']=~/wml/) || 
+            (request.env['HTTP_ACCEPT']=~/wap/)  )
+        @client="wap"
+      else
+        @client="html"
+      end
+
+      if @client == "xf"
+        headers.delete("Cache-Control")
+        headers['Content-Type']="application/mform"
+        @body = request.body.read.to_s if request.body
+        if request.env['REQUEST_METHOD'] == "POST" and @body 
+          paramsFromXml(@body,'data')
+        end 
+      end
+
+      # now check client version
+      # 
+      @client_version = request.env['HTTP_CLIENT_INFO_URL']? '0.8' : '0.6' 
+
+      # check if it's Window Mobile family
+      @client_family = request.env['HTTP_MOBIO_AGENT']=~/WM5/? 'wm': 'other' 
+
+      # get user_id
+      @user_id=request.env['HTTP_USERID'] 
+      if (@user_id.nil?)
+        @user_id="101"
+      end      
+    end 
+
+   
+    # creates params[] array from xml in argument xml
+    def paramsFromXml(xml,parentname)
+      @paramsdoc = Hpricot(xml)
+      
+      if not parentname.nil?
+        doc = @paramsdoc.search("/" + parentname + "/*")
+        doc.each do |x| 
+          params[(x.name).to_sym]= x.inner_html 
+        end
+      end
+    end
+
+
+    #== getDeviceAttrValue(attribute, default)
+    #=== To get the value for a device attribute
+    # This utility queries the device capability service to get the value for 
+    # a particular device attribute.  
+    # 
+    #=== Sample device url: 
+    # http://homer.mobiolabs.com/gateway/public/clientServices/getCapability?id=.0.6.28:SonyEriccson:K750i 
+    #=== Sample device attributes:
+    # <mob:Client>
+    #  <mob:client-id>.0.6.28:Sony-Ericsson:Z800</mob:client-id>
+    #  <mob:name>Sony-Ericsson/Z800</mob:name>
+    #  <mob:height>220</mob:height>
+    #  <mob:width>176</mob:width>
+    #  <mob:bit-depth>0</mob:bit-depth>
+    #  <mob:memory>1.5 MB</mob:memory>
+    #  <mob:memory-heap>0</mob:memory-heap>
+    #  <mob:memory-rms>0</mob:memory-rms>
+    # </mob:Client>
+    #
+    #=== parameter
+    #* attribute => the device attribute string, ex: "width", "height"
+    #* default => default value if attribute is not available in the client_info_url
+    #
+    #=== return
+    # Value of the attribute
+    # 
+    def getDeviceAttrValue(attribute, default) 
+
+      if request.env['HTTP_CLIENT_INFO_URL'] 
+        logger.debug 'HTTP_CLIENT_INFO_URL:'+request.env['HTTP_CLIENT_INFO_URL']  
+        begin 
+          doc = Hpricot.XML(open(request.env['HTTP_CLIENT_INFO_URL'])) 
+          value = doc.search("//mob:" + attribute).inner_html
+          if value and not value.empty? 
+            default = value
+          end 
+        rescue
+          # do nothing
+        end
+      end 
+      default   
+    end  
+ 
+    #== get_device_info
+    #=== For asset management   
+    #  
+    #=== Sample device url: 
+    # http://xenimage1-3:8080/gateway/public/clientServices/getCapability?id=.0.6.28:Sony-Ericsson:Z800 
+    # 
+    # All client attributes are stored in Hash plus "iconsize" which is "13" or "17" 
+    # If device width is null or 0, it defaults to '176' for asset to work.
+    #
+    def get_device_info  
+      device={:iconsize=> "13"} 
+       
+      if request.env['HTTP_CLIENT_INFO_URL'] 
+        logger.debug 'HTTP_CLIENT_INFO_URL:'+request.env['HTTP_CLIENT_INFO_URL']   
+        begin 
+          doc = Hpricot.XML(open(request.env['HTTP_CLIENT_INFO_URL'])) 
+          
+          doc.search("//mob:Client/*").each do |x| 
+            if x.inner_html and not x.inner_html.empty?
+              # strip off "mob:"
+              name = x.name[4..-1]
+              device[name.to_sym] = x.inner_html
+            end 
+        
+            if x.name == "mob:fontsize"
+              if x.inner_html.to_i >=21
+                device[:iconsize] = "17"
+              end
+            end
+        
+          end
+        rescue 
+          # do nothing
+        end 
+      end  
+      
+      # Make sure we always have a device width for asset to work 
+      if device[:width].nil? or device[:width]==0
+        device[:width] = '176'
+      end
+      device
+    end #end get_device_info 
+
+  end #end Device_Info
+   
+end  #end Mobio

data/lib/rmobio/config_manager.rb

@@ -0,0 +1,63 @@
+#
+# Copyright (C) 2007 Mobio Networks, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+=begin
+This module manages yaml-based configuration sets. Uses some logic from the
+rfacebook gem.
+=end
+module Rmobio
+  module ConfigManager
+    if defined? RAILS_DEFAULT_LOGGER
+      logger = RAILS_DEFAULT_LOGGER
+    else
+      logger = nil
+    end
+    begin
+      app_yaml_file = YAML.load_file("#{RAILS_ROOT}/config/rmobio.yml")
+    rescue Exception => e
+      raise StandardError, "config/rmobio.yml could not be loaded."
+    end
+
+    if app_yaml_file
+      if app_yaml_file[RAILS_ENV]
+        MOBIO_CONFIG = app_yaml_file[RAILS_ENV]
+        
+        # Replace all properties containing @somekey@ with the value of
+        # "somekey"
+        MOBIO_CONFIG.each do |key, value|
+          filter_value = value.to_s.strip
+          filter_key = /@(.*)@/.match(filter_value).to_s.strip
+          if not filter_key.nil? and not filter_key == ''
+            filter_key = filter_key.gsub(/@/,'')
+            if not filter_key.nil? and not filter_value.nil? and not filter_key == ''
+              filter_value = filter_value.gsub(/@.*@/, MOBIO_CONFIG[filter_key.strip])
+              logger.debug('filtered key: ' + key + ' filtered value: ' + filter_value) unless logger.nil?
+              MOBIO_CONFIG[key] = filter_value
+            end
+          end
+        end
+      else
+        raise StandardError, "config/rmobio.yml exists, but doesn't have a configuration for RAILS_ENV=#{RAILS_ENV}."
+      end
+    else
+      raise StandardError, "config/rmobio.yml does not exist."
+    end
+  end
+end
+
+# Now we want to initialize the MOBIO_CONFIG constant
+include Rmobio::ConfigManager

data/lib/rmobio/raketasks.rb

@@ -0,0 +1,143 @@
+#
+# Copyright (C) 2007 Mobio Networks, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'tasks/rails'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'fileutils'
+require 'rcov/rcovtask'
+
+CLEAN.include('pkg/*')
+CLEAN.include('coverage/*')
+
+# BEGIN CRUISE SECTION
+def get_version
+  if not defined? PKG_VERSION
+    @version = `svnversion #{RAILS_ROOT}`
+    if @version.nil? || @version == 'exported'
+      @version = '1.0.0'
+    else
+      @version =~ /([0-9]+)/
+      @version = $1
+      if @version.nil?
+        @version = '1.0.0'
+      else
+        @version = '1.0.' + @version
+      end
+    end
+  else
+    @version = PKG_VERSION
+  end
+  @version
+end
+
+task :reconnect do
+  require 'active_record'
+  configurations = ActiveRecord::Base.configurations
+  if configurations and configurations.has_key?("test") and configurations["test"]["adapter"] == 'mysql'
+    ActiveRecord::Base.establish_connection(:test)
+  end
+end
+
+task :install_gem do
+  target = ENV['GEM_INSTALL_DIR']
+  unless target.nil?
+    cp("pkg/" + PKG_NAME + "-" + get_version + ".gem", target)
+  end
+end
+
+task :package_gem do
+  ENV['RAILS_ENV']   = 'test'
+  spec = Gem::Specification.new do |s|
+    if not defined? DEP_ADD
+      DEP_ADD = true
+    end
+    s.name = PKG_NAME
+    s.version = get_version
+    s.authors = PKG_AUTHORS
+    s.email = PKG_EMAILS
+    s.homepage = PKG_HOMEPAGE
+    s.platform = Gem::Platform::RUBY
+    s.summary = PKG_SUMMARY
+    s.description = PKG_DESCRIPTION
+    if not defined? PKG_INCLUDE
+      s.files =  FileList.new('**/*').to_a 
+    else 
+      s.files =  FileList[PKG_INCLUDE].to_a
+    end
+    s.has_rdoc = false
+    s.add_dependency("rmobio", ">= 1.1.0") unless DEP_ADD == false
+    s.add_dependency("hpricot", ">= 0.6")
+  end
+  
+  Rake::GemPackageTask.new(spec) do |p|
+  end
+end
+
+task :rcov do
+  Rcov::RcovTask.new do |t|
+    t.rcov_opts << '-T --rails'
+    t.libs << 'test'
+    t.test_files = FileList['test/*/*_test.rb']
+    t.verbose = true
+  end
+end
+
+task :cruise =>[:clean, 'db:test:purge', 'reconnect', 'db:migrate', :rcov, :package_gem, :package, :install_gem] do
+end
+# END CRUISE SECTION
+
+# BEGIN CONFIG SECTION
+namespace :rmobio do
+  desc "Set up the rmobio.yml configuration file. This is put into config/rmobio.yml. 
+        Using similar logic to the rfacebook plugin."
+  task :setup do
+    
+    filename = "#{RAILS_ROOT}/config/rmobio.yml"
+    puts "Setting up rmobio configuration file: config/rmobio.yml"
+    
+    file = File.new(filename, "w")
+    file <<
+      "
+development:
+    app_server_external: http://someexternalhost:someport
+    app_server_internal: http://somehost:someport
+    #example of a filtered property
+    service_base_url: @app_server_external@/service
+
+test:
+    app_server_external: http://someexternalhost:someport
+    app_server_internal: http://somehost:someport
+    #example of a filtered property
+    service_base_url: @app_server_external@/service
+
+production:
+    app_server_external: http://someexternalhost:someport
+    app_server_internal: http://somehost:someport
+    #example of a filtered property
+    service_base_url: @app_server_external@/service
+    "
+    file.close_write
+    puts "  [1] Created config/rmobio.yml <-- Please add the appropriate configuration options for your application!"
+    puts "Done."
+  end
+end
+# END CONFIG SECTION

data/lib/rmobio/utils.rb

@@ -0,0 +1,213 @@
+#
+# Copyright (C) 2007 Mobio Networks, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+=begin
+Some summary should go here
+=end
+ 
+#require 'rexml/document'
+require 'open-uri' 
+require 'hpricot'
+
+module Rmobio
+  module Utils
+
+    #== cachControl
+    #=== Adding cache control to response header 
+    def cacheControl(cacheStr='priority=P3;max-age=604800')  
+      headers.delete("Cache-Control");
+      headers["Cache-Control"] = cacheStr;   
+    end
+     
+    
+    #== cacheloader
+    #=== A utility method to add cache control to images, styles and files
+    # To add a cache control, edit the configuration file 'cachehints.txt' with 
+    # filename and header. Here is a ample configuration:
+    # 
+    # 
+    #<tt>logo.png: priority=P2;max-age=1296000</tt>
+    #
+    #<tt>base.rhtml: priority=P2;max-age=1296000</tt>
+    #
+    #   
+    # The utility assumes base directory for images files in RAILS_ROOT/public/images 
+    # and other files in RAILS_ROOT/apps/views.
+    # 
+    # 
+    # To access the image in your xform, use the following pattern:
+    #<tt><icon>recipe/loader?name=logo.png</icon></tt>
+    # To access the style in your xform, use the following pattern:
+    #<tt><style xmlns="http://www.mobio.com/ext" src="recipe/loader?name=layouts/base.rhtml"/></tt>
+    #
+    # where the controller 'recipe' should provide a method 'loader' that calls this
+    # utility:
+    #  def loader
+    #    cacheloader
+    #  end
+    # 
+    def cacheloader 
+      if (name=params[:name]).nil?
+        # Can't do anything, just return empty content so we don't get 
+        # 'no template' error.
+        render :text => ''
+        return
+      end
+
+      # Default cache configuration file
+      cache_hints = File::join RAILS_ROOT, 'public/cachehints.txt' 
+
+      # Add cache header
+      headers.delete("Cache-Control")  
+      if File.file?(cache_hints)
+        file = File.new(cache_hints,"r")
+        hintsTxt = file.read(File.size(cache_hints))
+        file.close()
+        hintsTxt.each_line do |line|
+          if line.index(name) == 0
+            line.scan(/(.*):(.*)/) do |garbage, ccheader|
+              headers["Cache-Control"] = ccheader.strip
+            end
+            break
+          end
+        end
+      end
+
+      if name=~ /.png$/
+        # for now hardcode the image directory
+        filePath = File::join RAILS_ROOT, 'public/images/', name 
+        file = File.new(filePath,"r")
+        filecontents = file.read(File.size(filePath))
+        file.close()
+
+        headers["Content-Type"] = "image/png"
+
+        render :text => filecontents
+        return
+      elsif name =~ /.xfs$/ or name =~ /.rxf/ 
+        headers["Content-Type"] = "application/mform" 
+      else 
+        headers["Content-Type"] = "application/xml"
+      end 
+
+      render :template => name   
+    end
+
+    #== cacheimg
+    #=== A utility method to add cache control to images
+    #=== This utility is deprecated, use cacheloader instead
+    # To add a cache control for an image file in RAILS_ROOT/public/images, edit
+    # the configuration file "cachehints.txt with image name and header. Ex:
+    # 
+    # logo.png: priority=P2;max-age=1296000
+    # 
+    # To access the image in your xforms, use the following pattern:
+    # <icon>img?name=logo.png</icon>
+    # Where the controller should provide an img method that just call this cacheimg utility.
+    #  
+    # Sample cachehints.txt:
+    # Skins_176A2-a.png: priority=P2;max-age=1296000
+    # logo.png: priority=P2;max-age=1296000
+    # 
+    def cacheimg
+      public_folder = File::join RAILS_ROOT, "public/images"
+      filePath = File::join RAILS_ROOT, "public/images", params['name'] 
+      file = File.new(filePath,"r")
+      filecontents = file.read(File.size(filePath))
+      file.close()
+
+
+      headers["Content-Type"] = "image/png"
+      headers.delete("Cache-Control")
+      fileDir = File.dirname(filePath)
+      fileName = File.basename(filePath)
+      hints = File::join fileDir, "cachehints.txt"
+      if File.file?(hints)
+        file = File.new(hints,"r")
+        hintsTxt = file.read(File.size(hints))
+        file.close()
+        hintsTxt.each_line do |line|
+          if line.index(fileName) == 0
+            line.scan(/(.*):(.*)/) do |garbage, ccheader|
+              headers["Cache-Control"] = ccheader.strip
+            end
+            break
+          end
+        end
+      end
+      render :text => filecontents
+    end
+
+    #== backURL(key)
+    # This utility handles back url to GLP if page is cached. 
+    # It expects params[:burl] or a session key and renders 
+    # the following xml data back to the caller: 
+    # 
+    # <data xmlns="">
+    #  <burl>blah blah url</burl>
+    # </data>
+    #  
+    # The returned instance data <burl> is determined by the following rules:
+    #* params[:burl] if parameter exists, the url in the session is also updated
+    #* session[:key] if params[:burl] is nil
+    #* empty string if none of the above
+    # 
+    #
+    # To access the backurl from your xfroms, use the following pattern:
+    # 
+    #   <xf:instance id="homepage" src="storeBackurl?burl=SOMEURL" />  
+    #   
+    # Where the controller should provide a "storeBackurl" method that just call this backURL utility:
+    #   def storeBackurl
+    #     backURL("recipe_burl")
+    #   end  
+    # 
+    #=== Parameter
+    # key  =>  a unique session key to store the burl for the app
+    # 
+    def backURL(key) 
+      url = backurl_xml(key)
+      headers['Content-Type']='application/xml' 
+      render :text => "<data xmlns=\"\">" + url  + "</data>"
+    end  # end backURLg
+
+    # if you want to just return partial backurl without headers and no rendering
+    def backurl_xml(key)
+      if params[:burl]
+        url =  params[:burl].gsub(/&/,'&amp;')
+        session[key] = url
+      elsif session[key]
+        url = session[key]
+      else 
+        # don't know what to do, just return an empty url
+        url = ''
+      end 
+      logger.debug('back url ' + key + ': ' + url)
+      "<burl>" + url  + "</burl>"
+    end # end backurl_xml
+      
+    def logHeaders
+      logger.debug( "Logging Headers...")
+      request.env.keys.each do |header|
+        logger.debug( header.to_s + ': ' + request.env[header].to_s)
+      end
+      logger.debug("End of Headers...")
+    end
+    
+
+  end #end Utils
+end  #end Mobio

data/lib/rmobio/webservices/soap/drivers.rb

@@ -0,0 +1,62 @@
+#
+# Copyright (C) 2007 Mobio Networks, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+###
+# This class uses class-based-instance variables to store a driver
+# for each type of WSDL based webservice that needs to be accessed.
+# :author   Nate Agrin
+###
+
+require 'soap/wsdlDriver'
+
+module Rmobio
+  module WebServices
+    class WsdlDriver
+      # class-level-instance variables
+      # see http://wiseheartdesign.com/2006/9/22/class-level-instance-variables/
+      @wsdl = nil
+      @driver = nil
+  
+      # class level methods
+      class << self
+        attr_accessor :wsdl, :driver
+        
+        # sets the wsdl variable and attempts to create a SOAP::WSDLDriver object
+        def wsdl=(wsdl)
+          @wsdl = wsdl
+          @driver = SOAP::WSDLDriverFactory.new(wsdl).create_rpc_driver
+        end
+      end
+    
+      # instance method for returning the underlying rpc_driver
+      def driver
+        self.class.driver
+      end
+      
+      # instance method for returning the underlying wsdl address      
+      def wsdl
+        self.class.wsdl
+      end
+    
+      # this may not be very useful because responses require interpertation
+      def method_missing(method_id, *args)
+        driver.send method_id, args if driver.respond_to?(method_id)
+      end
+    end
+    
+  end
+end

data/lib/rmobio/webservices/soap/geocode.rb

@@ -0,0 +1,19 @@
+#
+# Copyright (C) 2007 Mobio Networks, Inc.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+class Geocode < Mobio::WebServices::WsdlDriver
+end