greeve 0.0.1 → 1.0.0

data/lib/greeve/character/skill_in_training.rb

@@ -0,0 +1,27 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character skill in training.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_skillintraining.html
+    class SkillInTraining < Greeve::BaseItem
+      endpoint "char/SkillInTraining"
+
+      attribute :current_tq_time,         xpath: "eveapi/result/currentTQTime/?[0]",         type: :datetime
+      attribute :training_end_time,       xpath: "eveapi/result/trainingEndTime/?[0]",       type: :datetime
+      attribute :training_start_time,     xpath: "eveapi/result/trainingStartTime/?[0]",     type: :datetime
+      attribute :training_type_id,        xpath: "eveapi/result/trainingTypeID/?[0]",        type: :integer
+      attribute :training_start_sp,       xpath: "eveapi/result/trainingStartSP/?[0]",       type: :integer
+      attribute :training_destination_sp, xpath: "eveapi/result/trainingDestinationSP/?[0]", type: :integer
+      attribute :training_to_level,       xpath: "eveapi/result/trainingToLevel/?[0]",       type: :integer
+      attribute :skill_in_training,       xpath: "eveapi/result/skillInTraining/?[0]",       type: :boolean
+
+      # @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/skill_queue.rb

@@ -0,0 +1,28 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character skill queue.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_skillqueue.html
+    class SkillQueue < Greeve::BaseItem
+      endpoint "char/SkillQueue"
+
+      rowset :skillqueue, xpath: "eveapi/result/rowset[@name='skillqueue']" do
+        attribute :queue_position, xpath: "@queuePosition", type: :integer
+        attribute :type_id,        xpath: "@typeID",        type: :integer
+        attribute :level,          xpath: "@level",         type: :integer
+        attribute :start_sp,       xpath: "@startSP",       type: :integer
+        attribute :end_sp,         xpath: "@endSP",         type: :integer
+        attribute :start_time,     xpath: "@startTime",     type: :datetime
+        attribute :end_time,       xpath: "@endTime",       type: :datetime
+      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/skills.rb

@@ -0,0 +1,28 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Known skills of a character.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_skills.html
+    class Skills < Greeve::BaseItem
+      endpoint "char/Skills"
+
+      attribute :free_skill_points, xpath: "eveapi/result/freeSkillPoints/?[0]", type: :integer
+
+      rowset :skills, xpath: "eveapi/result/rowset[@name='skills']" do
+        attribute :type_id,     xpath: "@typeID",      type: :integer
+        attribute :type_name,   xpath: "@typeName",    type: :string
+        attribute :skillpoints, xpath: "@skillpoints", type: :integer
+        attribute :level,       xpath: "@level",       type: :integer
+        attribute :published,   xpath: "@published",   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/standings.rb

@@ -0,0 +1,36 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character standings (does not take character skills into account).
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_standings.html
+    class Standings < Greeve::BaseItem
+      endpoint "char/Standings"
+
+      rowset :agents, xpath: "eveapi/result/characterNPCStandings/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/characterNPCStandings/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/characterNPCStandings/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
+
+      # @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/upcoming_calendar_events.rb

@@ -0,0 +1,31 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character upcoming calendar events.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_upcomingcalendarevents.html
+    class UpcomingCalendarEvents < Greeve::BaseItem
+      endpoint "char/UpcomingCalendarEvents"
+
+      rowset :upcoming_events, xpath: "eveapi/result/rowset[@name='upcomingEvents']" do
+        attribute :event_id,      xpath: "@eventID",     type: :integer
+        attribute :owner_id,      xpath: "@ownerID",     type: :integer
+        attribute :owner_name,    xpath: "@ownerName",   type: :string
+        attribute :owner_type_id, xpath: "@ownerTypeID", type: :integer
+        attribute :event_date,    xpath: "@eventDate",   type: :datetime
+        attribute :event_title,   xpath: "@eventTitle",  type: :string
+        attribute :duration,      xpath: "@duration",    type: :integer
+        attribute :importance,    xpath: "@importance",  type: :boolean
+        attribute :response,      xpath: "@response",    type: :string
+        attribute :event_text,    xpath: "@eventText",   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/wallet_journal.rb

@@ -0,0 +1,49 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character wallet journal.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_walletjournal.html
+    class WalletJournal < Greeve::BaseItem
+      endpoint "char/WalletJournal"
+
+      rowset :transactions, xpath: "eveapi/result/rowset[@name='transactions']" 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 :tax_receiver_id, xpath: "@taxReceiverID", type: :integer
+        attribute :tax_amount,      xpath: "@taxAmount",     type: :numeric
+        attribute :owner_1_type_id, xpath: "@owner1TypeID",  type: :integer
+        attribute :owner_2_type_id, xpath: "@owner2TypeID",  type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      #
+      # @option opts [Integer] :from_id Optional upper bound for the ref ID of
+      #   returned journal entries. This argument is normally used to walk to
+      #   the journal backwards.
+      # @option opts [Integer] :row_count Optional limit on number of rows to
+      #   return. Default is 1000. Maximum is 2560.
+      def initialize(character_id, opts = {})
+        from_id = opts.delete(:from_id)
+        row_count = opts.delete(:row_count)
+
+        opts[:query_params] = { "characterID" => character_id }
+        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/character/wallet_transactions.rb

@@ -0,0 +1,47 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character wallet transactions.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_wallettransactions.html
+    class WalletTransactions < Greeve::BaseItem
+      endpoint "char/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 :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
+
+      # @param character_id [Integer] EVE character ID
+      #
+      # @option opts [Integer] :from_id Optional upper bound for the transaction
+      #   ID of returned transactions.
+      # @option opts [Integer] :row_count Optional upper bound for the
+      #   transaction ID of returned transactions. This argument is normally
+      #   used to walk to the transaction log backwards.
+      def initialize(character_id, opts = {})
+        from_id = opts.delete(:from_id)
+        row_count = opts.delete(:row_count)
+
+        opts[:query_params] = { "characterID" => character_id }
+        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/config.rb

@@ -0,0 +1,16 @@
+module Greeve
+  # Greeve configuration options.
+  class Config
+    private_class_method :new
+
+    # @return [String] HTTP client User-Agent
+    def self.user_agent
+      Typhoeus::Config.user_agent
+    end
+
+    # @param user_agent [String] HTTP client User-Agent
+    def self.user_agent=(user_agent)
+      Typhoeus::Config.user_agent = user_agent
+    end
+  end
+end

data/lib/greeve/corporation/account_balance.rb

@@ -0,0 +1,18 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Corporation account balances.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_accountbalance.html
+    class AccountBalance < Greeve::BaseItem
+      endpoint "corp/AccountBalance"
+
+      rowset :accounts, xpath: "eveapi/result/rowset[@name='accounts']" do
+        attribute :account_id,  xpath: "@accountID",  type: :integer
+        attribute :account_key, xpath: "@accountKey", type: :integer
+        attribute :balance,     xpath: "@balance",    type: :numeric
+      end
+    end
+  end
+end

data/lib/greeve/corporation/contracts.rb

@@ -0,0 +1,46 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Availabile contracts for a corporation.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_contracts.html
+    class Contracts < Greeve::BaseItem
+      endpoint "corp/Contracts"
+
+      rowset :contract_list, xpath: "eveapi/result/rowset[@name='contractList']" do
+        attribute :contract_id,      xpath: "@contractID",     type: :integer
+        attribute :issuer_id,        xpath: "@issuerID",       type: :integer
+        attribute :issuer_corp_id,   xpath: "@issuerCorpID",   type: :integer
+        attribute :assignee_id,      xpath: "@assigneeID",     type: :integer
+        attribute :acceptor_id,      xpath: "@acceptorID",     type: :integer
+        attribute :start_station_id, xpath: "@startStationID", type: :integer
+        attribute :end_station_id,   xpath: "@endStationID",   type: :integer
+        attribute :type,             xpath: "@type",           type: :string
+        attribute :status,           xpath: "@status",         type: :string
+        attribute :title,            xpath: "@title",          type: :string
+        attribute :for_corp,         xpath: "@forCorp",        type: :boolean
+        attribute :availability,     xpath: "@availability",   type: :string
+        attribute :date_issued,      xpath: "@dateIssued",     type: :datetime
+        attribute :date_expired,     xpath: "@dateExpired",    type: :datetime
+        attribute :date_accepted,    xpath: "@dateAccepted",   type: :datetime
+        attribute :date_completed,   xpath: "@dateCompleted",  type: :datetime
+        attribute :num_days,         xpath: "@numDays",        type: :integer
+        attribute :price,            xpath: "@price",          type: :numeric
+        attribute :reward,           xpath: "@reward",         type: :numeric
+        attribute :colalteral,       xpath: "@collateral",     type: :numeric
+        attribute :buyout,           xpath: "@buyout",         type: :numeric
+        attribute :volume,           xpath: "@volume",         type: :numeric
+      end
+
+      # @option opts [Integer] :contract_id (nil) ID of a specific contract
+      def initialize(opts = {})
+        contract_id = opts.delete(:contract_id)
+
+        opts[:query_params] = { "contractID" => contract_id } if contract_id
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/corporation_sheet.rb

@@ -0,0 +1,43 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Details for a specific corporation.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_corporationsheet.html
+    class CorporationSheet < Greeve::BaseItem
+      endpoint "corp/CorporationSheet"
+
+      attribute :corporation_id,   xpath: "eveapi/result/corporationID/?[0]",   type: :integer
+      attribute :corporation_name, xpath: "eveapi/result/corporationName/?[0]", type: :string
+      attribute :ticker,           xpath: "eveapi/result/ticker/?[0]",          type: :string
+      attribute :ceo_id,           xpath: "eveapi/result/ceoID/?[0]",           type: :integer
+      attribute :ceo_name,         xpath: "eveapi/result/ceoName/?[0]",         type: :string
+      attribute :station_id,       xpath: "eveapi/result/stationID/?[0]",       type: :integer
+      attribute :station_name,     xpath: "eveapi/result/stationName/?[0]",     type: :string
+      attribute :description,      xpath: "eveapi/result/description/?[0]",     type: :string
+      attribute :url,              xpath: "eveapi/result/url/?[0]",             type: :string
+      attribute :alliance_id,      xpath: "eveapi/result/allianceID/?[0]",      type: :integer
+      attribute :faction_id,       xpath: "eveapi/result/factionID/?[0]",       type: :integer
+      attribute :tax_rate,         xpath: "eveapi/result/taxRate/?[0]",         type: :numeric
+      attribute :member_count,     xpath: "eveapi/result/memberCount/?[0]",     type: :integer
+      attribute :shares,           xpath: "eveapi/result/shares/?[0]",          type: :integer
+
+      namespace :logo, xpath: "eveapi/result/logo" do
+        attribute :graphic_id, xpath: "graphicID/?[0]", type: :integer
+        attribute :shape1,     xpath: "shape1/?[0]",    type: :integer
+        attribute :shape2,     xpath: "shape2/?[0]",    type: :integer
+        attribute :shape3,     xpath: "shape3/?[0]",    type: :integer
+        attribute :color1,     xpath: "color1/?[0]",    type: :integer
+        attribute :color2,     xpath: "color2/?[0]",    type: :integer
+        attribute :color3,     xpath: "color3/?[0]",    type: :integer
+      end
+
+      # @param corporation_id [Integer] EVE corporation ID
+      def initialize(corporation_id, opts = {})
+        opts[:query_params] = { "corporationID" => corporation_id }
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/corporation/industry_jobs.rb

@@ -0,0 +1,42 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Unfinished corporation industry jobs.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_industryjobs.html
+    class IndustryJobs < Greeve::BaseItem
+      endpoint "corp/IndustryJobs"
+
+      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
+    end
+  end
+end

data/lib/greeve/corporation/industry_jobs_history.rb

@@ -0,0 +1,42 @@
+require_relative "../base_item"
+
+module Greeve
+  module Corporation
+    # Finished corporation industry jobs.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/corporation/corp_industryjobshistory.html
+    class IndustryJobsHistory < Greeve::BaseItem
+      endpoint "corp/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
+    end
+  end
+end