moceansdk 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d60c2b5a6d3baee166f95851e6882d58ecff0bbca91855fa471d3cb5e129523e
-  data.tar.gz: 0551d8738ac463a0ae9bf3e9a0836a5aa82302c40513d9e03d79126ccee29efd
+  metadata.gz: baa2fbc9440d656aee7a53d85dd3bac6be392cae9ac8559f41cf5e5c25694500
+  data.tar.gz: bb6c25ba828434a22b301decc6d5e1edb5f3c1e82c85182415dc09a8169a4564
 SHA512:
-  metadata.gz: 29e7c9f0e5a578d8bc1f0bc1afce8ae3179a928a850677ea212bff9fdebb3c0a93d7f67e49f2294bdc5d5cfd3e315492653f9e87828d1c4296202ee8318b5922
-  data.tar.gz: 489e052c4e49ac0ddf96a3d27411e2ca51c3cec7d05d02c84998c54d4fa0ce2cb3f9914a1fc49c5a6d1d3ec4952f147b05ae04627dcbc9118bae916442efc73c
+  metadata.gz: 516771c7d9ce1a9fa24ee023db3427e266abd89336bc15743f49f0877bffd5c03141eafa5867941cb95a8828d89647a7eef48232c185acb5b8b23c4fea80d270
+  data.tar.gz: cda8a8545f864c4717cc3efec9fcd29afe7b585b33c8bb99ddd9c7f69a0f44b13e6cfbc76c8d3883ef55bbffaaa1513ebb92bf0a8d86adba1b754c574a8447ee

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2018-2019 Micro Ocean Technologies Sdn Bhd
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2018-2019 Micro Ocean Technologies Sdn Bhd
+
+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

@@ -1,74 +1,74 @@
-MoceanAPI Client Library for Ruby 
-============================
-[![Gem Version](https://img.shields.io/gem/v/moceansdk.svg)](https://rubygems.org/gems/moceansdk) 
-[![build status](https://img.shields.io/travis/com/MoceanAPI/mocean-sdk-ruby.svg)](https://travis-ci.com/MoceanAPI/mocean-sdk-ruby)
-[![codecov](https://img.shields.io/codecov/c/github/MoceanAPI/mocean-sdk-ruby.svg)](https://codecov.io/gh/MoceanAPI/mocean-sdk-ruby)
-[![codacy](https://img.shields.io/codacy/grade/5d5f7f9e7b1c4e888636a244283bf6f7.svg)](https://app.codacy.com/project/MoceanAPI/mocean-sdk-ruby/dashboard)
-[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
-[![total downloads](https://img.shields.io/gem/dt/moceansdk.svg)](https://rubygems.org/gems/moceansdk)
-
-This is the Ruby client library for use Mocean's API. To use this, you'll need a Mocean account. Sign up [for free at 
-moceanapi.com][signup].
-
- * [Installation](#installation)
- * [Usage](#usage)
- * [Example](#example)
-
-## Installation
-
-To use the client library you'll need to have [created a Mocean account][signup]. 
-
-To install the Ruby client library using Gem.
-
-```bash
-gem install moceansdk
-```
-
-## Usage
-
-Create a client with your API key and secret:
-
-```ruby
-require 'moceansdk'
-
-credential = Moceansdk::Auth::Basic.new("API_KEY_HERE", "API_SECRET_HERE")
-mocean = Moceansdk::Client.new(credential)
-```
-
-## Example
-
-To use [Mocean's SMS API][doc_sms] to send an SMS message, call the `mocean.sms.send()` method.
-
-The API can be called directly, using a simple array of parameters, the keys match the [parameters of the API][doc_sms].
-
-```ruby
-res = mocean.sms.send({
-    "mocean-text": 'Hello World',
-    "mocean-from": 'MOCEAN',
-    "mocean-to": '60123456789'
-})
-
-puts res
-```
-
-### Responses
-
-For your convenient, the API response has been parsed to `Hash` using [hash_dot](https://github.com/adsteel/hash_dot) package.
-```ruby
-puts res           # show full response string
-puts res.status    # show response status, '0' in this case
-puts res['status'] # same as above
-```
-
-## Documentation
-
-Kindly visit [MoceanApi Docs][doc_main] for more usage
-
-## License
-
-This library is released under the [MIT License][license]
-
-[signup]: https://dashboard.moceanapi.com/register?medium=github&campaign=sdk-ruby
-[doc_main]: https://moceanapi.com/docs/?ruby
-[doc_sms]: https://moceanapi.com/docs/?ruby#send-sms
-[license]: LICENSE.txt
+MoceanAPI Client Library for Ruby 
+============================
+[![Gem Version](https://img.shields.io/gem/v/moceansdk.svg)](https://rubygems.org/gems/moceansdk) 
+[![build status](https://img.shields.io/travis/com/MoceanAPI/mocean-sdk-ruby.svg)](https://travis-ci.com/MoceanAPI/mocean-sdk-ruby)
+[![codecov](https://img.shields.io/codecov/c/github/MoceanAPI/mocean-sdk-ruby.svg)](https://codecov.io/gh/MoceanAPI/mocean-sdk-ruby)
+[![codacy](https://img.shields.io/codacy/grade/7564ecfa8e7948a7ba15cb7634258c7e.svg)](https://app.codacy.com/project/MoceanAPI/mocean-sdk-ruby/dashboard)
+[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
+[![total downloads](https://img.shields.io/gem/dt/moceansdk.svg)](https://rubygems.org/gems/moceansdk)
+
+This is the Ruby client library for use Mocean's API. To use this, you'll need a Mocean account. Sign up [for free at 
+moceanapi.com][signup].
+
+ * [Installation](#installation)
+ * [Usage](#usage)
+ * [Example](#example)
+
+## Installation
+
+To use the client library you'll need to have [created a Mocean account][signup]. 
+
+To install the Ruby client library using Gem.
+
+```bash
+gem install moceansdk
+```
+
+## Usage
+
+Create a client with your API key and secret:
+
+```ruby
+require 'moceansdk'
+
+credential = Moceansdk::Auth::Basic.new("API_KEY_HERE", "API_SECRET_HERE")
+mocean = Moceansdk::Client.new(credential)
+```
+
+## Example
+
+To use [Mocean's SMS API][doc_sms] to send an SMS message, call the `mocean.sms.send()` method.
+
+The API can be called directly, using a simple array of parameters, the keys match the [parameters of the API][doc_sms].
+
+```ruby
+res = mocean.sms.send({
+    "mocean-text": 'Hello World',
+    "mocean-from": 'MOCEAN',
+    "mocean-to": '60123456789'
+})
+
+puts res
+```
+
+### Responses
+
+For your convenient, the API response has been parsed to `Hash` using [hash_dot](https://github.com/adsteel/hash_dot) package.
+```ruby
+puts res           # show full response string
+puts res.status    # show response status, '0' in this case
+puts res['status'] # same as above
+```
+
+## Documentation
+
+Kindly visit [MoceanApi Docs][doc_main] for more usage
+
+## License
+
+This library is released under the [MIT License][license]
+
+[signup]: https://dashboard.moceanapi.com/register?medium=github&campaign=sdk-ruby
+[doc_main]: https://moceanapi.com/docs/?ruby
+[doc_sms]: https://moceanapi.com/docs/?ruby#send-sms
+[license]: LICENSE.txt

data/lib/moceansdk.rb

@@ -1,28 +1,28 @@
-require 'http'
-require 'json'
-require 'hash_dot'
-require 'xmlsimple'
-
-require 'moceansdk/auth/abstract_auth'
-require 'moceansdk/auth/basic'
-require 'moceansdk/exceptions/mocean_error'
-require 'moceansdk/exceptions/required_field_exception'
-
-require 'moceansdk/modules/abstact_client'
-require 'moceansdk/modules/response_factory'
-require 'moceansdk/modules/transmitter'
-
-require 'moceansdk/modules/account/balance'
-require 'moceansdk/modules/account/pricing'
-
-require 'moceansdk/modules/message/channel'
-require 'moceansdk/modules/message/message_status'
-require 'moceansdk/modules/message/sms'
-require 'moceansdk/modules/message/verify_request'
-require 'moceansdk/modules/message/verify_validate'
-
-require 'moceansdk/modules/number_lookup/number_lookup'
-
-require 'moceansdk/utils'
-require 'moceansdk/version'
+require 'http'
+require 'json'
+require 'hash_dot'
+require 'xmlsimple'
+
+require 'moceansdk/auth/abstract_auth'
+require 'moceansdk/auth/basic'
+require 'moceansdk/exceptions/mocean_error'
+require 'moceansdk/exceptions/required_field_exception'
+
+require 'moceansdk/modules/abstact_client'
+require 'moceansdk/modules/response_factory'
+require 'moceansdk/modules/transmitter'
+
+require 'moceansdk/modules/account/balance'
+require 'moceansdk/modules/account/pricing'
+
+require 'moceansdk/modules/message/channel'
+require 'moceansdk/modules/message/message_status'
+require 'moceansdk/modules/message/sms'
+require 'moceansdk/modules/message/verify_request'
+require 'moceansdk/modules/message/verify_validate'
+
+require 'moceansdk/modules/number_lookup/number_lookup'
+
+require 'moceansdk/utils'
+require 'moceansdk/version'
 require 'moceansdk/client'

data/lib/moceansdk/auth/abstract_auth.rb

@@ -1,15 +1,15 @@
-module Moceansdk
-  module Auth
-
-    class AbstractAuth
-      def auth_method
-        raise NotImplementedError, 'AbstractAuth is a abstract class'
-      end
-
-      def params
-        raise NotImplementedError, 'AbstractAuth is a abstract class'
-      end
-    end
-
-  end
-end
+module Moceansdk
+  module Auth
+
+    class AbstractAuth
+      def auth_method
+        raise NotImplementedError, 'AbstractAuth is a abstract class'
+      end
+
+      def params
+        raise NotImplementedError, 'AbstractAuth is a abstract class'
+      end
+    end
+
+  end
+end

data/lib/moceansdk/auth/basic.rb

@@ -1,29 +1,29 @@
-module Moceansdk
-  module Auth
-
-    class Basic < AbstractAuth
-      def initialize(api_key = nil, api_secret = nil)
-        @params = {}
-        @params['mocean-api-key'] = api_key unless api_key.nil?
-        @params['mocean-api-secret'] = api_secret unless api_secret.nil?
-      end
-
-      def api_key=(api_key)
-        @params['mocean-api-key'] = api_key
-      end
-
-      def api_secret=(api_secret)
-        @params['mocean-api-secret'] = api_secret
-      end
-
-      def auth_method
-        'basic'
-      end
-
-      def params
-        @params
-      end
-    end
-
-  end
-end
+module Moceansdk
+  module Auth
+
+    class Basic < AbstractAuth
+      def initialize(api_key = nil, api_secret = nil)
+        @params = {}
+        @params['mocean-api-key'] = api_key unless api_key.nil?
+        @params['mocean-api-secret'] = api_secret unless api_secret.nil?
+      end
+
+      def api_key=(api_key)
+        @params['mocean-api-key'] = api_key
+      end
+
+      def api_secret=(api_secret)
+        @params['mocean-api-secret'] = api_secret
+      end
+
+      def auth_method
+        'basic'
+      end
+
+      def params
+        @params
+      end
+    end
+
+  end
+end

data/lib/moceansdk/client.rb

@@ -1,62 +1,62 @@
-module Moceansdk
-
-  class Client
-    def initialize(obj_auth, options = nil)
-      unless obj_auth.is_a? Auth::AbstractAuth
-        raise Exceptions::MoceanError, 'auth object must extend AbstractAuth'
-      end
-
-      if obj_auth.auth_method.casecmp('basic').zero?
-        if Utils.nil_or_empty?(obj_auth.params['mocean-api-key']) || Utils.nil_or_empty?(obj_auth.params['mocean-api-secret'])
-          raise Exceptions::RequiredFieldException, "api key and api secret for client object can't be empty"
-        end
-      else
-        raise Exceptions::MoceanError, 'unsupported auth method'
-      end
-
-      @transmitter = if options.is_a? Modules::Transmitter
-                       options
-                     else
-                       Modules::Transmitter.new(options)
-                     end
-
-      @obj_auth = obj_auth
-    end
-
-    def sms
-      Modules::Message::Sms.new(@obj_auth, @transmitter)
-    end
-
-    def flash_sms
-      sms = Modules::Message::Sms.new(@obj_auth, @transmitter)
-      sms.mclass = 1
-      sms.alt_dcs = 1
-      sms
-    end
-
-    def pricing
-      Modules::Account::Pricing.new(@obj_auth, @transmitter)
-    end
-
-    def balance
-      Modules::Account::Balance.new(@obj_auth, @transmitter)
-    end
-
-    def message_status
-      Modules::Message::MessageStatus.new(@obj_auth, @transmitter)
-    end
-
-    def verify_request
-      Modules::Message::VerifyRequest.new(@obj_auth, @transmitter)
-    end
-
-    def verify_validate
-      Modules::Message::VerifyValidate.new(@obj_auth, @transmitter)
-    end
-
-    def number_lookup
-      Modules::NumberLookup::NumberLookup.new(@obj_auth, @transmitter)
-    end
-  end
-
-end
+module Moceansdk
+
+  class Client
+    def initialize(obj_auth, options = nil)
+      unless obj_auth.is_a? Auth::AbstractAuth
+        raise Exceptions::MoceanError, 'auth object must extend AbstractAuth'
+      end
+
+      if obj_auth.auth_method.casecmp('basic').zero?
+        if Utils.nil_or_empty?(obj_auth.params['mocean-api-key']) || Utils.nil_or_empty?(obj_auth.params['mocean-api-secret'])
+          raise Exceptions::RequiredFieldException, "api key and api secret for client object can't be empty"
+        end
+      else
+        raise Exceptions::MoceanError, 'unsupported auth method'
+      end
+
+      @transmitter = if options.is_a? Modules::Transmitter
+                       options
+                     else
+                       Modules::Transmitter.new(options)
+                     end
+
+      @obj_auth = obj_auth
+    end
+
+    def sms
+      Modules::Message::Sms.new(@obj_auth, @transmitter)
+    end
+
+    def flash_sms
+      sms = Modules::Message::Sms.new(@obj_auth, @transmitter)
+      sms.mclass = 1
+      sms.alt_dcs = 1
+      sms
+    end
+
+    def pricing
+      Modules::Account::Pricing.new(@obj_auth, @transmitter)
+    end
+
+    def balance
+      Modules::Account::Balance.new(@obj_auth, @transmitter)
+    end
+
+    def message_status
+      Modules::Message::MessageStatus.new(@obj_auth, @transmitter)
+    end
+
+    def verify_request
+      Modules::Message::VerifyRequest.new(@obj_auth, @transmitter)
+    end
+
+    def verify_validate
+      Modules::Message::VerifyValidate.new(@obj_auth, @transmitter)
+    end
+
+    def number_lookup
+      Modules::NumberLookup::NumberLookup.new(@obj_auth, @transmitter)
+    end
+  end
+
+end