oneapi-ruby 1.0.0

data/lib/oneapi-ruby/models.rb

@@ -0,0 +1,205 @@
+require_relative 'objects'
+
+# ----------------------------------------------------------------------------------------------------
+# Generic:
+# ----------------------------------------------------------------------------------------------------
+
+module OneApi
+
+    class OneApiAuthentication < OneApiModel
+
+        oneapi_attr_accessor :username, FieldConversionRule.new()
+        oneapi_attr_accessor :password, FieldConversionRule.new()
+        oneapi_attr_accessor :ibsso_token, FieldConversionRule.new('login.ibAuthCookie | TODO')
+        oneapi_attr_accessor :authenticated, FieldConversionRule.new()
+        oneapi_attr_accessor :verified, FieldConversionRule.new('login.verified | TODO')
+
+    end
+
+    class OneApiError < OneApiModel
+
+        oneapi_attr_accessor :message_id, FieldConversionRule.new('requestError.serviceException.messageId | requestError.policyException.messageId')
+        oneapi_attr_accessor :text, FieldConversionRule.new('requestError.serviceException.text | requestError.policyException.text')
+        oneapi_attr_accessor :variables, FieldConversionRule.new('requestError.serviceException.variables | requestError.policyException.variables')
+
+    end
+
+    class GenericObject < OneApiModel
+
+        # FIXME: WIthout this it is not a valid model
+        oneapi_attr_accessor :ignore, FieldConversionRule.new(:ignore)
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # Messaging:
+    # ----------------------------------------------------------------------------------------------------
+
+    class SMSRequest < OneApiModel
+
+        oneapi_attr_accessor :sender_address, FieldConversionRule.new(:senderAddress)
+        oneapi_attr_accessor :sender_name, FieldConversionRule.new(:senderName)
+        oneapi_attr_accessor :message, FieldConversionRule.new()
+        oneapi_attr_accessor :address, FieldConversionRule.new()
+        oneapi_attr_accessor :client_correlator, FieldConversionRule.new(:clientCorrelator)
+        oneapi_attr_accessor :notify_url, FieldConversionRule.new(:notifyUrl)
+        oneapi_attr_accessor :callback_data, FieldConversionRule.new()
+
+    end
+
+    class ResourceReference < OneApiModel
+
+        oneapi_attr_accessor :client_correlator, LastPartOfUrlFieldConversionRule.new('resourceReference.resourceURL')
+
+    end
+
+    class DeliveryInfo < OneApiModel
+
+        oneapi_attr_accessor :address, FieldConversionRule.new(:address)
+        oneapi_attr_accessor :delivery_status, FieldConversionRule.new(:deliveryStatus)
+
+    end
+
+    class DeliveryInfoList < OneApiModel
+
+        oneapi_attr_accessor :delivery_info, ObjectArrayConversionRule.new(DeliveryInfo, json_field_name='deliveryInfoList.deliveryInfo')
+
+    end
+
+    class DeliveryInfoNotification < OneApiModel
+
+        oneapi_attr_accessor :delivery_info, ObjectFieldConverter.new(DeliveryInfo, 'deliveryInfoNotification.deliveryInfo')
+        oneapi_attr_accessor :callback_data, FieldConversionRule.new('deliveryInfoNotification.callbackData')
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # HLR:
+    # ----------------------------------------------------------------------------------------------------
+
+    class ServingMccMnc < OneApiModel
+
+        oneapi_attr_accessor :mcc, FieldConversionRule.new(:mcc)
+        oneapi_attr_accessor :mnc, FieldConversionRule.new(:mnc)
+
+    end
+
+    class TerminalRoamingExtendedData < OneApiModel
+
+        oneapi_attr_accessor :destination_address, FieldConversionRule.new('destinationAddress')
+        oneapi_attr_accessor :status_id, FieldConversionRule.new('statusId')
+        oneapi_attr_accessor :done_time, FieldConversionRule.new('doneTime')
+        oneapi_attr_accessor :price_per_message, FieldConversionRule.new('pricePerMessage')
+        oneapi_attr_accessor :mcc_mnc, FieldConversionRule.new('mccMnc')
+        oneapi_attr_accessor :serving_msc, FieldConversionRule.new('servingMsc')
+        oneapi_attr_accessor :censored_serving_msc, FieldConversionRule.new('censoredServingMsc')
+        oneapi_attr_accessor :gsm_error_code, FieldConversionRule.new('gsmErrorCode')
+        oneapi_attr_accessor :original_network_name, FieldConversionRule.new('originalNetworkName')
+        oneapi_attr_accessor :ported_network_name, FieldConversionRule.new('portedNetworkName')
+        oneapi_attr_accessor :serving_hlr, FieldConversionRule.new('servingHlr')
+        oneapi_attr_accessor :imsi, FieldConversionRule.new('imsi')
+        oneapi_attr_accessor :original_network_prefix, FieldConversionRule.new('originalNetworkPrefix')
+        oneapi_attr_accessor :original_country_prefix, FieldConversionRule.new('originalCountryPrefix')
+        oneapi_attr_accessor :original_country_name, FieldConversionRule.new('originalCountryName')
+        oneapi_attr_accessor :is_number_ported, FieldConversionRule.new('isNumberPorted')
+        oneapi_attr_accessor :ported_network_prefix, FieldConversionRule.new('portedNetworkPrefix')
+        oneapi_attr_accessor :ported_country_prefix, FieldConversionRule.new('portedCountryPrefix')
+        oneapi_attr_accessor :ported_country_name, FieldConversionRule.new('portedCountryName')
+        oneapi_attr_accessor :number_in_roaming, FieldConversionRule.new('numberInRoaming')
+
+    end
+
+    class TerminalRoamingStatus < OneApiModel
+
+        oneapi_attr_accessor :servingMccMnc, ObjectFieldConverter.new(ServingMccMnc, 'servingMccMnc')
+        oneapi_attr_accessor :address, FieldConversionRule.new()
+        oneapi_attr_accessor :currentRoaming, FieldConversionRule.new('currentRoaming')
+        oneapi_attr_accessor :resourceURL, FieldConversionRule.new('resourceURL')
+        oneapi_attr_accessor :retrievalStatus, FieldConversionRule.new('retrievalStatus')
+        oneapi_attr_accessor :callbackData, FieldConversionRule.new('callbackData')
+        oneapi_attr_accessor :extendedData, ObjectFieldConverter.new(TerminalRoamingExtendedData, 'extendedData')
+
+    end
+
+
+    class TerminalRoamingStatusNotification < OneApiModel
+
+        oneapi_attr_accessor :delivery_info, ObjectFieldConverter.new(TerminalRoamingStatus, 'terminalRoamingStatusList.roaming')
+        oneapi_attr_accessor :callback_data, FieldConversionRule.new('terminalRoamingStatusList.roaming.callbackData')
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # Customer profile:
+    # ----------------------------------------------------------------------------------------------------
+
+    class CustomerProfile < OneApiModel
+
+        oneapi_attr_accessor :id, FieldConversionRule.new()
+        oneapi_attr_accessor :username, FieldConversionRule.new()
+        oneapi_attr_accessor :forename, FieldConversionRule.new()
+        oneapi_attr_accessor :surname, FieldConversionRule.new()
+        oneapi_attr_accessor :street, FieldConversionRule.new()
+        oneapi_attr_accessor :city, FieldConversionRule.new()
+        oneapi_attr_accessor :zip_code, FieldConversionRule.new('zipCode')
+        oneapi_attr_accessor :telephone, FieldConversionRule.new()
+        oneapi_attr_accessor :gsm, FieldConversionRule.new()
+        oneapi_attr_accessor :fax, FieldConversionRule.new()
+        oneapi_attr_accessor :email, FieldConversionRule.new()
+        oneapi_attr_accessor :msn, FieldConversionRule.new()
+        oneapi_attr_accessor :skype, FieldConversionRule.new()
+        oneapi_attr_accessor :country_id, FieldConversionRule.new('countryId')
+        oneapi_attr_accessor :timezone_id, FieldConversionRule.new('timezoneId')
+        oneapi_attr_accessor :primary_language_id, FieldConversionRule.new('primaryLanguageId')
+        oneapi_attr_accessor :secondary_language_id, FieldConversionRule.new('secondaryLanguageId')
+
+    end
+
+    class Currency < OneApiModel
+
+        oneapi_attr_accessor :id, FieldConversionRule.new()
+        oneapi_attr_accessor :currency_name, FieldConversionRule.new('currencyName')
+        oneapi_attr_accessor :symbol, FieldConversionRule.new()
+
+    end
+
+    class Currency < OneApiModel
+
+        oneapi_attr_accessor :id, FieldConversionRule.new()
+        oneapi_attr_accessor :currency_name, FieldConversionRule.new('currencyName')
+        oneapi_attr_accessor :symbol, FieldConversionRule.new()
+
+    end
+
+    class AccountBalance < OneApiModel
+
+        oneapi_attr_accessor :balance, FieldConversionRule.new()
+        oneapi_attr_accessor :currency, ObjectFieldConverter.new(Currency)
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # Inbound:
+    # ----------------------------------------------------------------------------------------------------
+
+    class InboundSmsMessage < OneApiModel
+
+        oneapi_attr_accessor :date_time, FieldConversionRule.new('dateTime')
+        oneapi_attr_accessor :destination_address, FieldConversionRule.new('destinationAddress')
+        oneapi_attr_accessor :message_id, FieldConversionRule.new('messageId')
+        oneapi_attr_accessor :message, FieldConversionRule.new('message')
+        oneapi_attr_accessor :resource_url, FieldConversionRule.new('resourceURL')
+        oneapi_attr_accessor :sender_address, FieldConversionRule.new('senderAddress')
+
+    end
+
+    class InboundSmsMessages < OneApiModel
+
+        oneapi_attr_accessor :inbound_sms_message, ObjectArrayConversionRule.new(InboundSmsMessage, 'inboundSMSMessageList.inboundSMSMessage')
+        oneapi_attr_accessor :number_of_messages_in_this_batch, FieldConversionRule.new('inboundSMSMessageList.numberOfMessagesInThisBatch')
+        oneapi_attr_accessor :total_number_of_pending_messages, FieldConversionRule.new('inboundSMSMessageList.totalNumberOfPendingMessages')
+        oneapi_attr_accessor :callback_data, FieldConversionRule.new('inboundSMSMessageList.callbackData')
+
+    end
+
+end

data/lib/oneapi-ruby/objects.rb

@@ -0,0 +1,174 @@
+=begin
+require_relative 'rubygems'
+require_relative 'ruby-debug'
+=end
+
+require_relative 'utils'
+
+module OneApi
+
+    class FieldConversionRule
+
+        attr_accessor :object_field_name
+        attr_accessor :json_field_name
+
+        def initialize(json_field_name=nil)
+            @json_field_name = json_field_name
+            @object_field_name = nil
+        end
+
+        def from_json(value)
+            value
+        end
+
+        def to_json(value)
+            value
+        end
+
+    end
+
+
+    class ObjectFieldConverter < FieldConversionRule
+
+        def initialize(classs, json_field_name=nil)
+            super(json_field_name)
+            @classs = classs
+        end
+
+        def from_json(value)
+            if value == nil
+                return nil
+            end
+
+            return Conversions.from_json(@classs, value, is_error=nil)
+        end
+
+        def to_json(value)
+            # TODO
+        end
+
+    end
+
+    class ObjectArrayConversionRule < FieldConversionRule
+
+        def initialize(classs, json_field_name=nil)
+            super(json_field_name)
+            @classs = classs
+        end
+
+        def from_json(values)
+            if not values
+                return []
+            end
+
+            result = []
+
+            for value in values
+                result.push(Conversions.from_json(@classs, value, is_error=nil))
+            end
+
+            return result
+        end
+
+        def to_json(value)
+            # TODO
+        end
+
+    end
+
+    class LastPartOfUrlFieldConversionRule < FieldConversionRule
+
+        def initialize(json_field_name=nil)
+            super(json_field_name)
+        end
+
+        def from_json(value)
+            if ! value
+                return nil
+            end
+
+            parts = value.split('/')
+
+            parts[-1]
+        end
+
+        def to_json(value)
+            value
+        end
+
+    end
+
+    class Conversions
+
+        def self.from_json(classs, json, is_error=nil)
+            object = classs.new
+
+            Conversions.fill_from_json(object, json, is_error)
+
+            object
+        end
+
+        def self.fill_from_json(object, json, is_error=nil)
+            if is_error
+                object.exception = Conversions.from_json(OneApiError, json, false)
+                return
+            end
+
+            json = JSONUtils.get_json(json)
+            conversion_rules = OneApiAccessorModifier.get_field_conversion_rules(object.class)
+            for conversion_rule in conversion_rules
+                json_value = JSONUtils.get(json, conversion_rule.json_field_name)
+                value = conversion_rule.from_json(json_value)
+                object.instance_variable_set("@#{conversion_rule.object_field_name}", value)
+            end
+        end
+
+        def self.to_json
+            # TODO(TK)
+        end
+
+    end
+
+    module OneApiAccessorModifier
+
+        @@field_conversion_rules = {}
+
+        def oneapi_attr_accessor(attr, field_conversion_rule)
+            attr_accessor attr
+
+            field_conversion_rule.object_field_name = attr
+
+            if Utils.empty(field_conversion_rule.json_field_name)
+                field_conversion_rule.json_field_name = attr
+            end
+
+            if not @@field_conversion_rules.has_key? self then
+                @@field_conversion_rules[self] = []
+            end
+
+            @@field_conversion_rules[self].push field_conversion_rule
+            #puts "field_conversion_rules is now #{@@field_conversion_rules}"
+        end
+
+        def OneApiAccessorModifier.get_field_conversion_rules(classs)
+            @@field_conversion_rules[classs]
+        end
+
+    end
+
+    class OneApiModel
+
+        extend OneApiAccessorModifier
+
+        attr_accessor :exception
+
+        def initialize
+        end
+
+        def is_success
+            return @exception == nil
+        end
+
+    end
+
+end

data/lib/oneapi-ruby/utils.rb

@@ -0,0 +1,164 @@
+#require 'pry'
+require 'json'
+require 'socket'
+
+module OneApi
+
+    class JSONUtils
+
+        def self.get_json(json)
+            if json.instance_of? String
+                return JSON.parse(json)
+            end
+
+            return json
+        end
+
+        def self.get(json, field)
+            json = JSONUtils.get_json(json)
+
+            if not field
+                return nil
+            end
+
+            if field.instance_of? Symbol
+                field = field.to_s
+            end
+
+            if field.include?('|') then
+                field_parts = field.split('|')
+                for field_part in field_parts
+                    value = JSONUtils.get(json, field_part.strip)
+                    if value
+                        return value
+                    end
+                end
+                return nil
+            end
+
+            result = nil
+            parts = field.split('.')
+            result = json
+            for part in parts
+                if result == nil
+                    return nil
+                end
+
+                if part.to_i.to_s == part
+                    # Int index => array:
+                    result = result[part.to_i]
+                else
+                    # Hash:
+                    result = result[part]
+                end
+            end
+
+            result
+        end
+
+    end
+
+    class Utils
+
+        def self.empty(obj)
+            if obj == nil
+                return true
+            end
+
+            if obj.instance_of? Hash or obj.instance_of? Array or obj.instance_of? String
+                return obj.size == 0
+            end
+
+            return obj == 0
+        end
+
+        def self.get_random_string(length, chars)
+            if not length
+                raise "Invalid random string length: #{length}"
+            end
+            if not chars
+                raise "Invalid random chars: #{chars}"
+            end
+
+            result = ''
+
+            for i in 0..length
+                result += chars[rand(chars.length - 1), 1]
+            end
+
+            result
+        end
+
+        def self.get_random_alphanumeric_string(length=10)
+            get_random_string(length, 'qwertzuiopasdfghjklyxcvbnm123456789')
+        end
+
+    end
+
+    # Web server, to be used only in examples
+    class DummyWebServer
+
+        attr_accessor :requests
+
+        def initialize(ip_address, port)
+            @webserver = TCPServer.new(ip_address, port)
+            @session = nil
+            @requests = []
+        end
+
+        def start(seconds)
+            Thread.new {
+                while (@session = @webserver.accept)
+                    request_string = @session.sysread 10000
+                    @session.print "HTTP/1.1 200/OK\r\nContent-type:text/html\r\n\r\n"
+                    @session.print("OK")
+                    @session.close
+                    @requests.push(parse_request_string request_string)
+                end
+            }
+
+            sleep(seconds)
+
+            @webserver.close
+            if @session != nil
+                begin
+                    @session.close
+                rescue
+                end
+            end
+        end
+
+        def parse_request_string request_string
+            lines = request_string.split(/\n/)
+            method, url, http_version = lines[0].split(' ')
+            headers = {}
+            body = nil
+            for line in lines[1,lines.length]
+                if body == nil
+                    if line.strip == ''
+                        body = ''
+                    else
+                        index = line.index ':'
+                        key = line[0,index].strip
+                        value = line[index + 1, line.length].strip
+                        headers[key] = value
+                    end
+                end
+
+                if body != nil
+                    body += line + "\n"
+                end
+            end
+            return method, url, headers, body.strip
+        end
+
+    end
+
+=begin
+dummy_web_server = DummyWebServer.new('localhost', 2000)
+dummy_web_server.start 10
+puts dummy_web_server.requests
+=end
+
+
+end