botkit 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73e5a8a7c044af180f0481945c11201c5e591c1c
-  data.tar.gz: 76423a8943d97de8c626b43ce0d6c765d263c0c6
+  metadata.gz: 5b00abfa24e03a260c60bd3543f02c2956d6395d
+  data.tar.gz: 78ad1d3fc8b22654db3593156386519322947bc2
 SHA512:
-  metadata.gz: 3328ca6512d7a8b0981c30716f17c582ee3b4b2a93f87db5e5d563c977c8ba349c64233d0ba2a45f7b0579ada1531936912b672373b19dfec0d17a0a288a8d5c
-  data.tar.gz: ede718d33abc2c9351bc0d7993a797ca636391d5edd39d82a2fbe4fda95d0cfa6c2a389ab4cd00a9f6d2957f3fddb8ff8fe1dd422b7c29bc7356db2a39375b01
+  metadata.gz: e29a2fbbb1b2f05ef552781bde751590527206445f98da851bd818bc7fed9eed836452f7dab325b69df184cfd7b1264b62900864db8fea80734383e3da0e69ab
+  data.tar.gz: 441dd448f09aaaaee8e1b2e4606a8ced8150c41f7309c954c56acfd20473079027e99f045fce4be342b395518c9484144810b3be6c7b1828b8fd156f081b35b0

data/.rubocop.yml

@@ -0,0 +1,116 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+Metrics/LineLength:
+  Max: 80
+
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Style/PerlBackrefs:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Encoding:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+OneLineConditional:
+  Enabled: false
+
+ParameterLists:
+  Enabled: false
+
+Proc:
+  Enabled: false
+
+SingleLineBlockParams:
+  Enabled: false
+
+VariableInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInLiteral:
+  Enabled: false
+
+WhileUntilModifier:
+  Enabled: false
+
+PredicateName:
+  NamePrefixBlacklist:
+    - is_
+
+StringLiterals:
+  EnforcedStyle: double_quotes
+
+DotPosition:
+  EnforcedStyle: leading
+
+SpaceBeforeBlockBraces:
+  EnforcedStyle: space
+
+SpaceInsideBlockBraces:
+  EnforcedStyle: no_space
+
+DoubleNegation:
+  Enabled: false
+
+SpaceInsideBlockBraces:
+  SpaceBeforeBlockParameters: false
+
+SpaceInsideHashLiteralBraces:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  '{}'
+    '%i': '{}'
+    '%q': '{}'
+    '%Q': '{}'
+    '%r': '{}'
+    '%s': '{}'
+    '%w': '{}'
+    '%W': '{}'
+    '%x': '{}'
+
+Style/CollectionMethods:
+  PreferredMethods:
+    collect: 'map'
+    collect!: 'map!'
+    inject: 'reduce'
+    detect: 'find'
+    find_all: 'select'

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    botkit (0.0.1)
+      aitch
+      signal
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aitch (1.0.2)
+      nokogiri (>= 1.6.0)
+    docile (1.1.5)
+    json (2.1.0)
+    metaclass (0.0.4)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    minitest-utils (0.4.0)
+      minitest
+    mocha (1.3.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    rake (12.2.1)
+    signal (1.1.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  botkit!
+  bundler
+  minitest-utils
+  mocha
+  rake
+  simplecov
+
+BUNDLED WITH
+   1.16.0

data/botkit.gemspec

@@ -20,7 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "aitch"
+  spec.add_dependency "signal"
+
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "mocha"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
 end

data/lib/botkit.rb

@@ -1,6 +1,15 @@
 # frozen_string_literal: true
 
-require "botkit/version"
-
 module Botkit
+  require "aitch"
+  require "signal"
+
+  require "botkit/version"
+  require "botkit/runner"
+  require "botkit/message"
+  require "botkit/bot"
+
+  def self.run(bot, **kwargs)
+    Runner.new(bot, **kwargs).call
+  end
 end

data/lib/botkit/bot.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Botkit
+  class Bot
+    include Signal
+
+    # When setting `bot.halt = true`, the bot will be halted
+    # after the current loop.
+    attr_writer :halt
+
+    # Detect if bot should halt himself from the loop.
+    def halt?
+      @halt
+    end
+
+    def call
+    end
+
+    def send_message(message)
+    end
+
+    def reply_message(_message, reply)
+      send_message(reply)
+    end
+
+    def handle_incoming_message(message)
+      if message.command?
+        emit("command:#{message.command}", message)
+      else
+        emit("internal:message", message)
+      end
+    end
+
+    def parse_message(input, matcher = nil)
+      input = input.to_s
+      _, command, text = *input.match(%r{\A/([^ ]+)(?:\s+(.*?))\z})
+      matches = text.to_s.match(matcher) if matcher
+
+      {
+        command: command,
+        text: text || input,
+        matches: matches&.named_captures
+      }
+    end
+
+    def command(name, &block)
+      on("command:#{name}", &block)
+    end
+
+    def message(&block)
+      on("internal:message", &block)
+    end
+
+    def exception(&block)
+      on("internal:exception", &block)
+    end
+
+    def report_exception(exception)
+      emit("internal:exception", exception)
+    end
+  end
+end

data/lib/botkit/message.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Botkit
+  class Message
+    attr_reader :text, :command, :matches, :raw, :options, :channel_id
+
+    def initialize(text:, raw: {}, channel_id: nil, command: nil, matches: nil, options: {})
+      @text = text
+      @command = command
+      @raw = raw
+      @channel_id = channel_id
+      @options = options
+      @matches = matches
+    end
+
+    def command?
+      command
+    end
+  end
+end

data/lib/botkit/runner.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Botkit
+  class Runner
+    attr_reader :bot, :polling
+
+    def initialize(bot, polling: 1)
+      @bot = bot
+      @polling = polling
+    end
+
+    def call
+      loop do
+        next_tick
+        break if bot.halt?
+        sleep(polling)
+      end
+    end
+
+    private def next_tick
+      bot.call
+    rescue StandardError => exception
+      bot.report_exception(exception)
+    end
+  end
+end

data/lib/botkit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Botkit
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: botkit
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: aitch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: signal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple chatbot framework
 email:
 - fnando.vieira@gmail.com
@@ -60,9 +116,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -70,6 +128,9 @@ files:
 - bin/setup
 - botkit.gemspec
 - lib/botkit.rb
+- lib/botkit/bot.rb
+- lib/botkit/message.rb
+- lib/botkit/runner.rb
 - lib/botkit/version.rb
 homepage: https://rubygems.org/gems/botkit
 licenses: