bot_framework 0.1.0beta → 0.1.0beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: affe51df6b475a675f090f4130ced19a0f2ff6c9
-  data.tar.gz: 053aa8a5ace3a3fbd89fbe8ddb61d9ea168786f0
+  metadata.gz: 1c07215bb82060edbbd21768944bfb0ec1ff09e7
+  data.tar.gz: c6a1f2a54951dbda6a127986d4dd258aba8054c4
 SHA512:
-  metadata.gz: d07903a48bc1036bb7f1e3c8960d7fd9d24ef5face9fccc1975e66e6ec1090f078e7425e718d5f6f8c91eb1d3db5b031035a6deb506a3af2feb57b0e6aa7dce3
-  data.tar.gz: b639f369042b2b8ccc98ea589cb1a29018e767f1ce2572755c4c2ab7eda79c0dc78f96f39ec1dfc82abcdcd1a4857260fc12581a9be6fff1c62c26b7f009ee5d
+  metadata.gz: 809d65ce001086add7ebc2d998d2610b59989cd6799b5ed9813c6149b5dc2db8ddc75b0c7a35bb326d5bcc6a7f3c0a38d0f09a244e658eecd38f2bef22dc2c8f
+  data.tar.gz: a3939ddc90d7d1473ccbdb43ef4d00f867e6e56fb3623bf7a59456065a03e0d21a7c657dd769b14c9ff207a5530bf0bb389684cfc4ce8ad3eb1a68cdba97bf12

data/.travis.yml

@@ -2,4 +2,7 @@ sudo: false
 language: ruby
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 1.12.5
+  - 2.4.0
+  - 2.4.1
+before_install: gem install bundler
+script: bundle exec rspec spec

data/README.md

@@ -1,5 +1,8 @@
 # BotFramework
 
+[![Build Status](https://travis-ci.org/tachyons/botframework-ruby.svg?branch=master)](https://travis-ci.org/tachyons/botframework-ruby)
+[![Build status](https://ci.appveyor.com/api/projects/status/fdbwdbvv3viswwec?svg=true)](https://ci.appveyor.com/project/tachyons/botframework-ruby)
+
 Ruby client to make statefull bots using microsoft botframework . Currently under development , don't try this in under production till v1.0
 
 ## Installation
@@ -43,6 +46,16 @@ end
 
 ```
 
+## Emulator
+
+You can use botframework emulator for testing your bot in local system.
+* Download https://github.com/Microsoft/BotFramework-Emulator
+* run `rackup` in the bot directory
+* Give url(default url for rackup is `localhost:9292`) and botframework credentials in the emulator
+
+![emulator1](images/emulator1.png)
+![emulator2](images/emulator2.png)
+
 ## 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.
@@ -51,7 +64,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tachyons/bot_framework. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tachyons/botframework-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/appveyor.yml

@@ -0,0 +1,20 @@
+version: '{build}'
+
+skip_tags: true
+
+environment:
+  matrix:
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - gem install bundler --no-document -v 1.14.6
+  - bundle install --retry=3
+
+test_script:
+  - bundle exec rake
+
+build: off

data/bot_framework.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.2.0'
 
   spec.add_development_dependency 'bundler', '~> 1.12'
   spec.add_development_dependency 'rake', '~> 10.0'
@@ -28,4 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'jwt'
   spec.add_dependency 'httparty'
   spec.add_dependency 'rack'
+  spec.add_dependency 'timers'
+  spec.add_dependency 'rb-readline'
+  spec.add_dependency 'chronic'
+  spec.add_dependency 'chronic_duration'
+  spec.add_dependency 'nio4r'
 end

data/examples/dialog/basic_first_run.rb

@@ -0,0 +1,12 @@
+require 'pry'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bot_framework'
+require 'bot_framework/console_connector'
+require 'bot_framework/universal_bot'
+# Setup bot and root message handler
+include BotFramework
+
+connector = ConsoleConnector.new.listen
+bot = UniversalBot.new(connector, lambda do |session|
+  session.send("You said #{session.message.text}")
+end)

data/examples/ruby_conf/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+ruby '2.4.0'
+
+gem 'puma'
+gem 'pry'
+gem 'luis', github: 'tachyons/luis', branch: 'master'
+gem 'bot_framework', github: 'tachyons/botframework-ruby', branch: 'master'
+gem 'bmtc', github: 'tachyons/bmtc', branch: 'master'

data/examples/ruby_conf/Gemfile.lock

@@ -0,0 +1,85 @@
+GIT
+  remote: git://github.com/tachyons/bmtc.git
+  revision: 9d258bf430469611f7c14a0f66badf65286dc6b4
+  branch: master
+  specs:
+    bmtc (0.1.2)
+      httparty
+      json
+
+GIT
+  remote: git://github.com/tachyons/botframework-ruby.git
+  revision: 6970d4c6d2fe9c13e2425194dbc2b47627e35f5e
+  branch: master
+  specs:
+    bot_framework (0.1.0beta)
+      chronic
+      chronic_duration
+      httparty
+      jwt
+      nio4r
+      oauth2
+      rack
+      rb-readline
+      timers
+
+GIT
+  remote: git://github.com/tachyons/luis.git
+  revision: 3bbb3c08b6e915ef0674ae6e4c4dda6df4920c46
+  branch: master
+  specs:
+    luis (0.1.1beta)
+      httparty
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chronic (0.10.2)
+    chronic_duration (0.10.6)
+      numerizer (~> 0.1.1)
+    coderay (1.1.1)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    hitimes (1.2.4)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    json (2.1.0)
+    jwt (1.5.6)
+    method_source (0.8.2)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nio4r (2.0.0)
+    numerizer (0.1.1)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    puma (3.8.2)
+    rack (2.0.1)
+    rb-readline (0.5.4)
+    slop (3.6.0)
+    timers (4.1.2)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bmtc!
+  bot_framework!
+  luis!
+  pry
+  puma
+
+RUBY VERSION
+   ruby 2.4.0p0
+
+BUNDLED WITH
+   1.14.6

data/examples/ruby_conf/bot.rb

@@ -0,0 +1,88 @@
+
+BotFramework.configure do |connector|
+  connector.app_id = ENV['RUBY_CONF_MICROSOFT_APP_ID']
+  connector.app_secret = ENV['RUBY_CONF_MICROSOFT_APP_PASSWORD']
+end
+
+SPEAKER_DATA = YAML.load_file('speaker_data.yaml')
+RUBY_CONF_DATA = {
+  'when'=> 'Jan 27, 28, 29',
+  'where' => 'Kochi',
+  'venue' => 'Le Méridien Kochi',
+  'organisers' => 'Emerging technology trust',
+  'website' => 'http://rubyconfindia.org/'
+}
+
+BotFramework::Bot.recognizer = BotFramework::Dialogs::LuisRecognizer.new('https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/f5104c51-8adc-4846-ba86-058ee25d88b2?subscription-key=d670862831e046c9bf1d8e9b0c485df2&q=')
+
+BotFramework::Bot.on :activity do |activity|
+  # All activities
+end
+
+BotFramework::Bot.on :message do |activity|
+  # Call back for messages
+end
+
+BotFramework::Bot.on :ping do |activity|
+  # Callback for pings
+end
+
+BotFramework::Bot.on :typing do |activity|
+  # Callback for typing
+end
+def speaker_data(activity, entities, field)
+  speaker = BotFramework::Dialogs::EntityRecognizer.find_entity(entities, 'speaker')
+  speaker ||= conversation_data(activity)['speaker']
+  if speaker && (SPEAKER_DATA[speaker[:entity]] || SPEAKER_DATA[speaker['entity']])
+    set_conversation_data(activity, speaker: speaker)
+    (SPEAKER_DATA[speaker[:entity]] || SPEAKER_DATA[speaker['entity']])[field]
+  elsif speaker
+    "Unable to find the speaker #{speaker[:entity]}"
+  else
+    'Could not find the speaker'
+  end
+end
+
+BotFramework::Bot.on_intent 'speakerList' do |activity, _intents|
+  reply(activity, SPEAKER_DATA.keys.map(&:capitalize).join(','))
+end
+
+BotFramework::Bot.on_intent 'speakerTopic' do |activity, intents|
+  entities = intents[:entities]
+  reply(activity, speaker_data(activity, entities, 'topic'))
+end
+
+BotFramework::Bot.on_intent 'speakerDescription' do |activity, intents|
+  entities = intents[:entities]
+  reply(activity, speaker_data(activity, entities, 'description'))
+end
+
+BotFramework::Bot.on_intent 'speakerTwitterHandle' do |activity, intents|
+  entities = intents[:entities]
+  reply(activity, speaker_data(activity, entities, 'twitter'))
+end
+
+BotFramework::Bot.on_intent 'speakerTalkTime' do |activity, intents|
+  entities = intents[:entities]
+
+  reply(activity, speaker_data(activity, entities, 'talk_date'))
+end
+
+BotFramework::Bot.on_intent 'eventSchedule' do |activity, intents|
+  # entities = intents[:entities]
+  # reply(activity, speaker_data(activity, entities,'talk_date'))
+end
+
+BotFramework::Bot.on_intent 'rubyconfDetails' do |activity, intents|
+  entities = intents[:entities]
+  detail = BotFramework::Dialogs::EntityRecognizer.find_entity(entities, 'eventDetailType')
+  if detail && RUBY_CONF_DATA[detail[:entity]]
+    reply(activity, RUBY_CONF_DATA[detail[:entity]])
+  else
+    reply(activity, "Sorry, I coudn't find that data")
+  end
+end
+
+BotFramework::Bot.on_intent :default do |activity, _intents|
+  reply(activity, 'Help text')
+end

data/examples/ruby_conf/config.ru

@@ -0,0 +1,6 @@
+require 'pry'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bot_framework'
+require_relative 'bot'
+# include BotFramework
+run BotFramework::Server

data/examples/ruby_conf/speaker_data.yaml

@@ -0,0 +1,41 @@
+'aaron cruz':
+    twitter: mraaroncruz
+    talk_date: '29 Jan 2017'
+    description: 'Aaron lives in the suburbs of Vienna, Austria but is a native of the suburbs of Seattle. In his former life he was a shepherd, a cheesemaker and a sous chef. Now he is freelancing, building native iOS and Android apps and their respective API''s. In his spare time, he organizes a range of user groups in Vienna. If you get him started talking about food, he may never stop.'
+    topic: 'This Bot Will Pump You Up!'
+'adam hawkins':
+    twitter: adman65
+    talk_date: '29 Jan 2017'
+    description: 'Adam is a proud traveller and trance addict. He lives in Bangalore, India. Right now his full time gig is for Saltside. He runs the SRE team and trains a new generation of engineers how to build, ship and operate production systems according to the DevOps philosophy using Docker.'
+    topic: 'Production Ready Ruby'
+'anagha r':
+    topic: 'Getting Started With Rails'
+    description: 'Anagha is an undergraduate student doing her computer science and engineering from Amrita University and an open source enthusiast. She has developed a basic application in Ruby on Rails and is currently developing it based upon her existing knowledge. She is a GHCI2016 student scholar and an advisor for the #include fellowship program by the she++ communit'
+'anil wadghule':
+    topic: 'Talk: concurrent-ruby modern tools explained'
+    description: 'Anil is currently an Independent Software Consultant and helps organising Deccan RubyConf. When not programming, he spends time in exploring music around the world. Emacs is his text editor of choice. He loves learning different programming languages so that he can use right one at right place. He believes in improvising solutions till they are perfectly right.'
+'kiran narasareddy':
+    topic: '10 things (not) to do before going to production with rails+mongo+sidekiq'
+    description: 'Kiran, one of the Co-Founders, heads the Technology division at Amura. With a passion for all things tech, he is always on the lookout for the latest trends and has been successful in leveraging them to maintain Amura''s competitive advantage in the digital space. Kiran''s expertise in technology took root right from his college days, where he built a complex decision-making engine for the US mortgage industry. Consequently, his proficiency in defining high level design and architecture, his data modelling skills as well as his acute interest in executing large scale systems have helped Amura launch Sell.Do, an industry leader in Real Estate Sales and Marketing Automation. With a penchant for coming up with quirky names for products, Kiran can usually be found wired into his mac, hacking on for the next big thing for Amura'
+'prasun anand':
+    topic: 'Scientific Computing on JRuby'
+    description: 'Prasun is a final-year student at BITS Pilani, Goa, India pursuing a dual degree in M.Sc. in Biological Sciences and B.E. in Chemical Engineering. He is a SciRuby contributor, Bioinformatics enthusiast and has worked on ''JRuby port of NMatrix'' in context of GSoC 2016. In his earlier days, he contributed to Javascript projects. Currently, he is working on bringing High-Performance GPU computation to Ruby (MRI and JRuby) using OpenCL by building ArrayFire gem. In his spare time, he likes playing Mortal Komba'
+'richard dchneeman':
+    topic: SLOMO
+    description: 'Richard ''Ruby Hero'' Schneems writes Ruby at Heroku, maintains CodeTriage.com, and co-organizes Keep Ruby Weird. He is in the top 50 Rails contributors and is an accidental maintainer of Sprockets. When he isn''t obsessively compulsively woodworking he writes such gems as Wicked, and derailed_benchmarks. Schneems wants you to have a nice day.'
+'sameer deshmukh':
+    topic: 'Introducing Rubex: A better way to write Ruby extensions'
+    description: 'Sameer is a Computer Engineering graduate from Pune University. He maintains scientific Ruby libraries as a maintainer for the Ruby Science Foundation (SciRuby). He is the author of daru, a DataFrame library for Ruby and is currently working full time on building Rubex, a new language to make it easier to write extensions for Ruby. He loves solo travelling and is also a part time musician - playing the bass guitar for his band Cat Kamikazee.'
+'shashank date':
+    topic: '(m)Ruby on small devices'
+    description: 'Shashank Daté has been programming in Ruby professionally since 2002. He has contributed to the very early versions of Ruby One Click installer on Windows and win32utils - a set of Ruby libraries for Windows. He is the technical editor of The Ruby Way (2nd. ed) by Hal Fulton. He has been instrumental in making Ruby popular in his hometowns (KC, USA and Pune, India). He co-founded Kansas City Ruby User Group. In 2011/12, he was on the organizing committee of Ruby Midwest regional conferences.'
+'shaunak pagnis':
+    topic: '(m)Ruby on small devices'
+    description: 'Shaunak is a core team member of Amura''s product division, Sell.Do, where he contributes to large scale Rails based products. Introduced to Ruby 4 years ago, it has since been his go-to language. When not working, you''ll probably find him listening to Metallica or exploring complex magic systems of Brandon Sanderson''s Cosmere.'
+'swanand pagnis':
+    topic: 'It''s 2017, and I _still_ want to sell you a graph database!'
+    description: 'Swanand is a Principal Engineer at First.io and an organiser at Garden City RubyConf. Fancy titles apart, he''s a software engineer who spent the last decade writing some bad code, and some good code, and shipping software to users. He loves writing software, building communities, and ranting on Twitter.'
+'yukihiro matsumoto':
+    topic: 'Opening Keynote'
+    description: 'Yukihiro ''Matz'' Matsumoto is a programmer, and the creator of the Ruby language. He works for many open source related organizations and companies, e.g. NaCl inc. in Japan, Heroku and Ruby Association. Since his real name is difficult for non-Japanese speakers to pronounce correctly, he uses the nickname Matz on the Net. Matz spoke at RubyConfIndia 2016.'
+

data/examples/simple_regex/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+ruby '2.4.0'
+
+gem 'puma'
+gem 'pry'
+gem 'bot_framework', path: '../../../bot_framework'

data/examples/simple_regex/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: ../..
+  specs:
+    bot_framework (0.1.0beta)
+      chronic
+      chronic_duration
+      httparty
+      jwt
+      nio4r
+      oauth2
+      rack
+      rb-readline
+      timers
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    chronic (0.10.2)
+    chronic_duration (0.10.6)
+      numerizer (~> 0.1.1)
+    coderay (1.1.1)
+    faraday (0.11.0)
+      multipart-post (>= 1.2, < 3)
+    hitimes (1.2.4)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    jwt (1.5.6)
+    method_source (0.8.2)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nio4r (2.0.0)
+    numerizer (0.1.1)
+    oauth2 (1.3.1)
+      faraday (>= 0.8, < 0.12)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    puma (3.8.2)
+    rack (2.0.1)
+    rb-readline (0.5.4)
+    slop (3.6.0)
+    timers (4.1.2)
+      hitimes
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bot_framework!
+  pry
+  puma
+
+RUBY VERSION
+   ruby 2.4.0p0
+
+BUNDLED WITH
+   1.14.6

data/examples/simple_regex/bot.rb

@@ -0,0 +1,35 @@
+BotFramework.configure do |connector|
+  connector.app_id = ENV['RUBY_CONF_MICROSOFT_APP_ID']
+  connector.app_secret = ENV['RUBY_CONF_MICROSOFT_APP_PASSWORD']
+end
+
+BotFramework::Bot.add_recognizer(BotFramework::Dialogs::RegExpRecognizer.new('HelpIntent', /^(help|options)/i))
+BotFramework::Bot.add_recognizer(BotFramework::Dialogs::RegExpRecognizer.new('HelloIntent', /^(hi|hello|hai)/i))
+
+BotFramework::Bot.on :activity do |activity|
+  # All activities
+end
+
+BotFramework::Bot.on :message do |activity|
+  # Call back for messages
+end
+
+BotFramework::Bot.on :ping do |activity|
+  # Callback for pings
+end
+
+BotFramework::Bot.on :typing do |activity|
+  # Callback for typing
+end
+
+BotFramework::Bot.on_intent 'HelpIntent' do |activity, _intents|
+  reply(activity, "<HELP TEXT HERE>")
+end
+
+BotFramework::Bot.on_intent 'HelloIntent' do |activity, _intents|
+  reply(activity, "Hello")
+end
+
+BotFramework::Bot.on_intent :default do |activity, _intents|
+  reply(activity, 'Unable to recognize')
+end