greeve 0.0.1 → 1.0.0

data/lib/greeve/corporation/locations.rb

@@ -0,0 +1,31 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Location of an item or character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_locations.html
+    class Locations < Greeve::BaseItem
+      endpoint "corp/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: :integer
+        attribute :y,         xpath: "@y",        type: :integer
+        attribute :z,         xpath: "@z",        type: :integer
+      end
+
+      # @param ids [Array<Integer>] IDs of items to retrieve location info for
+      #
+      # @!method initialize(*ids, opts = {})
+      def initialize(*ids)
+        opts = ids.last.is_a?(Hash) ? ids.pop : {}
+
+        opts[:query_params] = { "IDs" => ids.join(",") }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/market_orders.rb

@@ -0,0 +1,39 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Corporation market orders.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_marketorders.html
+    class MarketOrders < Greeve::BaseItem
+      endpoint "corp/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
+
+      # @option opts [Integer] :order_id (nil) ID of an order to retrieve
+      def initialize(opts = {})
+        order_id = opts.delete(:order_id)
+
+        opts[:query_params] = { "orderID" => order_id } if order_id
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/member_tracking.rb

@@ -0,0 +1,38 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Information about the members of a corporation.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_membertracking.html
+    class MemberTracking < Greeve::BaseItem
+      endpoint "corp/MemberTracking"
+
+      rowset :members, xpath: "eveapi/result/rowset[@name='members']" do
+        attribute :character_id,     xpath: "@characterID",    type: :integer
+        attribute :name,             xpath: "@name",           type: :string
+        attribute :start_date_time,  xpath: "@startDateTime",  type: :datetime
+        attribute :base_id,          xpath: "@baseID",         type: :integer
+        attribute :base,             xpath: "@base",           type: :string
+        attribute :title,            xpath: "@title",          type: :string
+        attribute :logon_date_time,  xpath: "@logonDateTime",  type: :datetime
+        attribute :logoff_date_time, xpath: "@logoffDateTime", type: :datetime
+        attribute :location_id,      xpath: "@locationID",     type: :integer
+        attribute :location,         xpath: "@location",       type: :string
+        attribute :ship_type_id,     xpath: "@shipTypeID",     type: :integer
+        attribute :ship_type,        xpath: "@shipType",       type: :string
+        attribute :roles,            xpath: "@roles",          type: :integer
+        attribute :grantable_roles,  xpath: "@grantableRoles", type: :integer
+      end
+
+      # @option opts [Boolean] :extended (false) query extended member tracking info
+      def initialize(opts = {})
+        extended = !!opts.delete(:extended)
+
+        opts[:query_params] = { "extended" => 1 } if extended
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/standings.rb

@@ -0,0 +1,30 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Standings that non-player entities have to the corporation.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_standings.html
+    class Standings < Greeve::BaseItem
+      endpoint "corp/Standings"
+
+      rowset :agents, xpath: "eveapi/result/corporationNPCStandings/rowset[@name='agents']" do
+        attribute :from_id,   xpath: "@fromID",   type: :integer
+        attribute :from_name, xpath: "@fromName", type: :string
+        attribute :standing,  xpath: "@standing", type: :numeric
+      end
+
+      rowset :npc_corporations, xpath: "eveapi/result/corporationNPCStandings/rowset[@name='NPCCorporations']" do
+        attribute :from_id,   xpath: "@fromID",   type: :integer
+        attribute :from_name, xpath: "@fromName", type: :string
+        attribute :standing,  xpath: "@standing", type: :numeric
+      end
+
+      rowset :factions, xpath: "eveapi/result/corporationNPCStandings/rowset[@name='factions']" do
+        attribute :from_id,   xpath: "@fromID",   type: :integer
+        attribute :from_name, xpath: "@fromName", type: :string
+        attribute :standing,  xpath: "@standing", type: :numeric
+      end
+    end
+  end
+end

data/lib/greeve/corporation/starbase_detail.rb

@@ -0,0 +1,58 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Details for a starbase.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_starbasedetail.html
+    class StarbaseDetail < Greeve::BaseItem
+      endpoint "corp/StarbaseDetail"
+
+      attribute :state,            xpath: "eveapi/result/state/?[0]",           type: :integer
+      attribute :state_timestamp,  xpath: "eveapi/result/stateTimestamp/?[0]",  type: :datetime
+      attribute :online_timestamp, xpath: "eveapi/result/onlineTimestamp/?[0]", type: :datetime
+
+      namespace :general_settings, xpath: "eveapi/result/generalSettings" do
+        attribute :usage_flags,               xpath: "usageFlags/?[0]",              type: :integer
+        attribute :deploy_flags,              xpath: "deployFlags/?[0]",             type: :integer
+        attribute :allow_corporation_members, xpath: "allowCorporationMembers/?[0]", type: :boolean
+        attribute :allow_alliance_members,    xpath: "allowAllianceMembers/?[0]",    type: :boolean
+      end
+
+      namespace :combat_settings, xpath: "eveapi/result/combatSettings" do
+        namespace :use_standings_from, xpath: "useStandingsFrom" do
+          attribute :owner_id, xpath: "@ownerID", type: :integer
+        end
+
+        namespace :on_standing_drop, xpath: "onStandingDrop" do
+          attribute :standing, xpath: "@standing", type: :integer
+        end
+
+        namespace :on_status_drop, xpath: "onStatusDrop" do
+          attribute :enabled,  xpath: "@enabled",  type: :boolean
+          attribute :standing, xpath: "@standing", type: :integer
+        end
+
+        namespace :on_aggression, xpath: "onAggression" do
+          attribute :enabled, xpath: "@enabled", type: :boolean
+        end
+
+        namespace :on_corporation_war, xpath: "onCorporationWar" do
+          attribute :enabled, xpath: "@enabled", type: :boolean
+        end
+      end
+
+      rowset :fuel, xpath: "eveapi/result/rowset[@name='fuel']" do
+        attribute :type_id,  xpath: "@typeID",   type: :integer
+        attribute :quantity, xpath: "@quantity", type: :integer
+      end
+
+      # @param item_id [Integer] ID of the POS as given in the {StarbaseList}
+      def initialize(item_id, opts = {})
+        opts[:query_params] = { "itemID" => item_id }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/starbase_list.rb

@@ -0,0 +1,23 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # List of corporation starbases.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_starbaselist.html
+    class StarbaseList < Greeve::BaseItem
+      endpoint "corp/StarbaseList"
+
+      rowset :starbases, xpath: "eveapi/result/rowset[@name='starbases']" do
+        attribute :item_id,           xpath: "@itemID",          type: :integer
+        attribute :type_id,           xpath: "@typeID",          type: :integer
+        attribute :location_id,       xpath: "@locationID",      type: :integer
+        attribute :moon_id,           xpath: "@moonID",          type: :integer
+        attribute :state,             xpath: "@state",           type: :integer
+        attribute :state_timestamp,   xpath: "@stateTimestamp",  type: :datetime
+        attribute :online_timestamp,  xpath: "@onlineTimestamp", type: :datetime
+        attribute :standing_owner_id, xpath: "@standingOwnerID", type: :integer
+      end
+    end
+  end
+end

data/lib/greeve/corporation/wallet_journal.rb

@@ -0,0 +1,48 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Corporation wallet journal.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_walletjournal.html
+    class WalletJournal < Greeve::BaseItem
+      endpoint "corp/WalletJournal"
+
+      rowset :entries, xpath: "eveapi/result/rowset[@name='entries']" do
+        attribute :date,            xpath: "@date",         type: :datetime
+        attribute :ref_id,          xpath: "@refID",        type: :integer
+        attribute :ref_type_id,     xpath: "@refTypeID",    type: :integer
+        attribute :owner_name_1,    xpath: "@ownerName1",   type: :string
+        attribute :owner_id_1,      xpath: "@ownerID1",     type: :integer
+        attribute :owner_name_2,    xpath: "@ownerName2",   type: :string
+        attribute :owner_id_2,      xpath: "@ownerID2",     type: :integer
+        attribute :arg_name_1,      xpath: "@argName1",     type: :string
+        attribute :arg_id_1,        xpath: "@argID1",       type: :integer
+        attribute :amount,          xpath: "@amount",       type: :numeric
+        attribute :balance,         xpath: "@balance",      type: :numeric
+        attribute :reason,          xpath: "@reason",       type: :string
+        attribute :owner_1_type_id, xpath: "@owner1TypeID", type: :integer
+        attribute :owner_2_type_id, xpath: "@owner2TypeID", type: :integer
+      end
+
+      # @option opts [Integer] :account_key account key of the wallet for which
+      #   journal entries will be returned (1000 - 1006)
+      # @option opts [Integer] :from_id upper bound for the ref_id of returned
+      #   journal entries. Normally used to walk the journal backwards
+      # @option opts [Integer] :row_count limit on the number of rows to return.
+      #   Default is 1000, max is 2560
+      def initialize(opts = {})
+        account_key = opts[:account_key]
+        from_id = opts[:from_id]
+        row_count = opts[:row_count]
+
+        opts[:query_params] = {}
+        opts[:query_params]["accountKey"] = account_key if account_key
+        opts[:query_params]["fromID"] = from_id if from_id
+        opts[:query_params]["rowCount"] = row_count if row_count
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/wallet_transactions.rb

@@ -0,0 +1,50 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Corporation wallet transactions.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_wallettransactions.html
+    class WalletTransactions < Greeve::BaseItem
+      endpoint "corp/WalletTransactions"
+
+      rowset :transactions, xpath: "eveapi/result/rowset[@name='transactions']" do
+        attribute :transaction_date_time,  xpath: "@transactionDateTime",  type: :datetime
+        attribute :transaction_id,         xpath: "@transactionID",        type: :integer
+        attribute :quantity,               xpath: "@quantity",             type: :integer
+        attribute :type_name,              xpath: "@typeName",             type: :string
+        attribute :type_id,                xpath: "@typeID",               type: :integer
+        attribute :price,                  xpath: "@price",                type: :numeric
+        attribute :client_id,              xpath: "@clientID",             type: :integer
+        attribute :client_name,            xpath: "@clientName",           type: :string
+        attribute :character_id,           xpath: "@characterID",          type: :integer
+        attribute :character_name,         xpath: "@characterName",        type: :string
+        attribute :station_id,             xpath: "@stationID",            type: :integer
+        attribute :station_name,           xpath: "@stationName",          type: :string
+        attribute :transaction_type,       xpath: "@transactionType",      type: :string
+        attribute :transaction_for,        xpath: "@transactionFor",       type: :string
+        attribute :journal_transaction_id, xpath: "@journalTransactionID", type: :integer
+        attribute :client_type_id,         xpath: "@clientTypeID",         type: :integer
+      end
+
+      # @option opts [Integer] :account_key account key of the wallet for which
+      #   transactions will be returned (1000 - 1006)
+      # @option opts [Integer] :from_id upper bound for the ref_id of returned
+      #   transactions. Normally used to walk the transaction log backwards
+      # @option opts [Integer] :row_count limit on the number of rows to return.
+      #   Default is 1000, max is 2560
+      def initialize(opts = {})
+        account_key = opts[:account_key]
+        from_id = opts[:from_id]
+        row_count = opts[:row_count]
+
+        opts[:query_params] = {}
+        opts[:query_params]["accountKey"] = account_key if account_key
+        opts[:query_params]["fromID"] = from_id if from_id
+        opts[:query_params]["rowCount"] = row_count if row_count
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/eve/alliance_list.rb

@@ -0,0 +1,29 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # Returns active alliances in New Eden and their member corporations.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_alliancelist.html
+    class AllianceList < Greeve::BaseItem
+      endpoint "eve/AllianceList"
+
+      rowset :alliances, xpath: "eveapi/result/rowset[@name='alliances']" do
+        attribute :name,             xpath: "@name",           type: :string
+        attribute :short_name,       xpath: "@shortName",      type: :string
+        attribute :alliance_id,      xpath: "@allianceID",     type: :integer
+        attribute :executor_corp_id, xpath: "@executorCorpID", type: :integer
+        attribute :member_count,     xpath: "@memberCount",    type: :integer
+        attribute :start_date,       xpath: "@startDate",      type: :datetime
+      end
+
+      # @param version [Integer] EVE Alliance List
+      def initialize(version, opts = {})
+        raise ArgumentError, "not implemented, use version=1" if version == 0
+
+        opts[:query_params] = { "version" => version }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/eve/character_affiliation.rb

@@ -0,0 +1,34 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # Corporations, alliances, and factions the character(s) are members of.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_characteraffiliation.html
+    class CharacterAffiliation < Greeve::BaseItem
+      endpoint "eve/CharacterAffiliation"
+
+      rowset :characters, xpath: "eveapi/result/rowset[@name='characters']" do
+        attribute :character_id,     xpath: "@characterID",     type: :integer
+        attribute :character_name,   xpath: "@characterName",   type: :string
+        attribute :corporation_id,   xpath: "@corporationID",   type: :integer
+        attribute :corporation_name, xpath: "@corporationName", type: :string
+        attribute :alliance_id,      xpath: "@allianceID",      type: :integer
+        attribute :alliance_name,    xpath: "@allianceName",    type: :string
+        attribute :faction_id,       xpath: "@factionID",       type: :integer
+        attribute :faction_name,     xpath: "@factionName",     type: :string
+      end
+
+      # @param ids [Array<Integer>] IDs of characters
+      #
+      # @!method initialize(*ids, opts = {})
+      def initialize(*ids)
+        opts = ids.last.is_a?(Hash) ? ids.pop : {}
+
+        opts[:query_params] = { "IDs" => ids.join(",") }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/eve/character_id.rb

@@ -0,0 +1,28 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # Retrieves character IDs based on names.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_characterid.html
+    class CharacterID < Greeve::BaseItem
+      endpoint "eve/CharacterID"
+
+      rowset :characters, xpath: "eveapi/result/rowset[@name='characters']" do
+        attribute :name,         xpath: "@name",        type: :string
+        attribute :character_id, xpath: "@characterID", type: :integer
+      end
+
+      # @param names [Array<Integer>] names of characters
+      #
+      # @!method initialize(*names, opts = {})
+      def initialize(*names)
+        opts = names.last.is_a?(Hash) ? names.pop : {}
+
+        opts[:query_params] = { "names" => names.join(",") }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/eve/character_info.rb

@@ -2,7 +2,10 @@ require_relative "../base_item"
 
 module Greeve
   module Eve
-    # Public character info.
+    # Information about the character. Has three data sets it can return
+    # depending on the access mask.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_characterinfo.html
     class CharacterInfo < Greeve::BaseItem
       endpoint "eve/CharacterInfo"
 

data/lib/greeve/eve/character_name.rb

@@ -0,0 +1,29 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # Returns the names for a comma-separated list of owner IDs for characters,
+    # corporations, alliances, etc.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_charactername.html
+    class CharacterName < Greeve::BaseItem
+      endpoint "eve/CharacterName"
+
+      rowset :characters, xpath: "eveapi/result/rowset[@name='characters']" do
+        attribute :name,         xpath: "@name",        type: :string
+        attribute :character_id, xpath: "@characterID", type: :integer
+      end
+
+      # @param ids [Array<Integer>] IDs of characters
+      #
+      # @!method initialize(*ids, opts = {})
+      def initialize(*ids)
+        opts = ids.last.is_a?(Hash) ? ids.pop : {}
+
+        opts[:query_params] = { "IDs" => ids.join(",") }
+
+        super(opts)
+      end
+    end
+  end
+end