eve_online 0.6.0 → 0.7.0

data/eve_online.gemspec

@@ -20,14 +20,12 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 1.9.3'
 
   spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'webmock'
 
-  # http://weblog.rubyonrails.org/2016/1/25/Rails-5-0-0-beta1-1-4-2-5-1-4-1-14-1-3-2-22-1-and-rails-html-sanitizer-1-0-3-have-been-released/
-  spec.add_runtime_dependency 'activesupport', '>= 4.2.5.1'
+  spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
   spec.add_runtime_dependency 'nori', '~> 2.6'
-  # https://github.com/sparklemotion/nokogiri/blob/v1.6.7.2/CHANGELOG.rdoc
-  spec.add_runtime_dependency 'nokogiri', '>= 1.6.7.2'
+  spec.add_runtime_dependency 'json'
 end

data/lib/eve_online.rb

@@ -1,11 +1,17 @@
 require 'eve_online/version'
+
 require 'eve_online/base'
+require 'eve_online/base_xml'
+require 'eve_online/base_crest'
+
 require 'eve_online/blueprint'
+require 'eve_online/bookmark'
+require 'eve_online/bookmark_folder'
 require 'eve_online/character'
 require 'eve_online/event'
 require 'eve_online/event_response_object'
-require 'eve_online/skill'
-require 'eve_online/skill_group'
+require 'eve_online/item'
+
 require 'eve_online/account/api_key_info'
 require 'eve_online/account/characters'
 require 'eve_online/account/status'
@@ -19,8 +25,10 @@ require 'eve_online/characters/contact_notifications'
 require 'eve_online/characters/character_sheet'
 require 'eve_online/characters/upcoming_calendar_events'
 require 'eve_online/characters/skill_in_training'
-require 'eve_online/eve/skill_tree'
+require 'eve_online/eve/character_id'
 require 'eve_online/server/status'
 
+require 'eve_online/sovereignty/campaigns'
+
 module EveOnline
 end

data/lib/eve_online/account/api_key_info.rb

@@ -1,8 +1,8 @@
 module EveOnline
   module Account
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/account_apikeyinfo/
-    class ApiKeyInfo < Base
-      API_ENDPOINT = 'https://api.eveonline.com/account/APIKeyInfo.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/account/account_apikeyinfo.html
+    class ApiKeyInfo < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/account/APIKeyInfo.xml.aspx'.freeze
 
       attr_reader :key_id, :v_code
 
@@ -36,8 +36,7 @@ module EveOnline
       end
 
       def expires
-        @expires ||= \
-          ActiveSupport::TimeZone['UTC'].parse(key.fetch('@expires'))
+        @expires ||= ActiveSupport::TimeZone['UTC'].parse(key.fetch('@expires'))
       end
 
       def type

data/lib/eve_online/account/characters.rb

@@ -1,8 +1,8 @@
 module EveOnline
   module Account
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/account_characters/
-    class Characters < Base
-      API_ENDPOINT = 'https://api.eveonline.com/account/Characters.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/account/account_characters.html
+    class Characters < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/account/Characters.xml.aspx'.freeze
 
       attr_reader :key_id, :v_code
 

data/lib/eve_online/account/status.rb

@@ -1,8 +1,8 @@
 module EveOnline
   module Account
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/account_accountstatus/
-    class Status < Base
-      API_ENDPOINT = 'https://api.eveonline.com/account/AccountStatus.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/account/account_accountstatus.html
+    class Status < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/account/AccountStatus.xml.aspx'.freeze
 
       attr_reader :key_id, :v_code
 
@@ -24,13 +24,11 @@ module EveOnline
       end
 
       def paid_until
-        @paid_until ||= \
-          ActiveSupport::TimeZone['UTC'].parse(result.fetch('paidUntil'))
+        @paid_until ||= ActiveSupport::TimeZone['UTC'].parse(result.fetch('paidUntil'))
       end
 
       def create_date
-        @create_date ||= \
-          ActiveSupport::TimeZone['UTC'].parse(result.fetch('createDate'))
+        @create_date ||= ActiveSupport::TimeZone['UTC'].parse(result.fetch('createDate'))
       end
 
       def logon_count

data/lib/eve_online/base.rb

@@ -1,43 +1,18 @@
 require 'open-uri'
-require 'nori'
-require 'active_support/time'
 
 module EveOnline
   class Base
-    attr_reader :parser
-
-    def initialize
-      @parser = Nori.new(advanced_typecasting: false)
-    end
-
-    def result
-      @result ||= eveapi.fetch('result')
-    end
-
-    def cached_until
-      @cached_until ||= \
-        ActiveSupport::TimeZone['UTC'].parse(eveapi.fetch('cachedUntil'))
-    end
-
-    def current_time
-      @current_time ||= \
-        ActiveSupport::TimeZone['UTC'].parse(eveapi.fetch('currentTime'))
-    end
-
-    def version
-      eveapi.fetch('@version').to_i
-    end
-
-    def eveapi
-      @eveapi ||= response.fetch('eveapi')
-    end
-
     def url
       raise NotImplementedError
     end
 
+    def user_agent
+      @user_agent ||= "EveOnline API (https://github.com/biow0lf/eve_online) v#{ EveOnline::VERSION }"
+    end
+
     def content
-      @content ||= open(url, open_timeout: 60, read_timeout: 60).read
+      @content ||= open(url, open_timeout: 60, read_timeout: 60,
+                             'User-Agent' => user_agent).read
     end
 
     def response

data/lib/eve_online/base_crest.rb

@@ -0,0 +1,11 @@
+require 'json'
+
+module EveOnline
+  class BaseCREST < Base
+    attr_reader :parser
+
+    def initialize
+      @parser = JSON
+    end
+  end
+end

data/lib/eve_online/base_xml.rb

@@ -0,0 +1,32 @@
+require 'nori'
+require 'active_support/time'
+
+module EveOnline
+  class BaseXML < Base
+    attr_reader :parser
+
+    def initialize
+      @parser = Nori.new(advanced_typecasting: false)
+    end
+
+    def result
+      @result ||= eveapi.fetch('result')
+    end
+
+    def cached_until
+      @cached_until ||= ActiveSupport::TimeZone['UTC'].parse(eveapi.fetch('cachedUntil'))
+    end
+
+    def current_time
+      @current_time ||= ActiveSupport::TimeZone['UTC'].parse(eveapi.fetch('currentTime'))
+    end
+
+    def version
+      eveapi.fetch('@version').to_i
+    end
+
+    def eveapi
+      @eveapi ||= response.fetch('eveapi')
+    end
+  end
+end

data/lib/eve_online/blueprint.rb

@@ -40,7 +40,7 @@ module EveOnline
       @flag_id ||= options.fetch('@flagID').to_i
     end
 
-    # TODO: return EvevOnline::Blueprint::Quantity
+    # TODO: return EveOnline::Blueprint::Quantity
     def quantity
       @quantity ||= options.fetch('@quantity').to_i
     end

data/lib/eve_online/bookmark.rb

@@ -0,0 +1,69 @@
+module EveOnline
+  class Bookmark
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def as_json(*args)
+      {
+        bookmark_id: bookmark_id,
+        creator_id: creator_id,
+        created: created,
+        item_id: item_id,
+        type_id: type_id,
+        location_id: location_id,
+        x: x,
+        y: y,
+        z: z,
+        memo: memo,
+        note: note
+      }
+    end
+
+    def bookmark_id
+      @bookmark_id ||= options.fetch('@bookmarkID').to_i
+    end
+
+    def creator_id
+      @creator_id ||= options.fetch('@creatorID').to_i
+    end
+
+    def created
+      @created ||= ActiveSupport::TimeZone['UTC'].parse(options.fetch('@created'))
+    end
+
+    def item_id
+      @item_id ||= options.fetch('@itemID').to_i
+    end
+
+    def type_id
+      @type_id ||= options.fetch('@typeID').to_i
+    end
+
+    def location_id
+      @location_id ||= options.fetch('@locationID').to_i
+    end
+
+    def x
+      @x ||= options.fetch('@x').to_f
+    end
+
+    def y
+      @y ||= options.fetch('@y').to_f
+    end
+
+    def z
+      @z ||= options.fetch('@z').to_f
+    end
+
+    def memo
+      @memo ||= options.fetch('@memo')
+    end
+
+    def note
+      @note ||= options.fetch('@note')
+    end
+  end
+end

data/lib/eve_online/bookmark_folder.rb

@@ -0,0 +1,24 @@
+module EveOnline
+  class BookmarkFolder
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    def as_json(*args)
+      {
+        folder_id: folder_id,
+        folder_name: folder_name
+      }
+    end
+
+    def folder_id
+      @folder_d ||= options.fetch('@folderID').to_i
+    end
+
+    def folder_name
+      @folder_name ||= options.fetch('@folderName')
+    end
+  end
+end

data/lib/eve_online/characters/account_balance.rb

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

data/lib/eve_online/characters/asset_list.rb

@@ -1,20 +1,44 @@
 module EveOnline
   module Characters
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/char_assetlist/
-    class AssetList < Base
-      API_ENDPOINT = 'https://api.eveonline.com/char/AssetList.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_assetlist.html
+    class AssetList < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/char/AssetList.xml.aspx'.freeze
 
-      attr_reader :key_id, :v_code, :character_id
+      attr_reader :key_id, :v_code, :character_id, :flat
 
-      def initialize(key_id, v_code, character_id)
+      def initialize(key_id, v_code, character_id, flat = 1)
         super()
         @key_id = key_id
         @v_code = v_code
         @character_id = character_id
+        @flat = flat
+      end
+
+      def assets
+        case row
+        when Hash
+          [EveOnline::Item.new(row)]
+        when Array
+          output = []
+          row.each do |item|
+            output << EveOnline::Item.new(item)
+          end
+          output
+        else
+          raise ArgumentError
+        end
+      end
+
+      def row
+        @row ||= rowset.fetch('row')
+      end
+
+      def rowset
+        @rowset ||= result.fetch('rowset')
       end
 
       def url
-        "#{ API_ENDPOINT }?keyID=#{ key_id }&vCode=#{ v_code }&characterID=#{ character_id }"
+        "#{ API_ENDPOINT }?keyID=#{ key_id }&vCode=#{ v_code }&characterID=#{ character_id }&flat=#{ flat }"
       end
     end
   end

data/lib/eve_online/characters/blueprints.rb

@@ -1,8 +1,8 @@
 module EveOnline
   module Characters
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/char_blueprints/
-    class Blueprints < Base
-      API_ENDPOINT = 'https://api.eveonline.com/char/Blueprints.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_blueprints.html
+    class Blueprints < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/char/Blueprints.xml.aspx'.freeze
 
       attr_reader :key_id, :v_code, :character_id
 

data/lib/eve_online/characters/bookmarks.rb

@@ -1,8 +1,8 @@
 module EveOnline
   module Characters
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/char_bookmarks/
-    class Bookmarks < Base
-      API_ENDPOINT = 'https://api.eveonline.com/char/Bookmarks.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_bookmarks.html
+    class Bookmarks < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/char/Bookmarks.xml.aspx'.freeze
 
       attr_reader :key_id, :v_code, :character_id
 
@@ -13,9 +13,34 @@ module EveOnline
         @character_id = character_id
       end
 
+      def bookmark_folders
+        @bookmark_folders ||= begin
+          case row
+          when Hash
+            [EveOnline::BookmarkFolder.new(row)]
+          when Array
+            bookmark_folders = []
+            row.each do |bookmark_folder|
+              bookmark_folders << EveOnline::BookmarkFolder.new(bookmark_folder)
+            end
+            bookmark_folders
+          else
+            raise ArgumentError
+          end
+        end
+      end
+
+      def row
+        @row ||= rowset.fetch('row')
+      end
+
+      def rowset
+        @rowset ||= result.fetch('rowset')
+      end
+
       def url
         "#{ API_ENDPOINT }?keyID=#{ key_id }&vCode=#{ v_code }&characterID=#{ character_id }"
-      end      
+      end
     end
   end
 end

data/lib/eve_online/characters/calendar_event_attendees.rb

@@ -1,8 +1,8 @@
 module EveOnline
   module Characters
-    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/char_calendareventattendees/
-    class CalendarEventAttendees < Base
-      API_ENDPOINT = 'https://api.eveonline.com/char/CalendarEventAttendees.xml.aspx'
+    # https://eveonline-third-party-documentation.readthedocs.org/en/latest/xmlapi/character/char_calendareventattendees.html
+    class CalendarEventAttendees < BaseXML
+      API_ENDPOINT = 'https://api.eveonline.com/char/CalendarEventAttendees.xml.aspx'.freeze
 
       attr_reader :key_id, :v_code, :character_id, :event_id