infobipapi 0.5.0

data/lib/infobipapi/models.rb

@@ -0,0 +1,277 @@
+# vim: set sw=4 ts=4 et :
+
+require_relative 'objects'
+
+# ----------------------------------------------------------------------------------------------------
+# Generic:
+# ----------------------------------------------------------------------------------------------------
+
+module InfobipApi
+
+
+    class InfobipApiError < InfobipApiModel
+
+        infobipapi_attr_accessor :message_id, FieldConversionRule.new('requestError.serviceException.messageId | requestError.policyException.messageId')
+        infobipapi_attr_accessor :text, FieldConversionRule.new('requestError.serviceException.text | requestError.policyException.text')
+        infobipapi_attr_accessor :variables, FieldConversionRule.new('requestError.serviceException.variables | requestError.policyException.variables')
+
+    end
+
+    class GenericObject < InfobipApiModel
+
+        # FIXME: WIthout this it is not a valid model
+        infobipapi_attr_accessor :ignore, FieldConversionRule.new(:ignore)
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # Messaging:
+    # ----------------------------------------------------------------------------------------------------
+
+
+    class AuthenticationAnswer < InfobipApiModel
+
+        infobipapi_attr_accessor :token, FieldConversionRule.new
+
+    end
+
+    class Language < InfobipApiModel
+
+      infobipapi_attr_accessor :language_code, FieldConversionRule.new(:languageCode)
+      infobipapi_attr_accessor :use_single_shift, FieldConversionRule.new(:useSingleShift)
+      infobipapi_attr_accessor :use_locking_shift, FieldConversionRule.new(:useLockingShift)
+
+    end
+
+    class StatusAnswer < InfobipApiModel
+
+        infobipapi_attr_accessor :group_id, FieldConversionRule.new(:groupId)
+        infobipapi_attr_accessor :group_name, FieldConversionRule.new(:groupName)
+        infobipapi_attr_accessor :id, FieldConversionRule.new()
+        infobipapi_attr_accessor :name, FieldConversionRule.new()
+        infobipapi_attr_accessor :descripton, FieldConversionRule.new()
+
+    end
+
+    class MessageAnswer < InfobipApiModel
+
+      infobipapi_attr_accessor :to, FieldConversionRule.new()
+      infobipapi_attr_accessor :status, ObjectFieldConverter.new(StatusAnswer, 'status')
+      infobipapi_attr_accessor :sms_count, FieldConversionRule.new(:smsCount)
+      infobipapi_attr_accessor :message_id, FieldConversionRule.new(:messageId)
+
+    end
+
+    class SimpleTextSMSRequest < InfobipApiModel
+
+        infobipapi_attr_accessor :from, FieldConversionRule.new()
+        infobipapi_attr_accessor :to, FieldConversionRule.new()
+        infobipapi_attr_accessor :text, FieldConversionRule.new()
+
+    end
+
+    class SimpleSMSAnswer < InfobipApiModel
+        infobipapi_attr_accessor :bulk_id, FieldConversionRule.new(:bulkId)
+        infobipapi_attr_accessor :messages, ObjectArrayConversionRule.new(MessageAnswer, 'messages')
+    end
+
+    class AdvancedTextSMSRequest < SimpleTextSMSRequest
+
+        infobipapi_attr_accessor :bulk_id, FieldConversionRule.new(:bulkId)
+        infobipapi_attr_accessor :message_id, FieldConversionRule.new(:messageId)
+        infobipapi_attr_accessor :flash, FieldConversionRule.new()
+        infobipapi_attr_accessor :transliteration, FieldConversionRule.new()
+        infobipapi_attr_accessor :language_code, FieldConversionRule.new(:languageCode)
+        infobipapi_attr_accessor :intermediate_report, FieldConversionRule.new(:intermediateReport)
+        infobipapi_attr_accessor :notify_url, FieldConversionRule.new(:notifyUrl)
+        infobipapi_attr_accessor :notify_content_type, FieldConversionRule.new(:notifyContentType)
+        infobipapi_attr_accessor :callback_data, FieldConversionRule.new(:callbackData)
+        infobipapi_attr_accessor :language, ObjectFieldConverter.new(Language,'language')
+
+    end
+
+    class ResourceReference < InfobipApiModel
+
+        infobipapi_attr_accessor :client_correlator, PartOfUrlFieldConversionRule.new('resourceReference.resourceURL',-2)
+
+    end
+
+    class DeliveryInfo < InfobipApiModel
+
+        infobipapi_attr_accessor :address, FieldConversionRule.new(:address)
+        infobipapi_attr_accessor :delivery_status, FieldConversionRule.new(:deliveryStatus)
+
+    end
+
+    class DeliveryInfoList < InfobipApiModel
+
+        infobipapi_attr_accessor :delivery_info, ObjectArrayConversionRule.new(DeliveryInfo, 'deliveryInfoList.deliveryInfo')
+
+    end
+
+    class DeliveryInfoNotification < InfobipApiModel
+
+        infobipapi_attr_accessor :delivery_info, ObjectFieldConverter.new(DeliveryInfo, 'deliveryInfoNotification.deliveryInfo')
+        infobipapi_attr_accessor :callback_data, FieldConversionRule.new('deliveryInfoNotification.callbackData')
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # HLR:
+    # ----------------------------------------------------------------------------------------------------
+
+    class ServingMccMnc < InfobipApiModel
+
+        infobipapi_attr_accessor :mcc, FieldConversionRule.new(:mcc)
+        infobipapi_attr_accessor :mnc, FieldConversionRule.new(:mnc)
+
+    end
+
+    class TerminalRoamingExtendedData < InfobipApiModel
+
+        infobipapi_attr_accessor :destination_address, FieldConversionRule.new('destinationAddress')
+        infobipapi_attr_accessor :status_id, FieldConversionRule.new('statusId')
+        infobipapi_attr_accessor :done_time, FieldConversionRule.new('doneTime')
+        infobipapi_attr_accessor :price_per_message, FieldConversionRule.new('pricePerMessage')
+        infobipapi_attr_accessor :mcc_mnc, FieldConversionRule.new('mccMnc')
+        infobipapi_attr_accessor :serving_msc, FieldConversionRule.new('servingMsc')
+        infobipapi_attr_accessor :censored_serving_msc, FieldConversionRule.new('censoredServingMsc')
+        infobipapi_attr_accessor :gsm_error_code, FieldConversionRule.new('gsmErrorCode')
+        infobipapi_attr_accessor :original_network_name, FieldConversionRule.new('originalNetworkName')
+        infobipapi_attr_accessor :ported_network_name, FieldConversionRule.new('portedNetworkName')
+        infobipapi_attr_accessor :serving_hlr, FieldConversionRule.new('servingHlr')
+        infobipapi_attr_accessor :imsi, FieldConversionRule.new('imsi')
+        infobipapi_attr_accessor :original_network_prefix, FieldConversionRule.new('originalNetworkPrefix')
+        infobipapi_attr_accessor :original_country_prefix, FieldConversionRule.new('originalCountryPrefix')
+        infobipapi_attr_accessor :original_country_name, FieldConversionRule.new('originalCountryName')
+        infobipapi_attr_accessor :is_number_ported, FieldConversionRule.new('isNumberPorted')
+        infobipapi_attr_accessor :ported_network_prefix, FieldConversionRule.new('portedNetworkPrefix')
+        infobipapi_attr_accessor :ported_country_prefix, FieldConversionRule.new('portedCountryPrefix')
+        infobipapi_attr_accessor :ported_country_name, FieldConversionRule.new('portedCountryName')
+        infobipapi_attr_accessor :number_in_roaming, FieldConversionRule.new('numberInRoaming')
+
+    end
+
+    class TerminalRoamingStatus < InfobipApiModel
+
+        infobipapi_attr_accessor :servingMccMnc, ObjectFieldConverter.new(ServingMccMnc, 'servingMccMnc')
+        infobipapi_attr_accessor :address, FieldConversionRule.new()
+        infobipapi_attr_accessor :currentRoaming, FieldConversionRule.new('currentRoaming')
+        infobipapi_attr_accessor :resourceURL, FieldConversionRule.new('resourceURL')
+        infobipapi_attr_accessor :retrievalStatus, FieldConversionRule.new('retrievalStatus')
+        infobipapi_attr_accessor :callbackData, FieldConversionRule.new('callbackData')
+        infobipapi_attr_accessor :extendedData, ObjectFieldConverter.new(TerminalRoamingExtendedData, 'extendedData')
+
+    end
+
+
+    class TerminalRoamingStatusNotification < InfobipApiModel
+
+        infobipapi_attr_accessor :delivery_info, ObjectFieldConverter.new(TerminalRoamingStatus, 'terminalRoamingStatusList.roaming')
+        infobipapi_attr_accessor :callback_data, FieldConversionRule.new('terminalRoamingStatusList.roaming.callbackData')
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # Customer profile:
+    # ----------------------------------------------------------------------------------------------------
+
+    class CustomerProfile < InfobipApiModel
+
+        infobipapi_attr_accessor :id, FieldConversionRule.new()
+        infobipapi_attr_accessor :username, FieldConversionRule.new()
+        infobipapi_attr_accessor :forename, FieldConversionRule.new()
+        infobipapi_attr_accessor :surname, FieldConversionRule.new()
+        infobipapi_attr_accessor :street, FieldConversionRule.new()
+        infobipapi_attr_accessor :city, FieldConversionRule.new()
+        infobipapi_attr_accessor :zip_code, FieldConversionRule.new('zipCode')
+        infobipapi_attr_accessor :telephone, FieldConversionRule.new()
+        infobipapi_attr_accessor :gsm, FieldConversionRule.new()
+        infobipapi_attr_accessor :fax, FieldConversionRule.new()
+        infobipapi_attr_accessor :email, FieldConversionRule.new()
+        infobipapi_attr_accessor :msn, FieldConversionRule.new()
+        infobipapi_attr_accessor :skype, FieldConversionRule.new()
+        infobipapi_attr_accessor :country_id, FieldConversionRule.new('countryId')
+        infobipapi_attr_accessor :timezone_id, FieldConversionRule.new('timezoneId')
+        infobipapi_attr_accessor :primary_language_id, FieldConversionRule.new('primaryLanguageId')
+        infobipapi_attr_accessor :secondary_language_id, FieldConversionRule.new('secondaryLanguageId')
+
+    end
+
+    class Currency < InfobipApiModel
+
+        infobipapi_attr_accessor :id, FieldConversionRule.new()
+        infobipapi_attr_accessor :currency_name, FieldConversionRule.new('currencyName')
+        infobipapi_attr_accessor :symbol, FieldConversionRule.new()
+
+    end
+
+    class Currency < InfobipApiModel
+
+        infobipapi_attr_accessor :id, FieldConversionRule.new()
+        infobipapi_attr_accessor :currency_name, FieldConversionRule.new('currencyName')
+        infobipapi_attr_accessor :symbol, FieldConversionRule.new()
+
+    end
+
+    class AccountBalance < InfobipApiModel
+
+        infobipapi_attr_accessor :balance, FieldConversionRule.new()
+        infobipapi_attr_accessor :currency, ObjectFieldConverter.new(Currency)
+
+    end
+
+    # ----------------------------------------------------------------------------------------------------
+    # Message delivery reports:
+    # ----------------------------------------------------------------------------------------------------
+
+    class DeliveryReportPrice < InfobipApiModel
+
+        infobipapi_attr_accessor :price_per_message, FieldConversionRule.new('pricePerMessage')
+        infobipapi_attr_accessor :currency, FieldConversionRule.new()
+
+    end
+
+    class DeliveryReportStatus < InfobipApiModel
+
+        infobipapi_attr_accessor :id, FieldConversionRule.new()
+        infobipapi_attr_accessor :group_id, FieldConversionRule.new('groupId')
+        infobipapi_attr_accessor :group_name, FieldConversionRule.new('groupName')
+        infobipapi_attr_accessor :name, FieldConversionRule.new()
+        infobipapi_attr_accessor :description, FieldConversionRule.new()
+
+    end
+
+    class DeliveryReportError < InfobipApiModel
+
+        infobipapi_attr_accessor :group_id, FieldConversionRule.new('groupId')
+        infobipapi_attr_accessor :group_name, FieldConversionRule.new('groupName')
+        infobipapi_attr_accessor :id, FieldConversionRule.new()
+        infobipapi_attr_accessor :name, FieldConversionRule.new()
+        infobipapi_attr_accessor :description, FieldConversionRule.new()
+        infobipapi_attr_accessor :permanent, FieldConversionRule.new()
+
+    end
+
+    class DeliveryReport < InfobipApiModel
+
+        infobipapi_attr_accessor :bulk_id, FieldConversionRule.new('bulkId')
+        infobipapi_attr_accessor :message_id, FieldConversionRule.new('messageId')
+        infobipapi_attr_accessor :to, FieldConversionRule.new()
+        infobipapi_attr_accessor :sent_at, FieldConversionRule.new('sentAt')
+        infobipapi_attr_accessor :done_at, FieldConversionRule.new('doneAt')
+        infobipapi_attr_accessor :sms_count, FieldConversionRule.new('smsCount')
+        infobipapi_attr_accessor :mcc_mnc, FieldConversionRule.new('mccMnc')
+        infobipapi_attr_accessor :price, ObjectFieldConverter.new(DeliveryReportPrice, 'price')
+        infobipapi_attr_accessor :status, ObjectFieldConverter.new(DeliveryReportStatus, 'status')
+        infobipapi_attr_accessor :error, ObjectFieldConverter.new(DeliveryReportError, 'error')
+
+    end
+
+    class DeliveryReportList < InfobipApiModel
+
+        infobipapi_attr_accessor :results, ObjectArrayConversionRule.new(DeliveryReport, 'results')
+    end
+
+
+end

data/lib/infobipapi/objects.rb

@@ -0,0 +1,198 @@
+# vim: set sw=4 ts=4 et :
+
+=begin
+require_relative 'rubygems'
+require_relative 'ruby-debug'
+=end
+
+require_relative 'utils'
+
+module InfobipApi
+
+    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, 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, 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 PartOfUrlFieldConversionRule < FieldConversionRule
+        def initialize(json_field_name=nil, part_index=nil)
+            super(json_field_name)
+            @part_index = part_index;
+        end
+
+        def from_json(value)
+            if ! value
+                return nil
+            end
+
+            parts = value.split('/')
+
+            parts[@part_index]
+        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)
+        end
+
+        def self.fill_from_json(object, json, is_error = nil)
+            if is_error
+                return Conversions.from_json(InfobipApiError, json, false)
+            end
+
+            json = JSONUtils.get_json(json)
+            conversion_rules = InfobipApiAccessorModifier.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
+            object
+        end
+
+        def self.to_json
+            # TODO(TK)
+        end
+
+    end
+
+    module InfobipApiAccessorModifier
+
+        @@field_conversion_rules = {}
+
+        def infobipapi_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 InfobipApiAccessorModifier.get_field_conversion_rules(classs)
+            @@field_conversion_rules[classs]
+        end
+
+    end
+
+    class InfobipApiModel
+
+        extend InfobipApiAccessorModifier
+
+        attr_accessor :exception
+
+        def initialize
+        end
+
+        def is_success
+            return @exception == nil
+        end
+
+    end
+
+end