oneapi-ruby 1.0.0

data/examples/example_on_inbound_message.rb

@@ -0,0 +1,13 @@
+lib = File.expand_path('../../lib', __FILE__)
+if File.exists?(lib)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+require 'oneapi-ruby'
+
+# In your script an HTTP POST request will be received, you should extract the body of this request...
+http_body = '...'
+
+#...and process it with:
+# example:on-mo
+inbound_messages = OneApi::SmsClient.unserialize_inbound_messages(http_body)
+# ----------------------------------------------------------------------------------------------------

data/examples/example_send_hlr_and_wait_for_delivery_push.rb

@@ -0,0 +1,50 @@
+lib = File.expand_path('../../lib', __FILE__)
+if File.exists?(lib)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+require 'oneapi-ruby'
+
+username = ARGV[0]
+password = ARGV[1]
+local_ip_address = ARGV[2]
+destination_address = ARGV[3]
+
+if OneApi::Utils.empty(username)
+  print "Username: "
+  username = gets.strip!
+end
+
+if OneApi::Utils.empty(password)
+  print "Password: "
+  password = gets.strip!
+end
+
+if OneApi::Utils.empty(local_ip_address)
+  print "Local IP address: "
+  local_ip_address = gets.strip!
+end
+
+if OneApi::Utils.empty(destination_address)
+  print "Destination (MSISDN): "
+  destination_address = gets.strip!
+end
+
+port = 9090
+
+data_connection_client = OneApi::DataConnectionProfileClient.new(username, password)
+
+notify_url = "http://#{local_ip_address}:#{port}"
+
+# example:retrieve-roaming-status-with-notify-url
+data_connection_client.retrieve_roaming_status(destination_address, notify_url)
+# ----------------------------------------------------------------------------------------------------
+
+dummy_web_server = OneApi::DummyWebServer.new(local_ip_address, port)
+dummy_web_server.start 30
+
+for method, url, headers, body in dummy_web_server.requests
+    # example:on-roaming-status
+    delivery_info = OneApi::DataConnectionProfileClient.unserialize_roaming_status(body)
+    # ----------------------------------------------------------------------------------------------------
+    puts delivery_info.inspect
+end

data/examples/example_send_message_and_check_delivery_status.rb

@@ -0,0 +1,53 @@
+lib = File.expand_path('../../lib', __FILE__)
+if File.exists?(lib)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+require 'oneapi-ruby'
+
+username = ARGV[0]
+password = ARGV[1]
+destination_address = ARGV[2]
+
+if OneApi::Utils.empty(username)
+  print "Username: "
+  username = gets.strip!
+end
+
+if OneApi::Utils.empty(password)
+  print "Password: "
+  password = gets.strip!
+end
+
+if OneApi::Utils.empty(destination_address)
+  print "Destination (MSISDN): "
+  destination_address = gets.strip!
+end
+
+# example:initialize-sms-client
+sms_client = OneApi::SmsClient.new(username, password)
+# ----------------------------------------------------------------------------------------------------
+
+# example:prepare-message-without-notify-url
+sms = OneApi::SMSRequest.new
+sms.sender_address = '38598123456'
+sms.address = destination_address
+sms.message = 'Test message'
+sms.callback_data = 'Any string'
+# ----------------------------------------------------------------------------------------------------
+
+# example:send-message
+result = sms_client.send_sms(sms)
+
+# Store the client correlator to be able to query for the delivery status later:
+client_correlator = result.client_correlator
+# ----------------------------------------------------------------------------------------------------
+
+# example:query-for-delivery-status
+delivery_status = sms_client.query_delivery_status(client_correlator)
+# ----------------------------------------------------------------------------------------------------
+
+sleep(10)
+
+for delivery_info in delivery_status.delivery_info
+    puts "Delivery status id #{delivery_info.delivery_status}"
+end

data/examples/example_send_message_and_wait_for_delivery_push.rb

@@ -0,0 +1,56 @@
+lib = File.expand_path('../../lib', __FILE__)
+if File.exists?(lib)
+  $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+end
+require 'oneapi-ruby'
+
+username = ARGV[0]
+password = ARGV[1]
+local_ip_address = ARGV[2]
+destination_address = ARGV[3]
+
+if OneApi::Utils.empty(username)
+  print "Username: "
+  username = gets.strip!
+end
+
+if OneApi::Utils.empty(password)
+  print "Password: "
+  password = gets.strip!
+end
+
+if OneApi::Utils.empty(local_ip_address)
+  print "Local IP address: "
+  local_ip_address = gets.strip!
+end
+
+if OneApi::Utils.empty(destination_address)
+  print "Destination (MSISDN): "
+  destination_address = gets.strip!
+end
+
+port = 9090
+
+sms_client = OneApi::SmsClient.new(username, password)
+
+# example:prepare-message-with-notify-url
+sms = OneApi::SMSRequest.new
+sms.sender_address = 'INFOSMS'
+sms.address = destination_address
+sms.message = 'Test message'
+sms.callback_data = 'Any string'
+sms.notify_url = "http://#{local_ip_address}:#{port}"
+# ----------------------------------------------------------------------------------------------------
+
+puts sms.inspect
+
+result = sms_client.send_sms(sms)
+
+dummy_web_server = OneApi::DummyWebServer.new(local_ip_address, port)
+dummy_web_server.start 30
+
+for method, url, headers, body in dummy_web_server.requests
+    # example:on-delivery-notification
+    delivery_info = OneApi::SmsClient.unserialize_delivery_status(body)
+    # ----------------------------------------------------------------------------------------------------
+end

data/lib/oneapi-ruby.rb

@@ -0,0 +1,8 @@
+require "oneapi-ruby/version"
+require "oneapi-ruby/utils"
+require "oneapi-ruby/objects"
+require "oneapi-ruby/models"
+require "oneapi-ruby/client"
+
+module OneApi
+end

data/lib/oneapi-ruby/client.rb

@@ -0,0 +1,309 @@
+#require 'pry'
+require 'net/http'
+require 'net/https'
+require "base64"
+
+require_relative 'objects'
+require_relative 'models'
+
+module OneApi
+
+    class OneApiClient
+
+        # If true -- an exception will be thrown on error, otherwise, you have 
+        # to check the is_success and exception methods on resulting objects.
+        attr_accessor :raise_exceptions
+
+        def initialize(username, password, base_url=nil)
+            @username = username
+            @password = password
+            if base_url
+                @base_url = base_url
+            else
+                @base_url = 'https://oneapi.infobip.com'
+            end
+
+            if @base_url[-1, 1] != '/'
+                @base_url += '/'
+            end
+
+            @oneapi_authentication = nil
+            @raise_exceptions = true
+        end
+
+
+        def login()
+            params = {
+                    'username' => @username,
+                    'password' => @password,
+            }
+
+            is_success, result = execute_POST('/1/customerProfile/login', params)
+
+            return fill_oneapi_authentication(result, is_success)
+        end
+
+        def get_or_create_client_correlator(client_correlator=nil)
+            if client_correlator
+                return client_correlator
+            end
+
+            return Utils.get_random_alphanumeric_string()
+        end
+
+        def prepare_headers(request)
+            request["User-Agent"] = "OneApi-ruby-#{OneApi::VERSION}"
+            if @oneapi_authentication and @oneapi_authentication.ibsso_token
+                request['Authorization'] = "IBSSO #{@oneapi_authentication.ibsso_token}"
+            else
+                auth_string = Base64.encode64("#{@username}:#{@password}").strip
+                request['Authorization'] = "Basic #{auth_string}"
+            end
+        end
+
+        def is_success(response)
+            http_code = response.code.to_i
+            is_success = 200 <= http_code && http_code < 300
+
+            is_success
+        end
+
+        def urlencode(params)
+            if Utils.empty(params)
+                return ''
+            end
+            if params.instance_of? String
+                return URI.encode(params)
+            end
+            result = ''
+            params.each_key do |key|
+                if ! Utils.empty(result)
+                    result += '&'
+                end
+                result += URI.encode(key.to_s) + '=' + URI.encode(params[key].to_s)
+            end
+
+            return result
+        end
+
+        def execute_GET(url, params=nil)
+            execute_request('GET', url, params)
+        end
+
+        def execute_POST(url, params=nil)
+            execute_request('POST', url, params)
+        end
+
+        def execute_request(http_method, url, params)
+            rest_url = get_rest_url(url)
+            uri = URI(rest_url)
+
+            if Utils.empty(params)
+                params = {}
+            end
+
+            if http_method == 'GET'
+                request = Net::HTTP::Get.new("#{uri.request_uri}?#{urlencode(params)}")
+            elsif http_method == 'POST'
+                request = Net::HTTP::Post.new(uri.request_uri)
+                request.set_form_data(params)
+            end
+
+            http = Net::HTTP.new(uri.host, uri.port)
+
+            use_ssl = rest_url.start_with? "https"
+            if use_ssl
+                http.use_ssl = true
+                http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            end
+
+            prepare_headers(request)
+            response = http.request(request)
+            
+            puts "response = #{response.body}"
+
+            return is_success(response), response.body
+        end
+
+        def get_rest_url(rest_path)
+            if not rest_path
+                return @base_url
+            end
+
+            if rest_path[0, 1] == '/'
+                return @base_url + rest_path[1, rest_path.length]
+            end
+
+            @base_url + rest_path
+        end
+
+        def fill_oneapi_authentication(json, is_success)
+            @oneapi_authentication = convert_from_json(OneApiAuthentication, json, !is_success)
+
+            @oneapi_authentication.username = @username
+            @oneapi_authentication.password = @password
+
+            @oneapi_authentication.authenticated = @oneapi_authentication.ibsso_token ? @oneapi_authentication.ibsso_token.length > 0 : false
+
+            @oneapi_authentication
+        end
+
+        def convert_from_json(classs, json, is_error)
+            result = Conversions.from_json(classs, json, is_error)
+
+            if @raise_exceptions and !result.is_success
+                raise "#{result.exception.message_id}: #{result.exception.text} [#{result.exception.variables}]"
+            end
+
+            result
+        end
+
+    end
+
+    class SmsClient < OneApiClient
+
+        def initialize(username, password, base_url=nil)
+            super(username, password, base_url)
+        end
+
+        def send_sms(sms)
+            client_correlator = sms.client_correlator
+            if not client_correlator
+                client_correlator = Utils.get_random_alphanumeric_string()
+            end
+
+            params = {
+                'senderAddress' => sms.sender_address,
+                'address' => sms.address,
+                'message' => sms.message,
+                'clientCorrelator' => client_correlator,
+                'senderName' => "tel:#{sms.sender_address}"
+            }
+
+            if sms.notify_url
+                params['notifyURL'] = sms.notify_url
+            end
+            if sms.callback_data
+                params['callbackData'] = sms.callback_data
+            end
+
+            is_success, result = execute_POST(
+                    "/1/smsmessaging/outbound/#{sms.sender_address}/requests",
+                    params
+            )
+
+            convert_from_json(ResourceReference, result, !is_success)
+        end
+
+        def query_delivery_status(client_correlator_or_resource_reference)
+            if defined? client_correlator_or_resource_reference.client_correlator
+                client_correlator = client_correlator_or_resource_reference.client_correlator
+            else
+                client_correlator = client_correlator_or_resource_reference
+            end
+
+            client_correlator = get_or_create_client_correlator(client_correlator)
+
+            params = {
+                'clientCorrelator' => client_correlator,
+            }
+
+            is_success, result = execute_GET(
+                    "/1/smsmessaging/outbound/TODO/requests/#{client_correlator}/deliveryInfos",
+                    params
+            )
+
+            return convert_from_json(DeliveryInfoList, result, !is_success)
+        end
+
+        def retrieve_inbound_messages(max_number=nil)
+            if Utils.empty(max_number)
+                max_number = 100
+            end
+
+            params = {
+                    'maxBatchSize' => max_number
+            }
+
+            is_success, result = execute_GET(
+                    '/1/smsmessaging/inbound/registrations/INBOUND/messages', 
+                    params
+            )
+
+            return convert_from_json(InboundSmsMessages, result, ! is_success)
+        end
+
+        # To be used when http push with a delivery notification comes.
+        def self.unserialize_delivery_status(http_body)
+            json = JSONUtils.get_json(http_body)
+            return Conversions::from_json(DeliveryInfoNotification, json, false)
+        end
+
+
+        @staticmethod
+        def self.unserialize_inbound_messages(http_body)
+            json = JSONUtils.get_json(http_body)
+            return Conversions::from_json(InboundSmsMessages, json, false)
+        end
+    end
+
+    class DataConnectionProfileClient < OneApiClient
+
+        def initialize(username, password, base_url=nil)
+            super(username, password, base_url)
+        end
+
+        def retrieve_roaming_status(destination_address, notify_url=nil)
+            # Retrieve asynchronously the customer’s roaming status for a single network-connected mobile device  (HLR)
+
+            params = {
+                'address' => destination_address
+            }
+            if notify_url
+                params['notifyURL'] = notify_url
+            end
+
+            is_success, result = execute_GET('/1/terminalstatus/queries/roamingStatus', params)
+
+            puts "params = #{params.inspect}"
+            puts "is_success = #{is_success}"
+            puts "result = #{result}"
+
+            if Utils.empty(notify_url)
+                json = JSONUtils.get_json(result)
+                return convert_from_json(TerminalRoamingStatus, json['roaming'], ! is_success);
+            else
+                return convert_from_json(GenericObject, {}, ! is_success);
+            end
+        end
+
+        # To be used when http push with a delivery notification comes.
+        def self.unserialize_roaming_status(http_body)
+            json = JSONUtils.get_json(http_body)
+            return Conversions::from_json(TerminalRoamingStatusNotification, json, false)
+        end
+
+    end
+
+    class CustomerProfileClient < OneApiClient
+
+        def initialize(username, password, base_url=nil)
+            super(username, password, base_url)
+        end
+
+        def get_account_balance()
+            is_success, result = execute_GET('/1/customerProfile/balance')
+            
+            return convert_from_json(AccountBalance, result, ! is_success)
+        end
+
+        def get_customer_profile()
+            is_success, result = execute_GET('/1/customerProfile')
+
+            return convert_from_json(CustomerProfile, result, ! is_success)
+        end
+
+    end
+
+end
+