didww-v3 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b50d18315fb77b5b7b7972645a2f75eaf305fc6e
-  data.tar.gz: ccb2fecdb8bb0ec6b21e9d041639a453a01dfb33
+SHA256:
+  metadata.gz: 9d736e9893b21ef96ef76993d6bb3da3e47c1dbb760edcc6ea13d0cf86d5e847
+  data.tar.gz: 9d641935ce36af938ea6641b7488835535ef4a01f6464b5c90f667dafac953c3
 SHA512:
-  metadata.gz: f36cf7c880103909cf816a5a6f7e34df60acbf32dbf9d8b08e5082c96b5c2b2022b8d457e1306facc18837545bc6f4f66e41331f8e72ef2a2a1b49e0d54d329f
-  data.tar.gz: ced5fc521ea77758b6767914886d94fccfbaf14c9264c4fe60534e69ea5d71b6d4a8bdd6cdaba86805b89981d7a90d78ee4559209a6280d002671275d5cd3320
+  metadata.gz: b2cef4993cda70bd45a3a1efd960ab26d9ba603de9a10c246c537ccdbbb3506e923f1628643fabcefcc7be8ca1f9a6a93342b996e6233b9eadadc77818d766fe
+  data.tar.gz: de556881b793c412ea2fb486bacd00f89a3c07ad3902e755f5a4140e2eb0fda10f1b748ea719ce9968e87e476797bed8b28ce3b032f1e107ed457946235f303f

data/.github/workflows/tests.yml

@@ -0,0 +1,27 @@
+name: Tests
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7' ]
+        rails: [ '~> 5.0', '~> 6.0' ]
+    name: Tests with Ruby ${{ matrix.ruby }} Activesupport ${{ matrix.rails }}
+    env:
+      RAILS_VERSION: ${{ matrix.rails }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Run tests
+        run: |
+          gem install bundler -v 2.2.7
+          bundle install
+          bundle exec rake

data/.rubocop.yml

@@ -1,18 +1,18 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
   DisplayCopNames: true
   DisabledByDefault: true
 
   Exclude:
     - db/migrate/**/*
 
-  Include:
-    - "**/*.rake"
-    - "**/Gemfile"
-    - "**/Rakefile"
-
 ##################### Layout ##################################
-Layout/TrailingBlankLines:
+Layout/TrailingEmptyLines:
   Enabled: true
 
 Layout/TrailingWhitespace:
@@ -52,6 +52,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   Enabled: true
 
+Style/FrozenStringLiteralComment:
+  Enabled: true
+
 ##################### Performance ############################
 
 # Use `casecmp` rather than `downcase ==`.
@@ -68,7 +71,7 @@ Performance/EndWith:
   Enabled: true
 
 # Use `strip` instead of `lstrip.rstrip`.
-Performance/LstripRstrip:
+Style/Strip:
   Enabled: true
 
 # Use `Range#cover?` instead of `Range#include?`.
@@ -91,7 +94,7 @@ Performance/RedundantMerge:
   Enabled: true
 
 # Use `sort` instead of `sort_by { |x| x }`.
-Performance/RedundantSortBy:
+Style/RedundantSortBy:
   Enabled: true
 
 # Use `start_with?` instead of a regex match anchored to the beginning of a
@@ -138,7 +141,7 @@ Lint/AssignmentInCondition:
   Enabled: true
 
 # Align block ends correctly.
-Lint/BlockAlignment:
+Layout/BlockAlignment:
   Enabled: true
 
 # Default values in optional keyword arguments and optional ordinal arguments
@@ -147,7 +150,7 @@ Lint/CircularArgumentReference:
   Enabled: true
 
 # Checks for condition placed in a confusing position relative to the keyword.
-Lint/ConditionPosition:
+Layout/ConditionPosition:
   Enabled: true
 
 # Check for debugger calls.
@@ -155,7 +158,7 @@ Lint/Debugger:
   Enabled: true
 
 # Align ends corresponding to defs correctly.
-Lint/DefEndAlignment:
+Layout/DefEndAlignment:
   Enabled: true
 
 # Check for deprecated class method calls.
@@ -179,11 +182,11 @@ Lint/EmptyWhen:
   Enabled: true
 
 # Align ends correctly.
-Lint/EndAlignment:
+Layout/EndAlignment:
   Enabled: true
 
 # END blocks should not be placed inside method definitions.
-Lint/EndInMethod:
+Style/EndBlock:
   Enabled: true
 
 # Do not use return in an ensure block.
@@ -199,7 +202,7 @@ Lint/FormatParameterMismatch:
   Enabled: true
 
 # This cop checks for *rescue* blocks with no body.
-Lint/HandleExceptions:
+Lint/SuppressedException:
   Enabled: true
 
 # Checks for adjacent string literals on the same line, which could better be
@@ -255,7 +258,7 @@ Lint/ShadowingOuterLocalVariable:
   Enabled: false
 
 # Checks for Object#to_s usage in string interpolation.
-Lint/StringConversionInInterpolation:
+Lint/RedundantStringCoercion:
   Enabled: false
 
 # Do not use prefix `_` for a variable that is used.
@@ -269,11 +272,11 @@ Lint/UnifiedInteger:
 # Checks for rubocop:disable comments that can be removed.
 # Note: this cop is not disabled when disabling all cops.
 # It must be explicitly disabled.
-Lint/UnneededDisable:
+Lint/RedundantCopDisableDirective:
   Enabled: false
 
 # This cop checks for unneeded usages of splat expansion
-Lint/UnneededSplatExpansion:
+Lint/RedundantSplatExpansion:
   Enabled: false
 
 # Unreachable code.
@@ -297,7 +300,7 @@ Lint/UselessAssignment:
   Enabled: false
 
 # Checks for comparison of something with itself.
-Lint/UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
   Enabled: false
 
 # Checks for useless `else` in `begin..end` without `rescue`.

data/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.0.0] - 2021-10-26
+### Breaking Changes
+- upgrade `json_api_client` version to `1.18.0` [#9](https://github.com/didww/didww-v3-ruby/pull/9)  
+    Handling of 4XX responses was changed - it now raises JsonApiClient::Errors::ClientError with `detail` as error message instead of adding it into base errors.
+- /v3/dids in request and response attributes pending_removal being removed in favor of billing_cycles_count.
+- /v3/did_groups restriction message removed in favor of requirements relationship.
+  
+### Changes
+- replace travis with github actions [#7](https://github.com/didww/didww-v3-ruby/pull/7) [#9](https://github.com/didww/didww-v3-ruby/pull/9)
+- use rubocop 1.9.X version [#7](https://github.com/didww/didww-v3-ruby/pull/7)
+- add bundle-audit [#7](https://github.com/didww/didww-v3-ruby/pull/7)
+- /v3/orders request attribute items of type DID Order Item Attributes can have billing_cycles_count.
+- /v3/dids added address_verification relationship.
+- callbacks attributes added to /v3/orders, /v3/cdr_exports.
+- /v3/proof_types read endpoints being added.
+- /v3/supporting_document_templates read endpoints being added.
+- /v3/requirements read endpoints being added.
+- /v3/identities read, write, and delete endpoints being added.
+- /v3/addresses read, write, and delete endpoints being added.
+- /v3/encrypted_files read, write, and delete endpoints being added.
+- /v3/proofs write, delete endpoint being added.
+- /v3/permanent_supporting_documents write, delete endpoint being added.
+- /v3/address_verifications read and write endpoints being added.
+- /v3/requirement_validations write endpoint being added.
+
+### Bugfixes
+- fix order purchase when activesupport 6.X.X is used.
+
+## [1.3.0] - 2018-09-03
+### Changes
+- Add Capacity Pool and Shared Capacity Group resources
+- Add Capacity Pool and Shared Capacity Group relationships to DID
+- Add Quantity based pricings and Capacity type Order Item
+
+## [1.2.0] - 2018-04-25
+### Changes
+- add number selection feature
+
+## [1.1.0] - 2018-03-05
+### Changes
+- add Pop resource
+- Remove old trunk.preferred_server property
+- Add max_transfers and max_30x_redirects to sip_configurations
+- Added custom user-agent header
+
+## [1.0.0] - 2017-12-05
+- initial release

data/Gemfile

@@ -1,6 +1,26 @@
+# frozen_string_literal: true
 source 'https://rubygems.org'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in didww-v3.gemspec
 gemspec
+
+if ENV['RAILS_VERSION']
+  gem 'activesupport', ENV['RAILS_VERSION'], require: false
+end
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'pry'
+gem 'byebug'
+gem 'awesome_print'
+gem 'http_logger'
+gem 'rubocop', '~> 1.9'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+gem 'simplecov'
+gem 'smart_rspec'
+gem 'webmock'
+gem 'bundler-audit'

data/README.md

@@ -1,14 +1,20 @@
 Ruby client for DIDWW API v3.
 
+![Tests](https://github.com/didww/didww-v3-ruby/workflows/Tests/badge.svg)
+
 About DIDWW API v3
 -----
 
-The DIDWW API provides a simple yet powerful interface that allows you to fully integrate your own applications with DIDWW services. An extensive set of actions may be performed using this API, such as ordering and configuring phone numbers, setting capacity, creating SIP trunks and retrieving CDRs and other operational data. As such, this interface is the ideal tool for building alternative dashboards, developing mobile applications and automating front and back-end applications.
+The DIDWW API provides a simple yet powerful interface that allows you to fully integrate your own applications with DIDWW services. An extensive set of actions may be performed using this API, such as ordering and configuring phone numbers, setting capacity, creating SIP trunks and retrieving CDRs and other operational data.
 
 The DIDWW API v3 is a fully compliant implementation of the [JSON API specification](http://jsonapi.org/format/).
 
 Read more https://doc.didww.com/api
 
+Gem Versions **2.X.X** are intended to use with DIDWW API 3 version [2021-04-19](https://doc.didww.com/api3/2021-04-19/index.html).
+
+Gem Versions **1.X.X** are intended to use with DIDWW API 3 version [2017-09-18](https://doc.didww.com/api3/2017-09-18/index.html).
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -1,6 +1,11 @@
+# frozen_string_literal: true
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'bundler/audit/task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
+Bundler::Audit::Task.new
+RuboCop::RakeTask.new
 
-task default: :spec
+task default: ['bundle:audit', :rubocop, :spec]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'didww'

data/didww-v3.gemspec

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -21,26 +22,10 @@ Gem::Specification.new do |spec|
   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 'json_api_client', '1.18.0'
   spec.add_dependency 'http'
   spec.add_dependency 'down'
-
+  spec.add_dependency 'openssl-oaep'
 end

data/lib/didww/{middleware.rb → base_middleware.rb}

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
 module DIDWW
   # :nodoc:
-  class Middleware < Faraday::Middleware
+  class BaseMiddleware < Faraday::Middleware
     def call(request_env)
       headers = {}
-      headers['Content-Type'] = 'application/vnd.api+json'
-      headers['Api-Key']      = DIDWW::Client.api_key
+      headers['Api-Key']             = DIDWW::Client.api_key
+      headers['User-Agent']          = "didww-v3 Ruby gem v#{VERSION}"
+      headers['x-didww-api-version'] = DIDWW::Client.api_version unless DIDWW::Client.api_version.blank?
 
       request_env[:request_headers].merge!(headers)
       request_env.url.host = URI(DIDWW::Client.api_base_url).host

data/lib/didww/callback/request_validator.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+require 'openssl'
+
+module DIDWW
+  module Callback
+    # @example
+    #   validator = DIDWW::Callback::RequestValidator.new(api_key)
+    #   uri = request.original_url
+    #   if request.post?
+    #     # Collect all parameters passed from DIDWW.
+    #     params = env['rack.request.form_hash']
+    #   else
+    #     params = env['rack.request.query_hash']
+    #   end
+    #
+    # signature = env['HTTP_X_DIDWW_SIGNATURE']
+    # validator.validate(uri, params, signature) #=> true if the request is from DIDWW
+    # # or with rails
+    class RequestValidator
+      DIGEST_ALGO = 'SHA1'
+      HEADER = 'X-DIDWW-Signature'
+
+      def initialize(api_key)
+        @api_key = api_key
+      end
+
+      # @param url [String]
+      # @param payload [Hash]
+      # @param signature [String]
+      # @return [Boolean] whether signature valid or not.
+      def validate(url, payload, signature)
+        return false if signature.blank?
+
+        signature == valid_signature(url, payload)
+      end
+
+      private
+
+      # @param url [String]
+      # @param payload [Hash]
+      # @return [String] generated signature in URL safe format.
+      def valid_signature(url, payload)
+        normalized_url = normalize_url(url)
+        data = normalized_url + payload.sort.join
+        OpenSSL::HMAC.hexdigest(DIGEST_ALGO, @api_key, data)
+      end
+
+      # @return [String] normalized URL.
+      def normalize_url(url)
+        parsed_url = URI ensure_protocol_url(url)
+        url = "#{parsed_url.scheme || 'http'}://"
+        url += "#{parsed_url.userinfo}@" if parsed_url.userinfo
+        url += "#{parsed_url.host}:#{parsed_url.port || parsed_url.default_port}#{parsed_url.path}"
+        url += "?#{parsed_url.query}" if parsed_url.query
+        url += "##{parsed_url.fragment}" if parsed_url.fragment
+        url
+      end
+
+      def ensure_protocol_url(url)
+        if url[%r{\A[a-zA-Z]+://}i]
+          url
+        else
+          'http://' + url
+        end
+      end
+    end
+  end
+end

data/lib/didww/client.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/core_ext/object/blank'
 require 'json_api_client'
 
 require 'didww/resources/base'
@@ -11,7 +13,7 @@ module DIDWW
     }.freeze
     DEFAULT_MODE = :sandbox
 
-    mattr_accessor :api_key, :api_mode, :http_verbose
+    mattr_accessor :api_key, :api_mode, :http_verbose, :api_version
 
     class << self
       def configure
@@ -29,14 +31,38 @@ module DIDWW
         @@api_key
       end
 
+      def api_version
+        @@api_version
+      end
+
+      def with_api_version(api_version)
+        old_api_version = self.api_version
+        self.api_version = api_version
+        yield
+      ensure
+        self.api_version = old_api_version
+      end
+
       def api_base_url
-        BASE_URLS[api_mode]
+        ENV['DIDWW_API_URL'].presence || BASE_URLS[api_mode]
       end
 
       def balance
         Resource::Balance.all.first
       end
 
+      def capacity_pools
+        Resource::CapacityPool
+      end
+
+      def cdr_exports
+        Resource::CdrExport
+      end
+
+      def shared_capacity_groups
+        Resource::SharedCapacityGroup
+      end
+
       def cities
         Resource::City
       end
@@ -61,6 +87,10 @@ module DIDWW
         Resource::Order
       end
 
+      def pops
+        Resource::Pop
+      end
+
       def regions
         Resource::Region
       end
@@ -73,8 +103,44 @@ module DIDWW
         Resource::Trunk
       end
 
-      def cdr_exports
-        Resource::CdrExport
+      def available_dids
+        Resource::AvailableDid
+      end
+
+      def did_reservations
+        Resource::DidReservation
+      end
+
+      def requirements
+        Resource::Requirement
+      end
+
+      def identities
+        Resource::Identity
+      end
+
+      def proofs
+        Resource::Proof
+      end
+
+      def addresses
+        Resource::Address
+      end
+
+      def permanent_supporting_documents
+        Resource::PermanentSupportingDocument
+      end
+
+      def encrypted_file
+        Resource::EncryptedFile
+      end
+
+      def address_verifications
+        Resource::AddressVerification
+      end
+
+      def requirement_validation
+        Resource::RequirementValidation
       end
 
       def api_mode=(arg)
@@ -94,7 +160,7 @@ module DIDWW
         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
+          connection.use DIDWW::JsonapiMiddleware
         end
         JsonApiClient::Paginating::Paginator.page_param = 'number'
         JsonApiClient::Paginating::Paginator.per_page_param = 'size'
@@ -102,17 +168,35 @@ module DIDWW
 
       def require_didww_resources
         require 'didww/resources/balance'
+        require 'didww/resources/capacity_pool'
+        require 'didww/resources/cdr_export'
+        require 'didww/resources/shared_capacity_group'
         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/pop'
+        require 'didww/resources/qty_based_pricing'
         require 'didww/resources/region'
+        require 'didww/resources/stock_keeping_unit'
         require 'didww/resources/trunk_group'
         require 'didww/resources/trunk'
-        require 'didww/resources/stock_keeping_unit'
-        require 'didww/resources/cdr_export'
+        require 'didww/resources/available_did'
+        require 'didww/resources/did_reservation'
+        require 'didww/resources/requirement'
+        require 'didww/resources/proof_type'
+        require 'didww/resources/supporting_document_template'
+        require 'didww/resources/identity'
+        require 'didww/resources/proof'
+        require 'didww/resources/address'
+        require 'didww/resources/permanent_supporting_document'
+        require 'didww/resources/encrypted_file'
+        require 'didww/resources/address_verification'
+        require 'didww/resources/requirement_validation'
+        require 'didww/resources/public_key'
+        require 'didww/resources/area'
       end
 
     end

data/lib/didww/complex_objects/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json_api_client/schema'
 
 module DIDWW
@@ -12,10 +13,8 @@ module DIDWW
 
         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
+          define_method(name.to_sym) { self[name] }
+          define_method("#{name}=".to_sym) { |val| self[name] = val }
         end
 
         def schema
@@ -46,7 +45,10 @@ module DIDWW
 
         # Returns a ComplexObject class if given JSON API type matches any
         def class_for_type(type)
-          "#{parent.name}::#{type.classify}".safe_constantize
+          # activesupport 6 has breaking change - parent* methods renamed to module_parent*.
+          # see https://github.com/rails/rails/pull/34051
+          name = respond_to?(:module_parent_name) ? module_parent_name : parent_name
+          "#{name}::#{type.classify}".safe_constantize
         end
       end
 
@@ -70,7 +72,8 @@ module DIDWW
       end
 
       def []=(key, value)
-        public_send("#{key}=", value)
+        property = self.class.schema.find(key)
+        attributes[key] = property ? property.cast(value) : value
       end
 
       # When we represent this resource for serialization (create/update), we do so

data/lib/didww/complex_objects/capacity_order_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module DIDWW
+  module ComplexObject
+    class CapacityOrderItem < Base
+      # passed at order creation
+      property :qty,                type: :int
+      property :capacity_pool_id,   type: :string
+
+      # returned
+      property :nrc,                type: :decimal
+      property :mrc,                type: :decimal
+      property :propated_mrc,       type: :boolean
+      property :billed_from,        type: :string
+      property :billed_to,          type: :string
+    end
+  end
+end

data/lib/didww/complex_objects/cdr_export_filter.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json_api_client/schema'
 
 module DIDWW

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'didww/complex_objects/configurations/const'
 
 module DIDWW

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module DIDWW
   module ComplexObject
     module Configuration