Module: Eve::JavascriptHelper

Defined in:
lib/eve/javascript_helper.rb

Overview

In addition to the helpers listed below, this library also exposes the “igb” method as described in Eve::Trust.

Instance Method Summary collapse

Instance Method Details

Causes the user to attempt to join the named channel. Normal channel access control rules apply. If the user is unable to join the channel, the method fails silently.

channel_name (String)
  The name of the channel which the user will join.

This method requires that the user grant Trust to the calling site.



182
183
184
 
# File 'lib/eve/javascript_helper.rb', line 182

def link_to_channel(text, channel_name, *args)
  link_to_function text, "CCPEVE.joinChannel(#{channel_name.inspect})", *args
end

#link_to_contract(text, solar_system_id, contract_id, *args) ⇒ Object

Creatse a hyperlink that results in opening the contract window and displaying the contract represented by the contract_id argument. Contracts are, however, assigned per-solar-system, and so a solar_system_id must also be provided.

solar_system_id (Number)
  The ID number of the solar system in which the contract is located.
contract_id (Number)
  The ID number of the contract to display.



100
101
102
 
# File 'lib/eve/javascript_helper.rb', line 100

def link_to_contract(text, solar_system_id, contract_id, *args)
  link_to_function text, "CCPEVE.showContract(#{solar_system_id.inspect}, #{contract_id.inspect})", *args
end

#link_to_destination(text, solar_system_id, *args) ⇒ Object

Sets the client’s autopilot destination to the specified solar system.

solar_system_id (Number)
  The numerical identifier of the solar system to which you wish to set the client's autopilot destination.

This method requires that the user grant Trust to the calling site.



160
161
162
 
# File 'lib/eve/javascript_helper.rb', line 160

def link_to_destination(text, solar_system_id, *args)
  link_to_function text, "CCPEVE.setDestination(#{solar_system_id.inspect})", *args
end

#link_to_evemail(text, *args) ⇒ Object

Creates a hyperlink that results in opening the client’s EVE mail inbox.



34
35
36
 
# File 'lib/eve/javascript_helper.rb', line 34

def link_to_evemail(text, *args)
  link_to_function(text, "CCPEVE.openEveMail()", *args)
end

#link_to_fitting(text, ship_dna_string, *args) ⇒ Object

Creates a hyperlink that results in opening the fitting window and displays the fitting represented by fitting.

fitting (String)
  A Ship DNA string.

See wiki.eveonline.com/en/wiki/Ship_DNA for details



88
89
90
 
# File 'lib/eve/javascript_helper.rb', line 88

def link_to_fitting(text, ship_dna_string, *args)
  link_to_function text, "CCPEVE.showFitting(#{ship_dna_string.inspect})", *args
end

#link_to_info(text, type_id, item_id = nil, *args) ⇒ Object

Creates a hyperlink that results in the “show info” dialog being displayed on the client’s screen. If item_id is given, the show info window will open for that item.

type_id (Number)
  Type ID of item to show info on.
item_id (Number)
  Optional item ID of specific item of type type_id to show info on. This is required for specific types of
  items, such as solar systems, stations, regions, and constellations.



47
48
49
50
51
52
 
# File 'lib/eve/javascript_helper.rb', line 47

def link_to_info(text, type_id, item_id = nil, *args)
  function = "CCPEVE.showInfo(#{type_id.inspect}"
  function.concat ", #{item_id.inspect}" if item_id
  function.concat ")"
  link_to_function text, function, *args
end

#link_to_mailing_list(text, mailing_list_name, *args) ⇒ Object

Causes the user to subscribe to the named mailing list.

mailing_list_name (String)
  The name of the mailing list which the user will join.

This method requires that the user grant Trust to the calling site.



192
193
194
 
# File 'lib/eve/javascript_helper.rb', line 192

def link_to_mailing_list(text, mailing_list_name, *args)
  link_to_function text, "CCPEVE.joinMailingList(#{mailing_list_name.inspect})", *args
end

#link_to_map(text, system_id = nil, *args) ⇒ Object

Creates a hyperlink that results in opening the map. If system_id is given, the map will focus on that system.

system_id (Number)
  Optional ID of solar system to focus map on.



78
79
80
 
# File 'lib/eve/javascript_helper.rb', line 78

def link_to_map(text, system_id = nil, *args)
  link_to_function text, "CCPEVE.showMap(#{system_id ? system_id.inspect : ''})", *args
end

#link_to_market_details(text, type_id, *args) ⇒ Object

Creates a hyperlink which results in opening the market details window and displays the information about the item represented by type_id.

typeID (Number)
  Type ID to display market details about



110
111
112
 
# File 'lib/eve/javascript_helper.rb', line 110

def link_to_market_details(text, type_id, *args)
  link_to_function text, "CCPEVE.showMarketDetails(#{type_id.inspect})", *args
end

#link_to_preview(text, type_id, *args) ⇒ Object

Creates a hyperlink that results in opening the preview window for type_id.

type_id (Number)
  Type ID of item to preview.



59
60
61
 
# File 'lib/eve/javascript_helper.rb', line 59

def link_to_preview(text, type_id, *args)
  link_to_function text, "CCPEVE.showPreview(#{type_id.inspect})", *args
end

#link_to_route(text, destination_id, source_id = nil, *args) ⇒ Object

Creates a hyperlink that results in showing the route to the destination_id from the source_id. If source_id is not given, the source system is taken to be the system the user is currently in.



66
67
68
69
70
71
 
# File 'lib/eve/javascript_helper.rb', line 66

def link_to_route(text, destination_id, source_id = nil, *args)
  function = "CCPEVE.showRouteTo(#{destination_id.inspect}"
  function.concat ", #{source_id.inspect}" if source_id
  function.concat ")"
  link_to_function text, function, *args
end

#link_to_trust_request(text, trust_url = "http://#{request.host}/", *args) ⇒ Object

Produces a hyperlink that will result in a pop-up a trust prompt in the client, allowing the user to either grant the trust request, ignore it, or always ignore trust requests from your site.

trust_url (String)
  This is a fully-qualified domain name and path (e.g. http://wiki.eveonline.com/w/) to which your site would
  like the user to grant trust.

The page will not be automatically refreshed if the user grants the trust request. Trust will take effect the next time the user refreshes the page, or navigates within the site.

Note that trust_url is processed and only the protocol, domain and path will be used from it. If you supply a query string or anchor, they will be discarded. It is recommended that you primarily pass in only fully-qualified domain names without paths (e.g. wiki.eveonline.com instead of wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.



129
130
131
132
 
# File 'lib/eve/javascript_helper.rb', line 129

def link_to_trust_request(text, trust_url = "http://#{request.host}/", *args)
  trust_url = url_for(trust_url.merge(:only_path => false)) if trust_url.kind_of?(Hash)
  link_to_function text, "CCPEVE.requestTrust(#{trust_url.inspect})", *args
end

#link_to_waypoint(text, solar_system_id, *args) ⇒ Object

Adds the specified solar system to the end of the client’s autopilot route. If the solar system is already in the route, no changes are made and the method fails silently.

solar_system_id (Number)
  The numerical identifier of the solar system which you wish to append to the client's autopilot route.

This method requires that the user grant Trust to the calling site.



171
172
173
 
# File 'lib/eve/javascript_helper.rb', line 171

def link_to_waypoint(text, solar_system_id, *args)
  link_to_function text, "CCPEVE.addWaypoint(#{solar_system_id.inspect})", *args
end

#request_trust(trust_url = "http://#{request.host}/", *args) ⇒ Object

This will generate a method call that produces a pop-up a trust prompt in the client, allowing the user to either grant the trust request, ignore it, or always ignore trust requests from your site.

trust_url (String)
  This is a fully-qualified domain name and path (e.g. http://wiki.eveonline.com/w/) to which your site would
  like the user to grant trust.

The page will not be automatically refreshed if the user grants the trust request. Trust will take effect the next time the user refreshes the page, or navigates within the site.

Note that trust_url is processed and only the protocol, domain and path will be used from it. If you supply a query string or anchor, they will be discarded. It is recommended that you primarily pass in only fully-qualified domain names without paths (e.g. wiki.eveonline.com instead of wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.



149
150
151
152
 
# File 'lib/eve/javascript_helper.rb', line 149

def request_trust(trust_url = "http://#{request.host}/", *args)
  trust_url = url_for(trust_url.merge(:only_path => false)) if trust_url.kind_of?(Hash)
  javascript_tag "CCPEVE.requestTrust(#{trust_url.inspect});", *args
end

#type_id(which) ⇒ Object

Returns the numeric type ID for a string, so you don’t have to manage “magic numbers” in your application. The argument can be a string or a symbol, and is case insensitive. Underscores will be converted to spaces.

Examples:

type_id('alliance')       # => 16159
type_id('character')      # => 1377
type_id('corporation')    # => 2
type_id('constellation')  # => 4
type_id('region')         # => 3
type_id('Solar System')   # => 5
type_id(:solar_system)    # => 5
type_id(:station)         # => 3867



18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/eve/javascript_helper.rb', line 18

def type_id(which)
  which = which.to_s.humanize unless which.kind_of?(String)
  which.downcase!
  case which
    when 'alliance' then 16159
    when 'character' then 1377
    when 'corporation' then 2
    when 'constellation' then 4
    when 'region' then 3
    when 'solar system', 'solarsystem' then 5
    when 'station' then 3867
    else raise ArgumentError, "Unknown type: #{which}"
  end
end