Module: Roart

Defined in:
lib/roart.rb,
lib/roart/roart.rb,
lib/roart/errors.rb,
lib/roart/ticket.rb,
lib/roart/history.rb,
lib/roart/callbacks.rb,
lib/roart/connection.rb,
lib/roart/ticket_page.rb

Defined Under Namespace

Modules: Callbacks, Connections, Histories, MethodFunctions, TicketPage, Tickets Classes: ArgumentError, Connection, History, HistoryArray, RoartError, Ticket, TicketSystemError, TicketSystemInterfaceError

Constant Summary collapse

VERSION =

:stopdoc:

'0.1.4'
LIBPATH = 
::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
PATH = 
::File.dirname(LIBPATH) + ::File::SEPARATOR

Class Method Summary collapse

Class Method Details

.check_keys!(hash, required) ⇒ Object 



3
4
5
6
7
8
9
 
# File 'lib/roart/roart.rb', line 3

def self.check_keys!(hash, required)
  unless required.inject(true) do |inc, attr| 
      inc ? hash.keys.include?(attr.to_sym) : nil
    end
    raise ArgumentError, "Not all required fields entered" 
  end
end

.libpath(*args) ⇒ Object

Returns the library path for the module. If any arguments are given, they will be joined to the end of the libray path using File.join.



20
21
22
 
# File 'lib/roart.rb', line 20

def self.libpath( *args )
  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
end

.path(*args) ⇒ Object

Returns the lpath for the module. If any arguments are given, they will be joined to the end of the path using File.join.



28
29
30
 
# File 'lib/roart.rb', line 28

def self.path( *args )
  args.empty? ? PATH : ::File.join(PATH, args.flatten)
end

.require_all_libs_relative_to(fname, dir = nil) ⇒ Object

Utility method used to require all files ending in .rb that lie in the directory below this file that has the same name as the filename passed in. Optionally, a specific directory name can be passed in such that the filename does not have to be equivalent to the directory.



37
38
39
40
41
42
43
 
# File 'lib/roart.rb', line 37

def self.require_all_libs_relative_to( fname, dir = nil )
  dir ||= ::File.basename(fname, '.*')
  search_me = ::File.expand_path(
      ::File.join(::File.dirname(fname), dir, '**', '*.rb'))

  Dir.glob(search_me).sort.each {|rb| require rb}
end

.version ⇒ Object

Returns the version string for the library.



12
13
14
 
# File 'lib/roart.rb', line 12

def self.version
  VERSION
end