greeve 0.0.1 → 1.0.0

data/lib/greeve/eve/conquerable_station_list.rb

@@ -0,0 +1,24 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # A list of conquerable stations in New Eden.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_conquerablestationlist.html
+    class ConquerableStationList < Greeve::BaseItem
+      endpoint "eve/ConquerableStationList"
+
+      rowset :outposts, xpath: "eveapi/result/rowset[@name='outposts']" do
+        attribute :station_id,       xpath: "@stationID",       type: :integer
+        attribute :station_name,     xpath: "@stationName",     type: :string
+        attribute :station_type_id,  xpath: "@stationTypeID",   type: :integer
+        attribute :solar_system_id,  xpath: "@solarSystemID",   type: :integer
+        attribute :corporation_id,   xpath: "@corporationID",   type: :integer
+        attribute :corporation_name, xpath: "@corporationName", type: :string
+        attribute :x,                xpath: "@x",               type: :integer
+        attribute :y,                xpath: "@y",               type: :integer
+        attribute :z,                xpath: "@z",               type: :integer
+      end
+    end
+  end
+end

data/lib/greeve/eve/error_list.rb

@@ -0,0 +1,17 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # A list of error codes and text that the API may return.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_errorlist.html
+    class ErrorList < Greeve::BaseItem
+      endpoint "eve/ErrorList"
+
+      rowset :errors, xpath: "eveapi/result/rowset[@name='errors']" do
+        attribute :error_code, xpath: "@errorCode", type: :integer
+        attribute :error_text, xpath: "@errorText", type: :string
+      end
+    end
+  end
+end

data/lib/greeve/eve/ref_types.rb

@@ -0,0 +1,18 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # A list of transaction types used in the Corporation::WalletJournal
+    # and Character::WalletJournal.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_reftypes.html
+    class RefTypes < Greeve::BaseItem
+      endpoint "eve/RefTypes"
+
+      rowset :ref_types, xpath: "eveapi/result/rowset[@name='refTypes']" do
+        attribute :ref_type_id,   xpath: "@refTypeID",   type: :integer
+        attribute :ref_type_name, xpath: "@refTypeName", type: :string
+      end
+    end
+  end
+end

data/lib/greeve/eve/type_name.rb

@@ -0,0 +1,28 @@
+require_relative "../base_item"
+
+module Greeve
+  module Eve
+    # Returns the names associated with a sequence of typeIDs.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/eve/eve_typename.html
+    class TypeName < Greeve::BaseItem
+      endpoint "eve/TypeName"
+
+      rowset :types, xpath: "eveapi/result/rowset[@name='types']" do
+        attribute :type_id,   xpath: "@typeID",   type: :integer
+        attribute :type_name, xpath: "@typeName", type: :string
+      end
+
+      # @param ids [Array<Integer>, Integer] EVE type IDs
+      #
+      # @!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/helpers/add_attribute.rb

@@ -0,0 +1,25 @@
+module Greeve
+  module Helpers
+    # Adds a helper method to add an attribute to the attributes hash instance
+    # variable.
+    module AddAttribute
+      private
+
+      # Add an attribute to the attributes hash instance variable.
+      #
+      # @param name [String] name of the attribute method
+      # @param opts [Hash] option hash passed from the attribute DSL helper method
+      def add_attribute(name, opts = {})
+        name = name.to_sym
+
+        raise "Attribute `#{name}` defined more than once" if @attributes[name]
+        raise "`:xpath` not specified for `#{name}`" unless opts[:xpath]
+
+        @attributes[name] = {
+          xpath: opts[:xpath],
+          type: opts[:type],
+        }
+      end
+    end
+  end
+end

data/lib/greeve/helpers/attribute_to_hash.rb

@@ -0,0 +1,24 @@
+module Greeve
+  module Helpers
+    # Adds the `#to_h` method.
+    module AttributeToHash
+      # The (private) `#_attributes` method must be implemented for this method
+      # to work.
+      #
+      # @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)
+          value = value.to_h if value.is_a?(Namespace)
+
+          [name, value]
+        }
+        .to_h
+        .reject { |k, v| v.nil? }
+      end
+    end
+  end
+end

data/lib/greeve/helpers/define_dsl_methods.rb

@@ -0,0 +1,70 @@
+module Greeve
+  module Helpers
+    # Adds helper methods to define a class or instance method for a given
+    # DSL method.
+    module DefineDSLMethods
+      private
+
+      # Define a class or instance method for a given attribute.
+      #
+      # @param scope [:class, :instance] define the attribute names as class or
+      #   instance methods
+      # @param name [String] name of the attribute method
+      # @param opts [Hash] option hash passed from the attribute DSL helper method
+      def define_attribute_method(scope, name, opts = {})
+        method = scope == :instance ? :define_singleton_method : :define_method
+
+        send(method, name) do
+          ivar = instance_variable_get(:"@#{name}")
+          return ivar unless ivar.nil?
+
+          value = @xml_element.locate(opts[:xpath]).first
+          value = value.value if value.is_a?(Ox::CData)
+
+          unless value.nil?
+            value =
+              case opts[:type]
+              when :integer
+                value.to_i
+              when :integer_array
+                value.split(",").map(&:to_i)
+              when :numeric
+                BigDecimal.new(value)
+              when :boolean
+                value == "1" || value.downcase == "true"
+              when :string
+                value.to_s.strip
+              when :datetime
+                value.empty? ? nil : Time.parse(value + " UTC")
+              when :hash
+                value.scan(/^(.*?): (.*?)$/).to_h
+              end
+          end
+
+          instance_variable_set(:"@#{name}", value)
+        end
+      end
+
+      # Define a class or instance method for a given namespace.
+      #
+      # @param scope [:class, :instance] define the namespace as a class or
+      #   instance method
+      # @param name [String] name of the namespace method
+      # @param opts [Hash] option hash passed from the namespace DSL helper method
+      def define_namespace_method(scope, name, opts = {}, &block)
+        method = scope == :instance ? :define_singleton_method : :define_method
+
+        send(method, name) do
+          ivar = instance_variable_get(:"@#{name}")
+          return ivar unless ivar.nil?
+
+          namespace_element = @xml_element.locate(opts[:xpath]).first
+
+          namespace = Namespace.new(name.to_sym, namespace_element, &block)
+
+          instance_variable_set(:"@#{name}", namespace)
+        end
+      end
+    end
+  end
+end

data/lib/greeve/map/fac_war_systems.rb

@@ -0,0 +1,26 @@
+require_relative "../base_item"
+
+module Greeve
+  module Map
+    # Returns a list of contestable solar systems and the NPC faction currently
+    # occupying them. It should be noted that this only returns a non-zero ID if
+    # the occupying faction is not the sovereign faction.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/map/map_facwarsystems.html
+    class FacWarSystems < Greeve::BaseItem
+      endpoint "map/FacWarSystems"
+
+      rowset :solar_systems, xpath: "eveapi/result/rowset[@name='solarSystems']" do
+        attribute :solar_system_id,         xpath: "@solarSystemID",         type: :integer
+        attribute :solar_system_name,       xpath: "@solarSystemName",       type: :string
+        attribute :occupying_faction_id,    xpath: "@occupyingFactionID",    type: :integer
+        attribute :occupying_faction_name,  xpath: "@occupyingFactionName",  type: :string
+        attribute :owning_faction_id,       xpath: "@owningFactionID",       type: :integer
+        attribute :owning_faction_name,     xpath: "@owningFactionName",     type: :string
+        attribute :contested,               xpath: "@contested",             type: :boolean
+        attribute :victory_points,          xpath: "@victoryPoints",         type: :integer
+        attribute :victory_point_threshold, xpath: "@victoryPointThreshold", type: :integer
+      end
+    end
+  end
+end

data/lib/greeve/map/jumps.rb

@@ -0,0 +1,19 @@
+require_relative "../base_item"
+
+module Greeve
+  module Map
+    # Returns the number of jumps in solarsystems within the last hour (doesn’t
+    # include wormhole space). Only solar systems where jumps have been made are
+    # listed; assume zero in case the system is not listed.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/map/map_jumps.html
+    class Jumps < Greeve::BaseItem
+      endpoint "map/Jumps"
+
+      rowset :solar_systems, xpath: "eveapi/result/rowset[@name='solarSystems']" do
+        attribute :solar_system_id, xpath: "@solarSystemID", type: :integer
+        attribute :ship_jumps,      xpath: "@shipJumps",     type: :integer
+      end
+    end
+  end
+end

data/lib/greeve/map/kills.rb

@@ -0,0 +1,21 @@
+require_relative "../base_item"
+
+module Greeve
+  module Map
+    # Provides number of ship, pod and NPC kills per solar system within the
+    # last hour (doesn’t include wormhole space). Only solar systems where kills
+    # have been made are listed; assume zero in case the system is not listed.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/map/map_kills.html
+    class Kills < Greeve::BaseItem
+      endpoint "map/Kills"
+
+      rowset :solar_systems, xpath: "eveapi/result/rowset[@name='solarSystems']" do
+        attribute :solar_system_id, xpath: "@solarSystemID", type: :integer
+        attribute :ship_kills,      xpath: "@shipKills",     type: :integer
+        attribute :faction_kills,   xpath: "@factionKills",  type: :integer
+        attribute :pod_kills,       xpath: "@podKills",      type: :integer
+      end
+    end
+  end
+end

data/lib/greeve/map/sovereignty.rb

@@ -0,0 +1,21 @@
+require_relative "../base_item"
+
+module Greeve
+  module Map
+    # Provides sovereignty / ownership information for solar systems in New Eden,
+    # excluding wormhole space.
+    #
+    # @see https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/map/map_sovereignty.html
+    class Sovereignty < Greeve::BaseItem
+      endpoint "map/Sovereignty"
+
+      rowset :solar_systems, xpath: "eveapi/result/rowset[@name='solarSystems']" do
+        attribute :solar_system_id,   xpath: "@solarSystemID",   type: :integer
+        attribute :alliance_id,       xpath: "@allianceID",      type: :integer
+        attribute :faction_id,        xpath: "@factionID",       type: :integer
+        attribute :corporation_id,    xpath: "@corporationID",   type: :integer
+        attribute :solar_system_name, xpath: "@solarSystemName", type: :string
+      end
+    end
+  end
+end

data/lib/greeve/namespace.rb

@@ -0,0 +1,74 @@
+require_relative "helpers/add_attribute"
+require_relative "helpers/attribute_to_hash"
+require_relative "helpers/define_dsl_methods"
+
+module Greeve
+  # Contains a group of attributes.
+  class Namespace
+    include Greeve::Helpers::AddAttribute
+    include Greeve::Helpers::DefineDSLMethods
+    include Greeve::Helpers::AttributeToHash
+
+    # @return [Symbol] name of the namespace
+    attr_reader :name
+
+    # @param name [Symbol] name of the namespace
+    # @param xml_element [Ox::Element] the xml namespace element for this item
+    # @yield a block containing the attribute definitions
+    def initialize(name, xml_element, &block)
+      @name = name
+      @xml_element = xml_element
+      @attributes = {}
+
+      # Load the attribute configuration in the rowset block.
+      instance_eval(&block)
+
+      # Disable the DSL methods since the attributes have been configured.
+      define_singleton_method(:attribute) { raise NoMethodError, "private method" }
+      define_singleton_method(:namespace) { raise NoMethodError, "private method" }
+    end
+
+    # :nodoc:
+    def inspect
+      attrs = to_s.lines[1..-1].join
+
+      "#<#{self.class.name}:#{object_id} name: #{@name}\n#{attrs}\n>"
+    end
+
+    # @return [String] a string representation of the non-nil attributes
+    def to_s
+      "#{@name}\n" +
+      to_h
+        .map { |k, v|
+          v = v.to_s("F") if v.is_a?(BigDecimal)
+          "  #{k}: #{v}"
+        }
+        .join("\n")
+    end
+
+    private
+
+    # @return [Hash] the hash of attributes for this object
+    def _attributes
+      @attributes || {}
+    end
+
+    # Map an XML attribute to a Ruby object.
+    #
+    # @see BaseItem.attribute
+    def attribute(name, opts = {})
+      add_attribute(name, opts)
+      define_attribute_method(:instance, name, opts)
+    end
+
+    # Nest a set of XML attributes inside a namespace.
+    #
+    # @see BaseItem.namespace
+    def namespace(name, opts = {}, &block)
+      opts[:type] = :namespace
+
+      add_attribute(name, opts)
+      define_namespace_method(:instance, name, opts, &block)
+    end
+  end
+end

data/lib/greeve/response_error.rb

@@ -0,0 +1,21 @@
+module Greeve
+  # HTTP response failed.
+  class ResponseError < StandardError
+    # HTTP error code
+    attr_reader :code
+    # HTTP error message
+    attr_reader :status_message
+
+    # @option opts [Integer] :code HTTP error code
+    # @option opts [String] :status_message HTTP error message
+    def initialize(opts = {})
+      @code = opts.fetch(:code).to_i
+      @status_message = opts.fetch(:status_message).dup.freeze
+    end
+
+    # @return [String] exception error message
+    def message
+      "#{@code} #{@status_message}"
+    end
+  end
+end

data/lib/greeve/row.rb

@@ -1,6 +1,12 @@
+require_relative "helpers/attribute_to_hash"
+require_relative "helpers/define_dsl_methods"
+
 module Greeve
   # Represents an XML `row` element, contained in a {Rowset}.
   class Row
+    include Greeve::Helpers::AttributeToHash
+    include Greeve::Helpers::DefineDSLMethods
+
     # @param xml_element [Ox::Element] the xml row element for this item
     # @param attributes [Hash] the hash of attribute definitions for this row
     def initialize(xml_element, attributes)
@@ -8,28 +14,7 @@ module Greeve
       @attributes = attributes
 
       attributes.each do |name, opts|
-        define_singleton_method(name) do
-          ivar = instance_variable_get(:"@#{name}")
-          return ivar unless ivar.nil?
-
-          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
+        define_attribute_method(:instance, name, opts)
       end
     end
 
@@ -55,18 +40,11 @@ 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)
+    private
 
-          [name, value]
-        }
-        .to_h
-        .reject { |k, v| v.nil? }
+    # @return [Hash] the hash of attributes for this object
+    def _attributes
+      @attributes || {}
     end
   end
 end