greeve 0.0.1 → 1.0.0

data/lib/greeve/character/industry_jobs_history.rb

@@ -0,0 +1,48 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Finished character industry jobs.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_industryjobshistory.html
+    class IndustryJobsHistory < Greeve::BaseItem
+      endpoint "char/IndustryJobsHistory"
+
+      rowset :jobs, xpath: "eveapi/result/rowset[@name='jobs']" do
+        attribute :job_id,                 xpath: "@jobID",                type: :integer
+        attribute :installer_id,           xpath: "@installerID",          type: :integer
+        attribute :installer_name,         xpath: "@installerName",        type: :string
+        attribute :facility_id,            xpath: "@facilityID",           type: :integer
+        attribute :solar_system_id,        xpath: "@solarSystemID",        type: :integer
+        attribute :solar_system_name,      xpath: "@solarSystemName",      type: :string
+        attribute :station_id,             xpath: "@stationID",            type: :integer
+        attribute :activity_id,            xpath: "@activityID",           type: :integer
+        attribute :blueprint_id,           xpath: "@blueprintID",          type: :integer
+        attribute :blueprint_type_id,      xpath: "@blueprintTypeID",      type: :integer
+        attribute :blueprint_type_name,    xpath: "@blueprintTypeName",    type: :string
+        attribute :blueprint_location_id,  xpath: "@blueprintLocationID",  type: :integer
+        attribute :output_location_id,     xpath: "@outputLocationID",     type: :integer
+        attribute :runs,                   xpath: "@runs",                 type: :integer
+        attribute :cost,                   xpath: "@cost",                 type: :numeric
+        attribute :licensed_runs,          xpath: "@licensedRuns",         type: :integer
+        attribute :probability,            xpath: "@probability",          type: :numeric
+        attribute :product_type_id,        xpath: "@productTypeID",        type: :integer
+        attribute :product_type_name,      xpath: "@productTypeName",      type: :string
+        attribute :status,                 xpath: "@status",               type: :integer
+        attribute :time_in_seconds,        xpath: "@timeInSeconds",        type: :integer
+        attribute :start_date,             xpath: "@startDate",            type: :datetime
+        attribute :end_date,               xpath: "@endDate",              type: :datetime
+        attribute :pause_date,             xpath: "@pauseDate",            type: :datetime
+        attribute :completed_date,         xpath: "@completedDate",        type: :datetime
+        attribute :completed_character_id, xpath: "@completedCharacterID", type: :integer
+        attribute :successful_runs,        xpath: "@successfulRuns",       type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/locations.rb

@@ -0,0 +1,36 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Location and name of specific items that belong to the character of the
+    # api key. This call can be used to retrieve the player-set name of
+    # containers and ships.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_locations.html
+    class Locations < Greeve::BaseItem
+      endpoint "char/Locations"
+
+      rowset :locations, xpath: "eveapi/result/rowset[@name='locations']" do
+        attribute :item_id,   xpath: "@itemID",   type: :integer
+        attribute :item_name, xpath: "@itemName", type: :string
+        attribute :x,         xpath: "@x",        type: :numeric
+        attribute :y,         xpath: "@y",        type: :numeric
+        attribute :z,         xpath: "@z",        type: :numeric
+      end
+
+      # @param character_id [Integer] EVE character ID
+      #
+      # @option opts [Array<Integer>, Integer] :ids (nil) ID or array of IDs of
+      #   items belonging to the character
+      def initialize(character_id, opts = {})
+        ids = opts.delete(:ids)
+        ids = [ids] unless ids.nil? || ids.is_a?(Array)
+
+        opts[:query_params] = { "characterID" => character_id }
+        opts[:query_params]["IDs"] = ids.join(",") if ids
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/mail_bodies.rb

@@ -0,0 +1,33 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Bodies of eve mail messages sent to the character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_mailbodies.html
+    class MailBodies < Greeve::BaseItem
+      endpoint "char/MailBodies"
+
+      rowset :messages, xpath: "eveapi/result/rowset[@name='messages']" do
+        attribute :message_id, xpath: "@messageID", type: :integer
+        attribute :message_text, xpath: "?[0]", type: :string
+      end
+
+      # @param character_id [Integer] EVE character ID
+      # @param message_ids [*Array<Integer>, Integer] either a single message ID,
+      #   or a list of message IDs
+      #
+      # @!method initialize(character_id, *message_ids, opts = {})
+      def initialize(character_id, *message_ids)
+        opts = message_ids.last.is_a?(Hash) ? message_ids.pop : {}
+
+        opts[:query_params] = {
+          "characterID" => character_id,
+          "IDs" => message_ids.join(","),
+        }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/mail_messages.rb

@@ -0,0 +1,29 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # The header of eve mail messages sent to the character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_mailmessages.html
+    class MailMessages < Greeve::BaseItem
+      endpoint "char/MailMessages"
+
+      rowset :messages, xpath: "eveapi/result/rowset[@name='messages']" do
+        attribute :message_id,             xpath: "@messageID",          type: :integer
+        attribute :sender_id,              xpath: "@senderID",           type: :integer
+        attribute :sender_name,            xpath: "@senderName",         type: :string
+        attribute :sent_date,              xpath: "@sentDate",           type: :datetime
+        attribute :title,                  xpath: "@title",              type: :string
+        attribute :to_corp_or_alliance_id, xpath: "@toCorpOrAllianceID", type: :integer
+        attribute :to_character_ids,       xpath: "@toCharacterIDs",     type: :integer_array
+        attribute :to_list_id,             xpath: "@toListID",           type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/mailing_lists.rb

@@ -0,0 +1,23 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Mailing lists the character is a member of.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_mailinglists.html
+    class MailingLists < Greeve::BaseItem
+      endpoint "char/MailingLists"
+
+      rowset :mailing_lists, xpath: "eveapi/result/rowset[@name='mailingLists']" do
+        attribute :list_id,      xpath: "@listID",      type: :integer
+        attribute :display_name, xpath: "@displayName", type: :string
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/market_orders.rb

@@ -0,0 +1,42 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character market orders.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_marketorders.html
+    class MarketOrders < Greeve::BaseItem
+      endpoint "char/MarketOrders"
+
+      rowset :orders, xpath: "eveapi/result/rowset[@name='orders']" do
+        attribute :order_id,      xpath: "@orderID",      type: :integer
+        attribute :char_id,       xpath: "@charID",       type: :integer
+        attribute :station_id,    xpath: "@stationID",    type: :integer
+        attribute :vol_entered,   xpath: "@volEntered",   type: :integer
+        attribute :vol_remaining, xpath: "@volRemaining", type: :integer
+        attribute :min_volume,    xpath: "@minVolume",    type: :integer
+        attribute :order_state,   xpath: "@orderState",   type: :integer
+        attribute :type_id,       xpath: "@typeID",       type: :integer
+        attribute :range,         xpath: "@range",        type: :integer
+        attribute :account_key,   xpath: "@accountKey",   type: :integer
+        attribute :duration,      xpath: "@duration",     type: :integer
+        attribute :escrow,        xpath: "@escrow",       type: :numeric
+        attribute :price,         xpath: "@price",        type: :numeric
+        attribute :bid,           xpath: "@bid",          type: :boolean
+        attribute :issued,        xpath: "@issued",       type: :datetime
+      end
+
+      # @param character_id [Integer] EVE character ID
+      #
+      # @option opts [Integer] :order_id Optional order ID of order to retrieve
+      def initialize(character_id, opts = {})
+        order_id = opts.delete(:order_id)
+
+        opts[:query_params] = { "characterID" => character_id }
+        opts[:query_params]["orderID"] = order_id if order_id
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/medals.rb

@@ -0,0 +1,40 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Medals the character has received.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_medals.html
+    class Medals < Greeve::BaseItem
+      endpoint "char/Medals"
+
+      rowset :current_corporation, xpath: "eveapi/result/rowset[@name='currentCorporation']" do
+        attribute :medal_id,       xpath: "@medalID",       type: :integer
+        attribute :reason,         xpath: "@reason",        type: :string
+        attribute :status,         xpath: "@status",        type: :string
+        attribute :issuer_id,      xpath: "@issuerID",      type: :integer
+        attribute :issued,         xpath: "@issued",        type: :datetime
+        attribute :corporation_id, xpath: "@corporationID", type: :integer
+        attribute :title,          xpath: "@title",         type: :string
+        attribute :description,    xpath: "@description",   type: :string
+      end
+
+      rowset :other_corporations, xpath: "eveapi/result/rowset[@name='otherCorporations']" do
+        attribute :medal_id,       xpath: "@medalID",       type: :integer
+        attribute :reason,         xpath: "@reason",        type: :string
+        attribute :status,         xpath: "@status",        type: :string
+        attribute :issuer_id,      xpath: "@issuerID",      type: :integer
+        attribute :issued,         xpath: "@issued",        type: :datetime
+        attribute :corporation_id, xpath: "@corporationID", type: :integer
+        attribute :title,          xpath: "@title",         type: :string
+        attribute :description,    xpath: "@description",   type: :string
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/notifications.rb

@@ -0,0 +1,27 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character notifications.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_notifications.html
+    class Notifications < Greeve::BaseItem
+      endpoint "char/Notifications"
+
+      rowset :notifications, xpath: "eveapi/result/rowset[@name='notifications']" do
+        attribute :notification_id, xpath: "@notificationID", type: :integer
+        attribute :type_id,         xpath: "@typeID",         type: :integer
+        attribute :sender_id,       xpath: "@senderID",       type: :integer
+        attribute :sender_name,     xpath: "@senderName",     type: :string
+        attribute :sent_date,       xpath: "@sentDate",       type: :datetime
+        attribute :read,            xpath: "@read",           type: :boolean
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/planetary_colonies.rb

@@ -0,0 +1,32 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Planetary colonies owned by character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetarycolonies.html
+    class PlanetaryColonies < Greeve::BaseItem
+      endpoint "char/PlanetaryColonies"
+
+      rowset :colonies, xpath: "eveapi/result/rowset[@name='colonies']" do
+        attribute :solar_system_id,   xpath: "@solarSystemID",   type: :integer
+        attribute :solar_system_name, xpath: "@solarSystemName", type: :string
+        attribute :planet_id,         xpath: "@planetID",        type: :integer
+        attribute :planet_name,       xpath: "@planetName",      type: :string
+        attribute :planet_type_id,    xpath: "@planetTypeID",    type: :integer
+        attribute :planet_type_name,  xpath: "@planetTypeName",  type: :string
+        attribute :owner_id,          xpath: "@ownerID",         type: :integer
+        attribute :owner_name,        xpath: "@ownerName",       type: :string
+        attribute :last_update,       xpath: "@lastUpdate",      type: :datetime
+        attribute :upgrade_level,     xpath: "@upgradeLevel",    type: :integer
+        attribute :number_of_pins,    xpath: "@numberOfPins",    type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/planetary_links.rb

@@ -0,0 +1,30 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Planetary links for colonies owned by character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetarylinks.html
+    class PlanetaryLinks < Greeve::BaseItem
+      endpoint "char/PlanetaryLinks"
+
+      rowset :links, xpath: "eveapi/result/rowset[@name='links']" do
+        attribute :source_pin_id,      xpath: "@sourcePinID",      type: :integer
+        attribute :destination_pin_id, xpath: "@destinationPinID", type: :integer
+        attribute :link_level,         xpath: "@linkLevel",        type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      # @param planet_id [Integer] planet ID. Can be obtained from
+      #   {Character::PlanetaryColonies}
+      def initialize(character_id, planet_id, opts = {})
+        opts[:query_params] = {
+          "characterID" => character_id,
+          "planetID" => planet_id,
+        }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/planetary_pins.rb

@@ -0,0 +1,41 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Planetary pins for colonies owned by character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetarypins.html
+    class PlanetaryPins < Greeve::BaseItem
+      endpoint "char/PlanetaryPins"
+
+      rowset :pins, xpath: "eveapi/result/rowset[@name='pins']" do
+        attribute :pin_id,             xpath: "@pinID",            type: :integer
+        attribute :type_id,            xpath: "@typeID",           type: :integer
+        attribute :type_name,          xpath: "@typeName",         type: :string
+        attribute :schematic_id,       xpath: "@schematicID",      type: :integer
+        attribute :last_launch_time,   xpath: "@lastLaunchTime",   type: :datetime
+        attribute :cycle_time,         xpath: "@cycleTime",        type: :integer
+        attribute :quantity_per_cycle, xpath: "@quantityPerCycle", type: :integer
+        attribute :install_time,       xpath: "@installTime",      type: :datetime
+        attribute :expiry_time,        xpath: "@expiryTime",       type: :datetime
+        attribute :content_type_id,    xpath: "@contentTypeID",    type: :integer
+        attribute :content_type_name,  xpath: "@contentTypeName",  type: :string
+        attribute :content_quantity,   xpath: "@contentQuantity",  type: :integer
+        attribute :longitude,          xpath: "@longitude",        type: :numeric
+        attribute :latitude,           xpath: "@latitude",         type: :numeric
+      end
+
+      # @param character_id [Integer] EVE character ID
+      # @param planet_id [Integer] planet ID. Can be obtained from
+      #   {Character::PlanetaryColonies}
+      def initialize(character_id, planet_id, opts = {})
+        opts[:query_params] = {
+          "characterID" => character_id,
+          "planetID" => planet_id,
+        }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/planetary_routes.rb

@@ -0,0 +1,38 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Planetary routes for colonies owned by character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetaryroutes.html
+    class PlanetaryRoutes < Greeve::BaseItem
+      endpoint "char/PlanetaryRoutes"
+
+      rowset :routes, xpath: "eveapi/result/rowset[@name='routes']" do
+        attribute :route_id,           xpath: "@routeID",          type: :integer
+        attribute :source_pin_id,      xpath: "@sourcePinID",      type: :integer
+        attribute :destination_pin_id, xpath: "@destinationPinID", type: :integer
+        attribute :content_type_id,    xpath: "@contentTypeID",    type: :integer
+        attribute :content_type_name,  xpath: "@contentTypeName",  type: :string
+        attribute :quantity,           xpath: "@quantity",         type: :integer
+        attribute :waypoint_1,         xpath: "@waypoint1",        type: :integer
+        attribute :waypoint_2,         xpath: "@waypoint2",        type: :integer
+        attribute :waypoint_3,         xpath: "@waypoint3",        type: :integer
+        attribute :waypoint_4,         xpath: "@waypoint4",        type: :integer
+        attribute :waypoint_5,         xpath: "@waypoint5",        type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      # @param planet_id [Integer] planet ID. Can be obtained from
+      #   {Character::PlanetaryColonies}
+      def initialize(character_id, planet_id, opts = {})
+        opts[:query_params] = {
+          "characterID" => character_id,
+          "planetID" => planet_id,
+        }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/research.rb

@@ -0,0 +1,26 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character research.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_research.html
+    class Research < Greeve::BaseItem
+      endpoint "char/Research"
+
+      rowset :research, xpath: "eveapi/result/rowset[@name='research']" do
+        attribute :agent_id,            xpath: "@agentID",           type: :integer
+        attribute :skill_type_id,       xpath: "@skillTypeID",       type: :integer
+        attribute :research_start_date, xpath: "@researchStartDate", type: :datetime
+        attribute :points_per_day,      xpath: "@pointsPerDay",      type: :numeric
+        attribute :remainder_points,    xpath: "@remainderPoints",   type: :numeric
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = { "characterID" => character_id }
+        super(opts)
+      end
+    end
+  end
+end