eve 1.0.0

data/lib/eve/api/services/eve.rb

@@ -0,0 +1,76 @@
+module Eve
+  class API
+    module Services
+      module Eve
+        def alliance_list;     request(:eve, :alliance_list);     end
+        def certificate_tree;  request(:eve, :certificate_tree, :column_mapping => { 'level' => 'skillLevel' });  end
+        def conquerable_station_list; request(:eve, :conquerable_station_list); end
+        def error_list; request(:eve, :error_list); end
+        def fac_war_stats; request(:eve, :fac_war_stats); end
+        def fac_war_top_stats; request(:eve, :fac_war_top_stats); end
+        def skill_tree; request(:eve, :skill_tree); end
+
+        # Returns a list of transaction types used in the Journal Entries
+        # Response Example:
+        #   result = api.eve.ref_types
+        #   result.ref_types                    #=> (Rowset)
+        #   result.ref_types[0].ref_type_id     #=> 0
+        #   result.ref_types[0].ref_type_name   #=> "Undefined"
+        #   result.ref_types[1].ref_type_id     #=> 1
+        #   result.ref_types[1].ref_type_name   #=> "Player Trading"
+        #   . . .
+        def ref_types
+          response = request(:eve, :ref_types)
+          result = {}
+          response.ref_types.each do |row|
+            result[row.ref_type_id] = row.ref_type_name
+          end
+          result
+        end
+
+        # Character ID to Name conversion. Accepts a list of character names, and returns the name for each name
+        # in the form of a Hash. Despite the name, it can also accept corporation and alliance names.
+        def character_id(*names)
+          response = request(:eve, :character_id, :names => names.flatten.join(','))
+          result = {}
+          [:characters, :corporations, :alliances].each do |field|
+            if response.respond_to?(field)
+              response.send(field).each { |row| result[row.name] = row.character_id }
+            end
+          end
+          result
+        end
+
+        # Character ID to Name conversion. Accepts a list of character IDs, and returns the name for each ID
+        # in the form of a Hash. Despite the name, it can also accept corporation and alliance IDs.
+        def character_name(*ids)
+          response = request(:eve, :character_name, :ids => ids.flatten.join(','))
+          result = {}
+          [:characters, :corporations, :alliances].each do |field|
+            if response.respond_to?(field)
+              response.send(field).each { |row| result[row.name] = row.name }
+            end
+          end
+          result
+        end
+
+        alias character_ids character_id
+        alias corporation_ids character_id
+        alias corporation_id character_id
+        alias corporation_ids character_id
+        alias alliance_ids character_id
+        alias alliance_id character_id
+
+        alias character_names character_name
+        alias corporation_names character_names
+        alias corporation_name character_name
+        alias corporation_names character_names
+        alias alliance_names character_names
+        alias alliance_name character_name
+
+        alias factional_warfare_stats fac_war_stats
+        alias factional_warfare_top100 fac_war_top_stats
+      end
+    end
+  end
+end

data/lib/eve/api/services/map.rb

@@ -0,0 +1,45 @@
+module Eve
+  class API
+    module Services
+      module Map
+        # Returns the sovereignty status of all solar systems. Warning: This is a lot of data!
+        #
+        # Returns an object with a single "solar_systems" array. Each element in the array contains:
+        #   solar_system_id
+        #   alliance_id
+        #   faction_id
+        #   corporation_id
+        #   solar_system_name
+        def sovereignty;     request('map', :sovereignty);     end
+
+        # Returns the sovereignty status of all solar systems. Warning: This is a lot of data!
+        #
+        # Returns an object with a single "solar_systems" array. Each element in the array contains:
+        #   solar_system_id
+        #   ship_kills      (number)
+        #   faction_kills   (number)
+        #   pod_kills       (number)
+        def kills;           request('map', :kills);           end
+
+        # Returns the sovereignty status of all solar systems. Warning: This is a lot of data!
+        #
+        # Returns an object with a single "solar_systems" array. Each element in the array contains:
+        #   solar_system_id
+        #   ship_jumps      (number)
+        def jumps;           request('map', :jumps);           end
+
+        # Returns the sovereignty status of all solar systems. Warning: This is a lot of data!
+        #
+        # Returns an object with a single "solar_systems" array. Each element in the array contains:
+        #   solar_system_id
+        #   solar_system_name
+        #   occupying_faction_id
+        #   occupying_faction_name
+        #   contested              (boolean)
+        def fac_war_systems; request('map', :fac_war_systems); end
+
+        alias contested_systems fac_war_systems
+      end
+    end
+  end
+end

data/lib/eve/api/services/misc.rb

@@ -0,0 +1,24 @@
+module Eve
+  class API
+    module Services
+      module Misc
+        # Returns a binary String representing a JPEG image that is the portrait of the character with
+        # the specified ID.
+        #
+        # Optionally, the :size may be set to 64x64 or 256x256. This defaults to 64x64.
+        #
+        # Example:
+        #  api.character_portrait(661196469)
+        #
+        def character_portrait(character_id, options = { :size => 64 })
+          options[:s] ||= options.delete(:size)
+          options[:c] ||= character_id
+          request('', 'serv', options.reverse_merge(:base_uri => 'http://img.eve.is',
+                                                    :extension => 'asp',
+                                                    :camelize => false,
+                                                    :response_type => :string))
+        end
+      end
+    end
+  end
+end

data/lib/eve/api/services/server.rb

@@ -0,0 +1,20 @@
+module Eve
+  class API
+    module Services
+      module Server
+        # Returns the current server status.
+        #
+        #  >> puts Eve::API.new.server_status.to_yaml
+        #  ---
+        #  current_time: 2010-03-14T04:41:51+00:00
+        #  cached_until: 2010-03-14T04:44:51+00:00
+        #  online_players: 30694
+        #  server_open: true
+        #  api_version: "2"
+        def server_status
+          request(:server, :server_status)
+        end
+      end
+    end
+  end
+end

data/lib/eve/core_extensions.rb

@@ -0,0 +1,3 @@
+Dir[File.join(File.dirname(__FILE__), "core_extensions/**/*.rb")].each do |fi|
+  require fi
+end

data/lib/eve/core_extensions/hash.rb

@@ -0,0 +1,51 @@
+class Hash
+  def without(*keys)
+    keys.flatten!
+    inject({}) do |hash, (key, value)|
+      hash[key] = value unless keys.include?(key)
+      hash
+    end
+  end
+
+  def without_values(*values)
+    values.flatten!
+    inject({}) do |hash, (key, value)|
+      hash[key] = value unless values.include?(value)
+      hash
+    end
+  end
+
+  # Returns a hash that is a copy of this one, except that all nil values have been removed, making them
+  # essentially "optional" keys.
+  def optionalize
+    without_values(nil)
+  end
+
+  alias without_nil_values optionalize
+
+  def camelize_keys
+    stringify_keys.rename(inject({}) do |renamed, (key, value)|
+      renamed[key.to_s] = key.to_s.camelize
+      renamed
+    end)
+  end
+
+  # Takes a hash whose keys must match keys in this hash. Those keys will be renamed to match the
+  # corresponding value in the specified hash.
+  #
+  # Keys not found are ignored.
+  #
+  # Returns self.
+  #
+  # Example:
+  #   { :a => 1 }.rename(:a => :b)
+  #     => {:b => 1}
+  #
+  def rename(to)
+    merge!(inject({}) do |hash, (old_key, value)|
+      hash[to[old_key] || old_key] = value
+      delete(old_key)
+      hash
+    end)
+  end
+end

data/lib/eve/core_extensions/string.rb

@@ -0,0 +1,11 @@
+class String
+  # The inverse of +ActiveSupport::Inflection#humanize+: Lowercases the first letter, and turns spaces into underscores.
+  # This is meant to assist in creating method names. A camelCase method name can be created using #dehumanize:
+  #   "say_hello_to_the_world".camelize.dehumanize  # => "sayHelloToTheWorld"
+  #
+  # This can also be used for creating permalinks:
+  #   "Say hello to the world".dehumanize           # => "say_hello_to_the_world"
+  def dehumanize
+    self.camelize.gsub(/^([A-Z])/) { |x| x.downcase }.gsub(/ /, '_')
+  end
+end

data/lib/eve/dependencies.rb

@@ -0,0 +1,18 @@
+unless defined?(Gem)
+  require 'rubygems'
+  gem 'hpricot',       '>= 0.8.2'
+  gem 'actionpack',    '>= 2.3.5'
+  gem 'activesupport', '>= 2.3.5'
+end
+
+require 'net/http'
+require 'hpricot'
+require 'yaml'
+require 'action_pack'
+require 'action_controller'
+require 'action_view'
+
+gem_path = File.expand_path(File.dirname(__FILE__), "..")
+$LOAD_PATH.unshift gem_path
+ActiveSupport::Dependencies.load_paths.unshift gem_path
+ActiveSupport::Dependencies.load_once_paths.unshift gem_path

data/lib/eve/errors.rb

@@ -0,0 +1,129 @@
+require 'eve/errors/user_input_errors'
+require 'eve/errors/authentication_errors'
+require 'eve/errors/internal_errors'
+require 'eve/errors/miscellaneous_errors'
+
+module Eve
+  module Errors
+    class << self
+      # Returns an error class by its code. If a match cannot be found, the closest match is used instead.
+      # For instance, '100' returns WalletNotLoaded; '199' returns UserInputError.
+      def find_by_code(code)
+        return API_ERROR_MAP[code.to_i] if API_ERROR_MAP.key?(code.to_i)
+        # exact match can't be found, look for x's
+        code = code.to_s
+        while code.length > 0
+          generic_code = code + "x"*(3-code.length)
+          return API_ERROR_MAP[generic_code] if API_ERROR_MAP.key?(generic_code)
+          code = code[0...-1]
+        end
+        UnknownError
+      end
+
+      def raise(*several_variants)
+        options = several_variants.extract_options!
+        super if options.empty?
+        if options[:code]
+          klass = find_by_code(options[:code])
+          message = options[:message]
+          raise klass, message, caller
+        end
+      end
+    end
+
+    # Raised when a rowset cannot be processed.
+    class InvalidRowset < StandardError; end
+
+    # Raised when something goes wrong and no other error can be found.
+    class UnknownError < StandardError; end
+
+    unless defined?(API_ERROR_MAP)
+      API_ERROR_MAP = {
+        '1xx' => Eve::Errors::UserInputError,
+        100 => Eve::Errors::UserInputErrors::WalletNotLoaded,
+        101 => Eve::Errors::UserInputErrors::WalletExhausted,
+        102 => Eve::Errors::UserInputErrors::WalletPreviouslyLoaded,
+        103 => Eve::Errors::UserInputErrors::RetryLater,
+        104 => Eve::Errors::UserInputErrors::KeyNotFound,
+        105 => Eve::Errors::UserInputErrors::InvalidCharacterID,
+        106 => Eve::Errors::UserInputErrors::MissingUserID,
+        107 => Eve::Errors::UserInputErrors::InvalidBeforeRefID,
+        108 => Eve::Errors::UserInputErrors::InvalidAccountKey,
+        109 => Eve::Errors::UserInputErrors::AccountKeyOutOfBounds,
+        110 => Eve::Errors::UserInputErrors::InvalidBeforeTransID,
+        111 => Eve::Errors::UserInputErrors::InvalidInteger,
+        112 => Eve::Errors::UserInputErrors::VersionMismatch,
+        113 => Eve::Errors::UserInputErrors::VersionEscalationNotAllowed,
+        114 => Eve::Errors::UserInputErrors::InvalidItemID,
+        115 => Eve::Errors::UserInputErrors::AssetsAlreadyDownloaded,
+        116 => Eve::Errors::UserInputErrors::IndustryJobsAlreadyDownloaded,
+        117 => Eve::Errors::UserInputErrors::MarketOrdersAlreadyDownloaded,
+        118 => Eve::Errors::UserInputErrors::KillsNotLoaded,
+        119 => Eve::Errors::UserInputErrors::KillsExhausted,
+        120 => Eve::Errors::UserInputErrors::KillsPreviouslyLoaded,
+        121 => Eve::Errors::UserInputErrors::InvalidBeforeKillID,
+        122 => Eve::Errors::UserInputErrors::InvalidNameList,
+        123 => Eve::Errors::UserInputErrors::InvalidIDList,
+        124 => Eve::Errors::UserInputErrors::CharacterNotEnlisted,
+        125 => Eve::Errors::UserInputErrors::CorporationNotEnlisted,
+
+        '2xx' => Eve::Errors::AuthenticationError,
+        200 => Eve::Errors::AuthenticationErrors::InadequateSecurityLevel,
+        201 => Eve::Errors::AuthenticationErrors::WrongAccount,
+        202 => Eve::Errors::AuthenticationErrors::CachedKeyAuthFailure,
+        203 => Eve::Errors::AuthenticationErrors::AuthenticationFailure,
+        204 => Eve::Errors::AuthenticationErrors::AuthenticationFailure,
+        205 => Eve::Errors::AuthenticationErrors::LastAuthenticationFailure,
+        206 => Eve::Errors::AuthenticationErrors::MissingRoles,
+        207 => Eve::Errors::AuthenticationErrors::NotAvailable,
+        208 => Eve::Errors::AuthenticationErrors::MissingRoles,
+        209 => Eve::Errors::AuthenticationErrors::MissingRoles,
+        210 => Eve::Errors::AuthenticationErrors::AuthenticationFailure,
+        211 => Eve::Errors::AuthenticationErrors::LoginDenied,
+        212 => Eve::Errors::AuthenticationErrors::LastAuthenticationFailure,
+        213 => Eve::Errors::AuthenticationErrors::MissingRoles,
+        214 => Eve::Errors::AuthenticationErrors::NotInAlliance,
+
+
+        '5xx' => Eve::Errors::InternalError,
+        500 => Eve::Errors::InternalErrors::InvalidOrNotLoaded,
+        501 => Eve::Errors::InternalErrors::InvalidOrNotLoaded,
+        502 => Eve::Errors::InternalErrors::CacheUtilMissing,
+        503 => Eve::Errors::InternalErrors::InvalidInput,
+        504 => Eve::Errors::InternalErrors::InvalidRace,
+        505 => Eve::Errors::InternalErrors::InvalidGender,
+        506 => Eve::Errors::InternalErrors::InvalidBloodline,
+        507 => Eve::Errors::InternalErrors::InvalidAttribute,
+        508 => Eve::Errors::InternalErrors::InvalidRefType,
+        509 => Eve::Errors::InternalErrors::NullAttributeID,
+        510 => Eve::Errors::InternalErrors::MissingCorporation,
+        511 => Eve::Errors::InternalErrors::InvalidAccountKey,
+        512 => Eve::Errors::InternalErrors::InvalidCharID,
+        513 => Eve::Errors::InternalErrors::RolesQueryFailure,
+        514 => Eve::Errors::InternalErrors::InvalidCorpID,
+        515 => Eve::Errors::InternalErrors::InvalidUserID,
+        516 => Eve::Errors::InternalErrors::UserInformationFailure,
+        517 => Eve::Errors::InternalErrors::CSVMismatch,
+        518 => Eve::Errors::InternalErrors::TQTimeFailure,
+        519 => Eve::Errors::InternalErrors::StarbaseDetailFailure,
+        520 => Eve::Errors::InternalErrors::UnexpectedDatabaseFailure,
+        521 => Eve::Errors::InternalErrors::InvalidCredentials,
+        522 => Eve::Errors::InternalErrors::CharacterInformationFailure,
+        523 => Eve::Errors::InternalErrors::CorporationInformationFailure,
+        524 => Eve::Errors::InternalErrors::FactionMemberInformationFailure,
+        525 => Eve::Errors::InternalErrors::MedalInformationFailure,
+        526 => Eve::Errors::InternalErrors::NotificationsNotAvailable,
+        527 => Eve::Errors::InternalErrors::MailNotAvailable,
+
+        '9xx' => Eve::Errors::MiscellaneousError,
+        900 => Eve::Errors::MiscellaneousErrors::BetaInProgress,
+        901 => Eve::Errors::MiscellaneousErrors::SiteDatabaseDisabled,
+        902 => Eve::Errors::MiscellaneousErrors::BackendDatabaseDisabled,
+        903 => Eve::Errors::MiscellaneousErrors::RateLimited,
+        999 => Eve::Errors::MiscellaneousErrors::TestErrorForced,
+      }
+
+      API_ERROR_MAP.freeze
+    end
+  end
+end

data/lib/eve/errors/authentication_errors.rb

@@ -0,0 +1,33 @@
+module Eve
+  module Errors
+    # 2xx - authentication/security/credentials error
+    class AuthenticationError < StandardError; end
+
+    module AuthenticationErrors
+      # 200 - Security level not high enough.
+      class InadequateSecurityLevel < AuthenticationError; end
+      # 201 - Character does not belong to account.
+      class WrongAccount < AuthenticationError; end
+      # 202 - Cached API key authentication failure.
+      class CachedKeyAuthFailure < AuthenticationError; end
+      # 203 - Authentication failure.
+      # 204 - Authentication failure.
+      # 210 - Authentication failure.
+      class AuthenticationFailure < AuthenticationError; end
+      # 205 - Authentication failure (final pass).
+      # 212 - Authentication failure (final pass).
+      class LastAuthenticationFailure < AuthenticationError; end
+      # 207 - Not available for NPC corporations.
+      class NotAvailable < AuthenticationError; end
+      # 206 - Character must have Accountant or Junior Accountant roles.
+      # 208 - Character must have Accountant, Junior Accountant, or Trader roles.
+      # 209 - Character must be a Director or CEO.
+      # 213 - Character must have Factory Manager role.
+      class MissingRoles < AuthenticationError; end
+      # 211 - Login denied by account status.
+      class LoginDenied < AuthenticationError; end
+      # 214 - Corporation is not part of alliance.
+      class NotInAlliance < AuthenticationError; end
+    end
+  end
+end

data/lib/eve/errors/internal_errors.rb

@@ -0,0 +1,64 @@
+module Eve
+  module Errors
+    # 5xx - Internal error (we did something bad)
+    class InternalError < StandardError; end
+
+    module InternalErrors
+      # 500 - GetName(#) is invalid or not loaded.
+      # 501 - GetID(#) is invalid or not loaded.
+      class InvalidOrNotLoaded < InternalError; end
+      # 502 - CacheUtil(#) seems to not be in the configuration.
+      class CacheUtilMissing < InternalError; end
+      # 503 - GetSkillpointsForLevel(#, #): invalid input.
+      class InvalidInput < InternalError; end
+      # 504 - GetRace(#): invalid race.
+      class InvalidRace < InternalError; end
+      # 505 - GetGender(#): invalid gender.
+      class InvalidGender < InternalError; end
+      # 506 - GetBloodline(#): invalid bloodline.
+      class InvalidBloodline < InternalError; end
+      # 507 - GetAttribute(#): invalid attribute.
+      class InvalidAttribute < InternalError; end
+      # 508 - GetRefType(#): invalid reftype.
+      class InvalidRefType < InternalError; end
+      # 509 - attributeID # has null data components.
+      class NullAttributeID < InternalError; end
+      # 510 - Character does not appear to have a corporation.  Not loaded?
+      class MissingCorporation < InternalError; end
+      # 511 - AccountCanQuery(#): invalid accountKey.
+      class InvalidAccountKey < InternalError; end
+      # 512 - Invalid charID passed to CharData.GetCharacter()
+      class InvalidCharID < InternalError; end
+      # 513 - Failed to get character roles in corporation.
+      class RolesQueryFailure < InternalError; end
+      # 514 - Invalid corpID passed to CorpData.GetCorporation().
+      class InvalidCorpID < InternalError; end
+      # 515 - Invalid userID and/or apiKey passed to UserData.GetUser().
+      class InvalidUserID < InternalError; end
+      # 516 - Failed getting user information.
+      class UserInformationFailure < InternalError; end
+      # 517 - CSV header/row count mismatch.
+      class CSVMismatch < InternalError; end
+      # 518 - Unable to get current TQ time.
+      class TQTimeFailure < InternalError; end
+      # 519 - Failed getting starbase detail information.
+      class StarbaseDetailFailure < InternalError; end
+      # 520 - Unexpected failure accessing database.
+      class UnexpectedDatabaseFailure < InternalError; end
+      # 521 - Invalid username and/or password passed to UserData.LoginWebUser().
+      class InvalidCredentials < InternalError; end
+      # 522 - Failed getting character information.
+      class CharacterInformationFailure < InternalError; end
+      # 523 - Failed getting corporation information.
+      class CorporationInformationFailure < InternalError; end
+      # 524 - Failed getting faction member information.
+      class FactionMemberInformationFailure < InternalError; end
+      # 525 - Failed getting medal information.
+      class MedalInformationFailure < InternalError; end
+      # 526 - Notifications for this character is not yet accessible.
+      class NotificationsNotAvailable < InternalError; end
+      # 527 - Mail for this character is not yet accessible.
+      class MailNotAvailable < InternalError; end
+    end
+  end
+end