moceansdk 0.1.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a4069e217f9393e5b8bf55f67a6b6dff4a718f2c
-  data.tar.gz: 1d71e45923ef237b947f6f37097da4004cd2a202
+SHA256:
+  metadata.gz: b0b4c0c5f19f708f2e1d0f255eed1341244f64922b75cde574d9765cadc570f6
+  data.tar.gz: 628465a50f969494c965a77b5f0868c89ac11d0b1f0be7f2b0d17c0ac786cc8c
 SHA512:
-  metadata.gz: 6c80e510696a3a2a6851c0e9c2977048ecaf1f4dff97c8cd11d2dcb2b6d8e383f55c50e4369c0549e4e1154674ddcb42150fbae5475fef6f111457d394b4eafb
-  data.tar.gz: ce2eb4eacfdfcf416e94d9fd0bcc9266c830b8b9289d583c41c4812bfd0e1229737738e1228f70d2f0389ef5f124a1636b2b202d1a00af86ff218c523df10fa2
+  metadata.gz: a1a3f349fdf7127a1157272a7cb56cac46a03d139ff8a03f756218f5697f936ac35bb4a20ec2056de93dda42100649e88ed789d2c55f9aed375f0828d9ff0f52
+  data.tar.gz: 38ba32440b25ad20da427f5e5242eaf0ab03ba22b273344a140d02e887424fbb216b6a5faacdb82cf4a5b0d44926f24c49f182446b1e1a366cfe827a2c1fbff8

data/LICENSE.txt

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

data/README.md

@@ -1,57 +1,75 @@
-MoceanAPI Client Library for Ruby 
-============================
-[![Gem Version](https://badge.fury.io/rb/moceansdk.svg)](https://badge.fury.io/rb/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 "moceanapi/init"
-
-token = Client.new("API_KEY_HERE", "API_SECRET_HERE")
-mocean = Mocean.new(token)
-```
-
-## Example
-
-To use [Mocean's SMS API][doc_sms] to send an SMS message, call the `mocean.sms.create().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()
-
-puts res
-```
-
-## 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
-[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)
+[![Github build status](https://github.com/MoceanAPI/mocean-sdk-ruby/actions/workflows/build.yml/badge.svg)](https://github.com/MoceanAPI/mocean-sdk-ruby/actions/workflows/build.yml)
+[![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=ruby-sdk
+[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,52 @@
-require "moceansdk/version"
-require "moceansdk/init"
+require 'http'
+require 'json'
+require 'hash_dot'
+require 'xmlsimple'
 
-module Moceansdk
-  
-end
+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/modules/voice/mc_object/abstract_mc'
+require 'moceansdk/modules/voice/mc_object/dial'
+require 'moceansdk/modules/voice/mc_object/collect'
+require 'moceansdk/modules/voice/mc_object/play'
+require 'moceansdk/modules/voice/mc_object/record'
+require 'moceansdk/modules/voice/mc_object/say'
+require 'moceansdk/modules/voice/mc_object/sleep'
+require 'moceansdk/modules/voice/mc'
+require 'moceansdk/modules/voice/mc_builder'
+require 'moceansdk/modules/voice/voice'
+
+require 'moceansdk/modules/command/mc_object/abstract_mc'
+require 'moceansdk/modules/command/mc_object/tg_send_text'
+require 'moceansdk/modules/command/mc_object/tg_send_audio'
+require 'moceansdk/modules/command/mc_object/tg_send_animation'
+require 'moceansdk/modules/command/mc_object/tg_send_photo'
+require 'moceansdk/modules/command/mc_object/tg_send_video'
+require 'moceansdk/modules/command/mc_object/tg_send_document'
+require 'moceansdk/modules/command/mc_object/tg_request_contact'
+require 'moceansdk/modules/command/mc_object/send_sms'
+require 'moceansdk/modules/command/mc'
+require 'moceansdk/modules/command/mc_builder'
+require 'moceansdk/modules/command/command'
+
+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,70 @@
-class Client
-    attr_reader :api_key,:api_secret
-    def initialize api_key = '',api_secret = ''
-        @api_key =  api_key 
-        @api_secret =  api_secret
-    end
-
-    def set_api_key(api_key)
-        @api_key = api_key
-    end
-    def set_api_secret(api_secret)
-        @api_secret = api_secret
-    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
+
+    def voice
+      Modules::Voice::Voice.new(@obj_auth, @transmitter)
+    end
+
+    def command
+      Modules::Command::Command.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 = Moceansdk::Utils.convert_to_symbol_hash(final_params)
+      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"
-
-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
+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
+
+    end
+  end
+end