eve_online 0.11.0 → 0.12.0

data/lib/eve_online/xml/base.rb

@@ -0,0 +1,84 @@
+require 'nori'
+require 'memoist'
+require 'faraday'
+require 'active_support/time'
+
+module EveOnline
+  module XML
+    class Base
+      extend Memoist
+
+      attr_reader :parser
+
+      def initialize
+        @parser = Nori.new(advanced_typecasting: false)
+      end
+
+      def url
+        raise NotImplementedError
+      end
+
+      def user_agent
+        "EveOnline API (https://github.com/biow0lf/eve_online) v#{ VERSION }"
+      end
+
+      def content
+        faraday = Faraday.new
+
+        faraday.headers[:user_agent] = user_agent
+        faraday.options.timeout = 60
+        faraday.options.open_timeout = 60
+
+        resource = faraday.get(url)
+
+        case resource.status
+        when 200
+          resource.body
+        when 400
+          raise EveOnline::Exceptions::InvalidCharacterIDException
+        when 403
+          raise EveOnline::Exceptions::UnauthorizedException
+        end
+      rescue Faraday::TimeoutError
+        raise EveOnline::Exceptions::TimeoutException
+      end
+      memoize :content
+
+      def response
+        parser.parse(content)
+      end
+      memoize :response
+
+      def eveapi
+        response.fetch('eveapi')
+      end
+      memoize :eveapi
+
+      def result
+        eveapi.fetch('result')
+      end
+      memoize :result
+
+      def cached_until
+        parse_datetime_with_timezone(eveapi.fetch('cachedUntil'))
+      end
+      memoize :cached_until
+
+      def current_time
+        parse_datetime_with_timezone(eveapi.fetch('currentTime'))
+      end
+      memoize :current_time
+
+      def version
+        eveapi.fetch('@version').to_i
+      end
+      memoize :version
+
+      private
+
+      def parse_datetime_with_timezone(value)
+        ActiveSupport::TimeZone['UTC'].parse(value)
+      end
+    end
+  end
+end

data/lib/eve_online/{characters/account_balance.rb → xml/character_account_balance.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_accountbalance.html
-    class AccountBalance < BaseXML
+    class CharacterAccountBalance < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/AccountBalance.xml.aspx'.freeze
 
       ACCESS_MASK = 1

data/lib/eve_online/{characters/asset_list.rb → xml/character_asset_list.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_assetlist.html
-    class AssetList < BaseXML
+    class CharacterAssetList < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/AssetList.xml.aspx'.freeze
 
       ACCESS_MASK = 2

data/lib/eve_online/{characters/blueprints.rb → xml/character_blueprints.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_blueprints.html
-    class Blueprints < BaseXML
+    class CharacterBlueprints < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Blueprints.xml.aspx'.freeze
 
       ACCESS_MASK = 2

data/lib/eve_online/{characters/bookmarks.rb → xml/character_bookmarks.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_bookmarks.html
-    class Bookmarks < BaseXML
+    class CharacterBookmarks < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Bookmarks.xml.aspx'.freeze
 
       ACCESS_MASK = 268_435_456

data/lib/eve_online/{characters/calendar_event_attendees.rb → xml/character_calendar_event_attendees.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_calendareventattendees.html
-    class CalendarEventAttendees < BaseXML
+    class CharacterCalendarEventAttendees < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/CalendarEventAttendees.xml.aspx'.freeze
 
       ACCESS_MASK = 4

data/lib/eve_online/{characters/chat_channels.rb → xml/character_chat_channels.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_chatchannels.html
-    class ChatChannels < BaseXML
+    class CharacterChatChannels < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/ChatChannels.xml.aspx'.freeze
 
       ACCESS_MASK = 536_870_912

data/lib/eve_online/{characters/contact_list.rb → xml/character_contact_list.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_contactlist.html
-    class ContactList < BaseXML
+    class CharacterContactList < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/ContactList.xml.aspx'.freeze
 
       ACCESS_MASK = 16

data/lib/eve_online/{characters/contact_notifications.rb → xml/character_contact_notifications.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_contactnotifications.html
-    class ContactNotifications < BaseXML
+    class CharacterContactNotifications < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/ContactNotifications.xml.aspx'.freeze
 
       ACCESS_MASK = 32

data/lib/eve_online/{characters/contract_bids.rb → xml/character_contract_bids.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_contractbids.html
-    class ContractBids < BaseXML
+    class CharacterContractBids < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/ContractBids.xml.aspx'.freeze
 
       ACCESS_MASK = 67_108_864

data/lib/eve_online/{characters/contract_items.rb → xml/character_contract_items.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_contractitems.html
-    class ContractItems < BaseXML
+    class CharacterContractItems < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/ContractItems.xml.aspx'.freeze
 
       ACCESS_MASK = 67_108_864

data/lib/eve_online/{characters/contracts.rb → xml/character_contracts.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_contracts.html
-    class Contracts < BaseXML
+    class CharacterContracts < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Contracts.xml.aspx'.freeze
 
       ACCESS_MASK = 67_108_864

data/lib/eve_online/{characters/fac_war_stats.rb → xml/character_fac_war_stats.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_facwarstats.html
-    class FacWarStats < BaseXML
+    class CharacterFacWarStats < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/FacWarStats.xml.aspx'.freeze
 
       ACCESS_MASK = 64

data/lib/eve_online/{characters/industry_jobs.rb → xml/character_industry_jobs.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_industryjobs.html
-    class IndustryJobs < BaseXML
+    class CharacterIndustryJobs < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/IndustryJobs.xml.aspx'.freeze
 
       ACCESS_MASK = 128

data/lib/eve_online/{characters/industry_jobs_history.rb → xml/character_industry_jobs_history.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_industryjobshistory.html
-    class IndustryJobsHistory < BaseXML
+    class CharacterIndustryJobsHistory < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/IndustryJobsHistory.xml.aspx'.freeze
 
       ACCESS_MASK = 128

data/lib/eve_online/{characters/kill_mails.rb → xml/character_kill_mails.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_killmails.html
-    class KillMails < BaseXML
+    class CharacterKillMails < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/KillMails.xml.aspx'.freeze
 
       ACCESS_MASK = 256

data/lib/eve_online/{characters/locations.rb → xml/character_locations.rb}

@@ -1,9 +1,9 @@
 require 'uri'
 
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_locations.html
-    class Locations < BaseXML
+    class CharacterLocations < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Locations.xml.aspx'.freeze
 
       ACCESS_MASK = 134_217_728

data/lib/eve_online/{characters/mail_bodies.rb → xml/character_mail_bodies.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_mailbodies.html
-    class MailBodies < BaseXML
+    class CharacterMailBodies < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/MailBodies.xml.aspx'.freeze
 
       ACCESS_MASK = 512

data/lib/eve_online/{characters/mail_messages.rb → xml/character_mail_messages.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_mailmessages.html
-    class MailMessages < BaseXML
+    class CharacterMailMessages < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/MailMessages.xml.aspx'.freeze
 
       ACCESS_MASK = 2_048

data/lib/eve_online/{characters/mailing_lists.rb → xml/character_mailing_lists.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_mailinglists.html
-    class MailingLists < BaseXML
+    class CharacterMailingLists < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/mailinglists.xml.aspx'.freeze
 
       ACCESS_MASK = 1_024

data/lib/eve_online/{characters/market_orders.rb → xml/character_market_orders.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_marketorders.html
-    class MarketOrders < BaseXML
+    class CharacterMarketOrders < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/MarketOrders.xml.aspx'.freeze
 
       ACCESS_MASK = 4_096

data/lib/eve_online/{characters/medals.rb → xml/character_medals.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_medals.html
-    class Medals < BaseXML
+    class CharacterMedals < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Medals.xml.aspx'.freeze
 
       ACCESS_MASK = 8_192

data/lib/eve_online/{characters/notification_texts.rb → xml/character_notification_texts.rb}

@@ -1,9 +1,9 @@
 require 'uri'
 
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_notificationtexts.html
-    class NotificationTexts < BaseXML
+    class CharacterNotificationTexts < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/NotificationTexts.xml.aspx'.freeze
 
       ACCESS_MASK = 32_768

data/lib/eve_online/{characters/notifications.rb → xml/character_notifications.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_notifications.html
-    class Notifications < BaseXML
+    class CharacterNotifications < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Notifications.xml.aspx'.freeze
 
       ACCESS_MASK = 16_384

data/lib/eve_online/{characters/planetary_colonies.rb → xml/character_planetary_colonies.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetarycolonies.html
-    class PlanetaryColonies < BaseXML
+    class CharacterPlanetaryColonies < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/PlanetaryColonies.xml.aspx'.freeze
 
       ACCESS_MASK = 2

data/lib/eve_online/{characters/planetary_links.rb → xml/character_planetary_links.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetarylinks.html
-    class PlanetaryLinks < BaseXML
+    class CharacterPlanetaryLinks < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/PlanetaryLinks.xml.aspx'.freeze
 
       ACCESS_MASK = 2

data/lib/eve_online/{characters/planetary_pins.rb → xml/character_planetary_pins.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetarypins.html
-    class PlanetaryPins < BaseXML
+    class CharacterPlanetaryPins < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/PlanetaryPins.xml.aspx'.freeze
 
       ACCESS_MASK = 2

data/lib/eve_online/{characters/planetary_routes.rb → xml/character_planetary_routes.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_planetaryroutes.html
-    class PlanetaryRoutes < BaseXML
+    class CharacterPlanetaryRoutes < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/PlanetaryRoutes.xml.aspx'.freeze
 
       ACCESS_MASK = 2

data/lib/eve_online/{characters/research.rb → xml/character_research.rb}

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/character/char_research.html
-    class Research < BaseXML
+    class CharacterResearch < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/Research.xml.aspx'.freeze
 
       ACCESS_MASK = 65_536

data/lib/eve_online/{characters → xml}/character_sheet.rb

@@ -1,7 +1,7 @@
 module EveOnline
-  module Characters
+  module XML
     # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_charactersheet.html
-    class CharacterSheet < BaseXML
+    class CharacterSheet < Base
       API_ENDPOINT = 'https://api.eveonline.com/char/CharacterSheet.xml.aspx'.freeze
 
       ACCESS_MASK = 8
@@ -149,39 +149,48 @@ module EveOnline
         parse_datetime_with_timezone(result.fetch('remoteStationDate'))
       end
 
+      # TODO: add to as_json output
       def jump_activation
         parse_datetime_with_timezone(result.fetch('jumpActivation'))
       end
 
+      # TODO: add to as_json output
       def jump_fatigue
         parse_datetime_with_timezone(result.fetch('jumpFatigue'))
       end
 
+      # TODO: add to as_json output
       def jump_last_update
         parse_datetime_with_timezone(result.fetch('jumpLastUpdate'))
       end
 
+      # TODO: add to as_json output
       def balance
         result.fetch('balance').to_f
       end
 
-      def base_intelligence
+      # TODO: add to as_json output
+      def intelligence
         attributes.fetch('intelligence').to_i
       end
 
-      def base_memory
+      # TODO: add to as_json output
+      def memory
         attributes.fetch('memory').to_i
       end
 
-      def base_charisma
+      # TODO: add to as_json output
+      def charisma
         attributes.fetch('charisma').to_i
       end
 
-      def base_perception
+      # TODO: add to as_json output
+      def perception
         attributes.fetch('perception').to_i
       end
 
-      def base_willpower
+      # TODO: add to as_json output
+      def willpower
         attributes.fetch('willpower').to_i
       end