eve_online 0.27.0 → 0.28.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17eb0d2aec3139c872785d811bdb2314c56b1b9c64b8a96dc91cf500944777b
-  data.tar.gz: 9d9c93b5cc0238575e56d14e3f772ce9bb4699836a08b93a9e41e109abfee3a8
+  metadata.gz: 943b658df93d204304c616a28be93c440fc185a794ecd97533a42ef0b9573eda
+  data.tar.gz: d12f89ba9d4960d4343d0f7f590121fc56ce011a98ec8c17ec177e192bb9a9a3
 SHA512:
-  metadata.gz: 8d3ea3e4d977d2d3bfd8dd730977b1c023125bc51978a9aceaa2af1c060e7813ce23bc6436727da210be2c37590bee107406fd2b890af4973b05e0139c398186
-  data.tar.gz: 8e13af4b0fd4abb10bafb1552ad98afd756b1ca091cb824a219771b8ed101f9a3e81154cbb9ea2f570ec6dc5a428248d770a53d1b9a6856907084e2b0a0167b5
+  metadata.gz: 3e4a436efa3bda306f56069d2840721e6579df0d03edd7e2a8ce150a50c6e7706da647083c32429c5c1ef5126f40ef621d20d756b2e521684caa108646400d47
+  data.tar.gz: cd7a036faac7af20fef0399877687085d759ad55b221379001249d7026c150c28ae0679df4e304e5b4ae2428039acaf96e25d9370a61e7146cf6ffaa554df076

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.28.0
+
+* Refactor url generator
+* Move language from header to query params. So, you can cache requests by url.
+* Remove `page` from `EveOnline::ESI::UniverseStructures`
+* Add support `filter` in `EveOnline::ESI::UniverseStructures`
+* Add support `max_war_id` in `EveOnline::ESI::Wars`
+* Add support `from_event` in `EveOnline::ESI::CharacterCalendar`
+* Add `EveOnline::ESI::CorporationAllianceHistory`
+* Add `EveOnline::ESI::Models::CorporationAllianceHistory`
+
 ## v0.27.0
 
 * Rails 6.0.0.rc1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eve_online (0.27.0)
+    eve_online (0.28.0)
       activesupport (>= 4.2.0)
 
 GEM
@@ -23,7 +23,7 @@ GEM
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
     docile (1.3.2)
-    fasterer (0.5.1)
+    fasterer (0.6.0)
       colorize (~> 0.7)
       ruby_parser (>= 3.13.0)
     hashdiff (0.4.0)
@@ -87,7 +87,7 @@ GEM
       sexp_processor (~> 4.9)
     safe_yaml (1.0.5)
     sexp_processor (4.12.1)
-    simplecov (0.16.1)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)

data/Gemfile.mutant.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    eve_online (0.27.0)
+    eve_online (0.28.0)
       activesupport (>= 4.2.0)
 
 GEM
@@ -101,7 +101,7 @@ GEM
       rspec-support (~> 3.8.0)
     rspec-support (3.8.2)
     safe_yaml (1.0.5)
-    simplecov (0.16.1)
+    simplecov (0.17.0)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)

data/README.md

@@ -407,6 +407,7 @@ bookmark_folder.name # => "Icecream"
 #### List calendar event summaries
 
 ```ruby
+# Add `from_event` if you want skip records
 options = { token: 'token123', character_id: 90_729_314 }
 
 character_calendar = EveOnline::ESI::CharacterCalendar.new(options)
@@ -429,7 +430,6 @@ event.event_response # => "not_responded"
 event.importance # => 0
 event.title # => "Moon extraction for 66-PMM - GoldMine-5-"
 
-# TODO: add from_event support
 # TODO: character_calendar.etag
 ```
 
@@ -828,6 +828,32 @@ corporation.etag # => "046430260be73e5d7ad3a9251954310bd547498eeb38f99e8d305796"
 
 #### Get alliance history
 
+```ruby
+options = { corporation_id: 98_134_807 }
+
+corporation_alliance_history = EveOnline::ESI::CorporationAllianceHistory.new(options)
+
+corporation_alliance_history.scope # => nil
+
+corporation_alliance_history.roles # => []
+
+corporation_alliance_history.entries.size # => 12
+
+entry = corporation_alliance_history.entries.first
+
+entry.as_json # => {:alliance_id=>99005874,
+              #     :is_deleted=>nil,
+              #     :record_id=>1254640,
+              #     :start_date=>Mon, 03 Jun 2019 00:17:00 UTC +00:00}
+
+entry.alliance_id # => 99005874
+entry.is_deleted # => nil
+entry.record_id # => 1254640
+entry.start_date # => Mon, 03 Jun 2019 00:17:00 UTC +00:00
+
+corporation_alliance_history.etag # => "9a949294cfa5fcef345ea8d89a574defa09be39845b9b97f1fdddd41"
+```
+
 #### Get corporation blueprints
 
 ```ruby
@@ -2315,11 +2341,23 @@ structures = EveOnline::ESI::UniverseStructures.new
 
 structures.scope # => nil
 
-structures.structure_ids.size # => 4004
+structures.structure_ids.size # => 3654
 
 structures.structure_ids.first # => 1027528548355
 
-structures.etag # => "6edc271fcf967ee50bec6935856501b233e58790fad237b097946a4c"
+structures.etag # => "1b64f9a8268bb3ba350acc7d7116bfd75dd9f88defb1bbc61771aec7"
+
+# with filter (`filter` is enum with values: nil, `market` and `manufacturing_basic`)
+
+options = { filter: 'market' }
+
+structures = EveOnline::ESI::UniverseStructures.new(options)
+
+structures.structure_ids.size # => 108
+
+structures.structure_ids.first # => 1030490622468
+
+structures.etag # => "2a825ab50413f1efe5f558b8d093e1299389b2f2ce3fa191907f7209"
 ```
 
 #### Get structure information
@@ -2602,9 +2640,19 @@ wars.war_ids.size # => 2000
 
 wars.war_ids.first # => 629019
 
-# TODO: max_war_id
-
 wars.etag # => "1e90be747fd163e5d74ab7a949bf8ad3f1d6ecd365cac31c534ab046"
+
+# with max_war_id
+
+options = { max_war_id: 10 }
+
+wars = EveOnline::ESI::Wars.new(options)
+
+wars.war_ids.size # => 9
+
+wars.war_ids.first # => 9
+
+wars.etag # => "f1c28227847464613c1cb82dfc8a8c859b7b6857fad2c2a54c562812"
 ```
 
 #### Get war information
@@ -2612,7 +2660,7 @@ wars.etag # => "1e90be747fd163e5d74ab7a949bf8ad3f1d6ecd365cac31c534ab046"
 #### List kills for a war
 
 ```ruby
-options = { war_id: 615578 }
+options = { war_id: 615578, page: 1 }
 
 war_killmails = EveOnline::ESI::WarKillmails.new(options)
 

data/lib/eve_online.rb

@@ -48,6 +48,7 @@ require 'eve_online/esi/character_clones'
 require 'eve_online/esi/character_implants'
 
 require 'eve_online/esi/corporation'
+require 'eve_online/esi/corporation_alliance_history'
 require 'eve_online/esi/corporation_blueprints'
 
 require 'eve_online/esi/dogma_attributes'
@@ -152,6 +153,7 @@ require 'eve_online/esi/models/server_status'
 require 'eve_online/esi/models/market_history'
 
 require 'eve_online/esi/models/corporation'
+require 'eve_online/esi/models/corporation_alliance_history'
 
 require 'eve_online/esi/models/alliance'
 require 'eve_online/esi/models/alliance_short'

data/lib/eve_online/esi/alliance.rb

@@ -7,7 +7,7 @@ module EveOnline
     class Alliance < Base
       extend Forwardable
 
-      API_PATH = '/v3/alliances/%<alliance_id>s/?datasource=%<datasource>s'
+      API_PATH = '/v3/alliances/%<alliance_id>s/'
 
       attr_reader :alliance_id
 
@@ -27,8 +27,8 @@ module EveOnline
 
       def scope; end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", alliance_id: alliance_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", alliance_id: alliance_id)
       end
     end
   end

data/lib/eve_online/esi/alliance_corporations.rb

@@ -3,7 +3,7 @@
 module EveOnline
   module ESI
     class AllianceCorporations < Base
-      API_PATH = '/v1/alliances/%<alliance_id>s/corporations/?datasource=%<datasource>s'
+      API_PATH = '/v1/alliances/%<alliance_id>s/corporations/'
 
       attr_reader :alliance_id
 
@@ -19,8 +19,8 @@ module EveOnline
 
       def scope; end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", alliance_id: alliance_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", alliance_id: alliance_id)
       end
     end
   end

data/lib/eve_online/esi/alliance_icon.rb

@@ -7,7 +7,7 @@ module EveOnline
     class AllianceIcon < Base
       extend Forwardable
 
-      API_PATH = '/v1/alliances/%<alliance_id>s/icons/?datasource=%<datasource>s'
+      API_PATH = '/v1/alliances/%<alliance_id>s/icons/'
 
       attr_reader :alliance_id
 
@@ -25,8 +25,8 @@ module EveOnline
 
       def scope; end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", alliance_id: alliance_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", alliance_id: alliance_id)
       end
     end
   end

data/lib/eve_online/esi/alliances.rb

@@ -3,7 +3,7 @@
 module EveOnline
   module ESI
     class Alliances < Base
-      API_PATH = '/v1/alliances/?datasource=%<datasource>s'
+      API_PATH = '/v1/alliances/'
 
       def alliance_ids
         response
@@ -11,8 +11,8 @@ module EveOnline
 
       def scope; end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", datasource: datasource)
+      def path
+        API_PATH
       end
     end
   end

data/lib/eve_online/esi/base.rb

@@ -8,7 +8,7 @@ require 'active_support/time'
 module EveOnline
   module ESI
     class Base
-      API_HOST = 'https://esi.evetech.net'
+      API_HOST = 'esi.evetech.net'
 
       attr_reader :token, :parser, :_read_timeout, :_open_timeout, :_etag,
                   :datasource, :language
@@ -31,7 +31,7 @@ module EveOnline
       end
 
       def url
-        raise NotImplementedError
+        uri.to_s
       end
 
       def scope
@@ -107,7 +107,6 @@ module EveOnline
 
           request['User-Agent'] = user_agent
           request['Accept'] = 'application/json'
-          request['Accept-Language'] = language
           request['Authorization'] = "Bearer #{ token }" if token
           request['If-None-Match'] = _etag if _etag
           request['Content-Type'] = 'application/json' if http_method == 'Post'
@@ -122,7 +121,31 @@ module EveOnline
       end
 
       def uri
-        @uri ||= URI.parse(url)
+        @uri ||= URI::HTTPS.build(host: API_HOST,
+                                  path: path,
+                                  query: query.to_query)
+      end
+
+      def additation_query_params
+        []
+      end
+
+      def base_query_params
+        [:datasource]
+      end
+
+      def path
+        raise NotImplementedError
+      end
+
+      def query
+        hash = {}
+
+        (base_query_params + additation_query_params).each do |param|
+          hash[param] = public_send(param)
+        end
+
+        hash.reject { |_, v| v.blank? }
       end
 
       def resource

data/lib/eve_online/esi/character.rb

@@ -7,7 +7,7 @@ module EveOnline
     class Character < Base
       extend Forwardable
 
-      API_PATH = '/v4/characters/%<character_id>s/?datasource=%<datasource>s'
+      API_PATH = '/v4/characters/%<character_id>s/'
 
       attr_reader :character_id
 
@@ -27,8 +27,8 @@ module EveOnline
 
       def scope; end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", character_id: character_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", character_id: character_id)
       end
     end
   end

data/lib/eve_online/esi/character_assets.rb

@@ -3,7 +3,7 @@
 module EveOnline
   module ESI
     class CharacterAssets < Base
-      API_PATH = '/v3/characters/%<character_id>s/assets/?datasource=%<datasource>s&page=%<page>s'
+      API_PATH = '/v3/characters/%<character_id>s/assets/'
 
       attr_reader :character_id, :page
 
@@ -29,8 +29,12 @@ module EveOnline
         'esi-assets.read_assets.v1'
       end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", character_id: character_id, datasource: datasource, page: page)
+      def additation_query_params
+        [:page]
+      end
+
+      def path
+        format("#{ API_PATH }", character_id: character_id)
       end
     end
   end

data/lib/eve_online/esi/character_assets_locations.rb

@@ -3,7 +3,7 @@
 module EveOnline
   module ESI
     class CharacterAssetsLocations < Base
-      API_PATH = '/v2/characters/%<character_id>s/assets/locations/?datasource=%<datasource>s'
+      API_PATH = '/v2/characters/%<character_id>s/assets/locations/'
 
       attr_reader :character_id, :item_ids
 
@@ -41,8 +41,8 @@ module EveOnline
         raise NotImplementedError
       end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", character_id: character_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", character_id: character_id)
       end
     end
   end

data/lib/eve_online/esi/character_assets_names.rb

@@ -3,7 +3,7 @@
 module EveOnline
   module ESI
     class CharacterAssetsNames < Base
-      API_PATH = '/v1/characters/%<character_id>s/assets/names/?datasource=%<datasource>s'
+      API_PATH = '/v1/characters/%<character_id>s/assets/names/'
 
       attr_reader :character_id, :item_ids
 
@@ -41,8 +41,8 @@ module EveOnline
         raise NotImplementedError
       end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", character_id: character_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", character_id: character_id)
       end
     end
   end

data/lib/eve_online/esi/character_attributes.rb

@@ -7,7 +7,7 @@ module EveOnline
     class CharacterAttributes < Base
       extend Forwardable
 
-      API_PATH = '/v1/characters/%<character_id>s/attributes/?datasource=%<datasource>s'
+      API_PATH = '/v1/characters/%<character_id>s/attributes/'
 
       attr_reader :character_id
 
@@ -29,8 +29,8 @@ module EveOnline
         'esi-skills.read_skills.v1'
       end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", character_id: character_id, datasource: datasource)
+      def path
+        format("#{ API_PATH }", character_id: character_id)
       end
     end
   end

data/lib/eve_online/esi/character_blueprints.rb

@@ -3,7 +3,7 @@
 module EveOnline
   module ESI
     class CharacterBlueprints < Base
-      API_PATH = '/v2/characters/%<character_id>s/blueprints/?datasource=%<datasource>s&page=%<page>s'
+      API_PATH = '/v2/characters/%<character_id>s/blueprints/'
 
       attr_reader :character_id, :page
 
@@ -29,8 +29,12 @@ module EveOnline
         'esi-characters.read_blueprints.v1'
       end
 
-      def url
-        format("#{ API_HOST }#{ API_PATH }", character_id: character_id, datasource: datasource, page: page)
+      def additation_query_params
+        [:page]
+      end
+
+      def path
+        format("#{ API_PATH }", character_id: character_id)
       end
     end
   end