moceansdk 0.1.7 → 1.0.0

data/lib/moceansdk/modules/response_factory.rb

@@ -0,0 +1,50 @@
+module Moceansdk
+  module Modules
+
+    class ResponseFactory
+      def self.create_object(raw_response)
+        begin
+          res = JSON.load(raw_response, proc {|obj|
+            case obj
+            when Hash
+              obj.each {|k, v|
+                obj[k] = if v.is_a? Float
+                           # hardcoded float to 4 decimal string
+                           sprintf('%.4f', v)
+                         elsif v.is_a? Integer
+                           v.to_s
+                         else
+                           v
+                         end
+              }
+            when Array
+              obj.map! {|v| v}
+            end
+          })
+        rescue JSON::JSONError
+          begin
+            res = XmlSimple.xml_in(raw_response, 'ForceArray': false)
+          rescue StandardError
+            raise Moceansdk::Exceptions::MoceanError, 'unable to parse response, ' + raw_response
+          end
+        end
+
+        hashed_res = HashExtended.new.merge(res)
+        hashed_res.to_dot
+      end
+    end
+
+    class HashExtended < Hash
+      attr_accessor :raw_response
+
+      def to_s
+        @raw_response
+      end
+
+      def to_hash
+        inspect
+      end
+    end
+
+  end
+end

data/lib/moceansdk/modules/transmitter.rb

@@ -0,0 +1,92 @@
+module Moceansdk
+  module Modules
+
+    class Transmitter
+      def initialize(options = nil)
+        @options = default_options
+
+        unless options.nil?
+          @options = @options.merge(options)
+        end
+      end
+
+      def default_options
+        {
+            base_url: 'https://rest.moceanapi.com',
+            version: '2'
+        }
+      end
+
+      def get(uri, params)
+        request('get', uri, params)
+      end
+
+      def post(uri, params)
+        request('post', uri, params)
+      end
+
+      def request(method, uri, params)
+        params[:'mocean-medium'] = 'RUBY-SDK'
+
+        # use json if default not set
+        params[:'mocean-resp-format'] = 'json' unless params[:'mocean-resp-format']
+
+        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)
+      end
+
+      def format_response(response_text, is_xml = false, uri = nil)
+        raw_response = response_text
+
+        # format for v1
+        if !uri.nil? && @options[:version] == '1' && is_xml
+          if uri == '/account/pricing'
+            response_text = response_text
+                                .sub('<data>', '<destinations>')
+                                .sub('</data>', '</destinations>')
+          elsif uri == '/sms'
+            response_text = response_text
+                                .sub('<result>', '<result><messages>')
+                                .sub('</result>', '</messages></result>')
+          end
+        end
+
+        processed_response = ResponseFactory.create_object(
+            response_text
+                .sub('<verify_request>', '')
+                .sub('</verify_request>', '')
+                .sub('<verify_check>', '')
+                .sub('</verify_check>', '')
+        )
+
+        if processed_response['status'] && processed_response['status'] != '0' && processed_response['status'] != 0
+          processed_response.raw_response = raw_response
+          raise Moceansdk::Exceptions::MoceanError.new(processed_response['err_msg'], processed_response)
+        end
+
+        # format for v1
+        if !uri.nil? && is_xml
+          if uri == '/account/pricing'
+            processed_response.destinations = processed_response.destinations.destination
+          elsif uri == '/sms'
+            unless processed_response.messages.message.is_a? Array
+              processed_response.messages.message = [processed_response.messages.message]
+            end
+            processed_response.messages = processed_response.messages.message
+          end
+        end
+
+        processed_response.raw_response = raw_response
+        processed_response
+      end
+    end
+
+  end
+end

data/lib/moceansdk/utils.rb

@@ -0,0 +1,9 @@
+module Moceansdk
+
+  class Utils
+    def self.nil_or_empty?(str)
+      str.nil? || str.empty?
+    end
+  end
+
+end

data/lib/moceansdk/version.rb

@@ -1,3 +1,3 @@
-module Moceansdk
-  VERSION = "0.1.7"
-end
+module Moceansdk
+  VERSION = "1.0.0"
+end

data/moceansdk.gemspec

@@ -1,20 +1,26 @@
-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','~>2.0')
-  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'
+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/**/*.rb') + %w(LICENSE.txt README.md moceansdk.gemspec)
+  s.required_ruby_version = '>= 2.2.0'
+  s.add_dependency('hash_dot', '~> 2.4')
+  s.add_dependency('http', '~> 3.0')
+  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.require_path = 'lib'
+  s.metadata = {
+      'homepage' => 'https://github.com/MoceanAPI/mocean-sdk-ruby',
+      'source_code_uri' => 'https://github.com/MoceanAPI/mocean-sdk-ruby'
+  }
 end

metadata

@@ -1,43 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: moceansdk
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Micro Ocean Technologies Sdn Bhd
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-18 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: openssl
+  name: hash_dot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.10
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
 description: Mocean SDK for Ruby
 email:
 - support@moceanapi.com
@@ -76,22 +104,31 @@ files:
 - LICENSE.txt
 - README.md
 - lib/moceansdk.rb
+- lib/moceansdk/auth/abstract_auth.rb
+- lib/moceansdk/auth/basic.rb
 - lib/moceansdk/client.rb
-- lib/moceansdk/init.rb
-- lib/moceansdk/mocean.rb
-- lib/moceansdk/modules/abstract.rb
+- lib/moceansdk/exceptions/mocean_error.rb
+- lib/moceansdk/exceptions/required_field_exception.rb
+- lib/moceansdk/modules/abstact_client.rb
 - lib/moceansdk/modules/account/balance.rb
 - lib/moceansdk/modules/account/pricing.rb
+- lib/moceansdk/modules/message/channel.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/modules/number_lookup/number_lookup.rb
+- lib/moceansdk/modules/response_factory.rb
+- lib/moceansdk/modules/transmitter.rb
+- lib/moceansdk/utils.rb
 - lib/moceansdk/version.rb
 - moceansdk.gemspec
-homepage: https://github.com/moceanapi/mocean-sdk-ruby
+homepage: https://github.com/MoceanAPI/mocean-sdk-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage: https://github.com/MoceanAPI/mocean-sdk-ruby
+  source_code_uri: https://github.com/MoceanAPI/mocean-sdk-ruby
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -108,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: This is a Mocean SDK written in Ruby, to use it you will need a mocean account.

data/lib/moceansdk/init.rb

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

data/lib/moceansdk/mocean.rb

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

@@ -1,142 +0,0 @@
-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.clone
-        tmp_params.each do |key,value|
-            if !isParamPrefixSet(key)
-                new_key ="mocean-"+key
-                params[new_key] = value
-                params.delete(key)
-            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.moceanapi.com'
-        @uri = uri 
-        @params = params
-        @params['mocean-medium'] = 'RUBY-SDK'
-        
-        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