socrates 0.1.18 → 0.1.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 67a86f6c23427a17a1271fc44b51b656b7e3e8c6
-  data.tar.gz: 331e7f16f68d78ca66490fc985861418cc891bf0
+SHA256:
+  metadata.gz: e648a9ac94de0a6fd27a051b478618c505f7027541eaa38e40677e555c22fc1a
+  data.tar.gz: '094d6680aefa6c2c5b64a667775c29069c9f95e9aaf953ebfcaefed5bbafef39'
 SHA512:
-  metadata.gz: c8445176b8a001cbe6957e23f9e4f4909f376439d9cc0aa045a5f23ecfbeccd850331c1f31313f8a12987222ab8f70900d2bf0a2fd472b6b62b0c0c63a0aeee2
-  data.tar.gz: ff3aeced1731694a2fe660658c83c24f2e21db08755531a64639046e66ab39ad2190c0796d27af612547a5793646ce0345f0441fb15c4d2070437f911c8b0907
+  metadata.gz: 2e7e0ee90d0486f5a325fce2889b99f9739b76fd45696577ca3e999f18250d2f4155bc46fb8d324eadeff0d986e65a6809c6baa31d0a2bd07fbe9938a0a148dc
+  data.tar.gz: f8b3c910975023e89e05216eea0b05eb24d17f2af4de933d736ab40f3662ed841e3fef53224076edac5f6e5f2a1c8d160290781e96890a620f1632e0ebb90f5d

data/.rubocop.yml

@@ -3,3 +3,6 @@ inherit_from:
 
 AllCops:
   TargetRubyVersion: 2.4
+
+Naming/UncommunicativeMethodParamName:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.4.2
+2.5.0

data/circle.yml

@@ -1,3 +1,7 @@
+dependencies:
+  pre:
+    - gem update --system
+
 test:
   post:
     - bundle exec rubocop

data/exe/socrates

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-File.expand_path("../../lib", __FILE__).tap do |lib|
+File.expand_path("../lib", __dir__).tap do |lib|
   $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 end
 

data/lib/socrates/configuration.rb

@@ -17,12 +17,14 @@ module Socrates
     attr_accessor :error_message
     attr_accessor :expired_timeout # seconds
     attr_accessor :logger
+    attr_accessor :error_handler   # a callable proc
 
     def initialize
       @storage         = Storage::Memory.new
       @error_message   = "Sorry, something went wrong. We'll have to start over..."
       @expired_timeout = 30.minutes
       @logger          = Socrates::Logger.default
+      @error_handler   = proc { |_message, _error| }
     end
   end
 end

data/lib/socrates/core/dispatcher.rb

@@ -18,6 +18,7 @@ module Socrates
         @storage       = storage || Socrates.config.storage
 
         @logger        = Socrates.config.logger
+        @error_handler = Socrates.config.error_handler
         @error_message = Socrates.config.error_message || DEFAULT_ERROR_MESSAGE
       end
 
@@ -41,7 +42,7 @@ module Socrates
         # return false unless conversation_state(user).nil?
 
         # Create state data to match the request.
-        state_data = Socrates::Core::StateData.new(state_id: state_id, state_action: :ask)
+        state_data = StateData.new(state_id: state_id, state_action: :ask)
 
         persist_state_data(session.client_id, state_data)
 
@@ -57,15 +58,8 @@ module Socrates
 
         return nil unless @storage.has_key?(client_id)
 
-        begin
-          snapshot   = @storage.get(client_id)
-          state_data = StateData.deserialize(snapshot)
-          state_data = nil if state_data.expired? || state_data.finished?
-        rescue StandardError => e
-          @logger.warn "Error while fetching state_data for client id '#{client_id}'."
-          @logger.warn e
-          state_data = nil
-        end
+        state_data = @storage.fetch(client_id)
+        state_data = nil if state_data&.expired? || state_data&.finished?
 
         state_data
       end
@@ -119,17 +113,7 @@ module Socrates
 
       # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
       def fetch_state_data(client_id)
-        if @storage.has_key?(client_id)
-          begin
-            snapshot   = @storage.get(client_id)
-            state_data = StateData.deserialize(snapshot)
-          rescue StandardError => e
-            @logger.warn "Error while fetching state_data for client id '#{client_id}', resetting state: #{e.message}"
-            @logger.warn e
-          end
-        end
-
-        state_data ||= StateData.new
+        state_data = @storage.fetch(client_id) || StateData.new
 
         # If the current state is nil or END_OF_CONVERSATION, set it to the default state, which is typically a state
         # that waits for an initial command or input from the user (e.g. help, start, etc).
@@ -152,8 +136,7 @@ module Socrates
       # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
       def persist_state_data(client_id, state_data)
-        state_data.reset_elapsed_time
-        @storage.put(client_id, state_data.serialize)
+        @storage.persist(client_id, state_data)
       end
 
       def instantiate_state(session, state_data)
@@ -168,9 +151,12 @@ module Socrates
         state.data.state_id.nil? || state.data.state_id == StateData::END_OF_CONVERSATION
       end
 
-      def handle_action_error(e, session, state)
-        @logger.warn "Error while processing action #{state.data.state_id}/#{state.data.state_action}: #{e.message}"
-        @logger.warn e
+      def handle_action_error(error, session, state)
+        msg = "Error while processing action #{state.data.state_id}/#{state.data.state_action}: #{error.message}"
+        @logger.warn msg
+        @logger.warn error
+
+        @error_handler.call(msg, error) if @error_handler.present?
 
         @adapter.queue_message(session, @error_message, send_now: true)
 

data/lib/socrates/logger.rb

@@ -3,7 +3,7 @@ require "logger"
 module Socrates
   class Logger < ::Logger
     def self.default
-      @logger ||= begin
+      @default ||= begin
         logger       = new(STDOUT)
         logger.level = Logger::WARN
         logger

data/lib/socrates/storage/memory.rb

@@ -1,6 +1,10 @@
+require "socrates/storage/storage"
+
 module Socrates
   module Storage
     class Memory
+      include Socrates::Storage::Storage
+
       def initialize
         @memory = {}
       end

data/lib/socrates/storage/redis.rb

@@ -1,8 +1,12 @@
 require "redis"
 
+require "socrates/storage/storage"
+
 module Socrates
   module Storage
     class Redis
+      include Socrates::Storage::Storage
+
       def initialize(url: "redis://localhost")
         @redis = ::Redis.new(url: url)
       end

data/lib/socrates/storage/storage.rb

@@ -0,0 +1,60 @@
+require "socrates/core/state_data"
+
+module Socrates
+  module Storage
+    module Storage
+      def initialize
+        @logger = Socrates.config.logger
+      end
+
+      def fetch(client_id)
+        key = generate_key(client_id)
+
+        snapshot = get(key)
+
+        return if snapshot.nil?
+
+        begin
+          Socrates::Core::StateData.deserialize(snapshot)
+        rescue StandardError => e
+          @logger.warn "Error while fetching state_data for client id '#{client_id}', resetting state: #{e.message}"
+          @logger.warn e
+        end
+      end
+
+      def persist(client_id, state_data)
+        key = generate_key(client_id)
+        state_data.reset_elapsed_time
+        put(key, state_data.serialize)
+      end
+
+      def generate_key(client_id)
+        client_id
+      end
+
+      # rubocop:disable Lint/UnusedMethodArgument
+
+      def has_key?(key)
+        raise NotImplementedError
+      end
+
+      def clear(key)
+        raise NotImplementedError
+      end
+
+      def get(key)
+        raise NotImplementedError
+      end
+
+      def put(key, value)
+        raise NotImplementedError
+      end
+
+      def clear_all
+        raise NotImplementedError
+      end
+
+      # rubocop:enable Lint/UnusedMethodArgument
+    end
+  end
+end

data/lib/socrates/version.rb

@@ -1,3 +1,3 @@
 module Socrates
-  VERSION = "0.1.18"
+  VERSION = "0.1.19"
 end

data/socrates.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "socrates/version"
@@ -21,17 +21,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.3.0"
+  spec.required_ruby_version = ">= 2.4.0"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "rake", "~> 12.1"
-  spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 0.50.0"
-  spec.add_development_dependency "timecop", "~> 0.9.1"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "rubocop", "~> 0.52"
+  spec.add_development_dependency "timecop", "~> 0.9"
 
   spec.add_dependency "activesupport", ">= 5.1.4"
   spec.add_dependency "celluloid-io", ">= 0.17.3"
-  spec.add_dependency "hashie", ">= 3.5.6"
-  spec.add_dependency "redis", ">= 4.0.0"
-  spec.add_dependency "slack-ruby-client", ">= 0.9.1"
+  spec.add_dependency "hashie", ">= 3.5.7"
+  spec.add_dependency "redis", ">= 4.0.1"
+  spec.add_dependency "slack-ruby-client", ">= 0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: socrates
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.1.19
 platform: ruby
 authors:
 - Christian Nelson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-19 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,70 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.1'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '0.52'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: '0.52'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.6
+        version: 3.5.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.6
+        version: 3.5.7
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: slack-ruby-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.11.0
 description: 
 email:
 - christian@carbonfive.com
@@ -186,6 +186,7 @@ files:
 - lib/socrates/sample_states.rb
 - lib/socrates/storage/memory.rb
 - lib/socrates/storage/redis.rb
+- lib/socrates/storage/storage.rb
 - lib/socrates/string_helpers.rb
 - lib/socrates/version.rb
 - sample-conversation-console.gif
@@ -202,7 +203,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -210,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A micro-framework for building stateful conversational bots.