eve 1.0.0

data/lib/eve/errors/miscellaneous_errors.rb

@@ -0,0 +1,19 @@
+module Eve
+  module Errors
+    # 9xx - Miscellaneous
+    class MiscellaneousError < StandardError; end
+
+    module MiscellaneousErrors
+      # 900 - Beta in progress, access denied.
+      class BetaInProgress < MiscellaneousError; end
+      # 901 - Web site database temporarily disabled.
+      class SiteDatabaseDisabled < MiscellaneousError; end
+      # 902 - EVE backend database temporarily disabled.
+      class BackendDatabaseDisabled < MiscellaneousError; end
+      # 903 - Rate limited [#]: please obey all cachedUntil timers.
+      class RateLimited < MiscellaneousError; end
+      # 999 - User forced test error condition.
+      class TestErrorForced < MiscellaneousError; end
+    end
+  end
+end

data/lib/eve/errors/user_input_errors.rb

@@ -0,0 +1,62 @@
+module Eve
+  module Errors
+    # 1xx - User Input Error
+    class UserInputError < StandardError; end
+
+    module UserInputErrors
+      # 100 - Expected beforeRefID = 0: wallet not previously loaded.
+      class WalletNotLoaded < UserInputError; end
+      # 101 - Wallet exhausted: retry after #.
+      class WalletExhausted < UserInputError; end
+      # 102 - Expected beforeRefID [#], got [#]: wallet previously loaded.
+      class WalletPreviouslyLoaded < UserInputError; end
+      # 103 - Already returned one week of data: retry after #.
+      class RetryLater < UserInputError; end
+      # 104 - GetAccountByKey(#): key not found.
+      class KeyNotFound < UserInputError; end
+      # 105 - Invalid characterID.
+      class InvalidCharacterID < UserInputError; end
+      # 106 - Must provide userID parameter for authentication.
+      class MissingUserID < UserInputError; end
+      # 107 - Invalid beforeRefID provided.
+      class InvalidBeforeRefID < UserInputError; end
+      # 108 - Invalid accountKey provided.
+      class InvalidAccountKey < UserInputError; end
+      # 109 - Invalid accountKey: must be in the range 1000 to 1006.
+      class AccountKeyOutOfBounds < UserInputError; end
+      # 110 - Invalid beforeTransID provided.
+      class InvalidBeforeTransID < UserInputError; end
+      # 111 - '#' is not a valid integer.
+      class InvalidInteger < UserInputError; end
+      # 112 - Version mismatch.
+      class VersionMismatch < UserInputError; end
+      # 113 - Version escalation is not allowed at this time.
+      class VersionEscalationNotAllowed < UserInputError; end
+      # 114 - Invalid itemID provided.
+      class InvalidItemID < UserInputError; end
+      # 115 - Assets already downloaded: retry after #.
+      class AssetsAlreadyDownloaded < UserInputError; end
+      # 116 - Industry jobs already downloaded: retry after #.
+      class IndustryJobsAlreadyDownloaded < UserInputError; end
+      # 117 - Market orders already downloaded: retry after #.
+      class MarketOrdersAlreadyDownloaded < UserInputError; end
+      # 118 - Expected beforeKillID = 0: wallet not previously loaded.
+      class KillsNotLoaded < UserInputError; end
+      # 119 - Kills exhausted: retry after #.
+      class KillsExhausted < UserInputError; end
+      # 120 - Expected beforeKillID [#] but supplied [#]: kills previously loaded.
+      class KillsPreviouslyLoaded < UserInputError; end
+      # 121 - Invalid beforeKillID provided.
+      class InvalidBeforeKillID < UserInputError; end
+      # 122 - Invalid or missing list of names.
+      class InvalidNameList < UserInputError; end
+      # 123 - Invalid or missing list of IDs.
+      class InvalidIDList < UserInputError; end
+      # 124 - Character not enlisted in Factional Warfare.
+      class CharacterNotEnlisted < UserInputError; end
+      # 125 - Corporation not enlisted in Factional Warfare.
+      class CorporationNotEnlisted < UserInputError; end
+    end
+  end
+end
+

data/lib/eve/helpers.rb

@@ -0,0 +1,12 @@
+require 'eve/helpers/view_helper'
+require 'eve/helpers/javascript_helper'
+
+module Eve
+  module Helpers
+    if defined?(ActionView::Base)
+      ActionView::Base.send(:include, Eve::Helpers::ViewHelper)
+      ActionView::Base.send(:include, Eve::Helpers::JavascriptHelper)
+    end
+  end
+end
+

data/lib/eve/helpers/javascript_helper.rb

@@ -0,0 +1,198 @@
+module Eve
+  module Helpers
+    # In addition to the helpers listed below, this library also exposes the "igb" method as described in
+    # Eve::Trust.
+    module JavascriptHelper
+      # 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
+      #
+      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
+
+      # Creates a hyperlink that results in opening the client's EVE mail inbox.
+      def link_to_evemail(text, *args)
+        link_to_function(text, "CCPEVE.openEveMail()", *args)
+      end
+
+      # 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.
+      #
+      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
+
+      # Creates a hyperlink that results in opening the preview window for type_id.
+      #
+      #  type_id (Number)
+      #    Type ID of item to preview.
+      #
+      def link_to_preview(text, type_id, *args)
+        link_to_function text, "CCPEVE.showPreview(#{type_id.inspect})", *args
+      end
+
+      # 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.
+      #
+      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
+
+      # 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.
+      #
+      def link_to_map(text, system_id = nil, *args)
+        link_to_function text, "CCPEVE.showMap(#{system_id ? system_id.inspect : ''})", *args
+      end
+
+      # Creates a hyperlink that results in opening the fitting window and displays the fitting represented by fitting.
+      #
+      #  fitting (String)
+      #    A Ship DNA string.
+      #
+      # See http://wiki.eveonline.com/en/wiki/Ship_DNA for details
+      def link_to_fitting(text, ship_dna_string, *args)
+        link_to_function text, "CCPEVE.showFitting(#{ship_dna_string.inspect})", *args
+      end
+
+      # 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.
+      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
+
+      # 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
+      #
+      def link_to_market_details(text, type_id, *args)
+        link_to_function text, "CCPEVE.showMarketDetails(#{type_id.inspect})", *args
+      end
+
+      # 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. http://wiki.eveonline.com instead of
+      # http://wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.
+      #
+      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
+
+      # 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. http://wiki.eveonline.com instead of
+      # http://wiki.eveonline.com/w/index.php), as this avoids pestering the user for trust on every page.
+      #
+      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
+
+      # 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.
+      def link_to_destination(text, solar_system_id, *args)
+        link_to_function text, "CCPEVE.setDestination(#{solar_system_id.inspect})", *args
+      end
+
+      # 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.
+      def link_to_waypoint(text, solar_system_id, *args)
+        link_to_function text, "CCPEVE.addWaypoint(#{solar_system_id.inspect})", *args
+      end
+
+      # 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.
+      def link_to_channel(text, channel_name, *args)
+        link_to_function text, "CCPEVE.joinChannel(#{channel_name.inspect})", *args
+      end
+
+      # 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.
+      def link_to_mailing_list(text, mailing_list_name, *args)
+        link_to_function text, "CCPEVE.joinMailingList(#{mailing_list_name.inspect})", *args
+      end
+    end
+  end
+end

data/lib/eve/helpers/view_helper.rb

@@ -0,0 +1,13 @@
+module Eve
+  module Helpers
+    # Provides various IGB-specific helper methods.
+    module ViewHelper
+      def self.included(base)
+        base.instance_eval do
+          delegate :igb, :to => :controller
+          delegate :igb?, :to => :igb
+        end
+      end
+    end
+  end
+end

data/lib/eve/trust.rb

@@ -0,0 +1,88 @@
+require 'eve/trust/mime_types'
+require 'eve/trust/controller_helpers'
+require 'eve/trust/igb_interface'
+
+module Eve
+  # == Trust
+  # The primary purpose for the ActionController is to figure out which View should be rendered, and what data to send
+  # to that View. In keeping with this design, a few helper methods have been established that allow you to establish
+  # trust with the In-Game Browser (IGB), which in turn provides access to more useful information such as the player's
+  # current location. To establish trust with a compatible browser, simply add one line to your controller:
+  #
+  #  class AnyController < ApplicationController
+  #    requires_trust
+  #  end
+  #
+  # This will cause the in-game browser to prompt the user, asking him/her to complete the handshake. If they refuse,
+  # the page will not load. To establish _optional_ trust -- that is, to allow the page to load even if the user hasn't
+  # granted the trust request -- you can use +prefers_trust+ instead:
+  #
+  #  class AnyController < ApplicationController
+  #    prefers_trust
+  #  end
+  #
+  # Both methods also accept a custom trust request message that will be shown to the user when they are prompted:
+  #
+  #  class AnyController < ApplicationController
+  #    prefers_trust "To take full advantage of the features on this site, please grant this trust request."
+  #  end
+  #
+  # == IGB Headers
+  # After trust has been established, the IGB sends additional content headers to the server with every request. These
+  # headers contain the most up-to-date information regarding the current user, his/her location, his/her character ID,
+  # and so on. The character ID could, for example, be used in conjunction with Eve::API to show the character's
+  # portrait in a forum.
+  #
+  # To gain access to this extra information, use the +igb+ method:
+  #
+  #  class AnyController < ApplicationController
+  #    . . .
+  #    def index
+  #      if igb? && igb.trusted?                  # if the client is using the IGB and trust has been established
+  #        @solar_system = igb.solar_system_name  # then make a note of the current solar system
+  #        @character_id = igb.character_id       # and the character ID
+  #      else
+  #        . . .                                  # handle a non-IGB browser such as Internet Explorer or Firefox.
+  #      end
+  #    end
+  #
+  # To find out which methods are exposed by the +igb+ method, take a look at Eve::Trust::IgbInterface.
+  #
+  # == View Format
+  # In Rails, the View is usually rendered in HTML format. That means the view template is usually called
+  # +some_action_name.html.erb+ , where "some_action_name" is the name of the current action and "html" is the file
+  # format. This library exposes a new format, "igb", which allows you to render an IGB-specific response. This response
+  # is expected to be in IGB-compatible HTML format. Here's an example of what an IGB file might look like:
+  #
+  #  <%=link_to_evemail "Check Your Mail!"%>
+  #  <%if igb.trusted?%>
+  #    <p>Thanks for your trust! I see you're currently in <%=igb.solar_system_name%>.</p>
+  #    <p>Here's some information about our secret headquarters:</p>
+  #    <ul>
+  #      <li><%=link_to_route "Click For Directions", "Jita"%></li>
+  #      <li><%=link_to_map "Show On Map", "Jita"%></li>
+  #    </ul>
+  #  <%end%>
+  #
+  # For more information about the various helpers available to your IGB-specific views, take a look at
+  # Eve::Helpers::JavascriptHelper.
+  #
+  # If the client is using the EVE In-Game Browser, then the "action_name.igb.erb" file will be automatically used,
+  # provided it exists. If the matching file is not found, then "action_name.html.erb" will be used in its place, just
+  # as if the client were using any other browser such as Internet Explorer or Firefox. You can also explicitly require
+  # that the .igb file be rendered using the +set_igb+ method:
+  #
+  #  class AnyController < ApplicationController
+  #    before_filter :check_for_igb_requirement
+  #    private
+  #    def check_for_igb_requirement
+  #      if (some_condition)
+  #        set_igb # force the IGB template for this action to be rendered
+  #      end
+  #    end
+  #  end
+  #
+  module Trust
+
+  end
+end

data/lib/eve/trust/controller_helpers.rb

@@ -0,0 +1,90 @@
+module Eve
+  module Trust
+    module ControllerHelpers
+      # None of this exists unless ActionController exists first.
+      if defined?(ActionController::Base)
+        class ::ApplicationController < ActionController::Base
+          hide_action :trust_message, :trust_message=, :detect_igb, :template_exists?,
+                      :set_igb_or_default, :default_template_exists?, :mock_methods_for_testing!,
+                      :igb, :igb?, :set_igb, :require_trust, :prefer_trust, :deliver_trust_message
+          class_inheritable_accessor :trust_message
+          read_inheritable_attribute(:trust_message) || write_inheritable_attribute(:trust_message,
+                                                                      "This web site is requesting your trust.")
+          delegate :igb?, :to => :igb
+          attr_reader :igb
+          before_filter :detect_igb
+
+          def require_trust(trust_message = self.class.trust_message)
+            if igb? && !igb.trusted?
+              deliver_trust_message(trust_message)
+              return false
+            end
+            true
+          end
+
+          def prefer_trust(trust_message = self.class.trust_message)
+            if igb? && !igb.trusted?
+              deliver_trust_message(trust_message)
+            end
+            true
+          end
+
+          def deliver_trust_message(trust_message = self.class.trust_message)
+            trust_uri = "http://#{request.host}/"
+            head 'eve.trustme' => "#{trust_uri}::#{trust_message}"
+          end
+
+          def detect_igb
+            @igb = Eve::Trust::IgbInterface.new(request)
+            mock_methods_for_testing! if request.headers['mock_methods']
+            if igb.igb?
+              set_igb_or_default
+            end
+          end
+
+          def set_igb_or_default
+            if default_template_exists? :igb
+              set_igb
+            end
+          end
+
+          def set_igb
+            request.format = :igb
+          end
+
+          def default_template_exists?(format = response.template.template_format)
+            template_exists?(default_template_name, format)
+          end
+
+          def template_exists?(template_name, format = response.template.template_format)
+            self.view_paths.find_template(template_name, format)
+          rescue ActionView::MissingTemplate, Errno::ENOENT
+            false
+          end
+
+          # a quick and dirty mocking solution. I should really make it better, but it works fine, and doesn't interfere
+          # with anything in prod, so I'll procrastinate a bit.
+          def mock_methods_for_testing! #:nodoc:
+            request.headers['mock_methods'].each do |method_name, return_value|
+              (class << self; self; end).instance_eval do
+                define_method(method_name) { |*not_used| return_value }
+              end
+            end
+          end
+
+          class << self
+            def requires_trust(message = trust_message)
+              self.trust_message = message if message != trust_message
+              before_filter :require_trust
+            end
+
+            def prefers_trust(message = trust_message)
+              self.trust_message = message if message != trust_message
+              before_filter :prefer_trust
+            end
+          end
+        end
+      end
+    end
+  end
+end