ncco 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a216f5030e69381a0ca46d99de4a863b516db4fd66f22064355e67cdb046d54c
-  data.tar.gz: e1b6caab15abf000193c4f8710b9b50522ce00cd15dd7e576c41547f8e5e77e2
+  metadata.gz: 83ee03788109717640e74920bb21cc2fbc07dd2d27ec8850bde4ad0002ae94a7
+  data.tar.gz: 625ca24611c7640f53e7bdfbae9758a7a13f74df4f61248977d8f44363baa49b
 SHA512:
-  metadata.gz: 674f045c36ab386af75256ac35ada221181eb5e342cff6e136fa307c5d5e2d21e9f829d8bac21da767d24e1e43aeb2ea9a4ee63d9ed6282e0c140cf0d3e06aff
-  data.tar.gz: f6cc04a4edbf5de4a22fdee12a5950416cb450d9dfeb82b25a6dcbfc1a0d32d58b83788b453efed44cd6d0612b574f86bff214046fcc43c91354dccf3d8f2c53
+  metadata.gz: e31008d689272f5ef55f293670fc160f7dd466288ea57bca7b38bc92cb39c0b69cb9259b2104154de5ba722ed938485566d0e9ee73d9d303b6ade9772ffe3969
+  data.tar.gz: 17b0a41431b94d9840972d06ec6792f0325f66645162946e86a02eb1831ed899f0226ac9fb6715ec5914dac5348155b3630f2c3756ac0b247723cd439e53f651

data/.circleci/config.yml

@@ -7,6 +7,7 @@ jobs:
       - image: circleci/ruby:2.5.1
     steps:
       - checkout
+      - run: gem install bundler --pre
       - type: cache-restore
         name: Restore Bundler cache
         key: ncco-{{ checksum "Gemfile.lock" }}

data/Gemfile.lock

@@ -1,17 +1,12 @@
 PATH
   remote: .
   specs:
-    ncco (0.1.0)
+    ncco (0.1.1)
       dry-validation (~> 0.12.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     ast (2.4.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.3)
@@ -29,7 +24,7 @@ GEM
       dry-container (~> 0.2, >= 0.2.6)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
-    dry-types (0.13.2)
+    dry-types (0.13.3)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.3)
       dry-core (~> 0.4, >= 0.4.4)
@@ -46,11 +41,8 @@ GEM
     gc_ruboconfig (2.3.13)
       rubocop (>= 0.57, < 0.61)
       rubocop-rspec (~> 1.25)
-    i18n (1.1.1)
-      concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
     method_source (0.9.2)
-    minitest (5.11.3)
     parallel (1.12.1)
     parser (2.5.3.0)
       ast (~> 2.4.0)
@@ -84,16 +76,12 @@ GEM
     rubocop-rspec (1.30.1)
       rubocop (>= 0.60.0)
     ruby-progressbar (1.10.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
     unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activesupport (~> 5.2.1)
   bundler (~> 1.17.a)
   gc_ruboconfig (~> 2.3.13)
   ncco!

data/lib/ncco/data/errors.yml

@@ -3,8 +3,8 @@ en:
     strict_keys?: has attributes which aren't part of the NCCO specification
     http_or_https_url?: must be a valid HTTP or HTTPS URL
     supported_http_method?: must be a supported HTTP method
-    single_digit?: must be a single digit from a phone keypad, as a string
-    digits?: must be a series of one or more digits from a phone keypad, as a string
+    phone_keypad_digit?: must be a single digit from a phone keypad, as a string
+    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

data/lib/ncco/predicates.rb

@@ -4,6 +4,7 @@ module NCCO
   module Predicates
     include ::Dry::Logic::Predicates
 
+    # TODO: Does Nexmo accept URLs relative to the current location?
     predicate(:http_or_https_url?) do |value|
       uri = URI.parse(value)
       %w[http https].include?(uri.scheme)
@@ -25,16 +26,17 @@ module NCCO
     end
 
     NUMBERS = (0..9).map(&:to_s).freeze
-    DIGITS = [*NUMBERS, "*", "#"].freeze
+    PHONE_KEYPAD_DIGITS = [*NUMBERS, "*", "#"].freeze
 
-    predicate(:single_digit?) do |value|
-      DIGITS.include?(value)
+    predicate(:phone_keypad_digit?) do |value|
+      PHONE_KEYPAD_DIGITS.include?(value)
     end
 
-    predicate(:digits?) do |value|
+    predicate(:phone_keypad_digits?) do |value|
       value.is_a?(String) &&
         !value.empty? &&
-        (value.chars - DIGITS).none?
+        # There shouldn't be any characters in the input that aren't keypad digits
+        (value.chars - PHONE_KEYPAD_DIGITS).none?
     end
 
     predicate(:e164?) do |value|

data/lib/ncco/schemas/base_schema.rb

@@ -6,8 +6,14 @@ module NCCO
       input :hash?, :strict_keys?
 
       configure do
+        # `dry-validations` includes a bunch of "predicates" which you can use to
+        # validate values. This includes some custom Nexmo-specific ones (e.g. for
+        # phone digits and URLs).
         predicates(Predicates)
 
+        # 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`!)
         def strict_keys?(input)
           (input.keys - rules.keys).empty?
         end

data/lib/ncco/schemas/connect.rb

@@ -9,9 +9,9 @@ module NCCO
       # Phone endpoint attributes
       optional(:number).value(:e164?)
       optional(:onAnswer).value(:http_or_https_url?)
-      optional(:dtmfAnswer).value(:digits?)
+      optional(:dtmfAnswer).value(:phone_keypad_digits?)
 
-      # Websocket endpoint attributes
+      # WebSocket endpoint attributes
       optional(:uri).value(:websocket_url?) # Also used for SIP endpoints
       optional("content-type").value(eql?: "audio/l16;rate=16000")
       optional(:headers).value(:hash_with_string_keys_and_values?)

data/lib/ncco/schemas/record.rb

@@ -11,7 +11,7 @@ module NCCO
       optional(:split).value(included_in?: [nil, "conversation"])
       optional(:channels).value(type?: Integer, gteq?: 1, lteq?: 32)
       optional(:endOnSilence).value(type?: Integer, gteq?: 3, lteq?: 10)
-      optional(:endOnKey).value(:single_digit?)
+      optional(:endOnKey).value(:phone_keypad_digit?)
       optional(:beepStart).value(:bool?)
       optional(:timeout).value(type?: Integer, gteq?: 3, lteq?: 7200)
       optional(:eventUrl).value(:http_or_https_url?)

data/lib/ncco/version.rb

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

data/lib/ncco.rb

@@ -14,6 +14,8 @@ require "ncco/schemas/talk"
 module NCCO
   class InvalidActionError < StandardError; end
 
+  # Maps the "action" attribute within an action to the schema which should be used
+  # to validate it
   SCHEMAS_BY_TYPE = {
     "connect" => Schemas::Connect,
     "conversation" => Schemas::Conversation,
@@ -62,7 +64,8 @@ module NCCO
                             index: index)
       end
 
-      error_messages = transform_error_messages(schema.call(action).messages(full: true))
+      result = schema.call(action)
+      error_messages = get_error_messages(result)
 
       raise_invalid_error(error_messages.join(", "), index: index) if error_messages.any?
     end
@@ -105,14 +108,16 @@ module NCCO
       end
     end
 
-    # Transforms error messages returned by dry-validations into a consistent format. For
+    # 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.
     #
-    # @param error_messages [Array<String>, Hash] messages returned by dry-validations
+    # @param result [Dry::Valiation::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 transform_error_messages(error_messages)
+    def get_error_messages(result)
+      error_messages = result.messages(full: true)
       return error_messages if error_messages.is_a?(Array)
 
       error_messages.values.flatten

data/ncco.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "dry-validation", "~> 0.12.2"
 
-  spec.add_development_dependency "activesupport", "~> 5.2.1"
   spec.add_development_dependency "bundler", "~> 1.17.a"
   spec.add_development_dependency "gc_ruboconfig", "~> 2.3.13"
   spec.add_development_dependency "pry", "~> 0.12.2"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ncco
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Rogers
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.2
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.2.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement