eve_online 0.31.0 → 0.35.1

data/README.md

@@ -3,8 +3,9 @@
 [![CircleCI](https://circleci.com/gh/evemonk/eve_online.svg?style=svg)](https://circleci.com/gh/evemonk/eve_online)
 [![Gem Version](https://badge.fury.io/rb/eve_online.svg)](https://badge.fury.io/rb/eve_online)
 [![Gem Downloads](https://img.shields.io/gem/dt/eve_online.svg)](https://rubygems.org/gems/eve_online)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/955073c905b91d53e68c/test_coverage)](https://codeclimate.com/github/evemonk/eve_online/test_coverage)
+[![Known Vulnerabilities](https://snyk.io/test/github/evemonk/eve_online/badge.svg)](https://snyk.io/test/github/evemonk/eve_online)
 [![security](https://hakiri.io/github/evemonk/eve_online/master.svg)](https://hakiri.io/github/evemonk/eve_online/master)
+[![DeepSource](https://static.deepsource.io/deepsource-badge-light-mini.svg)](https://deepsource.io/gh/evemonk/eve_online/?ref=repository-badge)
 
 This gem implement Ruby API for EveOnline MMORPG (ESI).
 
@@ -48,17 +49,13 @@ gem install eve_online
 
 ## Supported ruby versions
 
-* MRI 2.4
 * MRI 2.5
 * MRI 2.6
 * MRI 2.7
-* JRuby 9.2.9.0
+* JRuby 9.2.11.1
 
 ## Supported rails versions
 
-* 4.2
-* 5.0
-* 5.1
 * 5.2
 * 6.0
 * Edge
@@ -331,74 +328,8 @@ corporation_assets_names.etag # => NotImplementedError
 
 #### List bookmarks
 
-```ruby
-options = { token: 'token123', character_id: 90_729_314, page: 1 }
-
-character_bookmarks = EveOnline::ESI::CharacterBookmarks.new(options)
-
-character_bookmarks.scope # => "esi-bookmarks.read_character_bookmarks.v1"
-
-character_bookmarks.page # => 1
-
-character_bookmarks.total_pages # => 1
-
-character_bookmarks.bookmarks.size # => 20
-
-bookmark = character_bookmarks.bookmarks.first
-
-bookmark.as_json # => {:bookmark_id=>4,
-                 #     :created=>Mon, 09 Jul 2012 22:38:31 UTC +00:00,
-                 #     :creator_id=>2112625428,
-                 #     :folder_id=>5,
-                 #     :item_id=>30003496,
-                 #     :item_type_id=>5,
-                 #     :label=>"Stargate",
-                 #     :location_id=>30003430,
-                 #     :notes=>"This is a stargate"}
-
-bookmark.bookmark_id # => 4
-bookmark.created # => Mon, 09 Jul 2012 22:38:31 UTC +00:00
-bookmark.creator_id # => 2112625428
-bookmark.folder_id # => 5
-bookmark.item_id # => 30003496
-bookmark.item_type_id # => 5
-bookmark.label # => "Stargate"
-bookmark.location_id # => 30003430
-bookmark.notes # => "This is a stargate"
-
-bookmark.coordinates.as_json # => {:x=>-144951231521.81625,
-                             #     :y=>164030047870.25558,
-                             #     :z=>211467631848.1311}
-
-# TODO: character_bookmarks.etag
-```
-
 #### List bookmark folders
 
-```ruby
-options = { token: 'token123', character_id: 90_729_314, page: 1 }
-
-character_bookmark_folders = EveOnline::ESI::CharacterBookmarkFolders.new(options)
-
-character_bookmark_folders.scope # => "esi-bookmarks.read_character_bookmarks.v1"
-
-character_bookmark_folders.page # => 1
-
-character_bookmark_folders.total_pages # => 1
-
-character_bookmark_folders.bookmark_folders.size # => 1
-
-bookmark_folder = character_bookmark_folders.bookmark_folders.first
-
-bookmark_folder.as_json # => {:folder_id=>5,
-                        #     :name=>"Icecream"}
-
-bookmark_folder.folder_id # => 5
-bookmark_folder.name # => "Icecream"
-
-# TODO: character_bookmark_folders.etag
-```
-
 #### List corporation bookmarks
 
 #### List corporation bookmark folders
@@ -645,15 +576,15 @@ character_portrait = EveOnline::ESI::CharacterPortrait.new(options)
 
 character_portrait.scope # => nil
 
-character_portrait.as_json # => {:medium=>"http://imageserver.eveonline.com/Character/90729314_128.jpg",
-                           #     :large=>"http://imageserver.eveonline.com/Character/90729314_256.jpg",
-                           #     :huge=>"http://imageserver.eveonline.com/Character/90729314_512.jpg",
-                           #     :small=>"http://imageserver.eveonline.com/Character/90729314_64.jpg"}
+character_portrait.as_json # => {:medium=>"https://images.evetech.net/Character/1337512245_128.jpg",
+                           #     :large=>"https://images.evetech.net/Character/1337512245_256.jpg",
+                           #     :huge=>"https://images.evetech.net/Character/1337512245_512.jpg",
+                           #     :small=>"https://images.evetech.net/Character/1337512245_64.jpg"}
 
-character_portrait.medium # => "http://imageserver.eveonline.com/Character/90729314_128.jpg"
-character_portrait.large # => "http://imageserver.eveonline.com/Character/90729314_256.jpg"
-character_portrait.huge # => "http://imageserver.eveonline.com/Character/90729314_512.jpg"
-character_portrait.small # => "http://imageserver.eveonline.com/Character/90729314_64.jpg"
+character_portrait.medium # => "https://images.evetech.net/Character/1337512245_128.jpg"
+character_portrait.large # => "https://images.evetech.net/Character/1337512245_256.jpg"
+character_portrait.huge # => "https://images.evetech.net/Character/1337512245_512.jpg"
+character_portrait.small # => "https://images.evetech.net/Character/1337512245_64.jpg"
 
 character_portrait.etag # => "2c8392581d493e06c015ca3d48d4076079bf4c976b1f776742592260"
 ```
@@ -767,14 +698,164 @@ character_implants.implant_ids # => [9899, 9941, 9942, 9943, 9956]
 
 #### Get contracts
 
+```ruby
+options = { token: 'token123', character_id: 1337512245, page: 1 }
+
+contracts = EveOnline::ESI::CharacterContracts.new(options)
+
+contracts.scope # => "esi-contracts.read_character_contracts.v1"
+
+contracts.contracts.size # => 3
+
+contract = contracts.contracts.first
+
+contract.as_json # => {:acceptor_id=>2116199184,
+                 #     :assignee_id=>2116199184,
+                 #     :availability=>"personal",
+                 #     :buyout=>nil,
+                 #     :collateral=>0.0,
+                 #     :contract_id=>154837125,
+                 #     :date_accepted=>Fri, 06 Mar 2020 21:09:32 UTC +00:00,
+                 #     :date_completed=>Fri, 06 Mar 2020 21:09:32 UTC +00:00,
+                 #     :date_expired=>Sat, 07 Mar 2020 21:09:11 UTC +00:00,
+                 #     :date_issued=>Fri, 06 Mar 2020 21:09:11 UTC +00:00,
+                 #     :days_to_complete=>0,
+                 #     :end_location_id=>60008674,
+                 #     :for_corporation=>false,
+                 #     :issuer_corporation_id=>98134807,
+                 #     :issuer_id=>1337512245,
+                 #     :price=>0.0,
+                 #     :reward=>0.0,
+                 #     :start_location_id=>60008674,
+                 #     :status=>"finished",
+                 #     :title=>"",
+                 #     :type=>"item_exchange",
+                 #     :volume=>15000.0}
+
+contract.acceptor_id # => 2116199184
+contract.assignee_id # => 2116199184
+contract.availability # => "personal"
+contract.buyout # => nil
+contract.collateral # => 0.0
+contract.contract_id # => 154837125
+contract.date_accepted # => Fri, 06 Mar 2020 21:09:32 UTC +00:00
+contract.date_completed # => Fri, 06 Mar 2020 21:09:32 UTC +00:00
+contract.date_expired # => Sat, 07 Mar 2020 21:09:11 UTC +00:00
+contract.date_issued # => Fri, 06 Mar 2020 21:09:11 UTC +00:00
+contract.days_to_complete # => 0
+contract.end_location_id # => 60008674
+contract.for_corporation # => false
+contract.issuer_corporation_id # => 98134807
+contract.issuer_id # => 1337512245
+contract.price # => 0.0
+contract.reward # => 0.0
+contract.start_location_id # => 60008674
+contract.status # => "finished"
+contract.title # => ""
+contract.type # => "item_exchange"
+contract.volume # => 15000.0
+
+contracts.etag # => "6e18566a8f786f08aba678262360d0c74a783f9923aa43f8043133e4"
+```
+
 #### Get contract bids
 
 #### Get contract items
 
 #### Get public contracts
 
+```ruby
+options = { region_id: 10_000_043, page: 1 }
+
+contracts = EveOnline::ESI::PublicContracts.new(options)
+
+contracts.scope # => nil
+
+contracts.page # => 1
+
+contracts.total_pages # => 4
+
+contracts.contracts.size # => 1000
+
+contract = contracts.contracts.first
+
+contract.as_json # => {:buyout=>nil,
+                 #     :collateral=>0.0,
+                 #     :contract_id=>157834735,
+                 #     :date_expired=>Wed, 17 Jun 2020 21:36:41 UTC +00:00,
+                 #     :date_issued=>Wed, 20 May 2020 21:36:41 UTC +00:00,
+                 #     :days_to_complete=>0,
+                 #     :end_location_id=>60008494,
+                 #     :for_corporation=>true,
+                 #     :issuer_corporation_id=>897372069,
+                 #     :issuer_id=>1314102096,
+                 #     :price=>1250000000.0,
+                 #     :reward=>0.0,
+                 #     :start_location_id=>60008494,
+                 #     :title=>"Apostle Me10/Te16 Complete Bpc 10 Pack",
+                 #     :kind=>"item_exchange",
+                 #     :volume=>100.0}
+
+contract.buyout # => nil
+contract.collateral # => 0.0
+contract.contract_id # => 157834735
+contract.date_expired # => Wed, 17 Jun 2020 21:36:41 UTC +00:00
+contract.date_issued # => Wed, 20 May 2020 21:36:41 UTC +00:00
+contract.days_to_complete # => 0
+contract.end_location_id # => 60008494
+contract.for_corporation # => true
+contract.issuer_corporation_id # => 897372069
+contract.issuer_id # => 1314102096
+contract.price # => 1250000000.0
+contract.reward # => 0.0
+contract.start_location_id # => 60008494
+contract.title # => "Apostle Me10/Te16 Complete Bpc 10 Pack"
+contract.kind # => "item_exchange"
+contract.volume # => 100.0
+
+contracts.etag # => "3f7fdf9a69e35bb35d619b6cb5043a2766d11ca6306a8b5af369ce6e"
+```
+
 #### Get public contract bids
 
+```ruby
+options = { contract_id: 157_872_948, page: 1 }
+
+contract = EveOnline::ESI::PublicContract.new(options)
+
+contract.scope # => nil
+
+contract.page # => 1
+
+contract.total_pages # => 1
+
+contract.items.size # => 1
+
+item = contract.items.first
+
+item.as_json # => {:is_blueprint_copy=>true,
+             #     :is_included=>true,
+             #     :item_id=>1029552558074,
+             #     :material_efficiency=>10,
+             #     :quantity=>1,
+             #     :record_id=>3210378611,
+             #     :runs=>400,
+             #     :time_efficiency=>20,
+             #     :type_id=>29040}
+
+item.is_blueprint_copy # => true
+item.is_included # => true
+item.item_id # => 1029552558074
+item.material_efficiency # => 10
+item.quantity # => 1
+item.record_id # => 3210378611
+item.runs # => 400
+item.time_efficiency # => 20
+item.type_id # => 29040
+
+contract.etag # => "d458c3f56c114882a9ecfe1aaf173837310b15b6e7cef86a019e700f"
+```
+
 #### Get public contract items
 
 #### Get corporation contracts
@@ -933,6 +1014,18 @@ corporation_blueprints.roles # => ["Director"]
 
 #### Get npc corporations
 
+```ruby
+corporation_npcs = EveOnline::ESI::CorporationNPC.new
+
+corporation_npcs.scope # => nil
+
+corporation_npcs.corporation_npc_ids.size # => 262
+
+corporation_npcs.corporation_npc_ids.first # => 1000001
+
+corporation_npcs.etag # => "085946820256a4f7be2e9926e9d1de9e420cca53ffb31f7547740a05"
+```
+
 ### Dogma
 
 #### Get attributes
@@ -1298,13 +1391,13 @@ character_killmails.killmails.size # => 1
 
 killmail = character_killmails.killmails.first
 
-killmail.as_json # => {:killmail_hash=>"07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5",
-                 #     :killmail_id=>72410059}
+killmail.as_json # => {:killmail_hash=>"8f1450fca8ce97be9b10e106a1257088407ef387",
+                 #     :killmail_id=>81_646_519}
 
-killmail.killmail_hash # => "07f7ef1d7f6090e78d8e85b4a98e680f67b5e9d5"
-killmail.killmail_id # => 72410059
+killmail.killmail_hash # => "8f1450fca8ce97be9b10e106a1257088407ef387"
+killmail.killmail_id # => 81646519
 
-# TODO: character_killmails.etag
+character_killmails.etag # => "ba5068bc1b07db98d9efce93437295fbdb9d29b14b4ffbcbfa91ac0d"
 ```
 
 #### Get a corporation's recent kills and losses
@@ -1337,6 +1430,14 @@ corporation_killmails.roles # => ["Director"]
 
 #### Get a single killmail
 
+```ruby
+options = { killmail_id: 81_646_519, killmail_hash: "8f1450fca8ce97be9b10e106a1257088407ef387" }
+
+killmail = EveOnline::ESI::Killmail.new(options)
+
+# TODO: finish this
+```
+
 ### Location
 
 #### Get character location
@@ -1727,6 +1828,27 @@ market_group.etag # => "bf7832bfc20f5f9fdeddc9cb0360b941067310e7e3a2a80315b45a43
 
 #### List market prices
 
+```ruby
+market_prices = EveOnline::ESI::MarketPrices.new
+
+market_prices.scope # => nil
+
+market_prices.market_prices.size # => 12565
+
+market_price = market_prices.market_prices.first
+
+
+market_price.as_json # => {:adjusted_price=>923296.88,
+                     #     :average_price=>1273871.6,
+                     #     :type_id=>32772}
+
+market_price.adjusted_price # => 923296.88
+market_price.average_price # => 1273871.6
+market_price.type_id # => 32772
+
+market_prices.etag # => "2d5acc3bd4555821bb91d787596f5ddad129f849739e83162e93c02f"
+```
+
 #### List orders in a structure
 
 ### Opportunities
@@ -2020,7 +2142,7 @@ category.published # => true
 category.group_ids.size # => 46
 category.group_ids.first # => 25
 
-# TODO: category.etag
+category.etag # => "37a39e7a5f5ecc07b19a3128c319f1198d035aee10052d0a21ccdd94"
 ```
 
 #### Get constellations
@@ -2267,12 +2389,12 @@ races.races.size # => 4
 
 race = races.races.first
 
-race.as_json # => {:alliance_id=>500002,
+race.as_json # => {:faction_id=>500002,
              #     :description=>"Once a thriving tribal civilization, the Minmatar...",
              #     :name=>"Minmatar",
              #     :race_id=>2}
 
-race.alliance_id # => 500002
+race.faction_id # => 500002
 race.description # => "Once a thriving tribal civilization, the Minmatar..."
 race.name # => "Minmatar"
 race.race_id # => 2
@@ -2690,7 +2812,7 @@ type.etag # => "e3f6a76b4a1287f54966c6253f8f5d6ac6460bc43d47570331b43e0b"
 #### Get a character's wallet balance
 
 ```ruby
-options = { token: 'token123', character_id: 90729314 }
+options = { token: 'token123', character_id: 90_729_314 }
 
 character_wallet = EveOnline::ESI::CharacterWallet.new(options)
 
@@ -2700,13 +2822,13 @@ character_wallet.as_json # => {:wallet=>409488252.49}
 
 character_wallet.wallet # => 409488252.49
 
-# TODO: character_wallet.etag
+character_wallet.etag # => "482786a491138fdf393f42c457424b0cd3f3c3c7c2c9afb3f55c618a"
 ```
 
 #### Get character wallet journal
 
 ```ruby
-options = { token: 'token123', character_id: 90729314, page: 1 }
+options = { token: 'token123', character_id: 90_729_314, page: 1 }
 
 character_wallet_journal = EveOnline::ESI::CharacterWalletJournal.new(options)
 
@@ -2716,39 +2838,94 @@ character_wallet_journal.page # => 1
 
 character_wallet_journal.total_pages # => 1
 
-character_wallet_journal.wallet_journal_entries.size # => 1
+character_wallet_journal.wallet_journal_entries.size # => 220
 
 wallet_journal_entry = character_wallet_journal.wallet_journal_entries.first
 
-wallet_journal_entry.as_json
-
-wallet_journal_entry.amount
-wallet_journal_entry.balance
-wallet_journal_entry.context_id
-wallet_journal_entry.context_id_type
-wallet_journal_entry.date
-wallet_journal_entry.description
-wallet_journal_entry.first_party_id
-wallet_journal_entry.id
-wallet_journal_entry.reason
-wallet_journal_entry.ref_type
-wallet_journal_entry.second_party_id
-wallet_journal_entry.tax
-wallet_journal_entry.tax_receiver_id
-
-# TODO: update example
-
-# TODO: character_wallet_journal.etag
+wallet_journal_entry.as_json # => {:amount=>87375.0,
+                             #     :balance=>2405126.01,
+                             #     :context_id=>30003498,
+                             #     :context_id_type=>"system_id",
+                             #     :date=>Sun, 08 Mar 2020 12:08:25 UTC +00:00,
+                             #     :description=>"Johnn Dillinger got bounty prizes for killing pirates in Sharhelund",
+                             #     :first_party_id=>1000125,
+                             #     :wallet_journal_id=>17740466914,
+                             #     :reason=>"3744: 2,3748: 2,18085: 2,18070: 1",
+                             #     :ref_type=>"bounty_prizes",
+                             #     :second_party_id=>1337512245,
+                             #     :tax=>nil,
+                             #     :tax_receiver_id=>nil}
+
+wallet_journal_entry.amount # => 87375.0
+wallet_journal_entry.balance # => 2405126.01
+wallet_journal_entry.context_id # => 30003498
+wallet_journal_entry.context_id_type # => "system_id"
+wallet_journal_entry.date # => Sun, 08 Mar 2020 12:08:25 UTC +00:00
+wallet_journal_entry.description # => "Johnn Dillinger got bounty prizes for killing pirates in Sharhelund"
+wallet_journal_entry.first_party_id # => 1000125
+wallet_journal_entry.wallet_journal_id # => 17740466914
+wallet_journal_entry.reason # => "3744: 2,3748: 2,18085: 2,18070: 1"
+wallet_journal_entry.ref_type # => "bounty_prizes"
+wallet_journal_entry.second_party_id # => 1337512245
+wallet_journal_entry.tax # => nil
+wallet_journal_entry.tax_receiver_id # => nil
+
+character_wallet_journal.etag # => "b618a1a584f6aad53cb79c72d6de26d8c9210d0a18be1421d5355446"
 ```
 
 #### Get wallet transactions
 
+```ruby
+options = { token: "token123", character_id: 1_337_512_245 } # optional, add `from_id: 123` to skip records
+
+wallet_transactions = EveOnline::ESI::CharacterWalletTransactions.new(options)
+
+wallet_transactions.scope # => "esi-wallet.read_character_wallet.v1"
+
+wallet_transactions.wallet_transactions.size # => 47
+
+wallet_transaction = wallet_transactions.wallet_transactions.first
+
+wallet_transaction.as_json # => {:client_id=>2116253203,
+                           #     :date=>Sun, 08 Mar 2020 11:49:16 UTC +00:00,
+                           #     :is_buy=>true,
+                           #     :is_personal=>true,
+                           #     :journal_ref_id=>17740411474,
+                           #     :location_id=>60008494,
+                           #     :quantity=>1,
+                           #     :transaction_id=>5296927639,
+                           #     :type_id=>3538,
+                           #     :unit_price=>99887.79}
+
+wallet_transaction.client_id # => 2116253203
+wallet_transaction.date # => Sun, 08 Mar 2020 11:49:16 UTC +00:00
+wallet_transaction.is_buy # => true
+wallet_transaction.is_personal # => true
+wallet_transaction.journal_ref_id # => 17740411474
+wallet_transaction.location_id # => 60008494
+wallet_transaction.quantity # => 1
+wallet_transaction.transaction_id # => 5296927639
+wallet_transaction.type_id # => 3538
+wallet_transaction.unit_price # => 99887.79
+
+wallet_transactions.etag # => "55d0fbe8b408d6a76dab70c0a709d4e7c5dd58d4e0b7bd785549e268"
+```
+
 #### Returns a corporation's wallet balance
 
+```ruby
+```
+
 #### Get corporation wallet journal
 
+```ruby
+```
+
 #### Get corporation wallet transactions
 
+```ruby
+```
+
 ### Wars
 
 #### List wars
@@ -2956,6 +3133,26 @@ Oj.mimic_JSON()
 races = EveOnline::ESI::UniverseRaces.new
 ```
 
+## Formulas
+
+### Blueprint copy time
+
+```ruby
+seconds = 240 # 240 seconds it time to copy e.g. "Acolyte I Blueprint"
+science_level = 5 # character science level
+advanced_industry_level = 1 # character advanced industry level
+science_copy_speed_bonus_per_level = -5.00 # type dogma attribute copy speed bonus for science
+advanced_industry_skill_industry_job_time_bonus_per_level = -3.00 # type dogma attribute industry job time bonuse for advanced industry
+runs = 1 # number of copy, optional. default: 1
+
+formula = EveOnline::Formulas::BlueprintCopyTime.new(seconds, science_level,
+  advanced_industry_level, science_copy_speed_bonus_per_level,
+  advanced_industry_skill_industry_job_time_bonus_per_level, runs)
+
+# time of copy in seconds
+formula.time # => 174.6
+```
+
 ## Useful links
 
 * [BREAKING CHANGES AND YOU - HOW TO USE ALT-ROUTES TO ENHANCE YOUR SANITY](https://developers.eveonline.com/blog/article/breaking-changes-and-you)