moceansdk 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6afe87fef5a9c54ffd8fa33c4762ea50515918ec4049276e2d2e41fd510153a
-  data.tar.gz: b5af61783dbe5ceaa491de065a52608a2bd9a7399088797ec5bbf31d105f1e8b
+  metadata.gz: b0b4c0c5f19f708f2e1d0f255eed1341244f64922b75cde574d9765cadc570f6
+  data.tar.gz: 628465a50f969494c965a77b5f0868c89ac11d0b1f0be7f2b0d17c0ac786cc8c
 SHA512:
-  metadata.gz: a0093116366cf6d19fce9d0b39f7e194098899a4d7dd195cfef71875d709498fe03da51b0a3c2bf1f2d97e1d5e9ac75288b94ad83fa54e4c4a23342b7c930166
-  data.tar.gz: c9931cd1bf804cbccf4d0f0f3d25597efb403a114e42c5d8324f55b8aa103913386b7f51ac513d9a004a7da72f2df9f52b384f6210129b0652eaa6c9c7d7e3c0
+  metadata.gz: a1a3f349fdf7127a1157272a7cb56cac46a03d139ff8a03f756218f5697f936ac35bb4a20ec2056de93dda42100649e88ed789d2c55f9aed375f0828d9ff0f52
+  data.tar.gz: 38ba32440b25ad20da427f5e5242eaf0ab03ba22b273344a140d02e887424fbb216b6a5faacdb82cf4a5b0d44926f24c49f182446b1e1a366cfe827a2c1fbff8

data/README.md

@@ -2,6 +2,7 @@ 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)
@@ -68,7 +69,7 @@ Kindly visit [MoceanApi Docs][doc_main] for more usage
 
 This library is released under the [MIT License][license]
 
-[signup]: https://dashboard.moceanapi.com/register?medium=github&campaign=sdk-ruby
+[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

@@ -34,6 +34,19 @@ 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/client.rb

@@ -61,6 +61,10 @@ module Moceansdk
     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/modules/command/command.rb

@@ -0,0 +1,47 @@
+module Moceansdk
+  module Modules
+    module Command
+
+      class Command < Moceansdk::Modules::AbstractClient
+        def initialize(obj_auth, transmitter)
+          super(obj_auth, transmitter)
+          @required_fields = ['mocean-api-key', 'mocean-api-secret','mocean-command']
+        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 execute(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?
+
+          # @sym_params[:'mocean-command'] = JSON.generate(@sym_params[:'mocean-command'].build)
+          @transmitter.post('/send-message', @params)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+module Moceansdk
+  module Modules
+    module Command
+
+      class Mc
+        def self.tg_send_text()
+          McObject::TgSendText.new
+        end
+
+        def self.tg_send_audio()
+          McObject::TgSendAudio.new
+        end
+
+        def self.tg_send_animation()
+          McObject::TgSendAnimation.new
+        end
+
+        def self.tg_send_document()
+          McObject::TgSendDocument.new
+        end
+
+        def self.tg_send_photo()
+          McObject::TgSendPhoto.new
+        end
+
+        def self.tg_send_video()
+          McObject::TgSendVideo.new
+        end
+
+        def self.tg_request_contact()
+          McObject::TgRequestContact.new
+        end
+
+        def self.send_sms()
+          McObject::SendSMS.new
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Moceansdk
+  module Modules
+    module Command
+
+      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/command/mc_object/abstract_mc.rb

@@ -0,0 +1,36 @@
+module Moceansdk
+  module Modules
+    module Command
+      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/command/mc_object/send_sms.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class SendSMS < AbstractMc
+          def action
+            'send-sms'
+          end
+
+          def required_key
+            ['from','to','content']
+          end
+
+          def from(from, contact_type = 'phone_num')
+            @params[:'from'] = {}
+            @params[:'from'][:'id'] = from
+            @params[:'from'][:'type'] = contact_type
+            return self
+          end
+
+          def to(to, contact_type = "phone_num")
+            @params[:'to'] = {}
+            @params[:'to'][:'id'] = to
+            @params[:'to'][:'type'] = contact_type
+            return self
+          end
+
+          def content(text)
+            @params[:'content'] = {}
+            @params[:'content'][:'text'] = text
+            @params[:'content'][:'type'] = 'text'
+            return self
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_request_contact.rb

@@ -0,0 +1,49 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgRequestContact < AbstractMc
+          def action
+            'send-telegram'
+          end
+
+          def required_key
+            ['from', 'to', 'content', 'tg_keyboard']
+          end
+
+          def from(from, contact_type = 'bot_username')
+            @params[:'from'] = {}
+            @params[:'from'][:'id'] = from
+            @params[:'from'][:'type'] = contact_type
+            return self
+          end
+
+          def to(to, contact_type = "chat_id")
+            @params[:'to'] = {}
+            @params[:'to'][:'id'] = to
+            @params[:'to'][:'type'] = contact_type
+            return self
+          end
+
+          def content(text)
+            @params[:'content'] = {}
+            @params[:'content'][:'text'] = text
+            @params[:'content'][:'type'] = 'text'
+            return self
+          end
+
+          def button(text)
+            @params[:'tg_keyboard'] = {
+              :'button_text' => text,
+              :'button_request' => 'contact'
+            }
+            return self
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_send_animation.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgSendAnimation < AbstractMc
+            def action
+              'send-telegram'
+            end
+
+            def required_key
+              ['from','to','content']
+            end
+
+            def from(from, contact_type = 'bot_username')
+              @params[:'from'] = {}
+              @params[:'from'][:'id'] = from
+              @params[:'from'][:'type'] = contact_type
+              return self
+            end
+
+            def to(to, contact_type = "chat_id")
+              @params[:'to'] = {}
+              @params[:'to'][:'id'] = to
+              @params[:'to'][:'type'] = contact_type
+              return self
+            end
+
+            def content(url,text)
+              @params[:'content'] = {}
+              @params[:'content'][:'rich_media_url'] = url
+              @params[:'content'][:'text'] = text
+              @params[:'content'][:'type'] = 'animation'
+              return self
+            end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_send_audio.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgSendAudio < AbstractMc
+            def action
+              'send-telegram'
+            end
+
+            def required_key
+              ['from','to','content']
+            end
+
+            def from(from, contact_type = 'bot_username')
+              @params[:'from'] = {}
+              @params[:'from'][:'id'] = from
+              @params[:'from'][:'type'] = contact_type
+              return self
+            end
+
+            def to(to, contact_type = "chat_id")
+              @params[:'to'] = {}
+              @params[:'to'][:'id'] = to
+              @params[:'to'][:'type'] = contact_type
+              return self
+            end
+
+            def content(url, text)
+              @params[:'content'] = {}
+              @params[:'content'][:'rich_media_url'] = url
+              @params[:'content'][:'text'] = text
+              @params[:'content'][:'type'] = 'audio'
+              return self
+            end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_send_document.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgSendDocument < AbstractMc
+          def action
+            'send-telegram'
+          end
+
+          def required_key
+            ['from','to','content']
+          end
+
+          def from(from, contact_type = 'bot_username')
+            @params[:'from'] = {}
+            @params[:'from'][:'id'] = from
+            @params[:'from'][:'type'] = contact_type
+            return self
+          end
+
+          def to(to, contact_type = "chat_id")
+            @params[:'to'] = {}
+            @params[:'to'][:'id'] = to
+            @params[:'to'][:'type'] = contact_type
+            return self
+          end
+
+          def content(url,text)
+            @params[:'content'] = {}
+            @params[:'content'][:'rich_media_url'] = url
+            @params[:'content'][:'text'] = text
+            @params[:'content'][:'type'] = 'document'
+            return self
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_send_photo.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgSendPhoto < AbstractMc
+          def action
+            'send-telegram'
+          end
+
+          def required_key
+            ['from','to','content']
+          end
+
+          def from(from, contact_type = 'bot_username')
+            @params[:'from'] = {}
+            @params[:'from'][:'id'] = from
+            @params[:'from'][:'type'] = contact_type
+            return self
+          end
+
+          def to(to, contact_type = "chat_id")
+            @params[:'to'] = {}
+            @params[:'to'][:'id'] = to
+            @params[:'to'][:'type'] = contact_type
+            return self
+          end
+
+          def content(url,text)
+            @params[:'content'] = {}
+            @params[:'content'][:'rich_media_url'] = url
+            @params[:'content'][:'text'] = text
+            @params[:'content'][:'type'] = 'photo'
+            return self
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_send_text.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgSendText < AbstractMc
+          def action
+            'send-telegram'
+          end
+
+          def required_key
+            ['from','to','content']
+          end
+
+          def from(from, contact_type = 'bot_username')
+            @params[:'from'] = {}
+            @params[:'from'][:'id'] = from
+            @params[:'from'][:'type'] = contact_type
+            return self
+          end
+
+          def to(to, contact_type = "chat_id")
+            @params[:'to'] = {}
+            @params[:'to'][:'id'] = to
+            @params[:'to'][:'type'] = contact_type
+            return self
+          end
+
+          def content(text)
+            @params[:'content'] = {}
+            @params[:'content'][:'text'] = text
+            @params[:'content'][:'type'] = 'text'
+            return self
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/command/mc_object/tg_send_video.rb

@@ -0,0 +1,41 @@
+module Moceansdk
+  module Modules
+    module Command
+      module McObject
+
+        class TgSendVideo < AbstractMc
+          def action
+            'send-telegram'
+          end
+
+          def required_key
+            ['from','to','content']
+          end
+
+          def from(from, contact_type = 'bot_username')
+            @params[:'from'] = {}
+            @params[:'from'][:'id'] = from
+            @params[:'from'][:'type'] = contact_type
+            return self
+          end
+
+          def to(to, contact_type = "chat_id")
+            @params[:'to'] = {}
+            @params[:'to'][:'id'] = to
+            @params[:'to'][:'type'] = contact_type
+            return self
+          end
+
+          def content(url,text)
+            @params[:'content'] = {}
+            @params[:'content'][:'rich_media_url'] = url
+            @params[:'content'][:'text'] = text
+            @params[:'content'][:'type'] = 'video'
+            return self
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/moceansdk/modules/message/channel.rb

@@ -5,6 +5,7 @@ module Moceansdk
       class Channel
         AUTO = 1
         SMS = 2
+        TELEGRAM = 3
       end
 
     end

data/lib/moceansdk/modules/message/verify_request.rb

@@ -63,6 +63,8 @@ module Moceansdk
 
           if @channel == Channel::SMS
             verify_request_url += '/sms'
+          elsif @channel == Channel::TELEGRAM
+            verify_request_url += '/telegram'
           end
 
           @transmitter.post(verify_request_url, @params)

data/lib/moceansdk/version.rb

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

data/moceansdk.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.description = 'Mocean SDK for Ruby'
   s.summary = 'This is a Mocean SDK written in Ruby, to use it you will need a mocean account. Signup for free at https://moceanapi.com'
   s.files = Dir.glob('lib/**/*.rb') + %w(LICENSE.txt README.md moceansdk.gemspec)
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.3.0'
   s.add_dependency('hash_dot', '~> 2.4')
   s.add_dependency('http', '>= 3', '< 5')
   s.add_dependency('xml-simple', '~> 1.1')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: moceansdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Micro Ocean Technologies Sdn Bhd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-14 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hash_dot
@@ -132,6 +132,18 @@ files:
 - lib/moceansdk/modules/abstact_client.rb
 - lib/moceansdk/modules/account/balance.rb
 - lib/moceansdk/modules/account/pricing.rb
+- lib/moceansdk/modules/command/command.rb
+- lib/moceansdk/modules/command/mc.rb
+- lib/moceansdk/modules/command/mc_builder.rb
+- lib/moceansdk/modules/command/mc_object/abstract_mc.rb
+- lib/moceansdk/modules/command/mc_object/send_sms.rb
+- lib/moceansdk/modules/command/mc_object/tg_request_contact.rb
+- lib/moceansdk/modules/command/mc_object/tg_send_animation.rb
+- lib/moceansdk/modules/command/mc_object/tg_send_audio.rb
+- lib/moceansdk/modules/command/mc_object/tg_send_document.rb
+- lib/moceansdk/modules/command/mc_object/tg_send_photo.rb
+- lib/moceansdk/modules/command/mc_object/tg_send_text.rb
+- lib/moceansdk/modules/command/mc_object/tg_send_video.rb
 - lib/moceansdk/modules/message/channel.rb
 - lib/moceansdk/modules/message/message_status.rb
 - lib/moceansdk/modules/message/sms.rb
@@ -167,15 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: This is a Mocean SDK written in Ruby, to use it you will need a mocean account.