bot_framework 0.1.0beta

data/lib/bot_framework/models/receipt_item.rb

@@ -0,0 +1,60 @@
+module BotFramework
+  class ReceiptItem < Base
+    # Title of the Card
+    attr_accessor :title
+
+    # Subtitle appears just below Title field, differs from Title in font styling only
+    attr_accessor :subtitle
+
+    # Text field appears just below subtitle, differs from Subtitle in font styling only
+    attr_accessor :text
+
+    # Image
+    attr_accessor :image
+
+    # Amount with currency
+    attr_accessor :price
+
+    # Number of items of given kind
+    attr_accessor :quantity
+
+    # This action will be activated when user taps on the Item bubble.
+    attr_accessor :tap
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        title: :String,
+        subtitle: :String,
+        text: :String,
+        image: :CardImage,
+        price: :String,
+        quantity: :String,
+        tap: :CardAction
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.title = attributes[:title] if attributes.key?(:title)
+
+      self.subtitle = attributes[:subtitle] if attributes.key?(:subtitle)
+
+      self.text = attributes[:text] if attributes.key?(:text)
+
+      self.image = attributes[:image] if attributes.key?(:image)
+
+      self.price = attributes[:price] if attributes.key?(:price)
+
+      self.quantity = attributes[:quantity] if attributes.key?(:quantity)
+
+      self.tap = attributes[:tap] if attributes.key?(:tap)
+    end
+  end
+end

data/lib/bot_framework/models/resource_response.rb

@@ -0,0 +1,13 @@
+module BotFramework
+  class ResourceResponse < Base
+    # Id of the resource
+    attr_accessor :id
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        id: :String
+      }
+    end
+  end
+end

data/lib/bot_framework/models/signin_card.rb

@@ -0,0 +1,35 @@
+module BotFramework
+  # A card representing a request to signing
+  class SigninCard < Base
+    # Text for signin request
+    attr_accessor :text
+
+    # Action to use to perform signin
+    attr_accessor :buttons
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        text: :String,
+        buttons: :'Array<CardAction>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.text = attributes[:text] if attributes.key?(:text)
+
+      if attributes.key?(:buttons)
+        if (value = attributes[:buttons]).is_a?(Array)
+          self.buttons = value
+        end
+      end
+    end
+  end
+end

data/lib/bot_framework/models/thumbnail_card.rb

@@ -0,0 +1,62 @@
+module BotFramework
+  class ThumbnailCard < Base
+    # Title of the card
+    attr_accessor :title
+
+    # Subtitle of the card
+    attr_accessor :subtitle
+
+    # Text for the card
+    attr_accessor :text
+
+    # Array of i
+    attr_accessor :images
+
+    # Set of actions applicable to the current card
+    attr_accessor :buttons
+
+    # This action will be activated when user taps on the card itself
+    attr_accessor :tap
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        title: :String,
+        subtitle: :String,
+        text: :String,
+        images: :'Array<CardImage>',
+        buttons: :'Array<CardAction>',
+        tap: :CardAction
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      self.title = attributes[:title] if attributes.key?(:title)
+
+      self.subtitle = attributes[:subtitle] if attributes.key?(:subtitle)
+
+      self.text = attributes[:text] if attributes.key?(:text)
+
+      if attributes.key?(:images)
+        if (value = attributes[:images]).is_a?(Array)
+          self.images = value
+        end
+      end
+
+      if attributes.key?(:buttons)
+        if (value = attributes[:buttons]).is_a?(Array)
+          self.buttons = value
+        end
+      end
+
+      self.tap = attributes[:tap] if attributes.key?(:tap)
+    end
+  end
+end

data/lib/bot_framework/server.rb

@@ -0,0 +1,56 @@
+module BotFramework
+  class Server
+    def self.call(env)
+      new.call(env)
+    end
+
+    def call(env)
+      @request = Rack::Request.new env
+      @response = Rack::Response.new
+      if @request.post?
+        if verify
+          receive
+        else
+          raise InvalidToken
+        end
+      end
+      @response.finish
+    end
+
+    # TODO: reply in separate thread t avoid timeout
+    def receive
+      # Thread.new {
+      activity = Activity.new.build_from_hash JSON.parse(@request.body.read)
+      Bot.receive(activity)
+      # }
+    end
+
+    def headers
+      env = @request.env
+      Hash[*env.select { |k, _v| k.start_with? 'HTTP_' }
+               .collect { |k, v| [k.sub(/^HTTP_/, ''), v] }
+               .collect { |k, v| [k.split('_').collect(&:capitalize).join('-'), v] }
+           .sort
+           .flatten]
+    end
+
+    # Use logger instead of puts
+    def verify
+      validator = TokenValidator.new(headers)
+      if validator.valid?
+        return true
+      else
+        p "Errors: #{validator.errors}"
+        return false
+      end
+    rescue JWT::DecodeError
+      [401, { 'Content-Type' => 'text/plain' }, ['A token must be passed.']]
+    rescue JWT::ExpiredSignature
+      [403, { 'Content-Type' => 'text/plain' }, ['The token has expired.']]
+    rescue JWT::InvalidIssuerError
+      [403, { 'Content-Type' => 'text/plain' }, ['The token does not have a valid issuer.']]
+    rescue JWT::InvalidIatError
+      [403, { 'Content-Type' => 'text/plain' }, ['The token does not have a valid "issued at" time.']]
+    end
+  end
+end

data/lib/bot_framework/token_validator.rb

@@ -0,0 +1,87 @@
+module BotFramework
+  class TokenValidator
+    include HTTParty
+    attr_accessor :headers, :errors
+
+    OPEN_ID_CONFIG_URI = 'https://api.aps.skype.com/v1/.well-known/openidconfiguration'.freeze
+
+    def initialize(headers)
+      @headers = headers
+    end
+
+    def valid?
+      valid_header? &&
+        valid_jwt? &&
+        valid_iss? &&
+        valid_audience? &&
+        valid_token? &&
+        valid_signature?
+    end
+
+    def errors
+      @errors ||= []
+    end
+
+    private
+
+    def open_id_config
+      JSON.parse(self.class.get(OPEN_ID_CONFIG_URI).body)
+    end
+
+    def jwks_uri
+      open_id_config['jwks_uri']
+    end
+
+    def valid_keys
+      JSON.parse(self.class.get(jwks_uri).body)['keys']
+    end
+
+    def auth_header
+      headers['Authorization']
+    end
+
+    def token
+      auth_header.gsub('Bearer ', '')
+    end
+
+    def valid_header?
+      # The token was sent in the HTTP Authorization header with "Bearer" scheme
+      condition = auth_header.start_with? 'Bearer'
+      errors << 'Invalid headers' unless condition
+      condition
+    end
+    # Validations
+
+    def valid_jwt?
+      # The token is valid JSON that conforms to the JWT standard (see references)
+      condition = JWT.decode token, nil, false
+      errors << 'Invalid jwt' unless condition
+      condition
+    end
+
+    def valid_iss?
+      # The token contains an issuer claim with value of https://api.botframework.com
+      condition = JWT.decode(token, nil, false).first['iss'] == 'https://api.botframework.com'
+      errors << 'Invalid iss' unless condition
+      condition
+    end
+
+    def valid_audience?
+      # The token contains an audience claim with a value equivalent to your bot’s Microsoft App ID.
+      condition = (JWT.decode(token, nil, false).first['aud'] == BotFramework.connector.app_id)
+      errors << 'Invalid audience' unless condition
+      condition
+    end
+
+    def valid_token?
+      # The token has not yet expired. Industry-standard clock-skew is 5 minutes.
+      # Should not raise JWT::ExpiredSignature
+      true
+    end
+
+    def valid_signature?
+      # The token has a valid cryptographic signature with a key listed in the OpenId keys document retrieved in step 1, above.
+      true
+    end
+  end
+end

data/lib/bot_framework/util.rb

@@ -0,0 +1,19 @@
+module BotFramework
+  module Util
+    class << self
+      def to_underscore(string)
+        string = string.to_s unless string.is_a? String
+        string.gsub(/::/, '/')
+              .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+              .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+              .tr('-', '_')
+              .downcase
+      end
+
+      def camel_case_lower(string)
+        string = string.to_s unless string.is_a? String
+        string.split('_').inject([]) { |buffer, e| buffer.push(buffer.empty? ? e : e.capitalize) }.join
+      end
+    end
+  end
+end

data/lib/bot_framework/version.rb

@@ -0,0 +1,3 @@
+module BotFramework
+  VERSION = '0.1.0beta'.freeze
+end

metadata

@@ -0,0 +1,206 @@
+--- !ruby/object:Gem::Specification
+name: bot_framework
+version: !ruby/object:Gem::Version
+  version: 0.1.0beta
+platform: ruby
+authors:
+- Aboobacker MK
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: oauth2
+  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: jwt
+  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: httparty
+  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: rack
+  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'
+description: Unofficial ruby client for microsoft botframework
+email:
+- aboobackervyd@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bot_framework.gemspec
+- examples/echo/bot.rb
+- examples/echo/config.ru
+- examples/stock/bot.rb
+- examples/stock/config.ru
+- lib/bot_framework.rb
+- lib/bot_framework/api_base.rb
+- lib/bot_framework/bot.rb
+- lib/bot_framework/bot_state.rb
+- lib/bot_framework/connector.rb
+- lib/bot_framework/conversation.rb
+- lib/bot_framework/errors.rb
+- lib/bot_framework/models/activity.rb
+- lib/bot_framework/models/api_response.rb
+- lib/bot_framework/models/attachment.rb
+- lib/bot_framework/models/attachment_data.rb
+- lib/bot_framework/models/attachment_info.rb
+- lib/bot_framework/models/attachment_view.rb
+- lib/bot_framework/models/base.rb
+- lib/bot_framework/models/bot_data.rb
+- lib/bot_framework/models/card_action.rb
+- lib/bot_framework/models/card_image.rb
+- lib/bot_framework/models/channel_account.rb
+- lib/bot_framework/models/conversation_account.rb
+- lib/bot_framework/models/conversation_parameters.rb
+- lib/bot_framework/models/entity.rb
+- lib/bot_framework/models/fact.rb
+- lib/bot_framework/models/geo_coordinates.rb
+- lib/bot_framework/models/hero_card.rb
+- lib/bot_framework/models/object.rb
+- lib/bot_framework/models/place.rb
+- lib/bot_framework/models/receipt_card.rb
+- lib/bot_framework/models/receipt_item.rb
+- lib/bot_framework/models/resource_response.rb
+- lib/bot_framework/models/signin_card.rb
+- lib/bot_framework/models/thumbnail_card.rb
+- lib/bot_framework/server.rb
+- lib/bot_framework/token_validator.rb
+- lib/bot_framework/util.rb
+- lib/bot_framework/version.rb
+homepage: https://github.com/tachyons/bot-framework-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for microsoft botframework .
+test_files: []