xip 0.0.1 → 2.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b165aa91b32341a5c6abb27ab2072e4618c67d5c1a112172aaa0faa4e3ca4fe8
-  data.tar.gz: d278b9b548252a4cdbd75baa1835b14a2cec9f388a627ff46c355a7dd5918efd
+  metadata.gz: 8ab4a49b00d8aa6cf932ce0e918e017ab2bd3fc226d31aa54d96af3e046fb6c9
+  data.tar.gz: 30b6944b77f421190585e3fb3159a913bdd9c9e3d6ddebe0c7b330a7ce0d2e96
 SHA512:
-  metadata.gz: ba7cbafb754fa2f4424705dd9dd5dfab8700835001e6909aee84593e021788f34dad51460962d492e01f1225da429827253d510c6500def568feab4f8754e6aa
-  data.tar.gz: bf6245766a9cfdb726a3153e5e4b018a7fadfaad38e521d2142cef776ccacc689d44d866b54cb5a85e31be66e113aaf0bd801df28c78a03a4dc87237dd12d35c
+  metadata.gz: 0cf670a2bf2804ab525df5af0bb7957dd851de3a39988a79817a0dfbc5036ca632541aa6758c76382cb1932763bbd5138ab29f4dbc720ad2fa11dc5d902b1b99
+  data.tar.gz: fe59920fec27c782efa08583854f3658f544673308b64d60734082e6aae2e09d61ed539b851c9938447dca8e0cedb3323f95bd40d8c61cf634c5200c769af56f

data/.circleci/config.yml

@@ -0,0 +1,116 @@
+version: 2
+
+jobs:
+  ruby_2_6:
+    docker:
+      - image: circleci/ruby:2.6-node-browsers
+        environment:
+          STEALTH_ENV: test
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                --format RspecJunitFormatter \
+                --out /tmp/test-results/rspec.xml \
+                --format progress \
+                -- \
+                $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+  ruby_2_7:
+    docker:
+      - image: circleci/ruby:2.7-node-browsers
+        environment:
+          STEALTH_ENV: test
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+      - run:
+          name: Configure Bundler
+          command: |
+            echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
+            source $BASH_ENV
+            gem install bundler
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+
+            bundle exec rspec --format progress \
+                --format RspecJunitFormatter \
+                --out /tmp/test-results/rspec.xml \
+                --format progress \
+                -- \
+                $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - ruby_2_6
+      - ruby_2_7

data/.gitignore

@@ -0,0 +1,12 @@
+# please add general patterns to your global ignore list
+# see https://github.com/github/gitignore#readme
+.DS_STORE
+*.swp
+*.rbc
+*.sass-cache
+/pkg
+/doc/api
+/coverage
+.yardoc
+doc/
+*.gem

data/CHANGELOG.md

@@ -0,0 +1,135 @@
+# Changelog for Xip v2.0.0
+
+## Enhancements
+
+* [Controllers] Added support for Dev Jumping. This feature allows developers to jump around flows and states for bot's in development.
+* [NLP] Added base classes for `Xip::Nlp::Result` and `Xip::Nlp::Client` to be used by NLP drivers.
+* [Controllers] Scheduled replies no longer call `controller.route` when they run. Instead we `step_to` to the flow and state directly. This ensures the `route` is reserved for incoming messages.
+* [Catch All] Backtrace logging has been improved. The error message is now included first in the backtrace.
+* [Logger] The thread's ID (TID) is now included in every logging entry preceding the log type, ie "[facebook]"
+* [Interrupt] Interrupt detection has been added. See the docs for more info on this feature.
+* [Controllers] When user's flow is set to `catch_all` or `interrupt`, Xip will ignore incoming messages. If you have interactive states in either of these controllers, you will need to move those interactions to a different controller.
+* [Sessions] Sessions can now be cleared by calling `session.clear_session`. Clearing a session removes the key from Redis.
+* [Logging] `primary_session`, `previous_session`, and `back_to_session` now explicitly logged
+* [Sessions] The session is no longer set on update or stepping witht destination flow and state match the existing session.
+* [Scheduled Replies] The `service_message.target_id` is now set for scheduled replies. NOTE: scheduled replies that are already enqueued will NOT have this set.
+* [Server] Updated to Puma 4.3
+* [Server] Updated to Sinatra 2.1
+* [Sessions] Added `to_s` for sessions to pretty print the slug. Useful when debugging.
+* `send_reples` now supports two additional options for replies:
+  `send_replies(custom_reply: 'hello/say_hello')`
+  `send_replies(inline: [])`
+* Dynamic delays for SMS platforms do not delay at the beginning of a reply.
+* Added support for Bandwidth SMS
+* The `ServiceMessage` (current_message) now contains a `target_id`. This can be set by the platform driver to provide more information about the intended target of a message.
+* [Controller] Added a `do_nothing` method that prevents `catch_all` from firing when a controller action doesn't send replies nor progresses the session.
+* [Replies] If `text` and `speech` replies are specified as an Array, Xip will now randomize the selected text.
+* [Generators] Added sample payload handling to generated bots since it can be tricky.
+* [Generators] Added `inflections.rb` to generators since we rely on `ActiveSupport::Inflector` to derive flow and controller names.
+* [Sessions] previous_session log entries now appear below current_session entries.
+* [Logging] Add option, `Xip.config.transcript_logging`, to log incoming and outgoing messages.
+* [Server] The only HTTP header passed along to `handle_message_job` is now `HTTP_HOST`.
+* [Controllers] Added `set_back_to` and `step_back` to allow user specified "redirect back". Useful for multi-state transitions that would otherwise not be possible with just `previous_session`.
+* [Configuration] Xip::Configuration now returns `nil` for a configuration option that is missing. It still returns a `NoMethodError` if attempting to access a key from a parent node that is also missing.
+* [Reloading] Bots in development mode now hot reload! It's no longer necessary to stop your local server.
+* [Production] Production bots now eager load bot code to improve copy-on-write performance. The `puma.rb` config has been updated with instructions for multiple workers.
+* [Flows] You can now specify custom options when defining states. These options can later be accessed via the flow specification.
+* [CoreExt] Added a `String#without_punctuation` method. Removes a lot of common punctuation.
+* [CoreExt] `String#normalize` no longer removes quotation marks.
+* [Controllers] Alpha ordinal checks are now done against a "normalized" string without punctuation. See above.
+* [Controllers] `normalized_msg` and `homophone_translated_msg` are now memoized for performance.
+* [Errors] `Xip::Errors::MessageNotRecognized` has been renamed to `Xip::Errors::UnrecognizedMessage`
+* [Controllers] When `handle_message` or `get_match` raise a `Xip::Errors::UnrecognizedMessage`, the user is first routed to a new `UnrecognizedMessagesController` to perform NLP. If that controller fails to match, the `catch_all` is run as normal.
+* [Errors] Client errors now call respective BotController actions: `handle_opt_out` and `handle_invalid_session_id`. Each client is responsible for raising `Xip::Errors::UserOptOut` or `Xip::Errors::InvalidSessionId` errors.
+* [Controllers] `handle_message` and `get_match` now detect homophones for alpha ordinals (A-Z)
+* [Controllers] `handle_message` and `get_match` now ignore single and double quotes for alpha-ordinals
+* [CoreExt] Strings now have a `normalize` method for removing padding and quotes
+* [Controllers] Improved logging when `UnrecognizedMessagesController` runs.
+* [Controllers] State transitions (via `step_to`, `update_session_to`, `step_to_at`, `step_to_in`, and `set_back_to`) now accept a session `slug` argument.
+* [Replies] Added support for sub-state replies. `step_to` can now take a `pos` argument that will force any resulting `send_replies` to be sent starting at the `pos` specified. `pos` can also be negative, for example, `-1` will force `send_replies` to send replies starting at (only) the last reply.
+* [Replies] Dynamic delays are automatically sent before each reply. This can be disabled by setting `Xip.config.auto_insert_delays` to `false`. If a delay is already included, the auto-delay is skipped.
+* [Controllers] `handle_message` now supports `Regexp` keys.
+* [Configuration] `database.yml` is now parsed with ERB in order to support environment variables. Thanks @malkovro.
+* [Replies] Speech and SSML replies now use `speech` and `ssml` as keys, respectively, instead of `text`
+
+## Bug Fixes
+
+* [Catch All] Errors triggered within CatchAlls no longer trigger a CatchAll. They are simply ignored. This prevents infinite looping scenarios.
+* [Interrupt] If CatchAll runs and doesn't `step_to`, it releases the session lock.
+* [Controller] Messages are no longer ignored in CatchAll and Interrupt controllers
+* [Interrupts] After `send_replies`, we now release the session lock. This ensures replies that send buttons can properly receive responses from them.
+* Callbacks specified in child controllers of `BotController` where not being called during `step_to`. While the fix was small, we've bumped the minor release to ensure this fix does not break existing codebases.
+* Fixed another bug loading replies from a `custom_reply` path in `send_replies`
+* Fixed bug loading replies from a `custom_reply` path in `send_replies`
+* Leading dynamic delays in a reply are not sent again on SMS platforms.
+* [Sessions] Sessions retrieved when session expiration was enabled would return as an Array rather than a slug.
+* [Sessions] previous_session now respects session_ttl values.
+* [Catch All] Log output from all catch_all logging now includes the session_id so they can be included in log searches.
+* [NLP] Strip out values from single element arrays in the case of custom LUIS List entities.
+* [Config] Attempting to overwrite default config values with `nil` or `false` now correctly sets those config values.
+
+## Deprecations
+
+* [Controllers] current_user_id has now been completely removed since becoming deprecated in 1.1.0.
+* [Ruby] MRI 2.4 is no longer supported as we depend on ActiveSupport 6.0 now. Rails 6.0 only supports Ruby MRI 2.5+.
+
+# Changelog for Xip v1.1.5
+
+## Enhancements
+
+* [Replies] Replies will now always send the `sender_id` that came in to the service drivers. This ensures `current_session_id` hasn't been modified which would cause replies to fail to send.
+
+# Changelog for Xip v1.1.4
+
+## Bug Fixes
+
+* [General] Fixed controller and model concern load order. Previously files in the concerns folder were not loading before their respective controllers or models causing LoadErrors.
+
+# Changelog for Xip v1.1.3
+
+## Bug Fixes
+
+* [Server] Additional CONTENT_TYPE fixes that would cause the server to 500 when it was missing.
+
+# Changelog for Xip v1.1.2
+
+## Bug Fixes
+
+* [Server] Handle cases where CONTENT_TYPE is missing from incoming requests.
+
+## Enhancements
+
+* [CI] Added Ruby 2.6 to build.
+
+# Changelog for Xip v1.1.1
+
+## Bug Fixes
+
+* [Server] Does not auto-return an HTTP 202. Leaves it up to the drivers again.
+
+# Changelog for Xip v1.1.0
+
+## Breaking Changes
+
+* [Sidekiq] Sidekiq queues have been renamed from `webhooks` and `default` to `xip_webhooks` and `xip_replies`. Please ensure your `Procfile` is adjusted accordingly.
+* [Flows] `flow_map.current_state.fails_to` now returns a `Xip::Session` instead of a `Xip::Flow::State`. This might affect your `catch_alls`.
+
+## Enhancements
+
+* [Controllers] `current_session_id` now references the session ID in controllers
+* [Replies] Added support for dynamic delays
+* [Replies] Added support for service-specific variants
+* [Models] ActiveRecord is now part of the generated bot Gemfile and can be removed from bots
+* [Flows] Added support for `redirects_to` during state declaration. If specified, will automatically step a user to the specified state or session.
+* [Flows] `redirects_to` and `fails_to` now support a session string as an argument (`my_flow->some_state`). This allows you to fail and redirect to other flows. A state name specified as a string or symbol is still allowed.
+* [Errors] Backtraces are now more readable in logs
+* [Sessions] Sessions can now be configured to expire after a specified period of inactivity.
+
+## Bug Fixes
+
+* [Generators] Fixed flow generation
+* [Generators] Fixed sample Facebook services.yml example
+
+## Deprecations
+
+* [Controllers] `current_user_id` has been soft deprecated in favor of `current_session_id`

data/Gemfile

@@ -1,3 +1,6 @@
+source 'https://rubygems.org'
 gemspec
 
-source 'https://rubygems.org'
+platforms :mri do
+  gem 'oj', '~> 3.10'
+end

data/Gemfile.lock

@@ -1,33 +1,83 @@
 PATH
   remote: .
   specs:
-    xip (0.0.1)
-      redis (>= 4.0.2)
+    xip (2.0.0.beta2)
+      activesupport (~> 6.0)
+      multi_json (~> 1.12)
+      puma (>= 4.2, < 5.0)
+      sidekiq (~> 6.0)
+      sinatra (~> 2.0)
+      thor (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.7)
+    connection_pool (2.2.3)
     diff-lcs (1.3)
-    redis (4.2.2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.2)
+    mock_redis (0.23.0)
+    multi_json (1.15.0)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    nio4r (2.5.4)
+    oj (3.10.6)
+    puma (4.3.7)
+      nio4r (~> 2.0)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    redis (4.2.5)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    ruby2_keywords (0.0.2)
+    sidekiq (6.1.2)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      redis (>= 4.2.0)
+    sinatra (2.1.0)
+      mustermann (~> 1.0)
+      rack (~> 2.2)
+      rack-protection (= 2.1.0)
+      tilt (~> 2.0)
+    thor (1.0.1)
+    tilt (2.0.10)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rspec (= 3.8.0)
+  mock_redis (~> 0.22)
+  oj (~> 3.10)
+  rack-test (~> 1.1)
+  rspec (~> 3.9)
+  rspec_junit_formatter (~> 0.3)
   xip!
 
 BUNDLED WITH

data/LICENSE

@@ -1,5 +1,7 @@
-Copyright (c) 2020 Moonbase LLC
+Copyright (c) 2017-2020 Mauricio Gomes
 
-Varsity is an Open Source project licensed under the terms of
-the LGPLv3 license. Please see <http://www.gnu.org/licenses/lgpl-3.0.html>
-for license text.
+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

@@ -1 +1,51 @@
-# Xip
+# <a href='https://xipkit.com'><img src='logo.svg' width='400' alt='Xip Logo' aria-label='xipkit.com' /></a>
+
+Xip is a Ruby framework for creating text and voice chatbots. It's design is inspired by Ruby on Rails's philosophy of convention over configuration. It has an MVC architecture with the slight caveat that `views` are aptly named `replies`.
+
+## Features
+
+* Deploy anywhere, it's just a Rack app
+* Variants allow you to use a single codebase on multiple messaging platforms
+* Structured, universal reply format
+* Sessions utilize a state-machine concept and are Redis backed
+* Highly scalable. Incoming webhooks are processed via a Sidekiq queue
+* Built-in best practices: catch-alls (error handling), hello flows, goodbye flows
+
+## Getting Started
+
+Getting started with Xip is simple:
+
+```
+> gem install xip
+> xip new <bot>
+```
+
+## Service Integrations
+
+Xip is extensible. All service integrations are split out into separate Ruby Gems. Things like analytics and natural language processing ([NLP](https://en.wikipedia.org/wiki/Natural-language_processing)) can be added in as gems as well.
+
+Currently, there are gems for:
+
+### Messaging
+* [Facebook Messenger](https://github.com/xipkit/xip-facebook)
+* [Twilio SMS and Whatsapp](https://github.com/xipkit/xip-twilio)
+
+### Voice
+* [Alexa Skill](https://github.com/xipkit/xip-alexa) (Early alpha)
+* [Custom Voice](https://github.com/xipkit/xip-voice) (Early alpha)
+
+### Natural Language Processing
+* [LUIS](https://github.com/xipkit/xip-luis)
+
+
+## Docs
+
+You can find our full docs [here](https://github.com/xipkit/docs). If something is not clear in the docs, please file an issue! We consider all shortcomings in the docs as bugs.
+
+## Versioning
+
+Xip is versioned using [Semantic Versioning](https://semver.org). Even with major versions, though, we will strive to minimize breaking changes.
+
+## License
+
+Xip is licensed under the MIT license. "Xip" and the Xip Kit logo are Copyright (c) 2020 Mauricio Gomes