oneapi-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af240edc82d74526271f72c8240aa034185f107b
+  data.tar.gz: e99dd67112f91808225ddd12280292c52ddb010e
+SHA512:
+  metadata.gz: 055160c65c86523f10217f96e60289e5b00d13e49f4485867c919bbf64ad1233416f13028c83c8f8481ef39aed8464fb154af1dee86951dc20b5bd3b35ca15ca
+  data.tar.gz: 02fecab99ca86b9cf8c22e098aa0d352f9e9c60a2a70b31a873345e063dbc71dbfd944bdc6f9c2dfe78c97d48d6ed431305eadaca4d45e325cca183b708d3f7a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+pkg
+*.iml
+*.ipr
+*.iws
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in oneapi-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2012] [Infobip]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,102 @@
+OneApi ruby client
+============================
+
+Basic messaging example
+-----------------------
+
+First initialize the messaging client using your username and password:
+
+    sms_client = OneApi::SmsClient.new(username, password)
+
+
+An exception will be thrown if your username and/or password are incorrect.
+
+Prepare the message:
+
+    sms = OneApi::SMSRequest.new
+    sms.sender_address = '38598123456'
+    sms.address = destination_address
+    sms.message = 'Test message'
+    sms.callback_data = 'Any string'
+
+
+Send the 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
+
+
+Later you can query for the delivery status of the message:
+
+    delivery_status = sms_client.query_delivery_status(client_correlator)
+
+
+Possible statuses are: **DeliveredToTerminal**, **DeliveryUncertain**, **DeliveryImpossible**, **MessageWaiting** and **DeliveredToNetwork**.
+
+Messaging with notification push example
+-----------------------
+
+Same as with the standard messaging example, but when preparing your message:
+
+    sms = OneApi::SMSRequest.new
+    sms.sender_address = '38598123456'
+    sms.address = '38598123456'
+    sms.message = 'Test message'
+    sms.callback_data = 'Any string'
+    sms.notify_url = "http://#{local_ip_address}:#{port}"
+
+
+When the delivery notification is pushed to your server as a HTTP POST request, you must process the body of the message with the following code:
+
+    delivery_info = OneApi::SmsClient.unserialize_delivery_status(body)
+
+
+HLR example
+-----------------------
+
+Initialize and login the data connection client:
+
+    data_connection_client = OneApi::DataConnectionProfileClient.new(username, password)
+
+
+Retrieve the roaming status (HLR):
+
+    result = data_connection_client.retrieve_roaming_status(destination_address)
+
+
+HLR with notification push example
+-----------------------
+
+Similar to the previous example, but this time you must set the notification url where the result will be pushed:
+
+    data_connection_client.retrieve_roaming_status(destination_address, notify_url)
+
+
+When the roaming status notification is pushed to your server as a HTTP POST request, you must process the body of the message with the following code:
+
+    delivery_info = OneApi::DataConnectionProfileClient.unserialize_roaming_status(body)
+
+
+Retrieve inbound messages example
+-----------------------
+
+With the existing sms client (see the basic messaging example to see how to start it):
+
+    result = sms_client.retrieve_inbound_messages()
+
+
+Inbound message push example
+-----------------------
+
+The subscription to recive inbound messages can be set up on our site.
+When the inbound message notification is pushed to your server as a HTTP POST request, you must process the body of the message with the following code:
+
+    inbound_messages = OneApi::SmsClient.unserialize_inbound_messages(http_body)
+
+
+License
+-------
+
+This library is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/examples/example_customer_profile.rb

@@ -0,0 +1,29 @@
+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]
+
+if OneApi::Utils.empty(username)
+  print "Username: "
+  username = gets.strip!
+end
+
+if OneApi::Utils.empty(password)
+  print "Password: "
+  password = gets.strip!
+end
+
+puts username
+puts password
+
+customer_profile_client = OneApi::CustomerProfileClient.new(username, password)
+
+customer_profile = customer_profile_client.get_customer_profile()
+puts customer_profile.inspect
+
+account_balance = customer_profile_client.get_account_balance()
+puts account_balance.inspect

data/examples/example_get_hlr.rb

@@ -0,0 +1,34 @@
+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:data-connection-client
+data_connection_client = OneApi::DataConnectionProfileClient.new(username, password)
+# ----------------------------------------------------------------------------------------------------
+
+# example:retrieve-roaming-status
+result = data_connection_client.retrieve_roaming_status(destination_address)
+# ----------------------------------------------------------------------------------------------------
+
+puts result.inspect

data/examples/example_get_inbound_messages.rb

@@ -0,0 +1,26 @@
+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]
+
+if OneApi::Utils.empty(username)
+  print "Username: "
+  username = gets.strip!
+end
+
+if OneApi::Utils.empty(password)
+  print "Password: "
+  password = gets.strip!
+end
+
+sms_client = OneApi::SmsClient.new(username, password)
+
+# example:retrieve-inbound-messages
+result = sms_client.retrieve_inbound_messages()
+# ----------------------------------------------------------------------------------------------------
+
+puts result.inspect