moceansdk 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baa2fbc9440d656aee7a53d85dd3bac6be392cae9ac8559f41cf5e5c25694500
-  data.tar.gz: bb6c25ba828434a22b301decc6d5e1edb5f3c1e82c85182415dc09a8169a4564
+  metadata.gz: e6afe87fef5a9c54ffd8fa33c4762ea50515918ec4049276e2d2e41fd510153a
+  data.tar.gz: b5af61783dbe5ceaa491de065a52608a2bd9a7399088797ec5bbf31d105f1e8b
 SHA512:
-  metadata.gz: 516771c7d9ce1a9fa24ee023db3427e266abd89336bc15743f49f0877bffd5c03141eafa5867941cb95a8828d89647a7eef48232c185acb5b8b23c4fea80d270
-  data.tar.gz: cda8a8545f864c4717cc3efec9fcd29afe7b585b33c8bb99ddd9c7f69a0f44b13e6cfbc76c8d3883ef55bbffaaa1513ebb92bf0a8d86adba1b754c574a8447ee
+  metadata.gz: a0093116366cf6d19fce9d0b39f7e194098899a4d7dd195cfef71875d709498fe03da51b0a3c2bf1f2d97e1d5e9ac75288b94ad83fa54e4c4a23342b7c930166
+  data.tar.gz: c9931cd1bf804cbccf4d0f0f3d25597efb403a114e42c5d8324f55b8aa103913386b7f51ac513d9a004a7da72f2df9f52b384f6210129b0652eaa6c9c7d7e3c0

data/lib/moceansdk.rb

@@ -23,6 +23,17 @@ 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/utils'
 require 'moceansdk/version'
 require 'moceansdk/client'

data/lib/moceansdk/client.rb

@@ -57,6 +57,10 @@ module Moceansdk
     def number_lookup
       Modules::NumberLookup::NumberLookup.new(@obj_auth, @transmitter)
     end
+
+    def voice
+      Modules::Voice::Voice.new(@obj_auth, @transmitter)
+    end
   end
 
 end

data/lib/moceansdk/modules/abstact_client.rb

@@ -22,7 +22,7 @@ module Moceansdk
         end
 
         # convert string hash to symbol hash
-        @params = final_params.inject({}) {|memo, (k, v)| memo[k.to_sym] = v; memo}
+        @params = Moceansdk::Utils.convert_to_symbol_hash(final_params)
       end
 
       def param_prefix_set?(key)

data/lib/moceansdk/modules/transmitter.rb

@@ -13,16 +13,23 @@ module Moceansdk
       def default_options
         {
             base_url: 'https://rest.moceanapi.com',
-            version: '2'
+            version: '2',
+            verify_ssl: true
         }
       end
 
       def get(uri, params)
-        request('get', uri, params)
+        request_and_parse_body('get', uri, params)
       end
 
       def post(uri, params)
-        request('post', uri, params)
+        request_and_parse_body('post', uri, params)
+      end
+
+      def request_and_parse_body(method, uri, params)
+        res = request(method, uri, params)
+
+        format_response(res.to_s, params[:'mocean-resp-format'] == 'xml', uri)
       end
 
       def request(method, uri, params)
@@ -33,13 +40,11 @@ module Moceansdk
 
         url = @options[:base_url] + '/rest/' + @options[:version] + uri
 
-        res = if method.casecmp('get').zero?
-                HTTP.get(url, params: params)
-              else
-                HTTP.post(url, form: params)
-              end
-
-        format_response(res.to_s, params[:'mocean-resp-format'] == 'xml', uri)
+        if method.casecmp('get').zero?
+          HTTP.follow.get(url, params: params, ssl_context: make_ssl_context)
+        else
+          HTTP.post(url, form: params, ssl_context: make_ssl_context)
+        end
       end
 
       def format_response(response_text, is_xml = false, uri = nil)
@@ -80,12 +85,27 @@ module Moceansdk
               processed_response.messages.message = [processed_response.messages.message]
             end
             processed_response.messages = processed_response.messages.message
+          elsif uri == '/voice/dial'
+            unless processed_response.calls.call.is_a? Array
+              processed_response.calls.call = [processed_response.calls.call]
+            end
+            processed_response.calls = processed_response.calls.call
           end
         end
 
         processed_response.raw_response = raw_response
         processed_response
       end
+
+      def make_ssl_context
+        if @options[:verify_ssl]
+          return nil
+        end
+
+        ctx = OpenSSL::SSL::SSLContext.new
+        ctx.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        ctx
+      end
     end
 
   end

data/lib/moceansdk/modules/voice/mc.rb

@@ -0,0 +1,63 @@
+module Moceansdk
+  module Modules
+    module Voice
+
+      class Mc
+        def self.say(text = nil)
+          ins = McObject::Say.new
+
+          unless text.nil?
+            ins.text = text
+          end
+
+          ins
+        end
+
+        def self.play(file = nil)
+          ins = McObject::Play.new
+
+          unless file.nil?
+            ins.files = file
+          end
+
+          ins
+        end
+
+        def self.dial(to = nil)
+          ins = McObject::Dial.new
+
+          unless to.nil?
+            ins.to = to
+          end
+
+          ins
+        end
+
+        def self.collect(event_url = nil)
+          ins = McObject::Collect.new
+
+          unless event_url.nil?
+            ins.event_url = event_url
+          end
+
+          ins
+        end
+
+        def self.sleep(duration = nil)
+          ins = McObject::Sleep.new
+
+          unless duration.nil?
+            ins.duration = duration
+          end
+
+          ins
+        end
+
+        def self.record
+          McObject::Record.new
+        end
+      end
+
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_builder.rb

@@ -0,0 +1,30 @@
+module Moceansdk
+  module Modules
+    module Voice
+
+      class McBuilder
+        def initialize
+          @mc = []
+        end
+
+        def add(mc)
+          unless mc.is_a? McObject::AbstractMc
+            raise Moceansdk::Exceptions::MoceanError, 'mc_object must extend AbstractMc'
+          end
+
+          @mc.push(mc)
+          self
+        end
+
+        def build
+          converted = []
+          @mc.each do |mc|
+            converted.push(mc.get_request_data)
+          end
+          converted
+        end
+      end
+
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/abstract_mc.rb

@@ -0,0 +1,38 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class AbstractMc
+          def initialize(params = nil)
+            @params = {}
+
+            @params = Moceansdk::Utils.convert_to_symbol_hash(params) unless params.nil?
+          end
+
+          def get_request_data
+            @params = Moceansdk::Utils.convert_to_symbol_hash(@params)
+
+            required_key.each do |key|
+              if @params[:"#{key}"].nil?
+                raise Moceansdk::Exceptions::RequiredFieldException, "#{key} is mandatory field, can't leave empty (#{self})"
+              end
+            end
+
+            @params[:action] = action
+            @params
+          end
+
+          def required_key
+            raise NotImplementedError, 'AbstractMc is a abstract class'
+          end
+
+          def action
+            raise NotImplementedError, 'AbstractMc is a abstract class'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/collect.rb

@@ -0,0 +1,39 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class Collect < AbstractMc
+          def event_url=(param)
+            @params[:'event-url'] = param
+          end
+
+          def minimum=(param)
+            @params[:min] = param
+          end
+
+          def maximum=(param)
+            @params[:max] = param
+          end
+
+          def terminators=(param)
+            @params[:terminators] = param
+          end
+
+          def timeout=(param)
+            @params[:timeout] = param
+          end
+
+          def required_key
+            ['event-url', 'min', 'max', 'timeout']
+          end
+
+          def action
+            'collect'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/dial.rb

@@ -0,0 +1,31 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class Dial < AbstractMc
+          def to=(param)
+            @params[:to] = param
+          end
+
+          def from=(param)
+            @params[:from] = param
+          end
+
+          def dial_sequentially=(param)
+            @params[:'dial-sequentially'] = param
+          end
+
+          def required_key
+            ['to']
+          end
+
+          def action
+            'dial'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/play.rb

@@ -0,0 +1,31 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class Play < AbstractMc
+          def files=(param)
+            @params[:file] = param
+          end
+
+          def barge_in=(param)
+            @params[:'barge-in'] = param
+          end
+
+          def clear_digit_cache=(param)
+            @params[:'clear-digit-cache'] = param
+          end
+
+          def required_key
+            ['file']
+          end
+
+          def action
+            'play'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/record.rb

@@ -0,0 +1,19 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class Record < AbstractMc
+          def required_key
+            []
+          end
+
+          def action
+            'record'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/say.rb

@@ -0,0 +1,43 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class Say < AbstractMc
+          def initialize(params = nil)
+            super(params)
+
+            if @params[:language].nil?
+              @params[:language] = 'en-US'
+            end
+          end
+
+          def language=(param)
+            @params[:language] = param
+          end
+
+          def text=(param)
+            @params[:text] = param
+          end
+
+          def barge_in=(param)
+            @params[:'barge-in'] = param
+          end
+
+          def clear_digit_cache=(param)
+            @params[:'clear-digit-cache'] = param
+          end
+
+          def required_key
+            ['text', 'language']
+          end
+
+          def action
+            'say'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/mc_object/sleep.rb

@@ -0,0 +1,23 @@
+module Moceansdk
+  module Modules
+    module Voice
+      module McObject
+
+        class Sleep < AbstractMc
+          def duration=(param)
+            @params[:duration] = param
+          end
+
+          def required_key
+            ['duration']
+          end
+
+          def action
+            'sleep'
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/voice/voice.rb

@@ -0,0 +1,84 @@
+module Moceansdk
+  module Modules
+    module Voice
+
+      class Voice < Moceansdk::Modules::AbstractClient
+        def initialize(obj_auth, transmitter)
+          super(obj_auth, transmitter)
+          @required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-to']
+        end
+
+        def to=(param)
+          @params['mocean-to'] = param
+        end
+
+        def event_url=(param)
+          @params['mocean-event-url'] = param
+        end
+
+        def mocean_command=(param)
+          if param.is_a? McBuilder
+            @params['mocean-command'] = JSON.generate(param.build)
+          elsif param.is_a? McObject::AbstractMc
+            @params['mocean-command'] = JSON.generate([param.get_request_data])
+          elsif param.is_a? Array
+            @params['mocean-command'] = JSON.generate(param)
+          else
+            @params['mocean-command'] = param
+          end
+        end
+
+        def resp_format=(param)
+          @params['mocean-resp-format'] = param
+        end
+
+        def call(params = {})
+          sym_params = Moceansdk::Utils.convert_to_symbol_hash(params)
+
+          unless sym_params[:'mocean-command'].nil?
+            mc = sym_params[:'mocean-command']
+            sym_params.delete(:'mocean-command')
+            self.mocean_command = mc
+          end
+
+          create(sym_params)
+          create_final_params
+          required_field_set?
+
+          @transmitter.post('/voice/dial', @params)
+        end
+
+        def hangup(call_uuid)
+          @required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-call-uuid']
+
+          create({:'mocean-call-uuid' => call_uuid})
+          create_final_params
+          required_field_set?
+
+          @transmitter.post("/voice/hangup", @params)
+        end
+
+        def recording(call_uuid)
+          @required_fields = ['mocean-api-key', 'mocean-api-secret', 'mocean-call-uuid']
+
+          create({:'mocean-call-uuid' => call_uuid})
+          create_final_params
+          required_field_set?
+
+          response = @transmitter.request('get', '/voice/rec', @params)
+
+          if response['Content-Type'] === 'audio/mpeg'
+            hashed_res = HashExtended.new.merge({'recording_buffer': response.to_s, 'filename': "#{call_uuid}.mp3"})
+            return hashed_res.to_dot
+          end
+
+          # this method will raise exception if there's error
+          processed_response = Moceansdk::Modules::ResponseFactory.create_object(response.to_s)
+          processed_response.raw_response = response.to_s
+          raise Moceansdk::Exceptions::MoceanError.new(processed_response['err_msg'], processed_response)
+        end
+      end
+
+    end
+  end
+end

data/lib/moceansdk/utils.rb

@@ -4,6 +4,12 @@ module Moceansdk
     def self.nil_or_empty?(str)
       str.nil? || str.empty?
     end
+
+    def self.convert_to_symbol_hash(str_hash)
+      str_hash.each_with_object({}) do |(k, v), memo|
+        memo[k.to_sym] = v
+      end
+    end
   end
 
 end

data/lib/moceansdk/version.rb

@@ -1,3 +1,3 @@
 module Moceansdk
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/moceansdk.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency('xml-simple', '~> 1.1')
   s.add_development_dependency('codecov', '>= 0.1.10')
   s.add_development_dependency('minitest', '~> 5.0')
-  s.add_development_dependency('rake', '~> 12.0')
+  s.add_development_dependency('rake', '~> 13.0')
   s.add_development_dependency('webmock', '~> 3.6')
   s.require_path = 'lib'
   s.metadata = {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moceansdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Micro Ocean Technologies Sdn Bhd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2019-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_dot
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,16 @@ files:
 - lib/moceansdk/modules/number_lookup/number_lookup.rb
 - lib/moceansdk/modules/response_factory.rb
 - lib/moceansdk/modules/transmitter.rb
+- lib/moceansdk/modules/voice/mc.rb
+- lib/moceansdk/modules/voice/mc_builder.rb
+- lib/moceansdk/modules/voice/mc_object/abstract_mc.rb
+- lib/moceansdk/modules/voice/mc_object/collect.rb
+- lib/moceansdk/modules/voice/mc_object/dial.rb
+- lib/moceansdk/modules/voice/mc_object/play.rb
+- lib/moceansdk/modules/voice/mc_object/record.rb
+- lib/moceansdk/modules/voice/mc_object/say.rb
+- lib/moceansdk/modules/voice/mc_object/sleep.rb
+- lib/moceansdk/modules/voice/voice.rb
 - lib/moceansdk/utils.rb
 - lib/moceansdk/version.rb
 - moceansdk.gemspec