didww-v3 1.0.0

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

@@ -0,0 +1,35 @@
+module DIDWW
+  module ComplexObject
+    module Configuration
+      class H323Configuration < Base
+        property :dst, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Phone number
+
+        property :host, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Destination server
+
+        property :port, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Destination port
+
+        property :codec_ids, type: :array
+        # TODO array type
+        # Type: Array
+        # Nullable: No
+        # Description:
+
+        DEFAULTS = {
+          codec_ids: DEFAULT_CODEC_IDS,
+          dst: DID_PLACEHOLDER,
+        }.freeze
+
+        RECOMMENDED = {}.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+module DIDWW
+  module ComplexObject
+    module Configuration
+      class Iax2Configuration < Base
+        property :dst, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Phone number
+
+        property :host, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Destination server
+
+        property :port, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Destination port
+
+        property :auth_user, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Optional authorization user
+
+        property :auth_password, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Optional authorization password
+
+        property :codec_ids, type: :array
+        # TODO array type
+        # Type: Array
+        # Nullable: No
+        # Description:
+
+        DEFAULTS = {
+          codec_ids: DEFAULT_CODEC_IDS,
+          dst: DID_PLACEHOLDER,
+        }.freeze
+
+        RECOMMENDED = {}.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module DIDWW
+  module ComplexObject
+    module Configuration
+      class PstnConfiguration < Base
+        property :dst, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Phone number
+
+        DEFAULTS = {}.freeze
+
+        RECOMMENDED = {}.freeze
+      end
+    end
+  end
+end

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

@@ -0,0 +1,203 @@
+module DIDWW
+  module ComplexObject
+    module Configuration
+      class SipConfiguration < Base
+        property :username, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: User part of R-URI in INVITE request.You also may use "{DID}" pattern which will be replaced by called DID number in E164 format. For example, you can set Username to "+{DID}"; if you wish to have it in +E164 format
+
+        property :host, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Host part of R-URI in INVITE request
+
+        property :auth_user, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Optional authorization user for the SIP server
+
+        property :auth_password, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Optional authorization password for the SIP server
+
+        property :auth_from_user, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Specify user in a "from" field instead of CallerID (overrides CallerID). Some equipment require "from"; to be equivalent to "Auth user";
+
+        property :auth_from_domain, type: :string
+        # Type: String
+        # Nullable: No
+        # Description: Sets default "from" domain in SIP messages. Some equipment may require specific "From" Domain
+
+        property :sst_refresh_method_id, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: SIP method which will be used for session update.
+        # See RFC 4028 for more details.
+        # Possible values:
+        # 1 - Invite
+        # 2 - Update
+        # 3 - Update fallback Invite
+
+        property :sip_timer_b, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: INVITE transaction timeout (Default 8000ms). See RFC 3261 Section 17.1.1.2 for more details
+
+        property :dns_srv_failover_timer, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: Invite transaction timeout for each of gateways with DNS SRV rerouting (Default 2000ms)
+
+        property :rtp_ping, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Use RTP PING when connecting a call. After establishing the call, DIDWW will send empty RTP packet "RTP PING". It is neccessary if both parties operate in Symmetric RTP / Comedia mode and expect the other party to start sending RTP first.
+
+        property :rtp_timeout, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: Disconnect call if the RTP packets do not arrive within the specified time
+
+        property :sst_min_timer, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: Minimal SIP Session timer value (Default 600 seconds). See RFC 4028 for more details
+
+        property :sst_max_timer, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: Maximal SIP Session timer value (Default 900 seconds). See RFC 4028 for more details
+
+        property :sst_session_expires, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: Session-Expires header value. Optional, should be in range sst_min_timer ... sst_max_timer.
+        # See RFC 4028 for more details
+
+        property :port, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: Port part of R-URI in INVITE request (is not mandatory).If port is null, SRV record will be resolved (or A record if SRV is unavailable)
+
+        property :rx_dtmf_format_id, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: The method id for receiving DTMF signals from customer equipment
+        # Possible values:
+        # 1 - RFC 2833
+        # 2 - SIP INFO application/dtmf-relay OR application/dtmf
+        # 3 - RFC 2833 OR SIP INFO
+
+        property :tx_dtmf_format_id, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: The method of sending DTMF signals to customer equipment
+        # Possible values:
+        # 1 - Disable sending
+        # 2 - RFC 2833
+        # 3 - SIP INFO application/dtmf-relay
+        # 4 - SIP INFO application/dtmf
+
+        property :force_symmetric_rtp, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Forced to work in Symmetric RTP / COMEDIA mode
+
+        property :symmetric_rtp_ignore_rtcp, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Avoid switching RTP session based on RTCP packet while working in Symmetric RTP / COMEDIA. Only RTP packets will be considered
+
+        property :sst_enabled, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Enable SIP Session timers customization. SIP session timers are used to make sure that a session (dialog) is still alive, even though there may have been a long time since the last in-dialog message. If the other end is not responding, the dialog will be hung up automatically. SIP session timers need to be supported by all end points for it to work. It's a SIP extension, standardized by the IETF. See RFC 4028 for more details
+
+        property :sst_accept_501, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Do not drop the call after receiving SIP 501 response for non-critical messages
+
+        property :auth_enabled, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Enable authorization for the SIP server
+
+        property :resolve_ruri, type: :boolean
+        # Type: Boolean
+        # Nullable: No
+        # Description: Replace host part of the R-URI by resolved IP address
+
+        property :rerouting_disconnect_code_ids, type: :array
+        # TODO array type
+        # Type: Array
+        # Nullable: No
+        # Description: Rerouting disconnect codes
+
+        property :codec_ids, type: :array
+        # TODO array type
+        # Type: Array
+        # Nullable: No
+        # Description: Codecs
+
+        property :transport_protocol_id, type: :integer
+        # Type: Integer
+        # Nullable: No
+        # Description: The transport layer that will be responsible for the actual transmission of SIP requests and responses (1 - UDP, 2 - TCP)
+
+        DEFAULTS = {
+            username: DID_PLACEHOLDER,
+            port: '5060',
+            tx_dtmf_format_id: 1,
+            sst_min_timer: 600,
+            sst_max_timer: 900,
+            sst_refresh_method_id: 1,
+            sst_accept_501: true,
+            sip_timer_b: 8000,
+            dns_srv_failover_timer: 2000,
+            rtp_timeout: 30,
+            auth_enabled: false,
+            codec_ids: DEFAULT_CODEC_IDS,
+            rerouting_disconnect_code_ids: DEFAULT_REROUTING_DISCONNECT_CODE_IDS,
+            transport_protocol_id: 1
+        }.freeze
+
+        RECOMMENDED = DEFAULTS.merge({
+            #-- Authentication
+            auth_user: '',
+            auth_password: '',
+            auth_from_user: '',
+            auth_from_domain: '',
+            #-- Media & DTMF
+            rx_dtmf_format_id: 1,
+            rtp_ping: false,
+            force_symmetric_rtp: false,
+            symmetric_rtp_ignore_rtcp: false,
+            #-- Advanced Signalling Settings
+            sst_enabled: false,
+            sst_session_expires: '',
+        }).freeze
+
+        def sst_refresh_method
+          SST_REFRESH_METHODS[sst_refresh_method_id]
+        end
+
+        def rx_dtmf_format
+          RX_DTMF_FORMATS[rx_dtmf_format_id]
+        end
+
+        def tx_dtmf_format
+          TX_DTMF_FORMATS[tx_dtmf_format_id]
+        end
+
+        def transport_protocol
+          TRANSPORT_PROTOCOLS[transport_protocol_id]
+        end
+      end
+    end
+  end
+end

data/lib/didww/complex_objects/did_order_item.rb

@@ -0,0 +1,14 @@
+module DIDWW
+  module ComplexObject
+    class DidOrderItem < Base
+      # passed at order creation
+      property :qty,     type: :int
+      property :sku_id,  type: :string
+
+      # returned
+      property :setup_price,    type: :decimal
+      property :monthly_price,  type: :decimal
+      property :did_group_id,   type: :string
+    end
+  end
+end

data/lib/didww/middleware.rb

@@ -0,0 +1,18 @@
+module DIDWW
+  # :nodoc:
+  class Middleware < Faraday::Middleware
+    def call(request_env)
+      headers = {}
+      headers['Content-Type'] = 'application/vnd.api+json'
+      headers['Api-Key']      = DIDWW::Client.api_key
+
+      request_env[:request_headers].merge!(headers)
+      request_env.url.host = URI(DIDWW::Client.api_base_url).host
+
+      @app.call(request_env).on_complete do |response_env|
+        # do something with the response
+        # response_env[:response_headers].merge!(...)
+      end
+    end
+  end
+end

data/lib/didww/resources/balance.rb

@@ -0,0 +1,20 @@
+module DIDWW
+  module Resource
+    class Balance < Base
+      def self.table_name
+        'balance'
+      end
+      property :balance, type: :decimal
+      # Type: String
+      # Description: Prepaid balance
+
+      property :credit, type: :decimal
+      # Type: String
+      # Description: Available credit
+
+      property :total_balance, type: :decimal
+      # Type: String
+      # Description: The net balance (balance + credit)
+    end
+  end
+end

data/lib/didww/resources/base.rb

@@ -0,0 +1,29 @@
+require 'didww/middleware'
+require 'didww/complex_objects/base'
+
+module DIDWW
+  module Resource
+    class Base < JsonApiClient::Resource
+      def as_json_api(*args)
+        serialize_complex_attributes(super(*args))
+      end
+
+      private
+
+      def serialize_complex_attributes(hash)
+        # Replace complex objects with their json_api representation
+        attributes = hash[:attributes]
+        hash[:attributes] = Hash[attributes.map do |k, v|
+          if v.respond_to?(:as_json_api)
+            [k, v.as_json_api]
+          elsif v.is_a?(Array)
+            [k, v.map { |i| i.respond_to?(:as_json_api) ? i.as_json_api : i }]
+          else
+            [k, v]
+          end
+        end].with_indifferent_access
+        return hash
+      end
+    end
+  end
+end

data/lib/didww/resources/cdr_export.rb

@@ -0,0 +1,47 @@
+require 'forwardable'
+require 'didww/complex_objects/cdr_export_filter'
+require 'down/http'
+
+module DIDWW
+  module Resource
+    class CdrExport < Base
+      extend Forwardable
+
+      property :filters, type: :cdr_export_filter
+      # Type: CDR Export Filters Object
+      # Nullable: No
+      # Description: Filters
+
+      property :status, type: :string
+      # Type: String
+      # Nullable: false
+      # Description: status can be "Pending", "Processing" or "Completed"
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Nullable: false
+      # Description: timestamp when export request was created
+
+      property :url, type: :string
+      # Type: String
+      # Nullable: true
+      # Description: url of csv file for downloading. available only when status is "Completed"
+
+      def_delegators :filters, :year, :month, :did_number, :year=, :month=, :did_number=
+
+      def initialize(params = {})
+        super params.reverse_merge(filters: {})
+      end
+
+      def csv
+        return unless url.present?
+        Down::Http.new(headers: { 'Api-Key' => DIDWW::Client.api_key }).open(url)
+      end
+
+      def complete?
+        status == 'Completed'
+      end
+      alias_method :completed?, :complete?
+    end
+  end
+end

data/lib/didww/resources/city.rb

@@ -0,0 +1,9 @@
+module DIDWW
+  module Resource
+    class City < Base
+      property :name, type: :string
+      # Type: String
+      # Description: City name
+    end
+  end
+end