ncco 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a216f5030e69381a0ca46d99de4a863b516db4fd66f22064355e67cdb046d54c
+  data.tar.gz: e1b6caab15abf000193c4f8710b9b50522ce00cd15dd7e576c41547f8e5e77e2
+SHA512:
+  metadata.gz: 674f045c36ab386af75256ac35ada221181eb5e342cff6e136fa307c5d5e2d21e9f829d8bac21da767d24e1e43aeb2ea9a4ee63d9ed6282e0c140cf0d3e06aff
+  data.tar.gz: f6cc04a4edbf5de4a22fdee12a5950416cb450d9dfeb82b25a6dcbfc1a0d32d58b83788b453efed44cd6d0612b574f86bff214046fcc43c91354dccf3d8f2c53

data/.circleci/config.yml

@@ -0,0 +1,20 @@
+---
+version: 2
+jobs:
+  build:
+    working_directory: ~/ncco
+    docker:
+      - image: circleci/ruby:2.5.1
+    steps:
+      - checkout
+      - type: cache-restore
+        name: Restore Bundler cache
+        key: ncco-{{ checksum "Gemfile.lock" }}
+      - run: bundle install --path vendor/bundle
+      - type: cache-save
+        name: Save Bundler cache
+        key: ncco-{{ checksum "Gemfile.lock" }}
+        paths:
+          - vendor/bundle
+      - run: bundle exec rake
+      - run: bundle exec rake lint

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  gc_ruboconfig: rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.5
+
+RSpec/NestedGroups:
+  Max: 5

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 (25 November 2018)
+
+* Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@timrogers.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ncco.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    ncco (0.1.0)
+      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)
+    diff-lcs (1.3)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.7)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.1)
+    dry-inflector (0.1.2)
+    dry-logic (0.4.2)
+      dry-container (~> 0.2, >= 0.2.6)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (0.13.2)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 0.4, >= 0.4.2)
+    dry-validation (0.12.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+      dry-core (~> 0.2, >= 0.2.1)
+      dry-equalizer (~> 0.2)
+      dry-logic (~> 0.4, >= 0.4.0)
+      dry-types (~> 0.13.1)
+    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)
+    powerpack (0.1.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    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!
+  pry (~> 0.12.2)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (~> 0.60.0)
+  rubocop-rspec (~> 1.30.1)
+
+BUNDLED WITH
+   1.17.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tim Rogers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# NCCO
+
+[Nexmo Call Control Objects](https://developer.nexmo.com/voice/voice-api/ncco-reference) (NCCOs) allow you to decide with your code what happens in a phone call which you've placed or received using [Nexmo's Voice API](https://developer.nexmo.com/voice/voice-api/overview).
+
+If you make a mistake in your NCCO (for example, you miss out a required parameter or misspell something), the call will fail.
+
+This gem allows you to __validate__ your NCCOs before you send them to Nexmo, giving you a tighter feedback loop and helping you to catch errors earlier, before they hit production (for example when you run your tests).
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem "ncco", "~> 0.1.0"
+```
+
+Next, install the gem by running:
+
+```bash
+bundle
+```
+
+## Usage
+
+Nexmo Call Control Objects (NCCOs) are JSON arrays of objects. In Ruby, you'll build a Ruby array of hashes, where each hash represents an "action" in your call, and then you'll send it to Nexmo as JSON:
+
+```ruby
+say_hello = {
+  action: "talk",
+  text: "Hello there! You're through to Acme Widgets. Leave a message after the tone. Press star or hang up when you're done.",
+}
+
+record_message = {
+  action: "record",
+  endOnKey: "*",
+  beepStart: true,
+  eventUrl: "https://acmewidgets.com/nexmo/recordings",
+  eventMethod: "POST",
+  format: "mp4"
+}
+
+ncco = [say_hello, record_message]
+render json: ncco
+```
+
+The eagle-eyed among you will have noticed that there's a mistake in our example above: Nexmo doesn't support the `mp4` format for recordings! This would lead to an error, and a bad experience for our users 😭
+
+But there's a better way:
+
+```ruby
+require "ncco"
+
+render json: NCCO.build(ncco)
+```
+
+This will still fail - our NCCO is invalid! - but our application will let us know ahead of time:
+
+```ruby
+NCCO.build(ncco)
+# NCCO::InvalidActionError (The 2nd action is invalid: format must be one of: mp3, wav,
+# ogg, eventUrl must be a valid HTTP or HTTPS URL)
+```
+
+This allows you to catch errors earlier and easily handle them with your usual exception tracking tools (for example Sentry).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Then, run `rake spec` to run the tests and `rake lint` to check the code style with Rubocop.
+
+You can also run `bin/console` for an interactive prompt that will allow you to experiment with the gem.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+NCCO "actions" are defined using schemas in `lib/ncco/schemas`, implemented using [dry-validation](https://github.com/dry-rb/dry-validation).
+
+To tweak how we validate an action (for example to add a new attribute or change how an existing one is validated), just update the action's corresponding schema. Testing is easy thanks to our `allow_value`, `require_attribute` and `allow_blank_values` matchers - see the existing tests for an example.
+
+If you want to add support for a new action, you'll need to crerate a new schema in `lib/ncco/schemas`, require it and add it to `SCHEMAS_BY_TYPE` in `lib/ncco.rb` and write some tests.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/timrogers/ncco. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Ncco project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/timrogers/ncco/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:lint)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ncco"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/rails.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class IncomingCallsController < ApplicationController
+  def create
+    say_hello = {
+      action: "talk",
+      text: "Hello there! You're through to Acme Widgets. Leave a message.",
+    }
+
+    record_message = {
+      action: "record",
+      eventUrl: record_incoming_calls_url,
+      eventMethod: "POST",
+    }
+
+    render json: NCCO.build([say_hello, record_message])
+  end
+
+  def record
+    recording_url = params[:recording_url]
+    conversation_uuid = params[:conversation_uuid]
+
+    SaveRecordedMessage.call(recording_url: recording_url,
+                             conversation_uuid: conversation_uuid)
+
+    render status: 204, nothing: true
+  end
+end

data/lib/ncco.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "dry-validation"
+require "ncco/version"
+require "ncco/predicates"
+require "ncco/schemas/base_schema"
+require "ncco/schemas/connect"
+require "ncco/schemas/conversation"
+require "ncco/schemas/input"
+require "ncco/schemas/record"
+require "ncco/schemas/stream"
+require "ncco/schemas/talk"
+
+module NCCO
+  class InvalidActionError < StandardError; end
+
+  SCHEMAS_BY_TYPE = {
+    "connect" => Schemas::Connect,
+    "conversation" => Schemas::Conversation,
+    "input" => Schemas::Input,
+    "record" => Schemas::Record,
+    "stream" => Schemas::Stream,
+    "talk" => Schemas::Talk,
+  }.freeze
+
+  # A Nexmo Call Control Object (NCCO) is a JSON array that you use to control the flow
+  # of a Nexmo call. This method validates an array, ensuring the "actions" inside are
+  # valid NCCO actions, either throwing an explanatory error if they're not, or returning
+  # back the array if the input is valid.
+  #
+  # This method can be used to pre-emptively ensure that an NCCO is valid *before* sending
+  # it to Nexmo, providing a kind of static analysis.
+  #
+  # @param actions [Array<Hash>] a Nexmo Call Control Object (NCCO) as a Ruby array, made
+  #   up of a series of "actions", each of which is a Ruby hash
+  # @return [Array<Hash>] the Nexmo Call Control Object (NCCO), as a Ruby array, which
+  #   was passed in
+  # @raise [InvalidActionError] if any of the actions within the Nexmo Call Control
+  #   Object is invalid. The error message will include details on which action was
+  #   invalid and why.
+  def self.build(actions)
+    actions.
+      map { |action| action.transform_keys(&:to_sym) }.
+      each_with_index { |action, index| validate_action!(action, index: index) }
+
+    actions
+  end
+
+  class << self
+    private
+
+    # Validates an NCCO action, raising an error if it is invalid
+    #
+    # @param action [Hash] the NCCO action
+    # @param index [Integer] the position of the action in the NCCO array
+    # @raise [InvalidActionError] if the action is invalid
+    def validate_action!(action, index:)
+      schema = SCHEMAS_BY_TYPE[action[:action]]
+
+      unless schema
+        raise_invalid_error("#{action[:action]} isn't a valid action type",
+                            index: index)
+      end
+
+      error_messages = transform_error_messages(schema.call(action).messages(full: true))
+
+      raise_invalid_error(error_messages.join(", "), index: index) if error_messages.any?
+    end
+
+    # Raises an InvalidActionError, featuring the human-readable index of the action
+    # within the provided NCCO object, with a specified error message
+    #
+    # @param error_message [String] the specific error message
+    # @param index [Integer] the zero-indexed position of the action within the NCCO
+    #   object
+    # @raise [InvalidActionError]
+    def raise_invalid_error(error_message, index:)
+      raise InvalidActionError, "The #{ordinalized_number(index + 1)} action is " \
+                                "invalid: #{error_message}"
+    end
+
+    # Finds a number's "ordinal string", used to denote its position in an ordered
+    # sequence, and returns the number followed by that string. See `#ordinalize` for
+    # further information.
+    #
+    # @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)}"
+    end
+
+    # Turns a number into an "ordinal string" used to denote its position in an ordered
+    # sequence - for example passing in 1 returns "st" (1st), 2 returns "nd" (2nd), etc.
+    #
+    # @param number [Integer] the number to fetch the ordinal string for
+    # @return [String] the ordinal string corresponding to the number
+    def ordinalize(number)
+      case number.digits.last
+      when 0 then "th"
+      when 1 then "st"
+      when 2 then "nd"
+      when 3 then "rd"
+      when 4..9 then "th"
+      end
+    end
+
+    # Transforms error messages returned by dry-validations into 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
+    # @return [Array<String>] a list of error messages which is guaranteed to be an array
+    def transform_error_messages(error_messages)
+      return error_messages if error_messages.is_a?(Array)
+
+      error_messages.values.flatten
+    end
+  end
+end

data/lib/ncco/data/errors.yml

@@ -0,0 +1,10 @@
+en:
+  errors:
+    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
+    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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Predicates
+    include ::Dry::Logic::Predicates
+
+    predicate(:http_or_https_url?) do |value|
+      uri = URI.parse(value)
+      %w[http https].include?(uri.scheme)
+    rescue URI::InvalidURIError
+      false
+    end
+
+    predicate(:websocket_url?) do |value|
+      uri = URI.parse(value)
+      uri.scheme == "ws"
+    rescue URI::InvalidURIError
+      false
+    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|
+      %w[GET POST].include?(value)
+    end
+
+    NUMBERS = (0..9).map(&:to_s).freeze
+    DIGITS = [*NUMBERS, "*", "#"].freeze
+
+    predicate(:single_digit?) do |value|
+      DIGITS.include?(value)
+    end
+
+    predicate(:digits?) do |value|
+      value.is_a?(String) &&
+        !value.empty? &&
+        (value.chars - DIGITS).none?
+    end
+
+    predicate(:e164?) do |value|
+      # Regular expression taken from https://www.twilio.com/docs/glossary/what-e164
+      value =~ /^\+?[1-9]\d{1,14}$/
+    end
+
+    predicate(:hash_with_string_keys_and_values?) do |value|
+      value.is_a?(Hash) &&
+        value.keys.map(&:class).uniq == [String] &&
+        value.values.map(&:class).uniq == [String]
+    end
+  end
+end

data/lib/ncco/schemas/base_schema.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Schemas
+    BaseSchema = Dry::Validation.Schema do
+      input :hash?, :strict_keys?
+
+      configure do
+        predicates(Predicates)
+
+        def strict_keys?(input)
+          (input.keys - rules.keys).empty?
+        end
+
+        config.messages_file = File.join(File.dirname(__FILE__), "../data/errors.yml")
+      end
+    end
+  end
+end

data/lib/ncco/schemas/connect.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+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])
+
+      # Phone endpoint attributes
+      optional(:number).value(:e164?)
+      optional(:onAnswer).value(:http_or_https_url?)
+      optional(:dtmfAnswer).value(:digits?)
+
+      # 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?)
+    end
+
+    Connect = Dry::Validation.Schema(BaseSchema) do
+      required(:action).value(eql?: "connect")
+      required(:endpoint).schema(ConnectEndpoint)
+      optional(:from).value(:e164?)
+      # TODO: What are the other options? (e.g. what is the default?)
+      optional(:eventType).value(included_in?: ["synchronous"])
+      # TODO: Are there any limitations on timeout?
+      optional(:timeout).value(type?: Integer, gteq?: 1)
+      optional(:limit).value(type?: Integer, gteq?: 1, lteq?: 7200)
+      optional(:machineDetection).value(included_in?: %w[continue hangup])
+      optional(:eventUrl).value(:http_or_https_url?)
+      optional(:eventMethod).value(:supported_http_method?)
+    end
+  end
+end

data/lib/ncco/schemas/conversation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Schemas
+    Conversation = Dry::Validation.Schema(BaseSchema) do
+      required(:action).value(eql?: "conversation")
+      required(:name).value(:filled?, type?: String)
+      optional(:musicOnHoldUrl).value(:http_or_https_url?)
+      optional(:startOnEnter).value(:bool?)
+      optional(:endOnExit).value(:bool?)
+      optional(:record).value(:bool?)
+      optional(:eventUrl).value(:http_or_https_url?)
+      optional(:eventMethod).value(:supported_http_method?)
+    end
+  end
+end

data/lib/ncco/schemas/input.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Schemas
+    Input = Dry::Validation.Schema(BaseSchema) do
+      required(:action).value(eql?: "input")
+      optional(:timeOut).value(type?: Integer, gteq?: 1, lteq?: 10)
+      optional(:maxDigits).value(type?: Integer, gteq?: 1, lteq?: 20)
+      optional(:submitOnHash).value(:bool?)
+      optional(:eventUrl).value(:http_or_https_url?)
+      optional(:eventMethod).value(:supported_http_method?)
+    end
+  end
+end

data/lib/ncco/schemas/record.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Schemas
+    DIGITS = (0..9).map(&:to_s).freeze
+
+    Record = Dry::Validation.Schema(BaseSchema) do
+      required(:action).value(eql?: "record")
+      optional(:format).value(included_in?: %w[mp3 wav ogg])
+      # TODO: Is nil allowed? What are the other options?
+      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(:beepStart).value(:bool?)
+      optional(:timeout).value(type?: Integer, gteq?: 3, lteq?: 7200)
+      optional(:eventUrl).value(:http_or_https_url?)
+      optional(:eventMethod).value(:supported_http_method?)
+    end
+  end
+end

data/lib/ncco/schemas/stream.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Schemas
+    Stream = Dry::Validation.Schema(BaseSchema) do
+      required(:action).value(eql?: "stream")
+      required(:streamUrl).value(:http_or_https_url?)
+      optional(:bargeIn).value(:bool?)
+      optional(:loop).value(type?: Integer)
+      optional(:level).value(included_in?: [-1, 0, 1])
+    end
+  end
+end

data/lib/ncco/schemas/talk.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module NCCO
+  module Schemas
+    Talk = Dry::Validation.Schema(BaseSchema) do
+      required(:action).value(eql?: "talk")
+      required(:text).value(:filled?, type?: String)
+      optional(:bargeIn).value(:bool?)
+      optional(:loop).value(type?: Integer)
+      optional(:level).value(included_in?: [-1, 0, 1])
+      optional(:voiceName).value(:filled?, type?: String)
+    end
+  end
+end

data/lib/ncco/version.rb

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

data/ncco.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ncco/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ncco"
+  spec.version       = NCCO::VERSION
+  spec.authors       = ["Tim Rogers"]
+  spec.email         = ["me@timrogers.co.uk"]
+
+  spec.summary       = "Build and validate Nexmo Call Control Objects (NCCOs) with a " \
+                       "simple API"
+  spec.homepage      = "https://github.com/timrogers/ncco-ruby"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/timrogers/ncco-ruby/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  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"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.60.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 1.30.1"
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: ncco
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tim Rogers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.17.a
+- !ruby/object:Gem::Dependency
+  name: gc_ruboconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.13
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.2
+- !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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.60.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.1
+description: 
+email:
+- me@timrogers.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/rails.rb
+- lib/ncco.rb
+- lib/ncco/data/errors.yml
+- lib/ncco/predicates.rb
+- lib/ncco/schemas/base_schema.rb
+- lib/ncco/schemas/connect.rb
+- lib/ncco/schemas/conversation.rb
+- lib/ncco/schemas/input.rb
+- lib/ncco/schemas/record.rb
+- lib/ncco/schemas/stream.rb
+- lib/ncco/schemas/talk.rb
+- lib/ncco/version.rb
+- ncco.gemspec
+homepage: https://github.com/timrogers/ncco-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/timrogers/ncco-ruby
+  source_code_uri: https://github.com/timrogers/ncco-ruby
+  changelog_uri: https://github.com/timrogers/ncco-ruby/blob/master/CHANGELOG.md
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Build and validate Nexmo Call Control Objects (NCCOs) with a simple API
+test_files: []