ncco 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ee03788109717640e74920bb21cc2fbc07dd2d27ec8850bde4ad0002ae94a7
-  data.tar.gz: 625ca24611c7640f53e7bdfbae9758a7a13f74df4f61248977d8f44363baa49b
+  metadata.gz: 8e630a1ba1f9ba6e1d6e7e77a733ae22e28e699d49bfdb594ab5a450817f2575
+  data.tar.gz: 1bfda713d0bf605db1565781aaff68971d4056f73bccb9b745f1a3b4c313452f
 SHA512:
-  metadata.gz: e31008d689272f5ef55f293670fc160f7dd466288ea57bca7b38bc92cb39c0b69cb9259b2104154de5ba722ed938485566d0e9ee73d9d303b6ade9772ffe3969
-  data.tar.gz: 17b0a41431b94d9840972d06ec6792f0325f66645162946e86a02eb1831ed899f0226ac9fb6715ec5914dac5348155b3630f2c3756ac0b247723cd439e53f651
+  metadata.gz: 4fa63d3d0c007fcd89b991494f3c0b3790e30d16852669a705f277500a86a82e9e1b4a96f00887af762fcfaa5d717ef998b6178e6881b389ad4b3180eabd2069
+  data.tar.gz: f6b5d7979e7d1d2321c289a45fe150c26937f5bc85dc43c4ed434a34097cfc1e5627676d4d3102d4aa4b34027ac5e042a067fdd2da9b8b7bf5b45f80c132c9e3

data/.rubocop.yml

@@ -5,4 +5,4 @@ AllCops:
   TargetRubyVersion: 2.5
 
 RSpec/NestedGroups:
-  Max: 5
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ncco (0.1.1)
+    ncco (0.2.0)
       dry-validation (~> 0.12.2)
 
 GEM
@@ -92,4 +92,4 @@ DEPENDENCIES
   rubocop-rspec (~> 1.30.1)
 
 BUNDLED WITH
-   1.17.0.pre.2
+   1.17.1

data/lib/ncco.rb

@@ -10,6 +10,7 @@ require "ncco/schemas/input"
 require "ncco/schemas/record"
 require "ncco/schemas/stream"
 require "ncco/schemas/talk"
+require "ncco/utils"
 
 module NCCO
   class InvalidActionError < StandardError; end
@@ -42,7 +43,7 @@ module NCCO
   #   invalid and why.
   def self.build(actions)
     actions.
-      map { |action| action.transform_keys(&:to_sym) }.
+      map { |action| Utils.deep_transform_keys_to_symbols(action) }.
       each_with_index { |action, index| validate_action!(action, index: index) }
 
     actions
@@ -65,9 +66,9 @@ module NCCO
       end
 
       result = schema.call(action)
-      error_messages = get_error_messages(result)
+      error_message = get_error_message_from_result(result)
 
-      raise_invalid_error(error_messages.join(", "), index: index) if error_messages.any?
+      raise_invalid_error(error_message, index: index) if error_message
     end
 
     # Raises an InvalidActionError, featuring the human-readable index of the action
@@ -78,7 +79,7 @@ module NCCO
     #   object
     # @raise [InvalidActionError]
     def raise_invalid_error(error_message, index:)
-      raise InvalidActionError, "The #{ordinalized_number(index + 1)} action is " \
+      raise InvalidActionError, "The #{ordinalised_number(index + 1)} action is " \
                                 "invalid: #{error_message}"
     end
 
@@ -89,8 +90,8 @@ module NCCO
     # @param number [Integer] the number to fetch the ordinal string for
     # @return [String] the number, followed by the ordinal string corresponding to the
     #   number
-    def ordinalized_number(number)
-      "#{number}#{ordinalize(number)}"
+    def ordinalised_number(number)
+      "#{number}#{ordinal_string_for_number(number)}"
     end
 
     # Turns a number into an "ordinal string" used to denote its position in an ordered
@@ -98,7 +99,7 @@ module NCCO
     #
     # @param number [Integer] the number to fetch the ordinal string for
     # @return [String] the ordinal string corresponding to the number
-    def ordinalize(number)
+    def ordinal_string_for_number(number)
       case number.digits.last
       when 0 then "th"
       when 1 then "st"
@@ -108,19 +109,26 @@ module NCCO
       end
     end
 
-    # Gets the error messages from `Dry::Validation::Result`s in a consistent format. For
-    # field-level errors, we get back a `Hash` mapping the attribute name to an array of
-    # `String` error messages, whereas for unrecognised attributes (which is a bit of a
-    # hack), we just get back an array. This handles either gracefully.
+    # Gets the error messages from a `Dry::Validation::Result`, if there is one, dealing
+    # with the slightly mad `Result` API
     #
-    # @param result [Dry::Valiation::Result] the result from validating an action against
+    # @param result [Dry::Validation::Result] the result from validating an action against
     #   a schema
-    # @return [Array<String>] a list of error messages which is guaranteed to be an array
-    def get_error_messages(result)
+    # @return [String, nil] an error message to display, if there was an error
+    def get_error_message_from_result(result)
       error_messages = result.messages(full: true)
-      return error_messages if error_messages.is_a?(Array)
+      return if error_messages.none?
 
-      error_messages.values.flatten
+      transform_error_message(error_messages)
+    end
+
+    def transform_error_message(error_messages)
+      case error_messages
+      when String then errror_messages
+      when Array then error_messages.first
+      when Hash then transform_error_message(error_messages.values.first)
+      else raise ArgumentError, "Unable to parse error message"
+      end
     end
   end
 end

data/lib/ncco/data/errors.yml

@@ -7,4 +7,6 @@ en:
     phone_keypad_digits?: must be a series of one or more digits from a phone keypad, as a string
     e164?: must be a valid E.164-formatted phone number
     websocket_url?: must be a valid Websocket URL
-    hash_with_string_keys_and_values?: must be a hash with String keys and values
+    sip_uri?: must be a valid SIP URI
+    hash_with_string_keys_and_values?: must be a hash with String keys and values
+    anything?: can be anything

data/lib/ncco/predicates.rb

@@ -19,6 +19,12 @@ module NCCO
       false
     end
 
+    SIP_URI_REGEX = /\Asip:/i.freeze
+
+    predicate(:sip_uri?) do |value|
+      value =~ SIP_URI_REGEX
+    end
+
     # TODO: Check what HTTP methods are supported by Nexmo - presumably not the full set?
     # <https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods>
     predicate(:supported_http_method?) do |value|
@@ -49,5 +55,9 @@ module NCCO
         value.keys.map(&:class).uniq == [String] &&
         value.values.map(&:class).uniq == [String]
     end
+
+    predicate(:anything?) do |_|
+      true
+    end
   end
 end

data/lib/ncco/schemas/base_schema.rb

@@ -13,7 +13,11 @@ module NCCO
 
         # Used to validate that the input only includes keys that are defined in
         # the schema, implementing a slightly hacky "whitelisting" behaviour (which
-        # for some reason isn't include in `dry-validations`!)
+        # for some reason isn't included in `dry-validations`!).
+        #
+        # In some places, we have to hack around this a bit by using our special
+        # `:anything?` predicate to whitelist an attribute which we have no rules
+        # to define about.
         def strict_keys?(input)
           (input.keys - rules.keys).empty?
         end

data/lib/ncco/schemas/connect.rb

@@ -2,21 +2,55 @@
 
 module NCCO
   module Schemas
-    # TODO: Validate these attributes depending on the specified endpoint type
-    ConnectEndpoint = Dry::Validation.Schema(BaseSchema) do
-      required(:type).value(included_in?: %w[phone websocket sip])
+    ConnectPhoneEndpoint = Dry::Validation.Schema(BaseSchema) do
+      required(:type).value(eql?: "phone")
 
-      # Phone endpoint attributes
-      optional(:number).value(:e164?)
+      required(:number).value(:e164?)
       optional(:onAnswer).value(:http_or_https_url?)
       optional(:dtmfAnswer).value(:phone_keypad_digits?)
+    end
+
+    ConnectSipEndpoint = Dry::Validation.Schema(BaseSchema) do
+      required(:type).value(eql?: "sip")
 
-      # WebSocket endpoint attributes
-      optional(:uri).value(:websocket_url?) # Also used for SIP endpoints
+      required(:uri).value(:sip_uri?)
+    end
+
+    ConnectWebSocketEndpoint = Dry::Validation.Schema(BaseSchema) do
+      required(:type).value(eql?: "websocket")
+
+      required(:uri).value(:websocket_url?)
       optional("content-type").value(eql?: "audio/l16;rate=16000")
       optional(:headers).value(:hash_with_string_keys_and_values?)
     end
 
+    ConnectEndpoint = Dry::Validation.Schema(BaseSchema) do
+      required(:type).value(included_in?: %w[phone websocket sip])
+
+      # How we validate the endpoint (i.e. what schema we should use) depends on the type
+      rule(phone_endpoint: [:type]) do |type|
+        type.eql?("phone") > schema(ConnectPhoneEndpoint)
+      end
+
+      rule(sip_endpoint: [:type]) do |type|
+        type.eql?("sip") > schema(ConnectSipEndpoint)
+      end
+
+      rule(websocket_endpoint: [:type]) do |type|
+        type.eql?("websocket") > schema(ConnectWebSocketEndpoint)
+      end
+
+      # We use this special `anything?` predicate to declare and whitelist the
+      # attribute without setting any rules for they must look like. The values
+      # are validated by our endpoint-specific schemas.
+      optional(:number).value(:anything?)
+      optional(:onAnswer).value(:anything?)
+      optional(:dtmfAnswer).value(:anything?)
+      optional(:uri).value(:anything?)
+      optional("content-type").value(:anything?)
+      optional(:headers).value(:anything?)
+    end
+
     Connect = Dry::Validation.Schema(BaseSchema) do
       required(:action).value(eql?: "connect")
       required(:endpoint).schema(ConnectEndpoint)

data/lib/ncco/utils.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Utils
+    # Transforms the keys of a Hash with the provided block recursively, walking through
+    # nested hashes
+    #
+    # @param hash [Hash] the hash to transform
+    # @yieldparam the key to transform
+    # @return [Hash] the transformed hash, with the block recursively applied to its keys
+    def self.deep_transform_keys(hash, &block)
+      result = {}
+
+      hash.each do |key, value|
+        result[yield(key)] = if value.is_a?(Hash)
+                               deep_transform_keys(value, &block)
+                             else
+                               value
+                             end
+      end
+
+      result
+    end
+
+    # Transforms the keys of Hash into symbols recursively, walking through nested hashes
+    #
+    # @param hash [Hash] the hash to transform
+    def self.deep_transform_keys_to_symbols(hash)
+      deep_transform_keys(hash, &:to_sym)
+    end
+  end
+end

data/lib/ncco/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NCCO
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ncco
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Rogers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-25 00:00:00.000000000 Z
+date: 2018-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-validation
@@ -153,6 +153,7 @@ files:
 - lib/ncco/schemas/record.rb
 - lib/ncco/schemas/stream.rb
 - lib/ncco/schemas/talk.rb
+- lib/ncco/utils.rb
 - lib/ncco/version.rb
 - ncco.gemspec
 homepage: https://github.com/timrogers/ncco-ruby