moceansdk 0.1.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f6532c4ee47058e7a4759f48927843506884547f
-  data.tar.gz: 32fdced53ca4cfcf0f89e2764bd1239d7184845a
+SHA256:
+  metadata.gz: d60c2b5a6d3baee166f95851e6882d58ecff0bbca91855fa471d3cb5e129523e
+  data.tar.gz: 0551d8738ac463a0ae9bf3e9a0836a5aa82302c40513d9e03d79126ccee29efd
 SHA512:
-  metadata.gz: 48297b9b9172925ac6a8a548c5bb167f278a939a553f1cb3e1bdfda9baa1e4b333c39cab8711161be73e65fb2a4226d7ee666f94cbf382cbf1be0664ed644b14
-  data.tar.gz: 45b77996ec94fa4a3927ddaeb57a8f3f422d8b960fc2f4b2c1e37ed5ce7e23083c6605e92fa074894ddd74154913310fd74f48e89accfa425ded1e5895fb0c26
+  metadata.gz: 29e7c9f0e5a578d8bc1f0bc1afce8ae3179a928a850677ea212bff9fdebb3c0a93d7f67e49f2294bdc5d5cfd3e315492653f9e87828d1c4296202ee8318b5922
+  data.tar.gz: 489e052c4e49ac0ddf96a3d27411e2ca51c3cec7d05d02c84998c54d4fa0ce2cb3f9914a1fc49c5a6d1d3ec4952f147b05ae04627dcbc9118bae916442efc73c

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 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,6 +1,11 @@
 MoceanAPI Client Library for Ruby 
 ============================
-[![Gem Version](https://badge.fury.io/rb/moceansdk.svg)](https://badge.fury.io/rb/moceansdk) 
+[![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].
@@ -24,34 +29,46 @@ gem install moceansdk
 Create a client with your API key and secret:
 
 ```ruby
-require "moceanapi/init"
+require 'moceansdk'
 
-token = Client.new("API_KEY_HERE", "API_SECRET_HERE")
-mocean = Mocean.new(token)
+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.create().send()` method.
+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.create({
-	"mocean-text"=>'Hello World',
-    "mocean-from"=>'MOCEAN',
-    "mocean-to"=>'60123456789'
-    }).send()
+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_sms]: https://docs.moceanapi.com/?ruby#send-sms
-[doc_inbound]: https://docs.moceanapi.com/?ruby#receive-sms
-[doc_verify]: https://docs.moceanapi.com/?ruby#overview-3
+[doc_main]: https://moceanapi.com/docs/?ruby
+[doc_sms]: https://moceanapi.com/docs/?ruby#send-sms
 [license]: LICENSE.txt

data/lib/moceansdk.rb

@@ -1,6 +1,28 @@
-require "moceansdk/version"
-require "moceansdk/init"
-
-module Moceansdk
-  
-end
+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

@@ -0,0 +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

data/lib/moceansdk/auth/basic.rb

@@ -0,0 +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

data/lib/moceansdk/client.rb

@@ -1,14 +1,62 @@
-class Client
-    attr_reader :api_key,:api_secret
-    def initialize api_key = '',api_secret = ''
-        @api_key =  api_key 
-        @api_secret =  api_secret
+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 set_api_key(api_key)
-        @api_key = api_key
+    def balance
+      Modules::Account::Balance.new(@obj_auth, @transmitter)
     end
-    def set_api_secret(api_secret)
-        @api_secret = api_secret
+
+    def message_status
+      Modules::Message::MessageStatus.new(@obj_auth, @transmitter)
     end
-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

data/lib/moceansdk/exceptions/mocean_error.rb

@@ -0,0 +1,18 @@
+module Moceansdk
+  module Exceptions
+
+    class MoceanError < StandardError
+      attr_reader :error_response
+
+      def initialize(msg, error_response = nil)
+        if error_response.nil?
+          super(msg)
+        else
+          super(error_response['err_msg'])
+          @error_response = error_response
+        end
+      end
+    end
+
+  end
+end

data/lib/moceansdk/exceptions/required_field_exception.rb

@@ -0,0 +1,8 @@
+module Moceansdk
+  module Exceptions
+
+    class RequiredFieldException < MoceanError
+    end
+
+  end
+end

data/lib/moceansdk/modules/abstact_client.rb

@@ -0,0 +1,54 @@
+module Moceansdk
+  module Modules
+
+    class AbstractClient
+      attr_accessor :params
+
+      def initialize(obj_auth, transmitter)
+        @params = obj_auth.params
+        @transmitter = transmitter
+      end
+
+      def create(params = {})
+        @params = @params.merge(params) if params.is_a? Hash
+      end
+
+      def create_final_params
+        final_params = {}
+        @params.each do |key, value|
+          unless value.nil?
+            param_prefix_set?(key) ? final_params[key] = value : final_params["mocean-#{key}"] = value
+          end
+        end
+
+        # convert string hash to symbol hash
+        @params = final_params.inject({}) {|memo, (k, v)| memo[k.to_sym] = v; memo}
+      end
+
+      def param_prefix_set?(key)
+        cloned_key = if key.is_a? String
+                       key
+                     else
+                       key.to_s
+                     end
+
+        return false if cloned_key.scan(/^mocean-/i).empty?
+
+        true
+      end
+
+      def required_field_set?
+        if @required_fields.is_a?(Array) && !@required_fields.empty?
+          @required_fields.each do |field|
+            if @params[:"#{field}"].nil?
+              raise Moceansdk::Exceptions::RequiredFieldException, "#{field} is mandatory field, can't leave empty"
+            end
+          end
+        end
+
+        true
+      end
+    end
+
+  end
+end

data/lib/moceansdk/modules/account/balance.rb

@@ -1,22 +1,26 @@
-require_relative "../abstract"
+module Moceansdk
+  module Modules
+    module Account
+
+      class Balance < Moceansdk::Modules::AbstractClient
+        def initialize(obj_auth, transmitter)
+          super(obj_auth, transmitter)
+          @required_fields = ['mocean-api-key', 'mocean-api-secret']
+        end
+
+        def resp_format=(param)
+          @params['mocean-resp-format'] = param
+        end
+
+        def inquiry(params = {})
+          create(params)
+          create_final_params
+          required_field_set?
+
+          @transmitter.get('/account/balance', @params)
+        end
+      end
 
-class Balance < MoceanFactory
-    def initialize client
-        super(client)
-        @required_fields = ['mocean-api-key','mocean-api-secret']
-    end
-    
-    def setRespFormat param
-        @params['mocean-resp-format'] = param
-        return self
-    end
-    
-    def inquiry params = {}
-        create(params)
-        createFinalParams
-        isRequiredFieldsSet
-        response = Transmitter.new('/rest/1/account/balance','get', @params)
-        reset
-        return response.getResponse()
     end
-end
+  end
+end

data/lib/moceansdk/modules/account/pricing.rb

@@ -1,38 +1,38 @@
-require_relative "../abstract"
+module Moceansdk
+  module Modules
+    module Account
+
+      class Pricing < Moceansdk::Modules::AbstractClient
+        def initialize(obj_auth, transmitter)
+          super(obj_auth, transmitter)
+          @required_fields = ['mocean-api-key', 'mocean-api-secret']
+        end
+
+        def mcc=(param)
+          @params['mocean-mcc'] = param
+        end
+
+        def mnc=(param)
+          @params['mocean-mnc'] = param
+        end
+
+        def delimiter=(param)
+          @params['mocean-delimiter'] = param
+        end
+
+        def resp_format=(param)
+          @params['mocean-resp-format'] = param
+        end
+
+        def inquiry(params = {})
+          create(params)
+          create_final_params
+          required_field_set?
+
+          @transmitter.get('/account/pricing', @params)
+        end
+      end
 
-class Pricing < MoceanFactory
-    
-    def initialize client
-        super(client)
-        required_fields = ['mocean-api-key','mocean-api-secret']
-    end
-    
-    def setMcc param
-        @params['mocean-mcc'] = param
-        return self
-    end
-    
-    def setMnc param
-        @params['mocean-mnc'] = param
-        return self
-    end
-    
-    def setDelimiter param
-        @params['mocean-delimiter'] = param
-        return self
-    end
-    
-    def setRespFormat param
-        @params['mocean-resp-format'] = param
-        return self
-    end
-    
-    def inquiry params = {}
-        create(params)
-        createFinalParams
-        isRequiredFieldsSet
-        response = Transmitter.new('/rest/1/account/pricing','get',@params)
-        reset
-        return response.getResponse()
     end
+  end
 end