stealth 0.10.2 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2f83e4487628f655994dec39aeb5258a3ea025d44a3cac4246f96601ab97ce47
-  data.tar.gz: 5aacfce7dffa452760ec58a2039c02942a7505f8dcc7c86d145b9c7c14f8afbc
+SHA1:
+  metadata.gz: 34868369470ef736c0356793ff7bcc8b9d259cad
+  data.tar.gz: 802522ae820d81e2232408b2b6c5eae400d67642
 SHA512:
-  metadata.gz: 1fbffa4f483f158a5d9bb64ef7ded968467ff923ec59e7dbb330472e8d88a53a96d686af805a37c6124cf9465a7ebe74bef82d22dc65447c65c2e861d1e5e982
-  data.tar.gz: 4addf66269c126893d698b0b42e3ff285d90619ea71b38e36ed45e2ea82641a7504a1b23dd6e948627653ce7bedbffd2a12e8c0f5ed0b08dc5299e671fc46b67
+  metadata.gz: d65b12faa1e3d4f7f6cad7cf36d8e6c31624c5b7229f301549f0db58fb92db438f8a8d9314f1141507acf8b1a41fdaeda036bb947b4ae623f02da3a12006f42e
+  data.tar.gz: 13bbf47471bf4fcdf2ae4c7c29d0393e8d8d3492ed355db6e1315004dc778ce8695a692ddef5601dfd6b51326239009896b26984e80f5947f588b830f72dc9a1

data/.circleci/config.yml

@@ -1,20 +1,59 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
 version: 2
+
 jobs:
-  build:
+  ruby_2_4:
     docker:
-      # specify the version you desire here
-       - image: circleci/ruby:2.4.1-node-browsers
-         environment:
-           STEALTH_ENV: test
+      - image: circleci/ruby:2.4-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: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
 
-      # Specify service dependencies here if necessary
-      # CircleCI maintains a library of pre-built images
-      # documented at https://circleci.com/docs/2.0/circleci-images/
-      # - image: circleci/postgres:9.4
+      - 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_5:
+    docker:
+      - image: circleci/ruby:2.5-node-browsers
+        environment:
+          STEALTH_ENV: test
 
     working_directory: ~/repo
 
@@ -58,3 +97,10 @@ jobs:
       - store_artifacts:
           path: /tmp/test-results
           destination: test-results
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - ruby_2_4
+      - ruby_2_5

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     stealth (0.10.2)
-      activesupport (~> 5.1)
+      activesupport (~> 5.2.0.rc1)
       multi_json (~> 1.12)
       puma (~> 3.10)
       sidekiq (~> 5.0)
@@ -12,7 +12,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.2.0.rc1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -20,14 +20,14 @@ GEM
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
     diff-lcs (1.3)
-    i18n (0.9.1)
+    i18n (0.9.3)
       concurrent-ruby (~> 1.0)
-    minitest (5.10.3)
+    minitest (5.11.3)
     mock_redis (0.17.3)
-    multi_json (1.12.2)
+    multi_json (1.13.1)
     mustermann (1.0.1)
     oj (3.3.6)
-    puma (3.11.0)
+    puma (3.11.2)
     rack (2.0.3)
     rack-protection (2.0.0)
       rack
@@ -49,7 +49,7 @@ GEM
     rspec-support (3.6.0)
     rspec_junit_formatter (0.3.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    sidekiq (5.0.5)
+    sidekiq (5.1.0)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
@@ -62,7 +62,7 @@ GEM
     thor (0.20.0)
     thread_safe (0.3.6)
     tilt (2.0.8)
-    tzinfo (1.2.4)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS

data/VERSION

@@ -1 +1 @@
-0.10.2
+0.10.3

data/lib/stealth/base.rb

@@ -21,6 +21,7 @@ require 'stealth/service_message'
 require 'stealth/session'
 require 'stealth/controller/callbacks'
 require 'stealth/controller/catch_all'
+require 'stealth/controller/helpers'
 require 'stealth/controller/controller'
 require 'stealth/flow/base'
 require 'stealth/services/base_client'

data/lib/stealth/cli.rb

@@ -78,5 +78,17 @@ module Stealth
       service_setup_klass = "Stealth::Services::#{service.classify}::Setup".constantize
       service_setup_klass.trigger
     end
+
+
+    desc 'clear_sessions', 'Clears all sessions in development'
+    long_desc <<-EOS
+    `stealth clear_sessions` clears all sessions from Redis in development.
+
+    $ > stealth clear_sessions
+    EOS
+    def clear_sessions
+      Stealth.load_environment
+      $redis.flushdb if ENV['STEALTH_ENV'] == 'development'
+    end
   end
 end

data/lib/stealth/controller/controller.rb

@@ -6,6 +6,7 @@ module Stealth
 
     include Stealth::Controller::Callbacks
     include Stealth::Controller::CatchAll
+    include Stealth::Controller::Helpers
 
     attr_reader :current_message, :current_user_id, :current_flow,
                 :current_service, :flow_controller, :action_name
@@ -92,6 +93,7 @@ module Stealth
           flow_controller.send(@action_name)
           run_catch_all(reason: 'Did not send replies, update session, or step') unless flow_controller.progressed?
         rescue StandardError => e
+          Stealth::Logger.l(topic: "catch_all", message: e.backtrace)
           run_catch_all(reason: e.message)
         end
       end

data/lib/stealth/controller/helpers.rb

@@ -0,0 +1,126 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require "active_support/dependencies"
+
+module Stealth
+  class Controller
+    module Helpers
+
+      extend ActiveSupport::Concern
+
+      class MissingHelperError < LoadError
+        def initialize(error, path)
+          @error = error
+          @path  = "helpers/#{path}.rb"
+          set_backtrace error.backtrace
+
+          if error.path =~ /^#{path}(\.rb)?$/
+            super("Missing helper file helpers/%s.rb" % path)
+          else
+            raise error
+          end
+        end
+      end
+
+      # class << self; attr_accessor :helpers_path; end
+
+      included do
+        class_attribute :_helpers, default: Module.new
+        class_attribute :helpers_path, default: []
+        class_attribute :include_all_helpers, default: true
+      end
+
+      class_methods do
+        # When a class is inherited, wrap its helper module in a new module.
+        # This ensures that the parent class's module can be changed
+        # independently of the child class's.
+        def inherited(subclass)
+          helpers = _helpers
+          subclass._helpers = Module.new { include helpers }
+
+          if subclass.superclass == Stealth::Controller && Stealth::Controller.include_all_helpers
+            subclass.helper :all
+          else
+            subclass.class_eval { default_helper_module! } unless subclass.anonymous?
+          end
+
+          include subclass._helpers
+
+          super
+        end
+
+        def modules_for_helpers(args)
+          # Allow all helpers to be included
+          args += all_bot_helpers if args.delete(:all)
+
+          args.flatten.map! do |arg|
+            case arg
+            when String, Symbol
+              file_name = "#{arg.to_s.underscore}_helper"
+              begin
+                require_dependency(file_name)
+              rescue LoadError => e
+                raise Stealth::Controller::Helpers::MissingHelperError.new(e, file_name)
+              end
+
+              mod_name = file_name.camelize
+              begin
+                mod_name.constantize
+              rescue LoadError
+                raise NameError, "Couldn't find #{mod_name}, expected it to be defined in helpers/#{file_name}.rb"
+              end
+            when Module
+              arg
+            else
+              raise ArgumentError, "helper must be a String, Symbol, or Module"
+            end
+          end
+        end
+
+        def helper(*args, &block)
+          modules_for_helpers(args).each do |mod|
+            add_template_helper(mod)
+          end
+
+          _helpers.module_eval(&block) if block_given?
+        end
+
+        def default_helper_module!
+          module_name = name.sub(/Controller$/, "".freeze)
+          module_path = module_name.underscore
+          helper module_path
+        rescue LoadError => e
+          raise e unless e.is_missing? "helpers/#{module_path}_helper"
+        rescue NameError => e
+          raise e unless e.missing_name? "#{module_name}Helper"
+        end
+
+        # Returns a list of helper names in a given path.
+        #
+        #   Stealth::Controller.all_helpers_from_path 'bot/helpers'
+        #   # => ["bot", "estimates", "tickets"]
+        def all_helpers_from_path(path)
+          helpers = Array(path).flat_map do |_path|
+            extract = /^#{Regexp.quote(_path.to_s)}\/?(.*)_helper.rb$/
+            names = Dir["#{_path}/**/*_helper.rb"].map { |file| file.sub(extract, '\1'.freeze) }
+            names.sort!
+          end
+          helpers.uniq!
+          helpers
+        end
+
+        private
+          def add_template_helper(mod)
+            _helpers.module_eval { include mod }
+          end
+
+          # Extract helper names from files in "bot/helpers/**/*_helper.rb"
+          def all_bot_helpers
+            all_helpers_from_path(helpers_path)
+          end
+      end
+
+    end
+  end
+end

data/lib/stealth/logger.rb

@@ -5,7 +5,9 @@ module Stealth
   class Logger
 
     def self.log(topic:, message:)
-      puts "[#{topic.upcase}] #{message}"
+      unless ENV['STEALTH_ENV'] == 'test'
+        puts "[#{topic.upcase}] #{message}"
+      end
     end
 
     class << self

data/spec/configuration_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')

data/spec/controller/callbacks_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', '/spec_helper'))

data/spec/controller/helpers_spec.rb

@@ -0,0 +1,94 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '/spec_helper'))
+
+$:.unshift File.expand_path("../support/helpers", __dir__)
+
+describe "Stealth::Controller helpers" do
+
+  Stealth::Controller.helpers_path = File.expand_path("../support/helpers", __dir__)
+
+  module Fun
+    class GamesController < Stealth::Controller
+      helper :all
+
+      def say_hello_world
+        hello_world
+      end
+    end
+
+    class PdfController < Stealth::Controller
+      def say_pdf_name
+        generate_pdf_name
+      end
+    end
+  end
+
+  class BaseController < Stealth::Controller
+
+  end
+
+  class AllHelpersController < Stealth::Controller
+    helper :all
+  end
+
+  class SizzleController < Stealth::Controller
+    helper :standalone
+
+    def say_sizzle
+
+    end
+  end
+
+  class HelpersTypoController < Stealth::Controller
+    path = File.expand_path("../support/helpers_typo", __dir__)
+    $:.unshift(path)
+    self.helpers_path = path
+  end
+
+  class VoodooController < Stealth::Controller
+    helpers_path = File.expand_path("../support/alternate_helpers", __dir__)
+
+    # Reload helpers
+    _helpers = Module.new
+    helper :all
+
+    def zoom
+
+    end
+  end
+
+  let(:facebook_message) { SampleMessage.new(service: 'facebook') }
+  let(:all_helper_methods) { [:hello_world, :baz, :generate_pdf_name] }
+
+  describe "loading" do
+
+    it "should load all helpers if none are specified by default" do
+      expect(BaseController._helpers.instance_methods).to match_array(all_helper_methods)
+    end
+
+    it "should not load helpers if none are specified by default and include_all_helpers = false" do
+      Stealth::Controller.include_all_helpers = false
+      class HelperlessController < Stealth::Controller; end
+      expect(HelperlessController._helpers.instance_methods).to eq []
+    end
+
+    it "should load all helpers if :all is used" do
+      expect(AllHelpersController._helpers.instance_methods).to match_array(all_helper_methods)
+    end
+
+    it "should allow a controller that has loaded all helpers to access a helper method" do
+      expect {
+        Fun::GamesController.new(service_message: facebook_message.message_with_text).say_hello_world
+      }.to_not raise_error
+    end
+
+    it "should allow a controller action to access a helper method" do
+      expect {
+        Fun::PdfController.new(service_message: facebook_message.message_with_text).say_pdf_name
+      }.to_not raise_error
+    end
+  end
+
+end

data/spec/controller/state_transitions_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.join(File.dirname(__FILE__), '..', '/spec_helper'))

data/spec/flow/flow_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/flow/state_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')

data/spec/service_reply_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')

data/spec/session_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
@@ -12,5 +15,5 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 $redis = MockRedis.new
 
 RSpec.configure do |config|
-
+  ENV['STEALTH_ENV'] = 'test'
 end

data/spec/support/alternate_helpers/foo_helper.rb

@@ -0,0 +1,5 @@
+module FooHelper
+  def foo
+
+  end
+end

data/spec/support/helpers/fun/games_helper.rb

@@ -0,0 +1,7 @@
+module Fun
+  module GamesHelper
+    def hello_world
+
+    end
+  end
+end

data/spec/support/helpers/fun/pdf_helper.rb

@@ -0,0 +1,7 @@
+module Fun
+  module PdfHelper
+    def generate_pdf_name
+
+    end
+  end
+end

data/spec/support/helpers/standalone_helper.rb

@@ -0,0 +1,5 @@
+module StandaloneHelper
+  def baz
+
+  end
+end

data/spec/support/helpers_typo/users_helper.rb

@@ -0,0 +1,2 @@
+module UsersHelpeR
+end

data/spec/support/sample_messages.rb

@@ -1,3 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
 class SampleMessage
 
   def initialize(service:)

data/spec/version_spec.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 # frozen_string_literal: true
 
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')

data/stealth.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'thor', '~> 0.20'
   s.add_dependency 'multi_json', '~> 1.12'
   s.add_dependency 'sidekiq', '~> 5.0'
-  s.add_dependency 'activesupport', '~> 5.1'
+  s.add_dependency 'activesupport', '~> 5.2.0.rc1'
 
   s.add_development_dependency 'rspec', '~> 3.6'
   s.add_development_dependency 'rspec_junit_formatter', '~> 0.3'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.3
 platform: ruby
 authors:
 - Mauricio Gomes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-10 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 5.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: 5.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +176,7 @@ files:
 - lib/stealth/controller/callbacks.rb
 - lib/stealth/controller/catch_all.rb
 - lib/stealth/controller/controller.rb
+- lib/stealth/controller/helpers.rb
 - lib/stealth/dispatcher.rb
 - lib/stealth/errors.rb
 - lib/stealth/flow/base.rb
@@ -197,6 +198,7 @@ files:
 - lib/stealth/version.rb
 - spec/configuration_spec.rb
 - spec/controller/callbacks_spec.rb
+- spec/controller/helpers_spec.rb
 - spec/controller/state_transitions_spec.rb
 - spec/flow/flow_spec.rb
 - spec/flow/state_spec.rb
@@ -204,6 +206,11 @@ files:
 - spec/service_reply_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
+- spec/support/alternate_helpers/foo_helper.rb
+- spec/support/helpers/fun/games_helper.rb
+- spec/support/helpers/fun/pdf_helper.rb
+- spec/support/helpers/standalone_helper.rb
+- spec/support/helpers_typo/users_helper.rb
 - spec/support/sample_messages.rb
 - spec/support/services.yml
 - spec/support/services_with_erb.yml
@@ -229,13 +236,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Ruby framework for conversational bots
 test_files:
 - spec/configuration_spec.rb
 - spec/controller/callbacks_spec.rb
+- spec/controller/helpers_spec.rb
 - spec/controller/state_transitions_spec.rb
 - spec/flow/flow_spec.rb
 - spec/flow/state_spec.rb
@@ -243,6 +251,11 @@ test_files:
 - spec/service_reply_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
+- spec/support/alternate_helpers/foo_helper.rb
+- spec/support/helpers/fun/games_helper.rb
+- spec/support/helpers/fun/pdf_helper.rb
+- spec/support/helpers/standalone_helper.rb
+- spec/support/helpers_typo/users_helper.rb
 - spec/support/sample_messages.rb
 - spec/support/services.yml
 - spec/support/services_with_erb.yml