singtel_sdp 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43a8326ed8b265c7ead7f7ea5c386a800a27d747
+  data.tar.gz: 7595fcfdcc6a294e7323ed5ea300bfc17d66d52d
+SHA512:
+  metadata.gz: d3a6c5701955cdc968146710befd6774948c815b7e057c4edeb4147cb43762ceb14a4e81a970dac23f5a1d23da8d9045f091df68f3bcdc0cb29cc65b90559a1c
+  data.tar.gz: 8ed91a7879fdaf249983c2d17ce8cce74a70616477fb9297b1eaae5ca44f92b54d3e46a0426b9743014e7b646e4cbc75de9a30147e43b82f9eb1d5ce9da9494d

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012-2014 Dropmysite Pte Ltd
+
+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.md

@@ -0,0 +1,134 @@
+# SingtelSdp
+
+The core of this gem its on `SingtelSdp::BaseAdapter` and `SingtelSdp::BaseAdapterController`.
+
+Implementing these 2 classes will let you decide what to do with each request received from the sdp.
+
+SingtelSdp let you forget about the xml connections, result codes and messages. It gives you the chance to focus on the implementation of the actions for each request.
+
+This gem solves most of the hard problems with the integration with singtel.
+
+## Installing
+
+## Get the gem
+
+Add this to your `Gemfile`.
+
+```
+gem 'singtel_sdp', '~>1.0.0', git: 'git://github.com/dropmyemail/singtel_sdp.git'
+```
+
+## Create the adapter
+
+Use the provided generator to create the model, controller and initializer file for SingtelSdp.
+
+```
+rails g singtel_sdp
+```
+
+### Customize the models
+
+`SingtelSdp::BaseAdapter` is an abstract class, You need to implement the abstract methods.
+
+``` ruby
+# app/models/singtel_Adapter.rb
+#
+class SingtelAdapter < SingtelSdp::BaseAdapter
+  def roles
+    # here you should return a list of the possible roles. eg ['ADMIN','DEFAULT']
+  end
+
+  def find_singtel_customer(isvcustno)
+    # Find and return a singtel customer here, can be an instances of any class that represents an active customer.
+  end
+
+  def find_singtel_product(isvsubsid)
+    # Find and return a singtel product subscription here, can be an instances of any class that represents an active subscription to a product in your domain.
+  end
+
+  def find_singtel_user(isvuserid)
+    # Find and return your singtel user here, can be an instances of any class that represents your active user.
+  end
+
+  def on_create_customer
+     #create your singtel customer here. in arguments variable you ll find a hash with the params received in the request. eg: arguments[:ISVCUSTNO], return the ivcustno as a string if everything went fine, if not nil.
+  end
+
+  def on_update_customer
+     #update your singtel customer here. in arguments variable you ll find a hash with the params received in the request. eg: arguments[:ISVCUSTNO], return the ivcustno as a string if everything went fine, if not nil.
+  end
+
+  def on_delete_customer
+     #delete your singtel customer here. in arguments variable you ll find a hash with the params received in the request. eg: arguments[:ISVCUSTNO], return the ivcustno as a string if everything went fine, if not nil.
+  end
+
+  def on_create_product
+    # Create your singtel product here. In arguments variable you ll find a hash with the params received in the request. eg arguments[:ISVSUBSID], return the isvsubsid as a string if everything went fine, if not nil.
+  end
+
+  def on_update_product
+    # Update your singtel product here. In arguments variable you ll find a hash with the params received in the request. eg: arguments[:NEWISVSUBSID], return the newisvsubsid as a string if everything went fine, if not nil.
+  end
+
+  def on_delete_product
+    # Update your singtel product here. In arguments variable you ll find a hash with the params received in the request. eg: arguments[:NEWISVSUBSID], return the newisvsubsid as a string if everything went fine, if not nil.
+  end
+
+  def on_create_user
+  end
+
+  def on_update_user
+  end
+
+  def on_delete_user
+  end
+end
+```
+
+### Customize the controller
+
+The `SintelSdp::BaseAdapterController` should be overriden. You have to override `SingtelSdp::SingtelBaseAdapterController#sign\_in\_singtel\_user #sign\_in\_singtel\_user`.
+
+Optionally you can override `SingtelSdp::SingtelBaseAdapterController#on\_singtel\_login\_success #on\_singtel\_login\_success` and `SingtelSdp::SingtelBaseAdapterController#on\_singtel\_login\_failure #on\_singtel\_login\_failure`
+
+``` ruby
+# app/controller/singtel_controller.rb
+class SingtelController < SingtelSdp::BaseAdapterController
+  def sign_in_singtel_user(isvuserid)
+    # this is an implementation :P
+  end
+end
+```
+
+### Mounting the routes
+
+We provide a shortcut so you can add the `SingtelSdp::BaseAdapterController BaseAdapterController` to your `routes.rb`.
+
+Here's a snippet showing two different ways of mounting the routes:
+
+``` ruby
+# your routes.rb
+YourApp::Application.routes.draw do
+
+  # Will mount the default SingtelSdp:BaseAdapterController in the
+  # /singtel path.
+  add_singtel_sdp_routes
+end
+```
+
+### Customize the invalid session template
+
+SingtelSdp will redirect to invalid session template if an sso login fails:
+
+  * problems with the otp.
+  * problems with the conextion.
+
+You can copy the the built in template into your app's directory structure and customize them:
+
+```
+$ rails g singtel_sdp_views
+```
+
+# LICENSE
+
+MIT-LICENSE. Check LICENSE for more details

data/Rakefile

@@ -0,0 +1,27 @@
+#!/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    = 'SingtelSdp'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/controllers/singtel_sdp/base_adapter_controller.rb

@@ -0,0 +1,64 @@
+class SingtelSdp::BaseAdapterController < ApplicationController
+  skip_before_filter :verify_authenticity_token
+  before_filter :parse_request, only: :adapter
+  before_filter :validate_request, only: :adapter
+  before_filter :validate_header, only: :adapter
+
+  #singtel/adapter
+  def adapter
+    @singtel_request.execute
+    @requestno = @singtel_request.requestno
+    @return_value = @singtel_request.return_value
+    @returncode = @singtel_request.returncode
+    logger.info @returncode
+    render(if @returncode == 0
+      "#{@singtel_request.action_method_name}_response"
+    else
+      :error_response
+    end)
+  end
+
+  #singtel/sso
+  def sso
+    isvuserid = SingtelAdapter.verify_otp(params['otp'])
+    isvuserid = SingtelAdapter.verify_otp(params['otp']) if isvuserid.nil?
+    if isvuserid && sign_in_singtel_user(isvuserid)
+      self.on_singtel_login_success
+    else
+      self.on_singtel_login_failure
+    end
+  end
+
+  def on_singtel_login_success
+    redirect_to root_path
+  end
+
+  def on_singtel_login_failure
+    redirect_to invalid_session_path
+  end
+
+  # Singtel_sdp engine call this method when an user is aproved by singtel.
+  # Here you need to loggin the User with the isvuserid received as a param to your site.
+  def sign_in_singtel_user(isvuserid)
+    raise NotImplementedError.new("You must implement sign in.")
+  end
+
+
+  def parse_request
+    @singtel_request = SingtelAdapter.new(request.raw_post)
+  end
+
+  def validate_request
+    unless @singtel_request.valid_sdp_call?
+      @returncode = @singtel_request.returncode
+      render :error_response
+    end
+  end
+
+  def validate_header
+    unless @singtel_request.valid_header?
+      @returncode = @singtel_request.returncode
+      render :error_response
+    end
+  end
+end

data/app/models/singtel_sdp/base_adapter.rb

@@ -0,0 +1,400 @@
+require 'builder'
+
+class SingtelSdp::BaseAdapter
+  def initialize(sdp_xml_call)
+    @sdp_xml_call = sdp_xml_call
+    @code = SingtelSdp::ReturnCode.new
+    @resource
+  end
+
+
+  # In order to validate the role sent by singtel the possible roles should be
+  # defined.
+  #
+  # @return [List] of all the values that the role can have. eg: ['COOL USER','DEFAULT USER']
+  def roles
+    raise NotImplementedError.new("You must implement roles.")
+  end
+
+  # In order to validate the product sent by singtel the possible products should be
+  # defined.
+  #
+  # @return [List] of all the values that the product can take. eg: ['PROD1','PROD2']
+  def products
+    raise NotImplementedError.new("You must implement products.")
+  end
+
+  # In order to validate the SELECTFROM value sent by singtel the possible values should be
+  # defined.
+  #
+  # @return [List] of all the values that the SELECTFROM field can take.
+  # eg: [ 'LICENSE_SUMMARY' ]
+  def selectfrom_values
+    raise NotImplementedError.new("You must implement selectfrom_values.")
+  end
+
+  # As each implementation manage subscriptions in a different way the engine needs to know
+  # how to find a singtel subscription in your domain.
+  #
+  # @return [Class, nil] with the product instance in your domain.
+  def find_singtel_product(isvsubsid)
+    raise NotImplementedError.new('You must implement this method')
+  end
+
+  # As each implementation manage users in a different way the engine needs to know
+  # how to find a singtel user in your domain.
+  #
+  # @return [Class, nil] with the user instance in your domain.
+  def find_singtel_user(isvuserid)
+    raise NotImplementedError.new('You must implement this method')
+  end
+
+  # As each implementation manage customers in a different way the engin needs to know
+  # how to find a singtel customers in your domain.
+  #
+  # @return [Class, nil] with the customer instance in your domain.
+  def find_singtel_customer(isvcustno)
+    raise NotImplementedError.new('You must implement this method')
+  end
+
+
+  # Singtel_sdp engine needs a way to know if the user that singtel wants to work with
+  # exists or no. In this way the engine will be able to validate the input received in
+  # the domain of the adapter.
+  #
+  # @return [Class, nil] with the user instance in your domain.
+  def current_singtel_user
+    find_singtel_user(arguments[:ISVUSERID])
+  end
+
+  # For manageing update_product requests the engine needs to check if that subscription exists.
+  #
+  # @return [Class, nil] with the current_singtel_product of the request.
+  def current_singtel_product
+    find_singtel_product(arguments[:ISVSUBSID])
+  end
+
+  # For almost all request the isvcustno should be check in your domain thats why this methods
+  # returns the current customer
+  #
+  # @return [Class, nil] with the customer that comes in each request.
+  def current_singtel_customer
+    find_singtel_customer(arguments[:ISVCUSTNO])
+  end
+
+  [ :on_create_customer, :on_update_customer, :on_delete_customer, :on_select_customer,
+    :on_create_product, :on_update_product, :on_delete_product,
+    :on_create_user, :on_update_user, :on_delete_user ].each do |name|
+  # When singtel send an action for updating deleting or creating an entity you should
+  # represent that action in your domain. that means for example updating deleting or creating
+  # one of your users.
+  #
+  # @return [String, nil] the external id of the object that was updated,deleted or created.
+  # nil on failure
+    define_method name do
+      raise NotImplementedError.new("You must implement #{name}.")
+    end
+  end
+
+  def invalid_settings
+    @invalid_settings ||= [:userid, :password, :application,
+      :env, :adapterversion].reject do |key|
+      header_info[key] == SingtelSdp.send("isv#{key}")
+    end
+  end
+
+  # @return [Boolean] with true value is the xml is correctly formed
+  # and its an sdp call
+  def valid_sdp_call?
+    valid =  !@sdp_xml_call.blank? && self.class.valid_request?(@sdp_xml_call)
+    unless valid
+      @code.origin = :source
+      @code.entity = :other
+      @code.custom = :invalid_xml
+    end
+    valid
+  end
+
+  def self.otp_xml_request_body(otp)
+    xml = Builder::XmlMarkup.new(indent: 2)
+    xml.instruct!
+    xml.SingTelSDPRequest xmlns: 'SingTelSDPRequest.xsd' do
+      xml.HeaderInfo '', userid: SingtelSdp.isvuserid, password: SingtelSdp.isvpassword,
+        application: SingtelSdp.isvapplication, env: SingtelSdp.isvenv,
+        adapterversion: SingtelSdp.isvadapterversion,
+        createdatetime:Time.now.strftime('%FT%T%z'),
+        requestno: Time.now.strftime('%Y%m%d%H%M%S%L')
+      xml.RequestDetail do
+        xml.Entity name: 'OTP', action:'SSO' do
+          xml.Item '', fieldname: 'OTP', datatype: 'string', value: otp
+        end
+      end
+    end
+  end
+
+  def self.verify_otp(otp)
+    url = SingtelSdp.sdp_url
+    xml_response = SingtelSdp::SingtelHelper.raw_post_to_sdp(otp_xml_request_body(otp), url)
+    response = parse_xml_response(xml_response) if xml_response
+    return response[:arguments][:ISVUSERID] if response
+    nil
+  end
+
+
+  # Used for validating a sdp request header.
+  # Checks the attibutes from the header and sets to source of the error
+  # that will yield the proper error code.
+  #
+  # @return [Boolean] true is the header is correct
+  def valid_header?
+    unless invalid_settings.empty?
+      @code.origin = :source
+      @code.entity = :customer
+    end
+
+    case
+    when !(invalid_settings & [:userid, :password]).empty?
+    when invalid_settings.include?(:application)
+      @code.custom = :invalid_application
+    when invalid_settings.include?(:env)
+      @code.custom = :invalid_environment
+    when invalid_settings.include?(:adapterversion)
+      @code.custom = :invalid_adapterversion
+    end
+
+    !@code.has_errors?
+  end
+
+  # Contains an the xml request parsed by Nokogiri
+  # @return [Hash] with the request parsed
+  def parsed
+    @parsed ||= self.class.parse_xml_request(@sdp_xml_call)
+  end
+
+  # @returns [Hash] with the accessor to the header node from the parsed request
+  def header_info
+    parsed[:header_info]
+  end
+
+  # returns all the params
+  def arguments
+    parsed[:request_details][:arguments]
+  end
+
+  def entity
+    parsed[:request_details][:name].downcase.to_sym
+  end
+
+  def action
+    parsed[:request_details][:action].to_sym
+  end
+
+  def action_method_name
+    "#{action}_#{entity}"
+  end
+
+  def execute
+    @code.action = action
+    @code.entity = action == :select ? :customer_for_select : entity
+    @return_value = send(action_method_name)
+    @code.origin = :target unless @return_value or has_errors?
+  end
+
+  def return_value
+    @return_value
+  end
+
+  def returncode
+    @code.generate
+  end
+
+  # This is for setting the request number in an specific response. That means that a
+  # response for a request will have the same requestno.
+  #
+  # @return [String] with the requestno that came in the request.
+  def requestno
+    header_info[:requestno]
+  end
+
+  # mainly use for testing purpose
+  def has_errors?
+    @code.has_errors?
+  end
+
+  def create_customer
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_create_customer
+  end
+
+  def update_customer
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_update_customer
+  end
+
+  def delete_customer
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_delete_customer
+  end
+
+  def select_customer
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_select_customer
+  end
+
+  def create_product
+    validate_product_arguments
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_create_product
+  end
+
+  # In case of an update in a subscription we check the amount of accounts that
+  # the previous account represented and replace that ammount in the max_account
+  # value. This value contains the max ammount of accounts that an organization
+  # backup
+  def update_product
+    validate_product_arguments
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_update_product
+  end
+
+  def delete_product
+    validate_customer_arguments
+    validate_product_arguments
+    return if @code.has_errors?
+    deleted_extenal_id = on_delete_product
+    @code.origin = :target unless deleted_extenal_id
+    deleted_extenal_id
+  end
+
+  def create_user
+    validate_customer_arguments
+    validate_user_arguments
+    return if @code.has_errors?
+    self.on_create_user
+  end
+
+  def update_user
+    validate_user_arguments
+    return if @code.has_errors?
+    self.on_update_user
+  end
+
+  def delete_user
+    validate_user_arguments
+    validate_customer_arguments
+    return if @code.has_errors?
+    self.on_delete_user
+  end
+
+  def validate_customer_arguments
+    if entity == :customer && action == :select
+      @code.origin = :select_method
+      if !current_singtel_customer
+        @code.custom = :customer_not_found_for_select
+      elsif not selectfrom_values.include?(arguments[:SELECTFROM])
+        @code.custom = :invalid_selectfrom_value
+      end
+    else
+      if entity == :customer && action == :create
+        @code.origin = :source if current_singtel_customer
+      elsif current_singtel_customer.nil?
+        @code.origin = :source
+        @code.custom = :customer_not_found if [:user, :product].include?(entity)
+      end
+    end
+    current_singtel_customer
+  end
+
+
+  class << self
+    def valid_xml?(xml, xsd_path)
+      doc = Nokogiri::XML(xml)
+      xsd = Nokogiri::XML::Schema(File.read(xsd_path))
+      xsd.valid?(doc)
+    end
+
+    def valid_request?(xml)
+      valid_xml?(xml, SingtelSdp::REQUEST_XSD)
+    end
+
+    def valid_response?(xml)
+      valid_xml?(xml, SingtelSdp::RESPONSE_XSD)
+    end
+
+    def parser
+      if @_parser.nil?
+        @_parser = Nori.new(convert_tags_to: lambda { |tag| tag.gsub('@', '').to_sym })
+      end
+      @_parser
+    end
+
+    def parse_xml_request(xml)
+      result = {}
+      main_node = parser.parse(xml)[:SingTelSDPRequest]
+      result[:header_info] = get_header(main_node[:HeaderInfo])
+      request_details = main_node[:RequestDetail][:Entity]
+      request_details[:arguments] = get_arguments(request_details)
+      result[:request_details] = request_details
+      result
+    end
+
+    def parse_xml_response(xml)
+      result = {}
+      main_node = parser.parse(xml)[:SingTelSDPResponse]
+      response = main_node[:Result]
+      return unless response[:returncode].to_i == 0
+      result[:arguments] = get_arguments(response)
+      result[:response] = response
+      result
+    end
+
+    def get_header(header)
+      header[:createdatetime] = DateTime.parse(header[:createdatetime])
+      header
+    end
+
+    def get_arguments(node)
+      items = node.delete(:Item)
+      items = [items] unless items.is_a? Array
+      Hash[items.collect{ |i| [i[:fieldname].to_sym, i[:value]] }]
+    end
+  end
+
+
+  private
+
+  def validate_user_arguments
+    user = current_singtel_user
+    if !roles.include?(arguments[:ISVUSERROLE]) && action != :delete
+      @code.origin = :source
+      @code.custom = :invalid_user_role
+    elsif entity == :user && action == :create
+      @code.origin = :source if user
+    elsif user.nil?
+      @code.origin = :source
+    end
+
+    user
+  end
+
+  def validate_product_arguments
+    if !products.include?(arguments[:NEWISVPRODID]) && action == :update or
+      !products.include?(arguments[:ISVPRODID]) && action == :create
+      @code.origin = :source
+      @code.custom = :invalid_product_name
+    elsif arguments[:NEWISVSUBSID] && find_singtel_product(arguments[:NEWISVSUBSID])
+      @code.custom = :duplicated_subscription
+      @code.origin = :source
+    elsif current_singtel_product.nil? && action != :create
+      @code.origin = :source
+    end
+    current_singtel_product
+  end
+
+end

data/app/models/singtel_sdp/return_code.rb

@@ -0,0 +1,113 @@
+class SingtelSdp::ReturnCode
+  ORIGINS = { no_error: 0, target: 1, source: 2, customer_data: 3, select_method: 6 }
+  ACTIONS = { general: 0, create: 2, update: 4, delete: 6, select: 0 }
+  ENTITIES = { general: 0, other: 1, customer: 2, product: 4, user: 6, customer_for_select: 0 }
+  CUSTOM_DIGIT = { general: 0, invalid_application: 1,
+    invalid_product_name: 1, invalid_user_role: 1,
+    invalid_environment: 3, invalid_adapterversion: 4,
+    duplicated_subscription: 4, invalid_xml: 5,
+    customer_not_found: 5,
+    customer_not_found_for_select: 1, invalid_selectfrom_value: 2 }
+
+  RETURN_MESSAGES = {
+    0 => 'Success',
+    -1 => 'In Progress',
+    1000 => 'General Error',
+    1220 => 'Failed to Create Customer',
+    1240 => 'Failed to Create Product',
+    1260 => 'Failed to Create User',
+    1420 => 'Failed to Update Customer',
+    1440 => 'Failed to Update Product',
+    1460 => 'Failed to Update User',
+    1620 => 'Failed to Delete Customer',
+    1640 => 'Failed to Delete Product',
+    1660 => 'Failed to Delete User',
+    2000 => 'Invalid OTP',
+    2010 => 'Invalid Source Server',
+    2015 => 'Invalid Request XML',
+    2016 => 'Invalid Response XML',
+    2020 => 'Invalid UserID and Password',
+    2021 => 'Invalid application name',
+    2023 => 'Invalid environment',
+    2024 => 'Invalid adapter version',
+    2025 => 'Invalid CreateDatetime',
+    2026 => 'Duplicated requestno',
+    2040 => 'Invalid Entity type',
+    2041 => 'Invalid Action type',
+    2220 => 'Duplicated Customer',
+    2240 => 'Duplicated Subscription',
+    2241 => 'Invalid Product Name',
+    2242 => 'Invalid Trial Indicator',
+    2243 => 'Invalid Quantity',
+    2245 => 'Customer not found',
+    2260 => 'Duplicated User',
+    2261 => 'Invalid User Role',
+    2265 => 'Customer not found',
+    2266 => 'Subscription not found',
+    2420 => 'Customer Not found',
+    2440 => 'Subscription Not found',
+    2441 => 'Invalid Product Name',
+    2442 => 'Invalid Trial Indicator',
+    2443 => 'Invalid Quantity',
+    2444 => 'Duplicated Subscription',
+    2460 => 'User Not Found',
+    2461 => 'Invalid User Role',
+    2620 => 'Customer not found',
+    2640 => 'Subscription not found',
+    2645 => 'Customer not found',
+    2660 => 'User not found',
+    2665 => 'Customer not found',
+    2666 => 'Subscription not found',
+    3260 => 'Email cannot be null',
+    3261 => 'Invalid Email account',
+    3262 => 'Existing Email account detected',
+    3263 => 'Exceeded allowed number of total users license',
+    3264 => 'Exceeded allowed number of admin users license',
+    3460 => 'Invalid Email account',
+    3462 => 'Existing Email account',
+    6001 => 'Customer not found',
+    6002 => 'Invalid SELECTFROM value',
+  }
+   
+  def initialize
+    # These are the four digits that will compose
+    # the final returncode
+    self.origin = :no_error
+    self.action = :general
+    self.entity = :general
+    self.custom = :general
+  end
+
+  def origin=(key)
+    @origin = ORIGINS[key]
+  end
+
+  def action=(key)
+    @action = ACTIONS[key]
+  end
+
+  def entity=(key)
+    @entity = ENTITIES[key]
+  end
+
+  def custom=(key)
+    @custom = CUSTOM_DIGIT[key]
+  end
+
+  def generate
+    return 0 unless has_errors?
+    "#{@origin}#{@action}#{@entity}#{@custom}".to_i
+  end
+
+  def message
+    RETURN_MESSAGES[generate]
+  end
+  
+  def has_errors?
+    if @origin == ORIGINS[:select_method]
+      @custom != 0
+    else
+      @origin != 0
+    end
+  end
+end

data/app/views/singtel_sdp/base_adapter/create_customer_response.xml.builder

@@ -0,0 +1,9 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo do
+      xml.Item '', fieldname: 'ISVCUSTNO', datatype: 'string',
+        value: @return_value
+  end
+end

data/app/views/singtel_sdp/base_adapter/create_product_response.xml.builder

@@ -0,0 +1,9 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo do
+      xml.Item '', fieldname: 'ISVSUBSID', datatype: 'string',
+        value: @return_value
+  end
+end

data/app/views/singtel_sdp/base_adapter/create_user_response.xml.builder

@@ -0,0 +1,9 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo do
+      xml.Item '', fieldname: 'ISVUSERID', datatype: 'string',
+        value: @return_value
+  end
+end

data/app/views/singtel_sdp/base_adapter/delete_customer_response.xml.builder

@@ -0,0 +1,6 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo
+end

data/app/views/singtel_sdp/base_adapter/delete_product_response.xml.builder

@@ -0,0 +1,6 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo
+end

data/app/views/singtel_sdp/base_adapter/delete_user_response.xml.builder

@@ -0,0 +1,6 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo
+end

data/app/views/singtel_sdp/base_adapter/error_response.xml.builder

@@ -0,0 +1,7 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo
+end
+

data/app/views/singtel_sdp/base_adapter/invalid_session.html.haml

@@ -0,0 +1 @@
+ivalid session :(

data/app/views/singtel_sdp/base_adapter/select_customer_response.xml.builder

@@ -0,0 +1,11 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo do
+      xml.Data fieldid: 'USAGELICENSE_LIST' do
+        xml.Licenses total: @return_value[:total], assigned: @return_value[:assigned],
+          spare: @return_value[:spare]
+      end
+  end
+end

data/app/views/singtel_sdp/base_adapter/update_customer_response.xml.builder

@@ -0,0 +1,6 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo
+end

data/app/views/singtel_sdp/base_adapter/update_product_response.xml.builder

@@ -0,0 +1,9 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo do
+      xml.Item '', fieldname: 'ISVSUBSID', datatype: 'string',
+        value: @return_value
+  end
+end

data/app/views/singtel_sdp/base_adapter/update_user_response.xml.builder

@@ -0,0 +1,6 @@
+xml.instruct!
+xml.SingTelSDPResponse xmlns: 'SingTelSDPResponse.xsd' do
+  xml.Result returncode: @returncode,
+    returnmessage: SingtelSdp::ReturnCode::RETURN_MESSAGES[@returncode],
+    requestno: @requestno, moreinfo: @moreinfo
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/generators/singtel_sdp_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+class SingtelSdpGenerator < Rails::Generators::Base
+  self.source_root([File.expand_path("../../../app/views", __FILE__)])
+
+  desc 'creates the controller and initializer file for SingtelSdp.'
+  def create_all
+    directory 'singtel_sdp', 'app/views'
+  end
+end

data/lib/generators/singtel_sdp_views_generator.rb

@@ -0,0 +1,10 @@
+require 'rails/generators'
+
+class SingtelSdpGenerator < Rails::Generators::Base
+  self.source_root([File.expand_path("../../../app/views", __FILE__)])
+
+  desc 'creates the controller and initializer file for SingtelSdp.'
+  def create_singtel_sdp_views
+    directory 'singtel_sdp', 'app/views'
+  end
+end

data/lib/resources/xsds/SingTelSDPRequest.xsd

@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema id="SingTelSDPRequest" targetNamespace="SingTelSDPRequest.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
+  <xs:element name="SingTelSDPRequest">
+    <xs:complexType>
+      <xs:sequence>
+        <xs:element name="HeaderInfo" minOccurs="1" maxOccurs="1">
+          <xs:complexType>
+            <xs:attribute name="userid" type="xs:string" use="required" />
+            <xs:attribute name="password" type="xs:string" use="required" />
+            <xs:attribute name="application" type="xs:string" use="required" />
+            <xs:attribute name="env" type="xs:string" use="required" />
+            <xs:attribute name="adapterversion" type="xs:string" use="required" />
+            <xs:attribute name="createdatetime" type="xs:string" use="required" />
+            <xs:attribute name="requestno" type="xs:string" use="required" />
+          </xs:complexType>
+        </xs:element>
+        <xs:element name="RequestDetail" minOccurs="1" maxOccurs="1">
+          <xs:complexType>
+            <xs:sequence>
+              <xs:element name="Entity" minOccurs="1" maxOccurs="unbounded">
+                <xs:complexType>
+                  <xs:sequence>
+                    <xs:element name="Item" minOccurs="1" maxOccurs="unbounded">
+                      <xs:complexType>
+                        <xs:attribute name="fieldname" type="xs:string" use="required" />
+                        <xs:attribute name="datatype" type="xs:string" use="required" />
+                        <xs:attribute name="value" type="xs:string" use="required" />
+                      </xs:complexType>
+                    </xs:element>
+                  </xs:sequence>
+                  <xs:attribute name="name" type="xs:string" use="required" />
+                  <xs:attribute name="action" type="xs:string" use="required" />
+                </xs:complexType>
+              </xs:element>
+            </xs:sequence>
+          </xs:complexType>
+        </xs:element>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

data/lib/resources/xsds/SingTelSDPResponse.xsd

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="utf-8"?>
+<xs:schema id="SingTelSDPResponse" targetNamespace="SingTelSDPResponse.xsd" xmlns:xs="http://www.w3.org/2001/XMLSchema"
+elementFormDefault="qualified">
+  <xs:element name="SingTelSDPResponse">
+    <xs:complexType>
+      <xs:sequence>
+          <xs:element name="Result" minOccurs="1" maxOccurs="1">
+              <xs:complexType>
+                  <xs:sequence>
+                    <xs:element name="Item" minOccurs="0" maxOccurs="unbounded">
+                      <xs:complexType>
+                        <xs:attribute name="fieldname" type="xs:string" use="required" />
+                        <xs:attribute name="datatype" type="xs:string" use="required" />
+                        <xs:attribute name="value" type="xs:string" use="required" />
+                      </xs:complexType>
+                    </xs:element>
+                  </xs:sequence>
+                  <xs:attribute name="returncode" type="xs:string"  use="required" />
+                  <xs:attribute name="returnmessage" type="xs:string"  use="required" />
+                  <xs:attribute name="moreinfo" type="xs:string"  use="required" />
+                  <xs:attribute name="requestno" type="xs:string"  use="required" />
+              </xs:complexType>
+          </xs:element>
+      </xs:sequence>
+    </xs:complexType>
+  </xs:element>
+</xs:schema>

data/lib/singtel_sdp.rb

@@ -0,0 +1,8 @@
+require "singtel_sdp/engine"
+require "singtel_sdp/singtel_helper"
+require "singtel_sdp/rails/routes"
+
+module SingtelSdp
+  REQUEST_XSD = "#{File.dirname(__FILE__)}/../lib/resources/xsds/SingTelSDPRequest.xsd"
+  RESPONSE_XSD = "#{File.dirname(__FILE__)}/../lib/resources/xsds/SingTelSDPResponse.xsd"
+end

data/lib/singtel_sdp/engine.rb

@@ -0,0 +1,51 @@
+require 'nori'
+require 'nokogiri'
+require 'hashie'
+
+module SingtelSdp
+  # This is the url of sdp
+  # !@property mattr_accessor
+  # @returns [String] example: https://marketplace-uat.singtel.com/SSOBalance/
+  mattr_accessor :sdp_url
+
+  # This is the user id that singtel uses to identify in your application
+  # !@property mattr_accessor
+  # @returns [String] example: dropmyemail_singtel_user
+  mattr_accessor :isvuserid
+
+  # This is the password that singtel uses to identify in your application
+  # !@property mattr_accessor
+  # @returns [String] example: 123456
+  mattr_accessor :isvpassword
+
+  # This is the name you gave to singtel for your application.
+  # !@property mattr_accessor
+  # @returns [String] example: dropmyemail.com
+  mattr_accessor :isvapplication
+
+  # This is the current environment of the request.
+  # !@property mattr_accessor
+  # @returns [String] example: UAT
+  mattr_accessor :isvenv
+
+  # This is the version of your adapter.
+  # !@property mattr_accessor
+  # @returns [String] example: 0.1
+  mattr_accessor :isvadapterversion
+
+  def self.setup
+    config = Hashie::Mash.new
+    yield config
+    self.sdp_url = config.sdpurl
+    self.isvuserid = config.isvuserid
+    self.isvpassword = config.isvpassword
+    self.isvapplication = config.isvapplication
+    self.isvenv = config.isvenv
+    self.isvadapterversion = config.isvadapterversion
+  end
+
+  class Engine < ::Rails::Engine
+    initializer 'singtel_sdp starts nori configs' do |app|
+    end
+  end
+end

data/lib/singtel_sdp/rails/routes.rb

@@ -0,0 +1,11 @@
+class ActionDispatch::Routing::Mapper
+  def add_singtel_sdp_routes(controller='singtel_sdp/singtel')
+    lambda do
+      scope '/singtel', module: :singtel do
+        match 'adapter', via: :all
+        match 'sso', via: :all
+        get 'invalid_session'
+      end
+    end.call
+  end
+end

data/lib/singtel_sdp/singtel_helper.rb

@@ -0,0 +1,37 @@
+require 'net/http'
+module SingtelSdp
+  class SingtelHelper
+    # This returns the absolute path of the engine whethere you are in the engine or in the host
+    # app.
+    def self.root
+      "#{File.dirname(__FILE__)}/../.."
+    end
+    
+    # Validates a user provided OTP against Singtel SSO remote API.
+    # Response is an XML containing either an error or the valid user id.
+    # Returns nil if any network errors occur. 
+    #
+    # @param xml [String] SSO request containing OTP
+    # @return [String,nil] XML response for the login attempt, nil on failure.
+    def self.raw_post_to_sdp(xml, url, ssl = true)
+      uri = URI.parse(url)
+      begin
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = ssl
+        request = Net::HTTP::Post.new(uri.path)
+        request.body = xml
+        request['Content-Type'] = 'text/xml'
+        response = http.request(request)
+        response.body
+      rescue => e 
+        return nil
+      end
+    end
+
+    # retrives the content of some xml request and response examples
+    def self.xml_for(filename)
+     File.read("#{root}/spec/fixtures/singtel/samples/#{filename}.xml") 
+    end
+    
+  end
+end

data/lib/singtel_sdp/version.rb

@@ -0,0 +1,3 @@
+module SingtelSdp
+  VERSION = "1.2.0"
+end

data/lib/tasks/singtel_sdp_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :singtel_sdp do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: singtel_sdp
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- Alan Moran
+- Tomas Rojas
+- Bruno Nubis
+- Wong Liang Zan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: rspec-rails
+  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: factory_girl_rails
+  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: capybara
+  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'
+description: |2
+      Rails 4 engine that provides Singtel's SDP integration points to your rails app.
+      Processes and translates requestes for the standard CRUD actions for Customers, Products, Users and OAuth SSO.
+email:
+- zan@dropmysite.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/assets/stylesheets/application.css
+- app/controllers/singtel_sdp/base_adapter_controller.rb
+- app/models/singtel_sdp/base_adapter.rb
+- app/models/singtel_sdp/return_code.rb
+- app/views/singtel_sdp/base_adapter/create_customer_response.xml.builder
+- app/views/singtel_sdp/base_adapter/create_product_response.xml.builder
+- app/views/singtel_sdp/base_adapter/create_user_response.xml.builder
+- app/views/singtel_sdp/base_adapter/delete_customer_response.xml.builder
+- app/views/singtel_sdp/base_adapter/delete_product_response.xml.builder
+- app/views/singtel_sdp/base_adapter/delete_user_response.xml.builder
+- app/views/singtel_sdp/base_adapter/error_response.xml.builder
+- app/views/singtel_sdp/base_adapter/invalid_session.html.haml
+- app/views/singtel_sdp/base_adapter/select_customer_response.xml.builder
+- app/views/singtel_sdp/base_adapter/update_customer_response.xml.builder
+- app/views/singtel_sdp/base_adapter/update_product_response.xml.builder
+- app/views/singtel_sdp/base_adapter/update_user_response.xml.builder
+- config/routes.rb
+- lib/generators/singtel_sdp_generator.rb
+- lib/generators/singtel_sdp_views_generator.rb
+- lib/resources/xsds/SingTelSDPRequest.xsd
+- lib/resources/xsds/SingTelSDPResponse.xsd
+- lib/singtel_sdp/engine.rb
+- lib/singtel_sdp/rails/routes.rb
+- lib/singtel_sdp/singtel_helper.rb
+- lib/singtel_sdp/version.rb
+- lib/singtel_sdp.rb
+- lib/tasks/singtel_sdp_tasks.rake
+- LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/dropmyemail/singtel_sdp
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Provides Singtel's SDP integration points to your rails app
+test_files: []