bot_framework 0.1.0beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: affe51df6b475a675f090f4130ced19a0f2ff6c9
+  data.tar.gz: 053aa8a5ace3a3fbd89fbe8ddb61d9ea168786f0
+SHA512:
+  metadata.gz: d07903a48bc1036bb7f1e3c8960d7fd9d24ef5face9fccc1975e66e6ec1090f078e7425e718d5f6f8c91eb1d3db5b031035a6deb506a3af2feb57b0e6aa7dce3
+  data.tar.gz: b639f369042b2b8ccc98ea589cb1a29018e767f1ce2572755c4c2ab7eda79c0dc78f96f39ec1dfc82abcdcd1a4857260fc12581a9be6fff1c62c26b7f009ee5d

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at aboobackervyd@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bot_framework.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Aboobacker MK
+
+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

@@ -0,0 +1,60 @@
+# BotFramework
+
+Ruby client to make statefull bots using microsoft botframework . Currently under development , don't try this in under production till v1.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bot_framework'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bot_framework
+
+## Usage
+
+Simple echo bot
+```ruby
+BotFramework.configure do |connector|
+  connector.app_id = ENV['MICROSOFT_APP_ID']
+  connector.app_secret = ENV['MICROSOFT_APP_SECRET']
+end
+
+BotFramework::Bot.on :activity do |activity|
+  # Activity.id , identifier of the activity
+  # activity.timestamp
+  # activity.channel_id
+  # activity.from, sender 
+  # activity.conversation
+  # activity.topic_name
+  # activity.locale
+  # activity.text
+  # and so on
+
+  reply(activity,activity.text)
+end
+
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'bot_framework'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require 'irb'
+# IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bot_framework.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bot_framework/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bot_framework'
+  spec.version       = BotFramework::VERSION
+  spec.authors       = ['Aboobacker MK']
+  spec.email         = ['aboobackervyd@gmail.com']
+
+  spec.summary       = 'Ruby client for microsoft botframework .'
+  spec.description   = 'Unofficial ruby client for microsoft botframework'
+  spec.homepage      = 'https://github.com/tachyons/bot-framework-ruby'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry'
+
+  spec.add_dependency 'oauth2'
+  spec.add_dependency 'jwt'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'rack'
+end

data/examples/echo/bot.rb

@@ -0,0 +1,8 @@
+BotFramework.configure do |connector|
+  connector.app_id = ENV['MICROSOFT_APP_ID']
+  connector.app_secret = ENV['MICROSOFT_APP_SECRET']
+end
+
+BotFramework::Bot.on :activity do |activity|
+  reply(activity, activity.text)
+end

data/examples/echo/config.ru

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

data/examples/stock/bot.rb

@@ -0,0 +1,38 @@
+require 'luis'
+require 'stock_quote'
+
+BotFramework.configure do |connector|
+  connector.app_id = ENV['MICROSOFT_APP_ID']
+  connector.app_secret = ENV['MICROSOFT_APP_SECRET']
+end
+Luis.configure do |config|
+  config.id = ENV['STOCK_LUIS_ID']
+  config.subscription_key = ENV['STOCK_LUIS_KEY']
+  # config.is_preview_mod = true
+end
+
+BotFramework::Bot.on :activity do |activity|
+  luis_result = Luis.query(activity.text)
+  if luis_result.intents.count > 0
+    case luis_result.intents[0].intent
+    when 'StockPrice'
+      stock = luis_result.entities[0].entity
+      stock_value = StockQuote::Stock.quote(stock).ask
+      result = " Current stock value of #{stock} is #{stock_value}"
+      set_conversation_data(activity, last_stock: stock)
+    when 'RepeatLastStock'
+      last_stock = get_conversation_data(activity)[:last_stock]
+      if last_stock
+        stock_value = StockQuote::Stock.quote(last_stock).ask
+        result = " Current stock value of #{last_stock} is #{stock_value}"
+      else
+        result = 'No previous value available'
+      end
+    when 'None'
+      result = "Sorry , I don't undersatnd"
+    end
+  else
+    result = "Sorry, I don't understand"
+  end
+  reply(activity, result)
+end

data/examples/stock/config.ru

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

data/lib/bot_framework.rb

@@ -0,0 +1,48 @@
+require 'oauth2'
+require 'jwt'
+require 'httparty'
+require 'json'
+require 'bot_framework/version'
+require 'bot_framework/errors'
+require 'bot_framework/util'
+require 'bot_framework/connector'
+require 'bot_framework/api_base'
+require 'bot_framework/conversation'
+require 'bot_framework/bot_state'
+require 'bot_framework/token_validator'
+require 'bot_framework/bot'
+require 'bot_framework/server'
+require 'bot_framework/models/base'
+require 'bot_framework/models/activity'
+require 'bot_framework/models/api_response'
+require 'bot_framework/models/attachment'
+require 'bot_framework/models/attachment_data'
+require 'bot_framework/models/attachment_info'
+require 'bot_framework/models/attachment_view'
+require 'bot_framework/models/bot_data'
+require 'bot_framework/models/card_action'
+require 'bot_framework/models/card_image'
+require 'bot_framework/models/channel_account'
+require 'bot_framework/models/conversation_account'
+require 'bot_framework/models/conversation_parameters'
+require 'bot_framework/models/entity'
+require 'bot_framework/models/fact'
+require 'bot_framework/models/geo_coordinates'
+require 'bot_framework/models/hero_card'
+require 'bot_framework/models/object'
+require 'bot_framework/models/place'
+require 'bot_framework/models/receipt_card'
+require 'bot_framework/models/receipt_item'
+require 'bot_framework/models/resource_response'
+require 'bot_framework/models/signin_card'
+require 'bot_framework/models/thumbnail_card'
+
+module BotFramework
+  class << self
+    attr_accessor :connector
+
+    def configure(*args, &block)
+      @connector = Connector.new(*args, &block)
+    end
+  end
+end

data/lib/bot_framework/api_base.rb

@@ -0,0 +1,31 @@
+module BotFramework
+  class ApiBase
+    include HTTParty
+    attr_accessor :service_url
+
+    def initialize(service_url)
+      @service_url = service_url
+    end
+
+    def api_get(local_uri, _opts = {})
+      uri = service_url + local_uri
+      JSON.parse(BotFramework.connector.token.get(uri).body)
+    end
+
+    def api_post(local_uri, opts = {})
+      uri = service_url + local_uri
+      JSON.parse(BotFramework.connector.token.post(uri, body: opts.to_json,
+                                                        headers: { 'Content-Type' => 'application/json' }).body)
+    end
+
+    def api_delete(local_uri)
+      uri = service_url + local_uri
+      BotFramework.connector.token.delete(uri)
+    end
+
+    def api_request(method, local_uri, opts)
+      uri = service_url + local_uri
+      BotFramework.connector.token.request(method, uri, opts)
+    end
+  end
+end

data/lib/bot_framework/bot.rb

@@ -0,0 +1,48 @@
+module BotFramework
+  class Bot
+    class << self
+      def on(event, &block)
+        hooks[event] = block
+      end
+
+      def trigger(event, *args)
+        # hooks.fetch(event).call(*args)
+        instance_exec *args, &hooks.fetch(event)
+      end
+
+      def receive(payload)
+        trigger(:activity, payload)
+      end
+
+      def reply(activity, message = '')
+        activity.reply(message)
+      end
+
+      def user_data=(data)
+        p "Data set as #{data}"
+      end
+
+      def set_conversation_data(activity, data)
+        data = BotFramework::BotData.new(data: data, e_tag: '*') if data.is_a? Hash
+        BotFramework::BotState.new('').set_conversation_data('channel_id' => activity.channel_id,
+                                                             'conversation_id' => activity.conversation.id,
+                                                             'bot_data' => data)
+      end
+
+      def conversation_data(activity)
+        BotFramework::BotState.new('').get_conversation_data(
+          'channel_id' => activity.channel_id,
+          'conversation_id' => activity.conversation.id
+        ).data || {}
+      end
+
+      def hooks
+        @hooks ||= {}
+      end
+
+      def reset_hooks
+        @hooks = {}
+      end
+    end
+  end
+end

data/lib/bot_framework/bot_state.rb

@@ -0,0 +1,89 @@
+module BotFramework
+  class BotState < ApiBase
+    def initialize(_service_url)
+      @service_url = 'https://state.botframework.com'
+    end
+
+    # DeleteStateForUser
+    # Delete all data for a user in a channel (UserData and PrivateConversationData)
+    # @param channel_id channelId
+    # @param user_id id for the user on the channel
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def delete_state_for_user(opts = {})
+      uri = "/v3/botstate/#{opts['channel_id']}/users/#{opts['user_id']}"
+      api_delete(uri)
+    end
+
+    # GetConversationData
+    # get the bots data for all users in a conversation
+    # @param channel_id the channelId
+    # @param conversation_id The id for the conversation on the channel
+    # @param [Hash] opts the optional parameters
+    # @return [BotData]
+
+    def get_conversation_data(opts = {})
+      # opts['channel_id'] & opts['conversation_id']
+      uri = "/v3/botstate/#{opts['channel_id']}/conversations/#{opts['conversation_id']}"
+      BotFramework::BotData.new api_get(uri)
+    end
+
+    # GetPrivateConversationData
+    # get bot's data for a single user in a conversation
+    # @param channel_id channelId
+    # @param conversation_id The id for the conversation on the channel
+    # @param user_id id for the user on the channel
+    def get_private_conversation_data(opts = {})
+      uri = "/v3/botstate/#{opts['channel_id']}/conversations/#{opts['conversation_id']}/users/#{opts['user_id']}"
+      BotFramework::BotData.new api_get(uri)
+    end
+
+    # GetUserData
+    # Get a bots data for the user across all conversations
+    # @param channel_id channelId
+    # @param user_id id for the user on the channel
+    # @return [BotData]
+
+    def get_user_data(opts = {})
+      uri = "/v3/botstate/#{opts['channel_id']}/users/#{opts['user_id']}"
+      BotFramework::BotData.new api_get(uri)
+    end
+
+    # SetConversationData
+    # Update the bot's data for all users in a conversation
+    # @param channel_id channelId
+    # @param conversation_id The id for the conversation on the channel
+    # @param bot_data the new botdata
+    # @return [BotData]
+    def set_conversation_data(opts = {})
+      uri = "/v3/botstate/#{opts['channel_id']}/conversations/#{opts['conversation_id']}"
+      api_post(uri, opts['bot_data'])
+    end
+
+    # SetPrivateConversationData
+    # Update the bot's data for a single user in a conversation
+    # @param channel_id channelId
+    # @param conversation_id The id for the conversation on the channel
+    # @param user_id id for the user on the channel
+    # @param bot_data the new botdata
+    # @param [Hash] opts the optional parameters
+    # @return [BotData]
+
+    def set_private_conversation_data(opts = {})
+      uri = "/v3/botstate/#{opts['channel_id']}/conversations/#{opts['conversation_id']}/users/#{opts['user_id']}"
+      api_post(uri, opts['bot_data'])
+    end
+    # SetUserData
+    # Update the bot's data for a user
+    # @param channel_id channelId
+    # @param user_id id for the user on the channel
+    # @param bot_data the new botdata
+    # @param [Hash] opts the optional parameters
+    # @return [BotData]
+
+    def set_user_data(opts = {})
+      uri = "/v3/botstate/#{opts['channel_id']}/users/#{opts['user_id']}"
+      api_post(uri, opts['bot_data'])
+    end
+  end
+end