wavix-sdk-ruby 1.0.0

data/lib/wavix_api/v2/messages/find.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V2
+    module Messages
+      class Find < ::WavixApi::V2::BaseFind
+        @params_schema = ::WavixApi::BaseMethods::ONLY_UUID_SCHEMA
+
+        class << self
+          private
+
+          def path
+            'v2/messages'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/opt_outs/create.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V2
+    module Messages
+      module OptOuts
+        class Create
+          include WavixApi::BaseMethods
+
+          @params_schema = {
+            type: 'object',
+            properties: {
+              number: { type: 'string' }.freeze,
+              sender_id: { type: 'string' }.freeze
+            }.freeze,
+            required: %i[
+              number
+            ].freeze
+          }.freeze
+
+          class << self
+            def call(params = {})
+              instance = new(params)
+
+              instance.validate!
+
+              instance.post('v2/messages/opt-outs')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/search.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'wavix_api'
+
+module WavixApi
+  module V2
+    module Messages
+      class Search < ::WavixApi::V2::BaseSearch
+        include ::WavixApi::V1::Messages::CommonVars
+
+        @params_schema = ::WavixApi::V1::Messages::CommonVars::SEARCH_PARAMS_SCHEMA
+
+        class << self
+          private
+
+          def path
+            'v2/messages'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/sender_ids/create.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V2
+    module Messages
+      module SenderIds
+        class Create
+          include WavixApi::BaseMethods
+
+          @params_schema = {
+            type: 'object',
+            properties: {
+              type: { enum: %w[numeric alphanumeric] }.freeze,
+              sender_id: { type: 'string' }.freeze,
+              countries: {
+                type: 'array',
+                items: { type: 'string' }.freeze
+              }
+            }.freeze,
+            required: %i[
+              type
+              sender_id
+              countries
+            ].freeze
+          }.freeze
+
+          class << self
+            def call(params = {})
+              instance = new(params)
+
+              instance.validate!
+
+              instance.post('v2/messages/sender-ids')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/sender_ids/destroy.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V2
+    module Messages
+      module SenderIds
+        class Destroy < ::WavixApi::V2::BaseDestroy
+          @params_schema = ::WavixApi::BaseMethods::ONLY_UUID_SCHEMA
+
+          class << self
+            private
+
+            def path
+              'v2/messages/sender-ids'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/sender_ids/find.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V2
+    module Messages
+      module SenderIds
+        class Find < ::WavixApi::V2::BaseFind
+          @params_schema = ::WavixApi::BaseMethods::ONLY_UUID_SCHEMA
+
+          class << self
+            private
+
+            def path
+              'v2/messages/sender-ids'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/sender_ids/restrictions.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V2
+    module Messages
+      module SenderIds
+        class Restrictions
+          include WavixApi::BaseMethods
+
+          @params_schema = {
+            type: 'object',
+            properties: {
+              country: { type: 'string' }.freeze,
+              type: { enum: %w[numeric alphanumeric] }.freeze
+            }.freeze,
+            required: %i[country type].freeze
+          }.freeze
+
+          class << self
+            def call(params = {})
+              instance = new(params)
+
+              instance.validate!
+
+              instance.get('v2/messages/sender-ids/restrictions')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v2/messages/sender_ids/search.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'wavix_api'
+
+module WavixApi
+  module V2
+    module Messages
+      module SenderIds
+        class Search < ::WavixApi::V2::BaseSearch
+          class << self
+            private
+
+            def path
+              'v2/messages/sender-ids'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v3/messages/sender_ids/create.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V3
+    module Messages
+      module SenderIds
+        class Create
+          include WavixApi::BaseMethods
+
+          MONTHLY_VOLUMES = ['1-1000', '1001-20000', '20001-50000',
+                             '50001-100000', 'More than 100000'].freeze
+          USECASES = %w[transactional promo authentication].freeze
+
+          @params_schema = {
+            type: 'object',
+            properties: {
+              type: { enum: %w[numeric alphanumeric] }.freeze,
+              sender_id: { type: 'string' }.freeze,
+              countries: {
+                type: 'array',
+                items: { type: 'string' }.freeze
+              },
+              usecase: { enum: USECASES }.freeze,
+              monthly_volume: { enum: MONTHLY_VOLUMES }.freeze,
+              samples: {
+                type: 'array',
+                items: { type: 'string' }.freeze
+              }
+            }.freeze,
+            required: %i[
+              type
+              sender_id
+              countries
+              usecase
+              samples
+            ].freeze
+          }.freeze
+          class << self
+            def call(params = {})
+              instance = new(params)
+
+              instance.validate!
+
+              instance.post('v3/messages/sender-ids')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v3/messages/sender_ids/find.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module WavixApi
+  module V3
+    module Messages
+      module SenderIds
+        class Find < ::WavixApi::V2::BaseFind
+          @params_schema = ::WavixApi::BaseMethods::ONLY_UUID_SCHEMA
+
+          class << self
+            private
+
+            def path
+              'v3/messages/sender-ids'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api/v3/messages/sender_ids/search.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'wavix_api'
+
+module WavixApi
+  module V3
+    module Messages
+      module SenderIds
+        class Search < ::WavixApi::V2::BaseSearch
+          class << self
+            private
+
+            def path
+              'v3/messages/sender-ids'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wavix_api.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'faraday'
+require 'faraday/multipart'
+require_relative 'middleware/follow_redirects_middleware'
+
+module WavixApi
+  class << self
+    DEFAULT_HOST = 'api.wavix.com'
+
+    attr_accessor :api_key, :host
+
+    def client
+      Client.new(host: @host, api_key: @api_key)
+    end
+  end
+
+  module HTTPMethods
+    DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+    Response = Struct.new(:status, :status_str, :body, :parsed_body, 'success?', :filename)
+    CONTENT_TYPES = {
+      'jpeg' => 'image/jpeg',
+      'jpg' => 'image/jpeg',
+      'gif' => 'image/gif',
+      'png' => 'image/png',
+      'pdf' => 'application/pdf',
+      'bmp' => 'image/bmp',
+      'tiff' => 'image/tiff',
+      'doc' => 'application/msword',
+      'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+      'dib' => 'image/dib',
+      'amr' => 'audio/amr',
+      '3g' => 'audio/3gpp',
+      'wav' => 'audio/wav',
+      'wave' => 'audio/wav',
+      'mp3' => 'audio/mpeg',
+      'aac' => 'audio/aac',
+      'gcp' => 'audio/gcp',
+      'midi' => 'audio/midi',
+      'midp' => 'audio/midi'
+    }.freeze
+    FILE_NAMES = %i[attachment paper invoice].freeze
+
+    def request(method, path, params: {}, body: nil, headers: {})
+      connection = Faraday.new(
+        url: "https://#{@host}",
+        params: { appid: @api_key },
+        headers: DEFAULT_HEADERS.merge(headers)
+      ) do |builder|
+        yield(builder) if block_given?
+
+        builder.use FollowRedirectsMiddleware
+        builder.adapter Faraday.default_adapter
+      end
+
+      response =
+        if %w[GET DELETE].index(method)
+          connection.send(method.downcase, path, params)
+        else
+          connection.send(method.downcase, path) do |request|
+            (params || {}).each { |k, v| request.params[k] = v }
+            request.body = body if body
+          end
+        end
+
+      parsed_body = begin
+        JSON.parse(response.body)
+      rescue JSON::ParserError
+        {}
+      end
+
+      Response.new(
+        response.status,
+        response.reason_phrase,
+        response.body,
+        parsed_body,
+        response.success?,
+        filename(response.env.response_headers, path)
+      )
+    end
+
+    def filename(response_headers, path)
+      file_by_disposition = response_headers['content-disposition']&.match(/filename="(.+)"/)
+
+      return file_by_disposition[1] if file_by_disposition
+
+      content_type = CONTENT_TYPES.key(response_headers[:content_type])
+
+      return unless content_type
+
+      "#{FILE_NAMES.find { |el| path.include?(el) }}_#{Time.now.to_i}.#{content_type}"
+    end
+  end
+
+  class Client
+    include HTTPMethods
+
+    def initialize(host:, api_key:)
+      @host = host.empty? ? DEFAULT_HOST : host
+      @api_key = api_key
+    end
+
+    def get(path, params: {}, headers: {})
+      request('GET', path, params: params, headers: HTTPMethods::DEFAULT_HEADERS.merge(headers))
+    end
+
+    def patch(path, body: {}, params: {})
+      request('PATCH', path, params: params, body: body.to_json)
+    end
+
+    def delete(path, params: {})
+      request('DELETE', path, params: params)
+    end
+
+    def put(path, body: {}, params: {})
+      request('PUT', path, params: params, body: body.to_json)
+    end
+
+    def post(path, body: {}, params: {}, with_file: false,
+             headers: { 'Content-Type' => 'application/json' })
+      body = body.to_json unless with_file
+      headers['Content-Type'] = 'multipart/form-data' if with_file
+
+      request('POST', path, params: params, body: body, headers: headers) do |builder|
+        builder.request :multipart if with_file
+      end
+    end
+
+    def download(path, headers: {}, params: {}, save_path: nil)
+      if save_path
+        dirname = File.dirname(save_path)
+        dir_parts = dirname.split(%r{[/\\]}).reject(&:empty?)
+
+        (1..dir_parts.size).each do |n|
+          dir = dir_parts[0...n].join('/')
+          Dir.mkdir("/#{dir}") unless Dir.exist?("/#{dir}")
+        end
+      end
+
+      response = request('GET', path, params: params, headers: headers)
+
+      return response if save_path.nil? || !response.success? || response.filename.nil?
+
+      filename = if CONTENT_TYPES.keys.find { |el| save_path.include?(".#{el}") }
+                   save_path
+                 else
+                   "#{save_path}/#{response.filename}"
+                 end
+
+      File.open(filename, 'wb') { |f| f.write response.body }
+      response
+    end
+  end
+end

data/wavix-sdk-ruby.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'wavix-sdk-ruby'
+  s.version       = '1.0.0'
+  s.authors       = ['Wavix']
+  s.email         = ['support@wavix.com']
+  s.summary       = 'Wavix Public API SDK for Ruby'
+  s.homepage      = 'https://wavix.com'
+  s.license       = 'MIT'
+  s.metadata = {
+    'homepage_uri' => 'http://wavix.com/',
+    'changelog_uri' => 'https://ci.unitedline.net/wavix/wavix-sdk-ruby/-/tree/master/CHANGELOG.md',
+    'source_code_uri' => 'https://ci.unitedline.net/wavix/wavix-sdk-ruby/-/tree/master',
+    'bug_tracker_uri' => 'https://ci.unitedline.net/wavix/wavix-sdk-ruby/-/issues'
+  }
+  s.files = %w[LICENSE README.md wavix-sdk-ruby.gemspec] + Dir['lib/**/*.rb']
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+  s.bindir = 'bin'
+
+  s.extra_rdoc_files  = ['README.md', 'LICENSE']
+  s.rdoc_options      = ['--charset=UTF-8']
+
+  s.required_ruby_version = '>= 2.5.5'
+
+  s.add_runtime_dependency 'faraday', '>= 0.17.6'
+  s.add_dependency 'faraday-multipart', '~> 1.0.4'
+  s.add_dependency 'json-schema', '~> 2.8.1'
+  s.add_development_dependency 'rspec', '~> 3.13.0'
+  s.add_development_dependency 'rubocop', '~> 1.60.2'
+
+  s.description = <<-DESC.gsub(/^    /, '')
+    Ruby integrations for Wavix Public API
+  DESC
+end