bot_framework 0.1.0beta

data/lib/bot_framework/connector.rb

@@ -0,0 +1,34 @@
+module BotFramework
+  # Connector class
+  class Connector
+    # include HTTParty
+    attr_accessor :app_id, :app_secret, :token
+    CONFIG_URI = 'https://api.aps.skype.com/v1/.well-known/openidconfiguration'.freeze
+
+    def initialize(options = {})
+      @app_id = options[:app_id]
+      @app_secret = options[:app_secret]
+      yield(self) if block_given?
+    end
+
+    def client
+      OAuth2::Client.new(app_id, app_secret,
+                         authorize_url: '/common/oauth2/v2.0/authorize',
+                         token_url: '/common/oauth2/v2.0/token',
+                         raise_errors: true,
+                         site: 'https://login.microsoftonline.com')
+    end
+
+    def token
+      @token = nil if @token && @token.expired?
+      @token ||= get_token
+      @token
+    end
+
+    def get_token
+      client.client_credentials.get_token(scope: 'https://graph.microsoft.com/.default',
+                                          client_id: app_id,
+                                          client_secret: app_secret)
+    end
+  end
+end

data/lib/bot_framework/conversation.rb

@@ -0,0 +1,33 @@
+module BotFramework
+  class Conversation < ApiBase
+    def create(attributes)
+      uri = '/v3/conversations'
+      api_post(uri, attributes)
+    end
+
+    def get_activity_members(conversation_id, activity_id, opts = {})
+      uri = "/v3/conversations/#{conversation_id}/activities/#{activity_id}/members"
+      api_get(uri, opts)
+    end
+
+    def get_conversation_members(conversation_id)
+      uri = "/v3/conversations/#{conversation_id}/activities/members"
+      api_get(uri, opts)
+    end
+
+    def send(conversation_id, activity)
+      uri = "/v3/conversations/#{conversation_id}/activities"
+      api_post(uri, activity.as_json)
+    end
+
+    def upload_attachment(conversation_id, opts = {})
+      uri = "/v3/conversations/#{conversation_id}/attachments"
+      api_post(uri, opts)
+    end
+
+    def reply_to_activity(conversation_id, activity_id, new_activity)
+      uri = "/v3/conversations/#{conversation_id}/activities/#{activity_id}"
+      api_post(uri, new_activity.to_hash)
+    end
+  end
+end

data/lib/bot_framework/errors.rb

@@ -0,0 +1,4 @@
+module BotFramework
+  class InvalidToken < StandardError
+  end
+end

data/lib/bot_framework/models/activity.rb

@@ -0,0 +1,106 @@
+module BotFramework
+  class Activity < Base
+    # The type of the activity [message|contactRelationUpdate|converationUpdate|typing]
+    attr_accessor :type
+
+    # Id for the activity
+    attr_accessor :id
+
+    # Time when message was sent
+    attr_accessor :timestamp
+
+    # Service endpoint
+    attr_accessor :service_url
+
+    # ChannelId the activity was on
+    attr_accessor :channel_id
+
+    # Sender address
+    attr_accessor :from
+
+    # Conversation
+    attr_accessor :conversation
+
+    # (Outbound to bot only) Bot's address that received the message
+    attr_accessor :recipient
+
+    # Format of text fields [plain|markdown] Default:markdown
+    attr_accessor :text_format
+
+    # AttachmentLayout - hint for how to deal with multiple attachments Values: [list|carousel] Default:list
+    attr_accessor :attachment_layout
+
+    # Array of address added
+    attr_accessor :members_added
+
+    # Array of addresses removed
+    attr_accessor :members_removed
+
+    # Conversations new topic name
+    attr_accessor :topic_name
+
+    # the previous history of the channel was disclosed
+    attr_accessor :history_disclosed
+
+    # The language code of the Text field
+    attr_accessor :locale
+
+    # Content for the message
+    attr_accessor :text
+
+    # Text to display if you can't render cards
+    attr_accessor :summary
+
+    # Attachments
+    attr_accessor :attachments
+
+    # Collection of Entity objects, each of which contains metadata about this activity. Each Entity object is typed.
+    attr_accessor :entities
+
+    # Channel specific payload
+    attr_accessor :channel_data
+
+    # ContactAdded/Removed action
+    attr_accessor :action
+
+    # the original id this message is a response to
+    attr_accessor :reply_to_id
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        type: :String,
+        id: :String,
+        timestamp: :DateTime,
+        service_url: :String,
+        channel_id: :String,
+        from: :ChannelAccount,
+        conversation: :ConversationAccount,
+        recipient: :ChannelAccount,
+        text_format: :String,
+        attachment_layout: :String,
+        members_added: :'Array<ChannelAccount>',
+        members_removed: :'Array<ChannelAccount>',
+        topic_name: :String,
+        history_disclosed: :BOOLEAN,
+        locale: :String,
+        text: :String,
+        summary: :String,
+        attachments: :'Array<Attachment>',
+        entities: :'Array<Entity>',
+        channel_data: :Object,
+        action: :String,
+        reply_to_id: :String
+      }
+    end
+
+    def reply(message)
+      return false if type != 'message'
+      new_activity = Activity.new(type: 'message',
+                                  locale: 'en',
+                                  text: message,
+                                  from: recipient.to_hash)
+      Conversation.new(service_url).reply_to_activity(conversation.id, id, new_activity)
+    end
+  end
+end

data/lib/bot_framework/models/api_response.rb

@@ -0,0 +1,23 @@
+module BotFramework
+  class APIResponse < Base
+    attr_accessor :message
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        message: :String
+      }
+    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.message = attributes[:message] if attributes.key?(:message)
+    end
+  end
+end

data/lib/bot_framework/models/attachment.rb

@@ -0,0 +1,52 @@
+module BotFramework
+  class Attachment < Base
+    # mimetype/Contenttype for the file
+    attr_accessor :content_type
+
+    # Content Url
+    attr_accessor :content_url
+
+    # Embedded content
+    attr_accessor :content
+
+    # (OPTIONAL) The name of the attachment
+    attr_accessor :name
+
+    # (OPTIONAL) Thumbnail associated with attachment
+    attr_accessor :thumbnail_url
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        content_type: :String,
+        content_url: :String,
+        content: :Object,
+        name: :String,
+        thumbnail_url: :String
+      }
+    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 }
+
+      if attributes.key?(:contentType)
+        self.content_type = attributes[:contentType]
+      end
+
+      self.content_url = attributes[:contentUrl] if attributes.key?(:contentUrl)
+
+      self.content = attributes[:content] if attributes.key?(:content)
+
+      self.name = attributes[:name] if attributes.key?(:name)
+
+      if attributes.key?(:thumbnailUrl)
+        self.thumbnail_url = attributes[:thumbnailUrl]
+      end
+    end
+  end
+end

data/lib/bot_framework/models/attachment_data.rb

@@ -0,0 +1,26 @@
+module BotFramework
+  # Attachment data
+  class AttachmentData < Base
+    # content type of the attachmnet
+    attr_accessor :type
+
+    # Name of the attachment
+    attr_accessor :name
+
+    # original content
+    attr_accessor :original_base64
+
+    # Thumbnail
+    attr_accessor :thumbnail_base64
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        type: :String,
+        name: :String,
+        original_base64: :String,
+        thumbnail_base64: :String
+      }
+    end
+  end
+end

data/lib/bot_framework/models/attachment_info.rb

@@ -0,0 +1,41 @@
+module BotFramework
+  # Metdata for an attachment
+  class AttachmentInfo < Base
+    # Name of the attachment
+    attr_accessor :name
+
+    # ContentType of the attachment
+    attr_accessor :type
+
+    # attachment views
+    attr_accessor :views
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        name: :String,
+        type: :String,
+        views: :'Array<AttachmentView>'
+      }
+    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.name = attributes[:name] if attributes.key?(:name)
+
+      self.type = attributes[:type] if attributes.key?(:type)
+
+      if attributes.key?(:views)
+        if (value = attributes[:views]).is_a?(Array)
+          self.views = value
+        end
+      end
+    end
+  end
+end

data/lib/bot_framework/models/attachment_view.rb

@@ -0,0 +1,31 @@
+module BotFramework
+  # Attachment View name and size
+  class AttachmentView < Base
+    # content type of the attachmnet
+    attr_accessor :view_id
+
+    # Name of the attachment
+    attr_accessor :size
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        view_id: :String,
+        size: :Integer
+      }
+    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.view_id = attributes[:viewId] if attributes.key?(:viewId)
+
+      self.size = attributes[:size] if attributes.key?(:size)
+    end
+  end
+end

data/lib/bot_framework/models/base.rb

@@ -0,0 +1,187 @@
+module BotFramework
+  class Base
+    class <<self
+       attr_accessor :attributes
+    end
+
+    def self.attr_accessor(*args)
+      @attributes ||= []
+      @attributes.concat args
+      super(*args)
+    end
+
+    def attributes
+      self.class.attributes
+    end
+
+    def attributes_hash
+      attributes.map { |attribute| { attribute => send(attribute) } }.reduce({}, :merge)
+    end
+
+    def compact_attributes_hash
+      to_hash
+    end
+
+    def as_json
+      to_hash
+    end
+
+    def to_json
+      as_json.to_json
+    end
+
+    def initialize(options = {})
+      return unless options.is_a?(Hash)
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      # FIXME: using class level caching breaks inheritance
+      @attribute_map ||= attributes.map do |attribute|
+        { attribute => BotFramework::Util.camel_case_lower(attribute).to_sym }
+      end.reduce({}, :merge)
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = []
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if equal?(o)
+      self.class = o.class && attributes_hash == o.attributes_hash
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      attributes_hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /^Array<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(Regexp.last_match(1), v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /^(true|t|yes|y|1)$/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = BotFramework.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end