didww-v3 1.0.0

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/didww-v3.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'didww/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'didww-v3'
+  spec.version       = DIDWW::VERSION
+  spec.authors       = ['Alex Korobeinikov']
+  spec.email         = ['alex.k@didww.com']
+
+  spec.summary       = %q{Ruby client for DIDWW API v3}
+  spec.description   = %q{Ruby client for DIDWW API v3}
+  spec.homepage      = 'https://github.com/didww/didww-v3-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  # development
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'http_logger'
+  spec.add_development_dependency 'rubocop'
+
+  # test
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'smart_rspec'
+  spec.add_development_dependency 'webmock'
+
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'faraday'
+  spec.add_dependency 'json_api_client'
+  spec.add_dependency 'http'
+  spec.add_dependency 'down'
+
+end

data/lib/didww.rb

@@ -0,0 +1,3 @@
+require 'didww/version'
+require 'didww/client'
+require 'didww/middleware'

data/lib/didww/client.rb

@@ -0,0 +1,120 @@
+require 'active_support/core_ext/module/attribute_accessors'
+require 'json_api_client'
+
+require 'didww/resources/base'
+
+module DIDWW
+  module Client
+    BASE_URLS = {
+      sandbox:    'https://sandbox-api.didww.com/v3/'         .freeze,
+      production: 'https://api.didww.com/v3/'                 .freeze
+    }.freeze
+    DEFAULT_MODE = :sandbox
+
+    mattr_accessor :api_key, :api_mode, :http_verbose
+
+    class << self
+      def configure
+        yield self if block_given?
+        connect!
+        require_didww_resources
+        self
+      end
+
+      def api_mode
+        @@api_mode || DEFAULT_MODE
+      end
+
+      def api_key
+        @@api_key
+      end
+
+      def api_base_url
+        BASE_URLS[api_mode]
+      end
+
+      def balance
+        Resource::Balance.all.first
+      end
+
+      def cities
+        Resource::City
+      end
+
+      def countries
+        Resource::Country
+      end
+
+      def did_group_types
+        Resource::DidGroupType
+      end
+
+      def did_groups
+        Resource::DidGroup
+      end
+
+      def dids
+        Resource::Did
+      end
+
+      def orders
+        Resource::Order
+      end
+
+      def regions
+        Resource::Region
+      end
+
+      def trunk_groups
+        Resource::TrunkGroup
+      end
+
+      def trunks
+        Resource::Trunk
+      end
+
+      def cdr_exports
+        Resource::CdrExport
+      end
+
+      def api_mode=(arg)
+        unless BASE_URLS.keys.include?(arg)
+          raise ArgumentError.new("Mode should be in #{BASE_URLS.keys} (given '#{arg}').")
+        end
+        @@api_mode = arg
+      end
+
+      private
+
+      def http_verbose?
+        ENV['HTTP_VERBOSE'] == 'true' || http_verbose
+      end
+
+      def connect!
+        DIDWW::Resource::Base.site = api_base_url
+        DIDWW::Resource::Base.connection do |connection|
+          connection.use Faraday::Response::Logger if http_verbose?
+          connection.use DIDWW::Middleware
+        end
+        JsonApiClient::Paginating::Paginator.page_param = 'number'
+        JsonApiClient::Paginating::Paginator.per_page_param = 'size'
+      end
+
+      def require_didww_resources
+        require 'didww/resources/balance'
+        require 'didww/resources/city'
+        require 'didww/resources/country'
+        require 'didww/resources/did_group_type'
+        require 'didww/resources/did_group'
+        require 'didww/resources/did'
+        require 'didww/resources/order'
+        require 'didww/resources/region'
+        require 'didww/resources/trunk_group'
+        require 'didww/resources/trunk'
+        require 'didww/resources/stock_keeping_unit'
+        require 'didww/resources/cdr_export'
+      end
+
+    end
+  end
+end

data/lib/didww/complex_objects/base.rb

@@ -0,0 +1,89 @@
+require 'json_api_client/schema'
+
+module DIDWW
+  module ComplexObject
+    class Base
+      class << self
+        # Specifies the JSON API resource type. By default this is inferred
+        # from the resource class name.
+        def type
+          name.demodulize.underscore.pluralize
+        end
+
+        def property(name, options = {})
+          property = schema.add(name, options)
+          define_method(name) { attributes[name] }
+          define_method("#{name}=".to_sym) do |val|
+            attributes[name] = property.cast(val)
+          end
+        end
+
+        def schema
+          @schema ||= JsonApiClient::Schema.new
+        end
+
+        # Type casting for JsonApiClient parser/setters
+        def cast(value, default)
+          case value
+          when self
+            value
+          when Hash
+            cast_single_object(value)
+          when Array
+            value.map { |item| cast(item, item) }
+          else
+            default
+          end
+        end
+
+        protected
+
+        def cast_single_object(hash)
+          hash = hash.with_indifferent_access
+          klass = class_for_type(hash[:type])
+          klass ? klass.new(hash[:attributes] || {}) : hash
+        end
+
+        # Returns a ComplexObject class if given JSON API type matches any
+        def class_for_type(type)
+          "#{parent.name}::#{type.classify}".safe_constantize
+        end
+      end
+
+      def type
+        self.class.type
+      end
+
+      def attributes
+        @attributes ||= ActiveSupport::HashWithIndifferentAccess.new
+      end
+
+      def initialize(params = {})
+        params.each { |k, v| self[k] = v }
+        self.class.schema.each_property do |property|
+          attributes[property.name] = property.default unless attributes.has_key?(property.name) || property.default.nil?
+        end
+      end
+
+      def [](key)
+        attributes[key]
+      end
+
+      def []=(key, value)
+        public_send("#{key}=", value)
+      end
+
+      # When we represent this resource for serialization (create/update), we do so
+      # with this implementation
+      def as_json(*)
+        { type: type }.with_indifferent_access.tap do |h|
+          h[:attributes] = attributes.as_json
+        end
+      end
+
+      def as_json_api(*); as_json end
+    end
+  end
+end
+
+JsonApiClient::Schema.register complex_object: DIDWW::ComplexObject::Base

data/lib/didww/complex_objects/cdr_export_filter.rb

@@ -0,0 +1,23 @@
+require 'json_api_client/schema'
+
+module DIDWW
+  module ComplexObject
+    class CdrExportFilter < Base
+      # Type casting for JsonApiClient parser/setters
+      def self.cast_single_object(hash)
+        new(hash)
+      end
+
+      property :year,       type: :integer
+      property :month,      type: :integer
+      property :did_number, type: :string
+
+      def as_json(*)
+        super[:attributes]
+      end
+
+    end
+  end
+end
+
+JsonApiClient::Schema.register cdr_export_filter: DIDWW::ComplexObject::CdrExportFilter

data/lib/didww/complex_objects/configurations.rb

@@ -0,0 +1,11 @@
+require 'didww/complex_objects/configurations/base'
+require 'didww/complex_objects/configurations/sip_configuration'
+require 'didww/complex_objects/configurations/iax2_configuration'
+require 'didww/complex_objects/configurations/pstn_configuration'
+require 'didww/complex_objects/configurations/h323_configuration'
+
+module DIDWW
+  module ComplexObject
+    include Configuration
+  end
+end

data/lib/didww/complex_objects/configurations/base.rb

@@ -0,0 +1,11 @@
+require 'didww/complex_objects/configurations/const'
+
+module DIDWW
+  module ComplexObject
+    module Configuration
+      class Base < ComplexObject::Base
+        include CONST
+      end
+    end
+  end
+end

data/lib/didww/complex_objects/configurations/const.rb

@@ -0,0 +1,149 @@
+module DIDWW
+  module ComplexObject
+    module Configuration
+      module CONST
+        RX_DTMF_FORMATS = {
+            1 => 'RFC 2833'                                  .freeze,
+            2 => 'SIP INFO application/dtmf-relay OR application/dtmf'.freeze,
+            3 => 'RFC 2833 OR SIP INFO'                      .freeze
+        }.freeze
+
+        TX_DTMF_FORMATS = {
+            0 => 'Disable sending'                           .freeze,
+            1 => 'RFC 2833'                                  .freeze,
+            2 => 'SIP INFO application/dtmf-relay'           .freeze,
+            4 => 'SIP INFO application/dtmf'                 .freeze
+        }.freeze
+
+        SST_REFRESH_METHODS = {
+            1 => 'Invite'                                    .freeze,
+            2 => 'Update'                                    .freeze,
+            3 => 'Update fallback Invite'                    .freeze
+        }.freeze
+
+        TRANSPORT_PROTOCOLS = {
+            1 => 'UDP'                                       .freeze,
+            2 => 'TCP'                                       .freeze
+        }.freeze
+
+        REROUTING_DISCONNECT_CODES = {
+            56   => '400 | Bad Request'                      .freeze,
+            57   => '401 | Unauthorized'                     .freeze,
+            58   => '402 | Payment Required'                 .freeze,
+            59   => '403 | Forbidden'                        .freeze,
+            60   => '404 | Not Found'                        .freeze,
+            64   => '408 | Request Timeout'                  .freeze,
+            65   => '409 | Conflict'                         .freeze,
+            66   => '410 | Gone'                             .freeze,
+            67   => '412 | Conditional Request Failed'       .freeze,
+            68   => '413 | Request Entity Too Large'         .freeze,
+            69   => '414 | Request-URI Too Long'             .freeze,
+            70   => '415 | Unsupported Media Type'           .freeze,
+            71   => '416 | Unsupported URI Scheme'           .freeze,
+            72   => '417 | Unknown Resource-Priority'        .freeze,
+            73   => '420 | Bad Extension'                    .freeze,
+            74   => '421 | Extension Required'               .freeze,
+            75   => '422 | Session Interval Too Small'       .freeze,
+            76   => '423 | Interval Too Brief'               .freeze,
+            77   => '424 | Bad Location Information'         .freeze,
+            78   => '428 | Use Identity Header'              .freeze,
+            79   => '429 | Provide Referrer Identity'        .freeze,
+            80   => '433 | Anonymity Disallowed'             .freeze,
+            81   => '436 | Bad Identity-Info'                .freeze,
+            82   => '437 | Unsupported Certificate'          .freeze,
+            83   => '438 | Invalid Identity Header'          .freeze,
+            84   => '480 | Temporarily Unavailable'          .freeze,
+            86   => '482 | Loop Detected'                    .freeze,
+            87   => '483 | Too Many Hops'                    .freeze,
+            88   => '484 | Address Incomplete'               .freeze,
+            89   => '485 | Ambiguous'                        .freeze,
+            90   => '486 | Busy Here'                        .freeze,
+            91   => '487 | Request Terminated'               .freeze,
+            92   => '488 | Not Acceptable Here'              .freeze,
+            96   => '494 | Security Agreement Required'      .freeze,
+            97   => '500 | Server Internal Error'            .freeze,
+            98   => '501 | Not Implemented'                  .freeze,
+            99   => '502 | Bad Gateway'                      .freeze,
+            100  => '503 | Service Unavailable'              .freeze,
+            101  => '504 | Server Time-out'                  .freeze,
+            102  => '505 | Version Not Supported'            .freeze,
+            103  => '513 | Message Too Large'                .freeze,
+            104  => '580 | Precondition Failure'             .freeze,
+            105  => '600 | Busy Everywhere'                  .freeze,
+            106  => '603 | Decline'                          .freeze,
+            107  => '604 | Does Not Exist Anywhere'          .freeze,
+            108  => '606 | Not Acceptable'                   .freeze,
+            1505 => 'Ringing timeout'                        .freeze
+        }.freeze
+
+        CODECS = {
+            6  => 'telephone-event'                          .freeze,
+            7  => 'G723'                                     .freeze,
+            8  => 'G729'                                     .freeze,
+            9  => 'PCMU'                                     .freeze,
+            10 => 'PCMA'                                     .freeze,
+            12 => 'speex'                                    .freeze,
+            13 => 'GSM'                                      .freeze,
+            14 => 'G726-32'                                  .freeze,
+            15 => 'G721'                                     .freeze,
+            16 => 'G726-24'                                  .freeze,
+            17 => 'G726-40'                                  .freeze,
+            18 => 'G726-16'                                  .freeze,
+            19 => 'L16'                                      .freeze
+        }.freeze
+
+        DEFAULT_REROUTING_DISCONNECT_CODE_IDS = [
+            56,
+            58,
+            59,
+            60,
+            64,
+            65,
+            66,
+            67,
+            68,
+            69,
+            70,
+            71,
+            72,
+            73,
+            74,
+            75,
+            76,
+            77,
+            78,
+            79,
+            80,
+            81,
+            82,
+            83,
+            84,
+            86,
+            87,
+            88,
+            89,
+            90,
+            91,
+            92,
+            96,
+            97,
+            98,
+            99,
+            101,
+            102,
+            103,
+            104,
+            105,
+            106,
+            107,
+            108,
+            1505
+        ].freeze
+
+        DEFAULT_CODEC_IDS = [ 9, 10, 8, 7, 6 ].freeze
+
+        DID_PLACEHOLDER = '{DID}'.freeze
+      end
+    end
+  end
+end