moceansdk 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 998cc0538b41009c84ef1b496953b91b435c4e06
+  data.tar.gz: cbc6985ad042e3f163505e6507d3f6097525f822
+SHA512:
+  metadata.gz: 4d43cf606822e08b9a3748cd86f388624dd080124d0e7be7094ff7dcb4f809060c2fef88201f6bf33f70a1fe3ea112389666892ee88fc7e2909c080523fdfdfc
+  data.tar.gz: 0c51c50fd2925f847a738a74c0b77145345173cd3ed8a8f9faf28b9d7d766a844bfe0e277558ff8cffabedb9696effebc7cf5c52f31e1a314a569b6d308c0666

data/LICENSE.txt

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

data/README.md

@@ -0,0 +1,56 @@
+MoceanAPI Client Library for Ruby 
+============================
+
+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

data/lib/moceansdk/client.rb

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

data/lib/moceansdk/init.rb

@@ -0,0 +1,4 @@
+module Deno92
+    require_relative "./mocean"
+    require_relative "./client"
+end

data/lib/moceansdk/mocean.rb

@@ -0,0 +1,52 @@
+class Mocean
+    
+    attr_reader :obj_auth
+      
+    def initialize client = Client
+        if client.class == Client
+            @obj_auth = client
+        elsif client.api_key == nil || client.api_secret == nil
+            raise Exception.new("Api key and api secret can't be empty")
+        else
+            raise Exception.new("Arguement pass into Mocean object must be Client object")
+        end        
+    end
+
+    def sms
+        require_relative "modules/message/sms"
+        return Sms.new(@obj_auth) 
+        
+    end
+    
+    def flashSms
+        require_relative "modules/message/sms"
+        _sms = Sms.new(@obj_auth)
+        _sms.flashSms = true
+        return _sms
+    end
+
+    def pricing_list
+        require_relative "modules/account/pricing"
+        return Pricing.new(@obj_auth)
+    end
+
+    def balance
+        require_relative "modules/account/balance"
+        return Balance.new(@obj_auth)
+    end
+
+    def message_status
+        require_relative "modules/message/message_status"
+        return Message_status.new(@obj_auth)
+    end
+    
+    def verify_request
+        require_relative "modules/message/verify_request"
+        return Verify_request.new(@obj_auth)
+    end
+
+    def verify_validate
+        require_relative "modules/message/verify_validate"
+        return Verify_validate.new(@obj_auth)
+    end
+end

data/lib/moceansdk/modules/abstract.rb

@@ -0,0 +1,139 @@
+require "net/http"
+require "uri"
+
+class MoceanFactory
+    attr_accessor :params
+
+    def initialize client
+        @params = {}
+        @params['mocean-api-key'] = client.api_key
+        @params['mocean-api-secret'] = client.api_secret
+    end
+    
+    def create params = {}
+        if params.class != Hash
+            raise Exception.new('Params past into create must be hash.')
+        end
+        tmp_params = params
+        tmp_params.each do |key,value|
+            if !isParamPrefixSet(key)
+                params["mocean-"+key] = value
+                params.delete(k)
+            end
+        end
+        tmp_params = nil
+        @params = @params.merge(params)
+    end
+    
+    def createFinalParams
+        final_params = {}
+        @params.each do |key,value|
+            unless value.nil? || (value.class != Integer && value.empty?)
+                final_params[key] = value
+            end
+        end
+        @params =  final_params
+    end
+    
+    def createResponse response
+    end
+    
+    def isParamPrefixSet param
+        if param.class != String
+            raise Exception.new("Parameter key must be string, "+param.class+" given.")
+        end
+        if param.scan(/^mocean-/i).empty?
+            return false
+        end
+        return true
+    end
+    
+    def isRequiredFieldsSet
+        if @required_fields.class == 'Array' && !@required_fields.empty?
+            @required_fields.each do |field|
+                if @params[field] == nil
+                    raise Exception.new("#{field} is mandatory field, can't leave empty")
+                end
+            end
+        end
+        return true
+    end
+    
+    def reset()
+       @params.each do |key,value|
+           if key == 'mocean-api-key' || key == 'mocean-api-secret'
+               next
+           end
+           @params[key] = nil
+       end       
+    end
+    
+end
+
+class Transmitter
+   
+    def initialize uri,method,params
+        @URL = 'rest-api.moceansms.com'
+        @uri = uri 
+        @params = params
+        
+        begin
+            @http = Net::HTTP.new(@URL,443)  
+            @http.use_ssl = true
+        rescue Exception
+            raise Exception.new('Unable to create connection, please contact SDK provider.')
+        end
+        
+        case method.downcase
+            when 'get'
+                @response = __get
+            when 'post'
+                @response = __post
+            when 'put'
+                @response = __put
+            when 'delete'
+                @response = __delete
+            else
+                raise Exception.new("Unknown request method, please contact SDK provider.")
+        end
+         
+    end
+  
+    def __get
+        form_data = ''
+        if @params.size > 0
+            form_data = URI.encode_www_form(@params)
+        end
+        request = Net::HTTP::Get.new(@uri+"?"+form_data)
+        return @http.request(request)
+    end
+  
+    def __post
+        request = Net::HTTP::Post.new(@uri)
+        if @params.size > 0
+            request.form_data = @params
+        end
+        return @http.request(request)
+    end
+  
+    def __put
+        request = Net::HTTP::Put.new(@uri)
+        if @params.size > 0
+            request.form_data = @params
+        end
+        return @http.request(request)
+    end
+  
+    def  __delete
+        request = Net::HTTP::Delete.new(@uri)
+        if @params.size > 0
+            request.form_data = @params
+        end
+        return @http.request(request)
+    end
+  
+    def getResponse
+        @response.body || nil
+    end
+  
+end

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

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

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

@@ -0,0 +1,38 @@
+require_relative "../abstract"
+
+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

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

@@ -0,0 +1,25 @@
+require_relative "../abstract"
+
+class Message_status < MoceanFactory
+    def initialize client
+        super(client)
+        @required_fields = ['mocean-api-key','mocean-api-secret','mocean-msgid']
+    end
+    
+    def setMsgid param
+        @params['mocean-msgid'] = param
+    end
+    
+    def setRespFormat param
+        @params['mocean-resp-format'] = param
+    end
+    
+    def inquiry params
+        create(params)
+        createFinalParams
+        isRequiredFieldsSet
+        response = Transmitter.new('/rest/1/report/message','get',@params)
+        reset
+        return response.getResponse()
+    end
+end

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

@@ -0,0 +1,96 @@
+require_relative "../abstract"
+
+class Sms < MoceanFactory
+    
+    attr_writer :flashSms 
+    
+    def initialize client
+        super(client)
+        @flashSms = false
+        @required_fileds = ['mocean-api-key','mocean-api-secret','mocean-from','mocean-to','mocean-text']
+    end
+    
+    def setFrom param
+        @params['mocean-from'] = param
+        return self
+    end
+    
+    def setTo param
+        @params['mocean-to'] = param
+        return self
+    end
+    
+    def setText param
+        @params['mocean-text'] = param
+        return self
+    end
+    
+    def setUdh param
+        @params['mocean-udh'] = param
+        return self
+    end
+    
+    def setCoding param
+        @params['mocean-coding'] = param
+        return self
+    end
+    
+    def setDlrMask param
+        @params['mocean-dlr-mask'] = param
+        return self
+    end
+    
+    def setDlrUrl param
+        @params['mocean-dlr-url'] = param
+        return self
+    end
+    
+    def setSchedule param
+        @params['mocean-schedule'] = param
+        return self
+    end
+    
+    def setMclass param
+        @params['mocean-mclass'] = param
+        return self
+    end
+    
+    def setAltDcs param
+        @params['mocean-alt-dcs'] = param
+        return self
+    end
+    
+    def setCharset param
+        @params['mocean-charset'] = param
+        return self
+    end
+    
+    def setValidity param
+        @params['mocean-validity'] = param
+        return self
+    end
+    
+    def setRespFormat param
+        @params['mocean-resp-format'] = param
+        return self
+    end
+    
+    def create params = {}
+        reset
+        super(params)
+        return self
+    end
+    
+    def send
+        if @flashSms == true
+            setMclass(1)
+            setAltDcs(1)
+        end
+        createFinalParams
+        isRequiredFieldsSet
+        response = Transmitter.new('/rest/1/sms','post',@params)
+        return response.getResponse()
+    end
+    
+    
+end

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

@@ -0,0 +1,59 @@
+require_relative "../abstract"
+
+class Verify_request < MoceanFactory
+    
+    def __init__ client
+        super(client)
+        @required_fields = ['mocean-api-key','mocean-api-secret','mocean-to','mocean-brand']
+    end
+    
+    def setTo param
+        @params['mocean-to'] = param
+        return self
+    end
+    
+    def setBrand
+        @params['mocean-brand'] = param
+        return self;
+    end
+    
+    def setFrom param
+        @params['mocean-from'] = param
+        return self;
+    end
+    
+    def setTemplate param
+        @params['mocean-template'] = param
+        return self;
+    end
+    
+    def setPinValidate param
+        @params['mocean-pin-validate'] = param
+        return self
+    end
+    
+    def setNextEventWait param
+        @params['mocean-next-event-wait'] = param
+        return self
+    end
+    
+    def setRespFormat param
+        @params['mocean-resp-format'] = param
+        return self
+    end
+    
+    def create params = {}
+        reset
+        super(params)
+        return self
+    end
+    
+    def send 
+        createFinalParams
+        isRequiredFieldsSet
+        response = Transmitter.new('/rest/1/verify/req','post',@params)
+        return response.getResponse()
+    end
+    
+    
+end

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

@@ -0,0 +1,38 @@
+require_relative "../abstract"
+
+class Verify_validate < MoceanFactory
+    
+    def __init__ client
+        super(client)
+        @required_fields = ['mocean-api-key','mocean-api-secret','mocean-reqid','mocean-otp-code']
+    end
+    
+    def setReqid param
+        @params['mocean-reqid'] = param
+        return self
+    end
+    
+    def setOtpCode param
+        @params['mocean-otp-code'] = param
+        return self
+    end
+    
+    def setRespFormat param
+        @params['mocean-resp-format'] = param
+        return self
+    end
+    
+    def create params = {}
+        reset
+        super(param)
+        return self
+    end
+    
+    def send 
+        createFinalParams
+        isRequiredFieldsSet
+        response = Transmitter.new('/rest/1/verify/check','post',@params)
+        return response.getResponse()
+    end
+    
+end

data/lib/moceansdk/version.rb

@@ -0,0 +1,3 @@
+module Moceansdk
+  VERSION = "0.1.2"
+end

data/lib/moceansdk.rb

@@ -0,0 +1,6 @@
+require "moceansdk/version"
+require "moceansdk/init"
+
+module Moceansdk
+  
+end

data/moceansdk.gemspec

@@ -0,0 +1,20 @@
+require File.expand_path('lib/moceansdk/version', File.dirname(__FILE__))
+
+Gem::Specification.new do |s|
+  s.name = 'moceansdk'
+  s.version = Moceansdk::VERSION
+  s.license = 'MIT'
+  s.platform = Gem::Platform::RUBY
+  s.authors = ['Micro Ocean Technologies Sdn Bhd']
+  s.email = ['support@moceanapi.com']
+  s.homepage = 'https://github.com/moceanapi/mocean-sdk-ruby'
+  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,spec}/**/*') + %w(LICENSE.txt README.md moceansdk.gemspec)
+  s.required_ruby_version = '>= 2.0.0'
+  s.add_dependency('openssl')
+  s.add_development_dependency('rake', '~> 12.0')
+  s.add_development_dependency('minitest', '~> 5.0')
+  s.add_development_dependency('webmock', '~> 3.0')
+  s.require_path = 'lib'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: moceansdk
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Micro Ocean Technologies Sdn Bhd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Mocean SDK for Ruby
+email:
+- support@moceanapi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/moceansdk.rb
+- lib/moceansdk/client.rb
+- lib/moceansdk/init.rb
+- lib/moceansdk/mocean.rb
+- lib/moceansdk/modules/abstract.rb
+- lib/moceansdk/modules/account/balance.rb
+- lib/moceansdk/modules/account/pricing.rb
+- lib/moceansdk/modules/message/message_status.rb
+- lib/moceansdk/modules/message/sms.rb
+- lib/moceansdk/modules/message/verify_request.rb
+- lib/moceansdk/modules/message/verify_validate.rb
+- lib/moceansdk/version.rb
+- moceansdk.gemspec
+homepage: https://github.com/moceanapi/mocean-sdk-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+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
+test_files: []