greeve 0.0.1 → 1.0.0

data/doc/top-level-namespace.html

@@ -102,7 +102,7 @@
 </div>
 
       <div id="footer">
-  Generated on Wed Aug 24 18:52:46 2016 by
+  Generated on Mon Dec 26 15:56:22 2016 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.9.5 (ruby-2.1.7).
 </div>

data/lib/greeve.rb

@@ -3,17 +3,89 @@ require "ox"
 require "typhoeus"
 
 require_relative "greeve/version"
+require_relative "greeve/config"
 
+require_relative "greeve/helpers/add_attribute"
+require_relative "greeve/helpers/attribute_to_hash"
+require_relative "greeve/helpers/define_dsl_methods"
+
+require_relative "greeve/response_error"
 require_relative "greeve/base_item"
+require_relative "greeve/namespace"
 require_relative "greeve/row"
 require_relative "greeve/rowset"
+require_relative "greeve/account/account_status"
+require_relative "greeve/account/api_key_info"
+require_relative "greeve/account/characters"
+require_relative "greeve/api/call_list"
+require_relative "greeve/character/account_balance"
+require_relative "greeve/character/asset_list"
+require_relative "greeve/character/blueprints"
+require_relative "greeve/character/calendar_event_attendees"
+require_relative "greeve/character/character_sheet"
+require_relative "greeve/character/clones"
+require_relative "greeve/character/contact_list"
+require_relative "greeve/character/contact_notifications"
+require_relative "greeve/character/contract_bids"
+require_relative "greeve/character/contract_items"
+require_relative "greeve/character/contracts"
+require_relative "greeve/character/fac_war_stats"
+require_relative "greeve/character/industry_jobs"
+require_relative "greeve/character/industry_jobs_history"
+require_relative "greeve/character/locations"
+require_relative "greeve/character/mail_bodies"
+require_relative "greeve/character/mail_messages"
+require_relative "greeve/character/mailing_lists"
+require_relative "greeve/character/market_orders"
+require_relative "greeve/character/medals"
+require_relative "greeve/character/notifications"
+require_relative "greeve/character/planetary_colonies"
+require_relative "greeve/character/planetary_links"
+require_relative "greeve/character/planetary_pins"
+require_relative "greeve/character/planetary_routes"
+require_relative "greeve/character/research"
+require_relative "greeve/character/skill_in_training"
+require_relative "greeve/character/skill_queue"
+require_relative "greeve/character/skills"
+require_relative "greeve/character/standings"
+require_relative "greeve/character/upcoming_calendar_events"
+require_relative "greeve/character/wallet_journal"
+require_relative "greeve/character/wallet_transactions"
+require_relative "greeve/corporation/account_balance"
+require_relative "greeve/corporation/contracts"
+require_relative "greeve/corporation/corporation_sheet"
+require_relative "greeve/corporation/industry_jobs"
+require_relative "greeve/corporation/industry_jobs_history"
+require_relative "greeve/corporation/locations"
+require_relative "greeve/corporation/market_orders"
+require_relative "greeve/corporation/member_tracking"
+require_relative "greeve/corporation/standings"
+require_relative "greeve/corporation/starbase_detail"
+require_relative "greeve/corporation/starbase_list"
+require_relative "greeve/corporation/wallet_journal"
+require_relative "greeve/corporation/wallet_transactions"
+require_relative "greeve/eve/alliance_list"
+require_relative "greeve/eve/character_affiliation"
+require_relative "greeve/eve/character_id"
 require_relative "greeve/eve/character_info"
+require_relative "greeve/eve/character_name"
+require_relative "greeve/eve/conquerable_station_list"
+require_relative "greeve/eve/error_list"
+require_relative "greeve/eve/ref_types"
+require_relative "greeve/eve/type_name"
+require_relative "greeve/map/fac_war_systems"
+require_relative "greeve/map/jumps"
+require_relative "greeve/map/kills"
+require_relative "greeve/map/sovereignty"
+require_relative "greeve/server/server_status"
 
 # A Ruby wrapper for the EVE Online XML API.
 module Greeve
   # Base URL of the EVE XML API.
   EVE_API_BASE_URL = "https://api.eveonline.com".freeze
 
+  # Account resources.
+  module Account; end
   # API resources.
   module API; end
   # Character resources.
@@ -26,4 +98,7 @@ module Greeve
   module Map; end
   # Server resources.
   module Server; end
+
+  # A namespace containing helper modules.
+  module Helpers; end
 end

data/lib/greeve/account/account_status.rb

@@ -0,0 +1,22 @@
+require_relative "../base_item"
+
+module Greeve
+  module Account
+    # Information about a player’s EVE account like creation time, minutes spent
+    # in game etc.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/account/account_accountstatus.html
+    class AccountStatus < Greeve::BaseItem
+      endpoint "account/AccountStatus"
+
+      attribute :paid_until,    xpath: "eveapi/result/paidUntil/?[0]",    type: :datetime
+      attribute :create_date,   xpath: "eveapi/result/createDate/?[0]",   type: :datetime
+      attribute :logon_count,   xpath: "eveapi/result/logonCount/?[0]",   type: :integer
+      attribute :logon_minutes, xpath: "eveapi/result/logonMinutes/?[0]", type: :integer
+
+      rowset :multi_character_training, xpath: "eveapi/result/rowset[@name='multiCharacterTraining']" do
+        attribute :training_end, xpath: "@trainingEnd", type: :datetime
+      end
+    end
+  end
+end

data/lib/greeve/account/api_key_info.rb

@@ -0,0 +1,27 @@
+require_relative "../base_item"
+
+module Greeve
+  module Account
+    # Represents the access rights of an API key.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/account/account_apikeyinfo.html
+    class APIKeyInfo < Greeve::BaseItem
+      endpoint "account/APIKeyInfo"
+
+      attribute :access_mask, xpath: "eveapi/result/key/@accessMask", type: :integer
+      attribute :type,        xpath: "eveapi/result/key/@type",       type: :string
+      attribute :expires,     xpath: "eveapi/result/key/@expires",    type: :datetime
+
+      rowset :characters, xpath: "eveapi/result/key/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
+    end
+  end
+end

data/lib/greeve/account/characters.rb

@@ -0,0 +1,23 @@
+require_relative "../base_item"
+
+module Greeve
+  module Account
+    # Lists all characters for an API key.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/account/account_characters.html
+    class Characters < Greeve::BaseItem
+      endpoint "account/Characters"
+
+      rowset :characters, xpath: "eveapi/result/rowset[@name='characters']" do
+        attribute :name,             xpath: "@name",            type: :string
+        attribute :character_id,     xpath: "@characterID",     type: :integer
+        attribute :corporation_name, xpath: "@corporationName", type: :string
+        attribute :corporation_id,   xpath: "@corporationID",   type: :integer
+        attribute :alliance_name,    xpath: "@allianceName",    type: :string
+        attribute :alliance_id,      xpath: "@allianceID",      type: :integer
+        attribute :faction_name,     xpath: "@factionName",     type: :string
+        attribute :faction_id,       xpath: "@factionID",       type: :integer
+      end
+    end
+  end
+end

data/lib/greeve/api/call_list.rb

@@ -0,0 +1,27 @@
+require_relative "../base_item"
+
+module Greeve
+  module API
+    # List of all selectable API endpoints/groups to which an API grants
+    # access to.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/api/api_calllist.html
+    class CallList < Greeve::BaseItem
+      endpoint "api/CallList"
+
+      rowset :call_groups, xpath: "eveapi/result/rowset[@name='callGroups']" do
+        attribute :group_id,    xpath: "@groupID",     type: :integer
+        attribute :name,        xpath: "@name",        type: :string
+        attribute :description, xpath: "@description", type: :string
+      end
+
+      rowset :calls, xpath: "eveapi/result/rowset[@name='calls']" do
+        attribute :access_mask, xpath: "@accessMask",  type: :integer
+        attribute :type,        xpath: "@type",        type: :string
+        attribute :name,        xpath: "@name",        type: :string
+        attribute :group_id,    xpath: "@groupID",     type: :integer
+        attribute :description, xpath: "@description", type: :string
+      end
+    end
+  end
+end

data/lib/greeve/base_item.rb

@@ -1,6 +1,11 @@
 require "bigdecimal"
 require "time"
 
+require_relative "response_error"
+require_relative "helpers/add_attribute"
+require_relative "helpers/attribute_to_hash"
+require_relative "helpers/define_dsl_methods"
+require_relative "namespace"
 require_relative "rowset"
 
 module Greeve
@@ -8,6 +13,10 @@ module Greeve
   # objects. This class is designed to be subclassed by classes representing
   # the specific EVE API resources.
   class BaseItem
+    extend Greeve::Helpers::AddAttribute
+    extend Greeve::Helpers::DefineDSLMethods
+    include Greeve::Helpers::AttributeToHash
+
     # A DSL method to map an XML attribute to a Ruby object.
     #
     # @param name [Symbol] the Ruby name for this attribute
@@ -20,39 +29,30 @@ module Greeve
     # @example
     #   attribute :character_id, xpath: "characterID/?[0]", type: :integer
     def self.attribute(name, opts = {})
-      name = name.to_sym
       @attributes ||= {}
 
-      raise "Attribute `#{name}` defined more than once" if @attributes[name]
-      raise "`:xpath` not specified for `#{name}`" unless opts[:xpath]
+      add_attribute(name, opts)
+      define_attribute_method(:class, name, opts)
+    end
 
-      @attributes[name] = {
-        xpath: opts[:xpath],
-        type: opts[:type],
-      }
+    # A DSL method to nest a set of attributes within a namespace.
+    #
+    # @param name [Symbol] the Ruby name for this namespace
+    #
+    # @option opts [Symbol] :xpath the xpath string used to locate the namespace
+    #   in the XML element
+    #
+    # @example
+    #   namespace :general_settings, xpath: "eveapi/result/generalSettings" do
+    #     attribute :usage_flags, xpath: "usageFlags/?[0]", type: :integer
+    #   end
+    def self.namespace(name, opts = {}, &block)
+      @attributes ||= {}
 
-      define_method(name) do
-        ivar = instance_variable_get(:"@#{name}")
-        return ivar unless ivar.nil?
+      opts[:type] = :namespace
 
-        value = @xml_element.locate(opts[:xpath]).first
-
-        unless value.nil?
-          value =
-            case opts[:type]
-            when :integer
-              value.to_i
-            when :numeric
-              BigDecimal.new(value)
-            when :string
-              value.to_s
-            when :datetime
-              Time.parse(value + " UTC")
-            end
-        end
-
-        instance_variable_set(:"@#{name}", value)
-      end
+      add_attribute(name, opts)
+      define_namespace_method(:class, name, opts, &block)
     end
 
     # A DSL method to map an XML rowset to a Ruby object.
@@ -70,16 +70,11 @@ module Greeve
     #     attribute :start_date,       xpath: "@startDate",       type: :datetime
     #   end
     def self.rowset(name, opts = {}, &block)
-      name = name.to_sym
       @attributes ||= {}
 
-      raise "Attribute `#{name}` defined more than once" if @attributes[name]
-      raise "`:xpath` not specified for `#{name}`" unless opts[:xpath]
+      opts[:type] = :rowset
 
-      @attributes[name] = {
-        xpath: opts[:xpath],
-        type: :rowset,
-      }
+      add_attribute(name, opts)
 
       define_method(name) do
         ivar = instance_variable_get(:"@#{name}")
@@ -103,14 +98,16 @@ module Greeve
 
     # A DSL method to specify the API endpoint.
     #
-    # @param path [String] path of the API endpoint. Doesn't need to include the
+    # @param path [String] path of the API endpoint. It shouldn't include the
     #   leading slash `/`, or the extension `.xml.aspx`
     #
     # @example
     #   endpoint "eve/CharacterInfo"
     def self.endpoint(path)
-      # Remove leading slash and file extension.
-      @endpoint = path.gsub(/\A\/*(.*?)(?:\.xml)?(?:\.aspx)?\z/, '\1')
+      raise ArgumentError, "Endpoint shouldn't start with a slash" \
+        if path.start_with?("/")
+
+      @endpoint = path
     end
 
     # @abstract Subclass and use the DSL methods to map API endpoints to objects
@@ -190,24 +187,10 @@ module Greeve
         .join("\n")
     end
 
-    # @return [Hash] a hash of non-nil attributes
-    def to_h
-      attributes
-        .keys
-        .map { |name|
-          value = __send__(name)
-          value = value.to_a if value.is_a?(Rowset)
-
-          [name, value]
-        }
-        .to_h
-        .reject { |k, v| v.nil? }
-    end
-
     private
 
     # @return [Hash] the hash of attributes for this object
-    def attributes
+    def _attributes
       self.class.instance_variable_get(:@attributes) || {}
     end
 
@@ -221,13 +204,14 @@ module Greeve
       url = "#{Greeve::EVE_API_BASE_URL}/#{endpoint}.xml.aspx"
       response = Typhoeus.get(url, params: @query_params)
 
-      # TODO: Use a better error class.
-      raise TypeError, "HTTP error #{response.code}" \
-        unless (200..299).include?(response.code.to_i)
+      raise ResponseError.new(
+        code: response.code,
+        status_message: response.status_message,
+      ) unless response.success?
 
       @xml_element = Ox.parse(response.body)
 
-      attributes.keys.each do |name|
+      _attributes.keys.each do |name|
         instance_variable_set(:"@#{name}", nil)
       end
 

data/lib/greeve/character/account_balance.rb

@@ -0,0 +1,24 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Character account balance.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_accountbalance.html
+    class AccountBalance < Greeve::BaseItem
+      endpoint "char/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
+
+      # @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/asset_list.rb

@@ -0,0 +1,32 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Everything a character owns.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_assetlist.html
+    class AssetList < Greeve::BaseItem
+      endpoint "char/AssetList"
+
+      rowset :assets, xpath: "eveapi/result/rowset[@name='assets']" do
+        attribute :item_id,      xpath: "@itemID",      type: :integer
+        attribute :location_id,  xpath: "@locationID",  type: :integer
+        attribute :type_id,      xpath: "@typeID",      type: :integer
+        attribute :quantity,     xpath: "@quantity",    type: :integer
+        attribute :flag,         xpath: "@flag",        type: :integer
+        attribute :singleton,    xpath: "@singleton",   type: :boolean
+        attribute :raw_quantity, xpath: "@rawQuantity", type: :integer
+      end
+
+      # @param character_id [Integer] EVE character ID
+      def initialize(character_id, opts = {})
+        opts[:query_params] = {
+          "characterID" => character_id,
+          "flat" => 1,
+        }
+
+        super(opts)
+      end
+    end
+  end
+end

data/lib/greeve/character/blueprints.rb

@@ -0,0 +1,35 @@
+require_relative "../base_item"
+
+module Greeve
+  module Character
+    # Blueprints in a character's inventory.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_blueprints.html
+    class Blueprints < Greeve::BaseItem
+      # Blueprint original
+      BPO = -1
+      # Blueprint copy
+      BPC = -2
+
+      endpoint "char/Blueprints"
+
+      rowset :blueprints, xpath: "eveapi/result/rowset[@name='blueprints']" do
+        attribute :item_id,             xpath: "@itemID",             type: :integer
+        attribute :location_id,         xpath: "@locationID",         type: :integer
+        attribute :type_id,             xpath: "@typeID",             type: :integer
+        attribute :type_name,           xpath: "@typeName",           type: :string
+        attribute :quantity,            xpath: "@quantity",           type: :integer
+        attribute :flag_id,             xpath: "@flagID",             type: :integer
+        attribute :time_efficiency,     xpath: "@timeEfficiency",     type: :integer
+        attribute :material_efficiency, xpath: "@materialEfficiency", type: :integer
+        attribute :runs,                xpath: "@runs",               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