Class: MineShaft::Shaft

Inherits:

Object

• Object
• MineShaft::Shaft

Defined in:

lib/mine_shaft/shaft.rb

Overview

Provides simple interface for deserializing an id'd HTML table from a specific page of a Redmine project site.

Constant Summary

LOGIN_PAGE_URL =

The relative URL for the login page on a Redmine site

"/login"

Instance Method Summary

• #grab(table_id, relative_wiki_page_url) ⇒ Object

  Public: Logs in and parses the specified page for a

  with the specified ID.

  #initialize(username, password, base_uri) ⇒ Shaft constructor

  Public: Initializes new instance of Shaft class.

  Constructor Details

  #initialize(username, password, base_uri) ⇒ Shaft

  Public: Initializes new instance of Shaft class.

  username - The username to log in with on the specified Redmine site. password - The password to log in with on the specified Redmine site. base_uri - The URL of the Redmine installation.

  Examples

  shaft = Shaft.new('uname', 'password', 'http://myredmineinstall.com')
  

  Returns a new instance of the Shaft class.

  # File 'lib/mine_shaft/shaft.rb', line 19
  
  def initialize(username, password, base_uri)
    @agent    = UserAgent.new(username, password, base_uri)
    @login_action = @login_page = LOGIN_PAGE_URL
  end