tenios 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8e7bfe618abcacfe8b4c7c3158a42861608204d504717bbd729459e59cbdf8c
-  data.tar.gz: '0906b8bde90001a38566f725b5c2d369f7c073869d6506dc75384ffedc725ccb'
+  metadata.gz: af1772cc247dc0e26b8b4165401cc3c735557810a5246ad8dfa02c1be98925db
+  data.tar.gz: b319c0b8e1f32e312fb3ede0300bf0c26e03e5f0519caa58e3bcbbc6d4cbac33
 SHA512:
-  metadata.gz: b46601f7e863032c45689ce83d52058fd76a62f89dbc85d208c40441a4028c579d7b2fa4da594c779c4fd52c1b9819594e1f8960ca8bb194c9d1f43c01ccc521
-  data.tar.gz: 409b88413a2759e6525ddd7e70f1f0cafa3348919c80cf8dd51405aa5f25b4876a48d97b6f85295bdf4e7b0770b6dbcff6777e8d1442016ec48d70244e3cc093
+  metadata.gz: f441d26e9bcdd2628d078ee3d843679b806be57837df3e85a6ef40980fdcf4f5618583a72bf43211a286832cd17c6e7fcc0e6b7751899d4ff43957348412fc3c
+  data.tar.gz: ec40c0cd903eb1e803deb41c86b1e2bf7bd07491a5c52d7824e65f4323b753a8a015c39dbc8b83f13385fb97b260308bad143696ad7bc2e3d435936dac62a745

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-02-11 10:20:16 +0000 using RuboCop version 0.63.1.
+# on 2019-02-21 23:25:38 +0000 using RuboCop version 0.63.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -14,12 +14,12 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Max: 10
 
-# Offense count: 2
+# Offense count: 3
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
   Max: 13
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountKeywordArgs.
 Metrics/ParameterLists:
   Max: 10
@@ -27,3 +27,15 @@ Metrics/ParameterLists:
 # Offense count: 1
 Metrics/PerceivedComplexity:
   Max: 10
+
+# Offense count: 6
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/tenios/blocks_spec.rb'
+    - 'spec/tenios_spec.rb'
+
+# Offense count: 3
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 2

data/README.md

@@ -1,6 +1,61 @@
 # Tenios
 
-TODO: Delete this and the text above, and describe your gem
+Wraps [Tenios Call Control](https://www.tenios.de/en/doc/api-spec) blocks in ruby.
+Each accepted block has a corresponding object under `Tenios::Blocks`, currently these are:
+- `Tenios::Blocks::Announcement`
+- `Tenios::Blocks::Bridge`
+- `Tenios::Blocks::CollectDigits`
+- `Tenios::Blocks::CollectSpeech`
+- `Tenios::Blocks::HangUp`
+- `Tenios::Blocks::RoutingPlan`
+- `Tenios::Blocks::Say`
+
+Each of these can be used as part of a `Tenios::Blocks` object, by using `Tenios::Blocks#add`.
+
+`Tenios::Blocks` implements `#as_json` which returns a JSON-like hash (although with symbolised keys).
+
+In rails you can pass the `Tenios::Blocks` object directly to `render` under the `json:` key.
+
+```ruby
+require 'tenios'
+
+class TeniosController < ApplicationController
+  def redirect_to_number
+    announcement = Tenios::Blocks::Announcement.new(announcement: 'redirect', standard: false)
+    bridge = Tenios::Blocks::Bridge.new(mode: Tenios::Blocks::Bridge::SEQUENTIAL) do |redirect|
+      redirect.with_destination(Tenios::Blocks::Bridge::EXTERNAL_NUMBER, '+440123456789', 10)
+    end
+
+    blocks = Tenios::Blocks.new do |response|
+      response.add(announcement)
+      response.add(bridge)
+    end
+
+    render json: blocks
+  end
+end
+```
+
+Else you can use any JSON serializer that can deal with a ruby `Hash`
+
+```ruby
+require 'json'
+require 'tenios'
+
+announcement = Tenios::Blocks::Announcement.new(announcement: 'redirect', standard: false)
+bridge =
+  Tenios::Blocks::Bridge
+  .new(mode: Tenios::Blocks::Bridge::SEQUENTIAL)
+  .with_destination(Tenios::Blocks::Bridge::EXTERNAL_NUMBER, '+440123456789', 10)
+
+Tenios::Blocks.new
+.add(announcement)
+.add(bridge)
+.as_json
+.yield_self { |hash| JSON.generate(hash) }
+```
+
+As you may have noticed in the exampled above you can both chain calls to `Tenios::Blocks#add` and `Tenios::Blocks::Bridge#with_destination` or pass a block to those initialisers. :man_shrugging: whatever floats your boat.
 
 ## Installation
 
@@ -18,16 +73,6 @@ Or install it yourself as:
 
     $ gem install tenios
 
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-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
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/carwow/tenios-ruby.

data/lib/tenios/blocks.rb

@@ -14,6 +14,90 @@ module Tenios
       self
     end
 
+    def announce(announcement:, standard: false)
+      block = Announcement.new(
+        announcement: announcement,
+        standard: standard
+      )
+
+      add(block)
+    end
+
+    def bridge(mode:, timeout: nil)
+      block = Bridge.new(
+        mode: mode,
+        timeout: timeout
+      )
+
+      yield(block) if block_given?
+
+      add(block)
+    end
+
+    def collect_digits(
+      announcement:,
+      standard_announcement:,
+      error_announcement:,
+      standard_error_announcement:,
+      variable:,
+      min_digits:,
+      max_digits:,
+      terminator:,
+      max_tries:,
+      timeout:
+    )
+      block = CollectDigits.new(
+        announcement: announcement,
+        standard_announcement: standard_announcement,
+        error_announcement: error_announcement,
+        standard_error_announcement: standard_error_announcement,
+        variable: variable,
+        min_digits: min_digits,
+        max_digits: max_digits,
+        terminator: terminator,
+        max_tries: max_tries,
+        timeout: timeout
+      )
+
+      add(block)
+    end
+
+    def collect_speech(
+      announcement:,
+      missing_input_announcement:,
+      language:,
+      variable:,
+      max_tries:
+    )
+      block = CollectSpeech.new(
+        announcement: announcement,
+        missing_input_announcement: missing_input_announcement,
+        language: language,
+        variable: variable,
+        max_tries: max_tries
+      )
+
+      add(block)
+    end
+
+    def hang_up(cause:)
+      block = HangUp.new(cause: cause)
+
+      add(block)
+    end
+
+    def routing_plan(routing_plan:)
+      block = RoutingPlan.new(routing_plan: routing_plan)
+
+      add(block)
+    end
+
+    def say(text:, voice:, ssml:)
+      block = Say.new(text: text, voice: voice, ssml: ssml)
+
+      add(block)
+    end
+
     def as_json(*)
       {
         blocks: @blocks.map(&:as_json)

data/lib/tenios/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tenios
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/tenios.rb

@@ -13,5 +13,11 @@
 ].each { |f| require f }
 
 module Tenios
-  class Error < StandardError; end
+  def self.blocks
+    blocks = Blocks.new
+
+    yield(blocks) if block_given?
+
+    blocks
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tenios
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - carwow Developers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-11 00:00:00.000000000 Z
+date: 2019-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler