Class: Irc::Bot::WebMessage

Inherits:

Object

• Object
• Irc::Bot::WebMessage

show all

Defined in:

/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb

Overview

Instance Attribute Summary (collapse)

• - (Object) args readonly

  Parsed url parameters.

• - (Object) bot readonly

  Bot instance.

• - (Object) client readonly

  Client IP.

• - (Object) method readonly

  HTTP method (POST, GET, etc.).

• - (Object) path readonly

  URL Path.

• - (Object) post readonly

  Parsed post request parameters.

• - (Object) req readonly

  Request object, a instance of WEBrick::HTTPRequest (docs).

• - (Object) res readonly

  Response object, a instance of WEBrick::HTTPResponse (docs).

• - (Object) source readonly

  The bot user issuing the command.

Instance Method Summary (collapse)

• - (WebMessage) initialize(bot, req, res) constructor

  A new instance of WebMessage.

• - (Object) parse_query(query)
• - (Boolean) private?

  Remote messages are always 'private'.

• - (Object) send_html(body, status = 200)

  Sends a html response.

• - (Object) send_json(body, status = 200)

  Sends a json response.

• - (Object) send_plaintext(body, status = 200)

  Sends a plaintext response.

• - (Object) send_response(body, status, type)

  Sends a response with the specified body, status and content type.

• - (Object) target

  The target of a RemoteMessage.

53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 53

def initialize(bot, req, res)
  @bot = bot
  @req = req
  @res = res

  @method = req.request_method
  @post = {}
  if req.body and not req.body.empty?
    @post = parse_query(req.body)
  end
  @args = {}
  if req.query_string and not req.query_string.empty?
    @args = parse_query(req.query_string)
  end
  @client = req.peeraddr[3]

  # login a botuser with http authentication
  WEBrick::HTTPAuth.basic_auth(req, res, 'RBotAuth') { |username, password|
    if username
      botuser = @bot.auth.get_botuser(Auth::BotUser.sanitize_username(username))
      if botuser and botuser.password == password
        @source = botuser
        true
      else
        false
      end
    else
      true # no need to request auth at this point
    end
  }

  @path = req.path
  debug '@path = ' + @path.inspect
end

43
44
45

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 43

def args
  @args
end

28
29
30

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 28

def bot
  @bot
end

46
47
48

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 46

def client
  @client
end

31
32
33

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 31

def method
  @method
end

49
50
51

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 49

def path
  @path
end

40
41
42

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 40

def post
  @post
end

34
35
36

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 34

def req
  @req
end

37
38
39

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 37

def res
  @res
end

52
53
54

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 52

def source
  @source
end

88
89
90
91
92
93
94

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 88

def parse_query(query)
  params = CGI::parse(query)
  params.each_pair do |key, val|
    params[key] = val.last
  end
  params
end

102
103
104

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 102

def private?
  true
end

124
125
126

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 124

def send_html(body, status=200)
  send_response(body, status, 'text/html')
end

119
120
121

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 119

def send_json(body, status=200)
  send_response(body, status, 'application/json')
end

114
115
116

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 114

def send_plaintext(body, status=200)
  send_response(body, status, 'text/plain')
end

107
108
109
110
111

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 107

def send_response(body, status, type)
  @res.status = status
  @res['Content-Type'] = type
  @res.body = body
end

97
98
99

# File '/home/apoc/projects/ruby/rbot/lib/rbot/core/webservice.rb', line 97

def target
  @bot
end