didww-v3 1.0.0

data/lib/didww/resources/country.rb

@@ -0,0 +1,17 @@
+module DIDWW
+  module Resource
+    class Country < Base
+      property :name, type: :string
+      # Type: String
+      # Description: Country name
+
+      property :prefix, type: :string
+      # Type: String
+      # Description: Country prefix (country calling code)
+
+      property :iso, type: :string
+      # Type: String
+      # Description: Country ISO code
+    end
+  end
+end

data/lib/didww/resources/did.rb

@@ -0,0 +1,49 @@
+module DIDWW
+  module Resource
+    class Did < Base
+      has_one :trunk
+      has_one :trunk_group
+
+      property :blocked, type: :boolean
+      # Type: Boolean
+      # Description: Identifier for a blocked DID. Blocked DIDs are numbers that have expired, have been cancelled or have been suspended by DIDWW.
+
+      property :awaiting_registration, type: :boolean
+      # Type: Boolean
+      # Description: Identifier for a DID that is awaiting registration.
+
+      property :terminated, type: :boolean
+      # Type: Boolean
+      # Description: Identifier for terminated DIDs that will be removed from service at the end of the billing cycle.
+
+      property :pending_removal, type: :boolean
+      # Type: Boolean
+      # Description: Identifier for DIDs that are pending removal from your account.
+
+      property :description, type: :string
+      # Type: String
+      # Description: DID custom description
+
+      property :number, type: :string
+      # Type: String
+      # Description: The actual DID number in the format [country code][area code][subscriber number].
+
+      property :capacity_limit, type: :integer
+      # Type: Integer
+      # Description: The capacity limit (maximum number of simultaneous calls) for this DID.
+
+      property :channels_included_count, type: :integer
+      # Type: Integer
+      # Description: The number of channels included with this DID.
+
+      property :expires_at, type: :time
+      # Type: DateTime
+      # Description: DateTime when the DID expired or will expire. DateTime is in the ISO 8601 format "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", where "SSS" are milliseconds and 'Z' denotes Zulu time (UTC).
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Description: DID created at DateTime
+
+    end
+  end
+end

data/lib/didww/resources/did_group.rb

@@ -0,0 +1,66 @@
+module DIDWW
+  module Resource
+    class DidGroup < Base
+      module CONST
+        # Possible values for did_group.features array
+        FEATURE_VOICE    = 'voice'                           .freeze
+        FEATURE_T38      = 't38'                             .freeze
+        FEATURE_SMS      = 'sms'                             .freeze
+        FEATURES = {
+          FEATURE_VOICE => 'Voice'                           .freeze,
+          FEATURE_T38   => 'T.38 Fax'                        .freeze,
+          FEATURE_SMS   => 'SMS'                             .freeze
+        }.freeze
+
+        def features_human
+          Array.wrap(features).map { |f| FEATURES[f] }
+        end
+      end
+
+      include CONST
+
+      has_one :country, class: Country
+      has_one :city,    class: City
+
+      property :area_name, type: :string
+      # Type: String
+      # Description: DID Group area name. This will be the name of the city, or a designation applicable to the area code such as "National".
+
+      property :prefix, type: :string
+      # Type: String
+      # Description: DID Group prefix (city or area calling code)
+
+      property :local_prefix, type: :string
+      # Type: String
+      # Description: DID Group local prefix
+
+      property :features, type: :complex_object  # TODO implement array of strings?
+      # Type: Array of strings
+      # Description: Features available for the DID Group, including voice, sms and t38. A DID Group may have multiple features.
+
+      property :is_metered, type: :boolean
+      # Type: Boolean
+      # Description: Defines if the DID Group supports metered services (per-minute billing).
+
+      property :allow_additional_channels, type: :boolean
+      # Type: Boolean
+      # Description: Defines if channel capacity may be added to this DID Group.
+
+      # TODO
+      # Meta attributes
+      #
+      # needs_registration
+      # Type: Boolean
+      # Description: Defines if end-user registration is required for this DID Group.
+      #
+      # is_available
+      # Type: Boolean
+      # Description: Defines if numbers in this DID Group are currently in stock.
+      #
+      # restrictions
+      # Type: String
+      # Description: Describes possible restrictions for the DID Group, such as "End User Registration is Required".
+
+    end
+  end
+end

data/lib/didww/resources/did_group_type.rb

@@ -0,0 +1,9 @@
+module DIDWW
+  module Resource
+    class DidGroupType < Base
+      property :name, type: :string
+      # Type: String
+      # Description: DID Group Type name, such as "Local", "Mobile" or "Toll-free".
+    end
+  end
+end

data/lib/didww/resources/order.rb

@@ -0,0 +1,67 @@
+require 'didww/complex_objects/did_order_item'
+
+module DIDWW
+  module Resource
+    class Order < Base
+      module CONST
+        # Possible values for order.status
+        STATUS_PENDING      = 'Pending'                       .freeze
+        STATUS_COMPLETED    = 'Completed'                     .freeze
+        STATUS_CANCELLED    = 'Canceled'                      .freeze
+        STATUSES = [
+          STATUS_PENDING,
+          STATUS_COMPLETED,
+          STATUS_CANCELLED
+        ].freeze
+      end
+
+      include CONST
+
+      property :reference, type: :string
+      # Type: String
+      # Description: Order Reference
+
+      property :amount, type: :decimal
+      # Type: String
+      # Description: Order Amount
+
+      property :status, type: :string
+      # Type: Enum
+      # Description: Order status. One of "Pending", "Completed", "Canceled".
+
+      property :description, type: :string
+      # Type: String
+      # Description: Order description
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Description: Order created at DateTime
+
+      property :items, type: :complex_object
+      # Type: Array<OrderItem>
+      # Description: Order items array
+
+      property :allow_back_ordering, type: :boolean
+      # Type: Boolean
+      # Description: Allowing back ordering
+
+      def initialize(*args)
+        super
+        self.items ||= []
+      end
+
+      def pending?
+        STATUS_PENDING == status
+      end
+
+      def completed?
+        STATUS_COMPLETED == status
+      end
+
+      def cancelled?
+        STATUS_CANCELLED == status
+      end
+
+    end
+  end
+end

data/lib/didww/resources/region.rb

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

data/lib/didww/resources/stock_keeping_unit.rb

@@ -0,0 +1,19 @@
+module DIDWW
+  module Resource
+    class StockKeepingUnit < Base
+      belongs_to :did_group
+
+      property :setup_price, type: :decimal
+      # Type: String
+      # Description: price for Order creation
+
+      property :monthly_price, type: :decimal
+      # Type: String
+      # Description: monthly price for order renew
+
+      property :channels_included_count, type: :integer
+      # Type: Integer
+      # Description: included channels capacity for each DID
+    end
+  end
+end

data/lib/didww/resources/trunk.rb

@@ -0,0 +1,70 @@
+require 'didww/complex_objects/configurations'
+require 'didww/resources/trunk/const'
+
+module DIDWW
+  module Resource
+    class Trunk < Base
+      include CONST
+
+      has_one :trunk_group
+
+      property :priority, type: :integer
+      # Type: Integer
+      # Description: The priority of this target host. DIDWW will attempt to contact the target trunk with the lowest-numbered priority; target trunk with the same priority will be tried in an order defined by the weight field. The range is 0-65535. See RFC 2782 for more details
+
+      property :weight, type: :integer
+      # Type: Integer
+      # Description: A trunk selection mechanism. The weight field specifies a relative weight for entries with the same priority. Larger weights will be given a proportionately higher probability of being selected. The range of this number is 0-65535. In the presence of records containing weights greater than 0, records with weight 0 will have a very small chance of being selected. See RFC 2782 for more details
+
+      property :capacity_limit, type: :integer
+      # Type: Integer
+      # Description: Maximum number of simultaneous calls for the trunk
+
+      property :ringing_timeout, type: :integer
+      # Type: Integer
+      # Description: After which it will be end transaction with internal disconnect code 'Ringing timeout' if the call was not connected.
+
+      property :name, type: :string
+      # Type: String
+      # Description: Friendly name of the trunk
+
+      property :cli_format, type: :string
+      # Type: String
+      # Description:
+      # RAW - Do not alter CLI (default)
+      # 164 - Attempt to convert CLI to E.164 format
+      # Local - Attempt to convert CLI to Localized format
+      # * CLI format conversion may not work correctly for phone calls originating from outside the country of that specific DID
+
+      property :cli_prefix, type: :string
+      # Type: String
+      # Description: You may prefix the CLI with an optional '+' sign followed by up to 6 characters, including digits and '#'
+
+      property :description, type: :string
+      # Type: String
+      # Description: Optional description of trunk
+
+      property :preferred_server, type: :string
+      # Type: String
+      # Description: Preferred server for your voice route. In general, you should choose the server that is the closest to your location ["LOCAL", "USA", "DE"] or omit.
+
+      property :configuration, type: :complex_object
+      # Type: one of
+      # sip_configurations
+      # pstn_configurations
+      # iax2_configurations
+      # h323_configurations
+      # Description: Trunk configuration complex object
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Description: Trunk created at DateTime
+
+      def initialize(*args)
+        super
+        attribute_will_change!(:configuration) if configuration
+      end
+
+    end
+  end
+end

data/lib/didww/resources/trunk/const.rb

@@ -0,0 +1,61 @@
+module DIDWW
+  module Resource
+    class Trunk < Base
+      module CONST
+        # Allowed values for trunk.preferred_server
+        PREFERRED_SERVER_LOCAL    = 'LOCAL'                  .freeze
+        PREFERRED_SERVER_USA      = 'USA'                    .freeze
+        PREFERRED_SERVER_EUROPE   = 'Europe'                 .freeze
+
+        PREFERRED_SERVERS = {
+          PREFERRED_SERVER_LOCAL  => 'Local'                 .freeze,
+          PREFERRED_SERVER_USA    => 'United States'         .freeze,
+          PREFERRED_SERVER_EUROPE => 'Europe'                .freeze
+        }.freeze
+
+        # Allowed values for trunk.cli_format
+        CLI_FORMAT_RAW     = 'raw'                           .freeze
+        CLI_FORMAT_E164    = 'e164'                          .freeze
+        CLI_FORMAT_LOCAL   = 'local'                         .freeze
+
+        CLI_FORMATS = {
+          CLI_FORMAT_RAW   => 'Raw'                          .freeze,
+          CLI_FORMAT_E164  => 'E.164'                        .freeze,
+          CLI_FORMAT_LOCAL => 'Local'                        .freeze
+        }.freeze
+
+        # Configuration types
+        CONF_TYPE_SIP     = 'sip_configurations'             .freeze
+        CONF_TYPE_H323    = 'h323_configurations'            .freeze
+        CONF_TYPE_IAX2    = 'iax2_configurations'            .freeze
+        CONF_TYPE_PSTN    = 'pstn_configurations'            .freeze
+
+        CONF_TYPES = {
+          CONF_TYPE_SIP   => 'SIP'                           .freeze,
+          CONF_TYPE_H323  => 'H323'                          .freeze,
+          CONF_TYPE_IAX2  => 'IAX2'                          .freeze,
+          CONF_TYPE_PSTN  => 'PSTN'                          .freeze
+        }.freeze
+
+        CONF_TYPE_CLASSES = {
+          CONF_TYPE_SIP   => DIDWW::ComplexObject::SipConfiguration,
+          CONF_TYPE_H323  => DIDWW::ComplexObject::H323Configuration,
+          CONF_TYPE_IAX2  => DIDWW::ComplexObject::Iax2Configuration,
+          CONF_TYPE_PSTN  => DIDWW::ComplexObject::PstnConfiguration
+        }.freeze
+
+        def preferred_server_human
+          PREFERRED_SERVERS[preferred_server]
+        end
+
+        def cli_format_human
+          CLI_FORMATS[cli_format]
+        end
+
+        def configuration_type_human
+          CONF_TYPES[configuration.type] if configuration
+        end
+      end
+    end
+  end
+end

data/lib/didww/resources/trunk_group.rb

@@ -0,0 +1,23 @@
+module DIDWW
+  module Resource
+    class TrunkGroup < Base
+      has_many :trunks
+
+      property :name, type: :string
+      # Type: String
+      # Description: Trunk Group name
+
+      property :capacity_limit, type: :integer
+      # Type: Integer
+      # Description: maximum number of simultaneous calls for the trunk
+
+      property :created_at, type: :time
+      # Type: DateTime
+      # Description: Trunk Group created at DateTime
+
+      def trunks_count
+        meta[:trunks_count]
+      end
+    end
+  end
+end

data/lib/didww/version.rb

@@ -0,0 +1,3 @@
+module DIDWW
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,307 @@
+--- !ruby/object:Gem::Specification
+name: didww-v3
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alex Korobeinikov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: http_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: smart_rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: faraday
+  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: json_api_client
+  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: http
+  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: down
+  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'
+description: Ruby client for DIDWW API v3
+email:
+- alex.k@didww.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- didww-v3.gemspec
+- lib/didww.rb
+- lib/didww/client.rb
+- lib/didww/complex_objects/base.rb
+- lib/didww/complex_objects/cdr_export_filter.rb
+- lib/didww/complex_objects/configurations.rb
+- lib/didww/complex_objects/configurations/base.rb
+- lib/didww/complex_objects/configurations/const.rb
+- lib/didww/complex_objects/configurations/h323_configuration.rb
+- lib/didww/complex_objects/configurations/iax2_configuration.rb
+- lib/didww/complex_objects/configurations/pstn_configuration.rb
+- lib/didww/complex_objects/configurations/sip_configuration.rb
+- lib/didww/complex_objects/did_order_item.rb
+- lib/didww/middleware.rb
+- lib/didww/resources/balance.rb
+- lib/didww/resources/base.rb
+- lib/didww/resources/cdr_export.rb
+- lib/didww/resources/city.rb
+- lib/didww/resources/country.rb
+- lib/didww/resources/did.rb
+- lib/didww/resources/did_group.rb
+- lib/didww/resources/did_group_type.rb
+- lib/didww/resources/order.rb
+- lib/didww/resources/region.rb
+- lib/didww/resources/stock_keeping_unit.rb
+- lib/didww/resources/trunk.rb
+- lib/didww/resources/trunk/const.rb
+- lib/didww/resources/trunk_group.rb
+- lib/didww/version.rb
+homepage: https://github.com/didww/didww-v3-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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Ruby client for DIDWW API v3
+test_files: []