eve_online 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f72e3d0391386671a7ea8afe41d20df5d826c965
-  data.tar.gz: bfd69d85ff66f716cb1dbf4d6a14d6d60224631e
+  metadata.gz: 504405d8b40072ca623979ee5b0388080335ee0c
+  data.tar.gz: f27d4dbfa2a07efd1b1ea5addd7311d07ce4b8e7
 SHA512:
-  metadata.gz: cfca91d3ee4d005c14861ee2d8d957712c7fd4afa4b52d3446a0885d529678bd33d233fe8866c986a0e5822fe80e6be22527ed7ade80ecc80ec742d854bc3623
-  data.tar.gz: '0768114f8a0ca56b34108641fa3e227052d7e2815fcb41ed5c90020b00c58084e741f669b7e4505d3001b06c32ed49f2c7ec42895035530eb14172ee07fbd409'
+  metadata.gz: 1264fa212dbe6eb520397dc225b8312ca4ff0af2c9d7bf0752f4a3ea45f104c0ed615e79e035ec1816e0bb84d10002a382aec02d253610ca0dcacc932d1cf81f
+  data.tar.gz: 42e15086fdf5b57cb3ef3d2b574895180fb6fd8b424fd3148f9d991ffb0bafb95422f9c71c86eacae4aa69c06ef1448cca1b9254c47e8d4ab9af459289349379

data/.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+ 

data/.rubocop.yml

@@ -20,9 +20,9 @@ Style/DotPosition:
   StyleGuide: '#consistent-multi-line-chains'
   Enabled: true
 
-# Disable magic
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
+  EnforcedStyle: never
 
 # Recheck this cop later
 Style/FlipFlop:
@@ -98,11 +98,6 @@ Style/MethodCalledOnDoEndBlock:
 Style/MultilineAssignmentLayout:
   Enabled: true
 
-# Use %i or %I for arrays of symbols
-# Ruby 1.9 doesn't support %i and %I for arrays of symbols
-Style/SymbolArray:
-  Enabled: false
-
 # Just ignore order of gems in Gemfile
 Bundler/OrderedGems:
   Enabled: false

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
   - 2.1
   - 2.2.6
   - 2.3.3
+  - 2.4.0
   - ruby-head
 
 gemfile:
@@ -21,6 +22,8 @@ matrix:
       gemfile: gemfiles/activesupport_50.gemfile
     - rvm: 2.1
       gemfile: gemfiles/activesupport_50.gemfile
+    - rvm: 2.4.0
+      gemfile: gemfiles/activesupport_42.gemfile
     - rvm: ruby-head
       gemfile: gemfiles/activesupport_42.gemfile
   include:
@@ -43,7 +46,7 @@ matrix:
     - rvm: jruby-head
   fast_finish: true
 
-before_install: gem install bundler -v 1.13.6
+before_install: gem install bundler -v 1.14.5
 
 script:
   - bundle exec rake

data/Gemfile

@@ -9,4 +9,4 @@ gem 'pry'
 gem 'mutant'
 gem 'mutant-rspec'
 # rubocop version locked due config. Update rubocop config on gem update.
-gem 'rubocop', '0.46.0', require: false
+gem 'rubocop', '0.47.1', require: false

data/README.md

@@ -1,4 +1,4 @@
-# EveOnline API (XML, CREST and ESI)
+# EveOnline API (XML, CREST and ESI). With SDE.
 
 [![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)
@@ -8,7 +8,7 @@
 [![Dependency Status](https://gemnasium.com/biow0lf/eve_online.svg)](https://gemnasium.com/biow0lf/eve_online)
 [![security](https://hakiri.io/github/biow0lf/eve_online/master.svg)](https://hakiri.io/github/biow0lf/eve_online/master)
 
-This gem implement Ruby API for EveOnline MMORPG. All, XML, CREST and ESI API.
+This gem implement Ruby API for EveOnline MMORPG. All, XML, CREST and ESI API. With SDE.
 
 This gem was extracted from [EveMonk](http://evemonk.com). Source code of evemonk backend published [here](https://github.com/biow0lf/evemonk).
 
@@ -37,12 +37,15 @@ Or install it yourself as:
  * MRI 2.1
  * MRI 2.2
  * MRI 2.3
- * MRI 2.4 (head)
+ * MRI 2.4
+ * MRI 2.5 (head)
  * JRuby 9.1.5.0
  * JRuby (head)
 
 ## Usage
 
+### XML API
+
 Account status:
 
 ```ruby
@@ -993,16 +996,249 @@ campaigns.items.first
 # => {"eventType_str"=>"1", "campaignID"=>21773, "eventType"=>1, "sourceSolarsystem"=>{"id_str"=>"30003629", "href"=>"https://crest-tq.eveonline.com/solarsystems/30003629/", "id"=>30003629, "name"=>"S-KSWL"}, "attackers"=>{"score"=>0.8}, "campaignID_str"=>"21773", "sourceItemID"=>1020806305659, "startTime"=>"2016-05-04T15:43:16", "sourceItemID_str"=>"1020806305659", "defender"=>{"defender"=>{"id_str"=>"99006297", "href"=>"https://crest-tq.eveonline.com/alliances/99006297/", "id"=>99006297, "name"=>"DRONE WALKERS"}, "score"=>0.2}, "constellation"=>{"id_str"=>"20000529", "href"=>"https://crest-tq.eveonline.com/constellations/20000529/", "id"=>20000529, "name"=>"TJ10-O"}}
 ```
 
-## ESI Examples
+### ESI Examples
+
+#### Public information about a character
+
+```ruby
+character_id = 90729314
+
+character = EveOnline::ESI::Character.new(character_id)
+
+character.as_json
+# => {:corporation_id=>1000168, :birthday=>Fri, 15 Jan 2010 15:26:00 UTC +00:00, :name=>"Green Black", :gender=>"male", :race_id=>2, :bloodline_id=>4, :description=>"", :alliance_id=>12345678, :ancestry_id=>24, :security_status=>1.8694881661345457}
+
+character.corporation_id # => 1000168
+character.birthday # => Fri, 15 Jan 2010 15:26:00 UTC +00:00
+character.name # => "Green Black"
+character.gender # => "male"
+character.race_id # => 2
+character.bloodline_id # => 4
+character.description  # => ""
+character.alliance_id # => 12345678
+character.ancestry_id # => 24
+character.security_status # => 1.8694881661345457
+```
+
+#### Get portrait urls for a character
+
+```ruby
+character_id = 90729314
+
+character_portrait = EveOnline::ESI::CharacterPortrait.new(character_id)
+
+character_portrait.as_json
+# => {:small=>"http://image.eveonline.com/Character/90729314_64.jpg", :medium=>"http://image.eveonline.com/Character/90729314_128.jpg", :large=>"http://image.eveonline.com/Character/90729314_256.jpg", :huge=>"http://image.eveonline.com/Character/90729314_512.jpg"}
+
+character_portrait.small # => "http://image.eveonline.com/Character/90729314_64.jpg"
+character_portrait.medium # => "http://image.eveonline.com/Character/90729314_128.jpg"
+character_portrait.large # => "http://image.eveonline.com/Character/90729314_256.jpg"
+character_portrait.huge # => "http://image.eveonline.com/Character/90729314_512.jpg"
+```
+
+#### List all trained skills for the given character
+
+```ruby
+token = 'token123'
+
+character_id = 90729314
+
+character_skills = EveOnline::ESI::CharacterSkills.new(token, character_id)
+
+character_skills.total_sp # => 43232144
+
+character_skills.as_json # => {:total_sp=>43232144}
+
+character_skills.skills.size # => 180
+
+skill = character_skills.skills.first
+
+skill.as_json # => {:skill_id=>22536, :skillpoints_in_skill=>500, :current_skill_level=>1}
+
+skill.skill_id # => 22536
+skill.skillpoints_in_skill # => 500
+skill.current_skill_level # => 1
+```
+
+#### List the configured skill queue for the given character
+
+```ruby
+token = 'token123'
+
+character_id = 90729314
+
+character_skill_queue = EveOnline::ESI::CharacterSkillQueue.new(token, character_id)
 
-Character info:
+character_skill_queue.skills.size # => 50
+
+skill_queue_entry = character_skill_queue.skills.first
+
+skill_queue_entry.as_json
+# => {:skill_id=>12487, :finished_level=>3, :queue_position=>0, :finish_date=>Mon, 16 Jan 2017 03:00:35 UTC +00:00, :start_date=>Sun, 15 Jan 2017 11:38:25 UTC +00:00, :training_start_sp=>7263, :level_end_sp=>40000, :level_start_sp=>7072}
+
+skill_queue_entry.skill_id # => 12487
+skill_queue_entry.finished_level # => 3
+skill_queue_entry.queue_position # => 0
+skill_queue_entry.finish_date # => Mon, 16 Jan 2017 03:00:35 UTC +00:00
+skill_queue_entry.start_date # => Sun, 15 Jan 2017 11:38:25 UTC +00:00
+skill_queue_entry.training_start_sp # => 7263
+skill_queue_entry.level_end_sp # => 40000
+skill_queue_entry.level_start_sp # => 7072
+```
+
+#### List of loyalty points for all corporations the character has worked for
 
 ```ruby
+token = 'token123'
+
 character_id = 90729314
 
-character = EveOnline::ESI::Characters::Character.new(character_id)
+character_loyalty_points = EveOnline::ESI::CharacterLoyaltyPoints.new(token, character_id)
+
+character_loyalty_points.loyalty_points.size # => 5
+
+loyalty_point = character_loyalty_points.loyalty_points.first
 
-# TODO: finish
+loyalty_point.as_json # => {:corporation_id=>1000035, :loyalty_points=>14163}
+
+loyalty_point.corporation_id # => 1000035
+loyalty_point.loyalty_points # => 14163
+```
+
+### SDE Examples
+
+Agent Types:
+```ruby
+file = 'agtAgentTypes.yaml'
+
+agt_agent_types = EveOnline::SDE::AgtAgentTypes.new(file)
+
+agt_agent_types.agt_agent_types.size # => 12
+
+agent_type = agt_agent_types.agt_agent_types.first
+
+agent_type.as_json # => {:agent_type=>"NonAgent", :agent_type_id=>1}
+
+agent_type.agent_type # => "NonAgent"
+agent_type.agent_type_id # => 1
+```
+
+Agents:
+```ruby
+file = 'agtAgents.yaml'
+
+agt_agents = EveOnline::SDE::AgtAgents.new(file)
+
+agt_agents.agt_agents.size # => 10975
+
+agt_agent = agt_agents.agt_agents.first
+
+agt_agent.as_json # => {:agent_id=>3008416, :agent_type_id=>2, :corporation_id=>1000002, :division_id=>22, :is_locator=>false, :level=>1, :location_id=>60000004, :quality=>20}
+
+agt_agent.agent_id # => 3008416
+agt_agent.agent_type_id # => 2
+agt_agent.corporation_id # => 1000002
+agt_agent.division_id # => 22
+agt_agent.is_locator # => false
+agt_agent.level # => 1
+agt_agent.location_id # => 60000004
+agt_agent.quality # => 20
+```
+
+Inventory Flags:
+```ruby
+file = 'invFlags.yaml'
+
+inv_flags = EveOnline::SDE::InvFlags.new(file)
+
+inv_flags.inv_flags.size # => 152
+
+inv_flag = inv_flags.inv_flags.first
+
+inv_flag.as_json # => {:flag_id=>0, :flag_name=>"None", :flag_text=>"None", :order_id=>0}
+
+inv_flag.flag_id # => 0
+inv_flag.flag_name # => "None"
+inv_flag.flag_text # => "None"
+inv_flag.order_id  # => 0
+```
+
+Inventory Items:
+```ruby
+file = 'invItems.yaml'
+
+inv_items = EveOnline::SDE::InvItems.new(file)
+
+inv_items.inv_items.size # => 531470
+
+inv_item = inv_items.inv_items.first
+
+inv_item.as_json # => {:flag_id=>0, :item_id=>40021067, :location_id=>30000334, :owner_id=>1, :quantity=>34, :type_id=>14}
+
+inv_item.flag_id # => 0
+inv_item.item_id # => 40021067
+inv_item.location_id # => 30000334
+inv_item.owner_id # => 1
+inv_item.quantity # => 34
+inv_item.type_id # => 14
+```
+
+Inventory Names:
+```ruby
+file = 'invNames.yaml'
+
+inv_names = EveOnline::SDE::InvNames.new(file)
+
+inv_names.inv_names.size # => 519921
+
+inv_name = inv_names.inv_names.first
+
+inv_name.as_json # => {:item_id=>0, :item_name=>"(none)"}
+
+inv_name.item_id # => 0
+inv_name.item_name # => "(none)"
+```
+
+Invertory Positions:
+```ruby
+file = 'invPositions.yaml'
+
+inv_positions = EveOnline::SDE::InvPositions.new(file)
+
+inv_positions.inv_positions.size # => 508383
+
+inv_position = inv_positions.inv_positions.first
+
+inv_position.as_json # => {:item_id=>0, :pitch=>0.0, :roll=>0.0, :x=>0.0, :y=>0.0, :yaw=>0.0, :z=>0.0}
+
+inv_position.item_id # => 0
+inv_position.pitch # => 0.0
+inv_position.roll # => 0.0
+inv_position.x # => 0.0
+inv_position.y # => 0.0
+inv_position.yaw # => 0.0
+inv_position.z # => 0.0
+```
+
+Character Races:
+```ruby
+file = 'chrRaces.yaml'
+
+chr_races = EveOnline::SDE::ChrRaces.new(file)
+
+chr_races.chr_races.size # => 8
+
+chr_race = chr_races.chr_races.first
+
+chr_race.as_json # => {:race_id=>16,
+                 #     :race_name=>"Jove",
+                 #     :short_description=>"",
+                 #     :description=>"The most mysterious and elusive of all the universe's peoples..."}
+
+chr_race.race_id # => 16
+chr_race.race_name # => "Jove"
+chr_race.short_description # => ""
+chr_race.description # => "The most mysterious and elusive of all the universe's peoples..."
 ```
 
 ## Useful links
@@ -1025,6 +1261,36 @@ Issue reports and pull requests are welcome on GitHub at https://github.com/biow
 
 ## Changelog
 
+**v0.11.0**
+
+* Add SDE support classes
+* `EveOnline::SDE::AgtAgentTypes`
+* `EveOnline::SDE::AgtAgents`
+* `EveOnline::SDE::AgtResearchAgents`
+* `EveOnline::SDE::ChrRaces`
+* `EveOnline::SDE::InvFlags`
+* `EveOnline::SDE::InvItems`
+* `EveOnline::SDE::InvNames`
+* `EveOnline::SDE::InvPositions`
+* `EveOnline::SDE::Models::AgtAgentType`
+* `EveOnline::SDE::Models::AgtAgent`
+* `EveOnline::SDE::Models::AgtResearchAgent`
+* `EveOnline::SDE::Models::ChrRace`
+* `EveOnline::SDE::Models::InvFlag`
+* `EveOnline::SDE::Models::InvItem`
+* `EveOnline::SDE::Models::InvName`
+* `EveOnline::SDE::Models::InvPosition`
+* Finish `EveOnline::ESI::Characters::Character`
+* Add `EveOnline::ESI::CharacterPortrait`
+* Add `EveOnline::ESI::CharacterSkills`
+* Rename `EveOnline::ESI::Characters::Character` to `EveOnline::ESI::Character`
+* Add `EveOnline::ESI::CharacterSkillQueue`
+* Add `EveOnline::ESI::CharacterLoyaltyPoints`
+* Add `EveOnline::ESI::Models::LoyaltyPoint` class for handling character loyalty points
+* Add `EveOnline::ESI::Models::SkillQueue` class for handling character skill queue entries
+* Add `EveOnline::ESI::Models::Skill` class for handing character skills
+* Rename `EveOnline::SkillQueueEntry` to `EveOnline::XML::Models::SkillQueueEntry`
+
 **v0.10.0**
 
 * Replace `open-uri` with `faraday`

data/eve_online.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Igor Zubkov']
   spec.email         = ['igor.zubkov@gmail.com']
 
-  spec.summary       = 'EveOnline API. XML, CREST and ESI.'
-  spec.description   = 'EveOnline API. XML, CREST and ESI.'
+  spec.summary       = 'EveOnline API. XML, CREST and ESI. And SDE.'
+  spec.description   = 'EveOnline API. XML, CREST and ESI. And SDE.'
   spec.homepage      = 'https://github.com/biow0lf/eve_online'
   spec.license       = 'MIT'
 
@@ -28,6 +28,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '>= 3.0.0'
   spec.add_runtime_dependency 'nori', '~> 2.6'
   spec.add_runtime_dependency 'json'
+  # spec.add_runtime_dependency 'bitset'
+  # spec.add_runtime_dependency 'hashformer'
   spec.add_runtime_dependency 'memoist'
   spec.add_runtime_dependency 'faraday'
 end

data/lib/eve_online.rb

@@ -23,7 +23,6 @@ require 'eve_online/character_implants'
 require 'eve_online/character_jump_clones'
 require 'eve_online/character_jump_clone_implants'
 require 'eve_online/standing'
-require 'eve_online/skill_queue_entry'
 require 'eve_online/contact_notification'
 require 'eve_online/wallet_journal_entry'
 require 'eve_online/market_order'
@@ -76,10 +75,41 @@ require 'eve_online/server/status'
 
 require 'eve_online/sovereignty/campaigns'
 
+require 'eve_online/xml/models/skill_queue_entry'
+
 # ESI API
 require 'eve_online/esi/base'
 
-require 'eve_online/esi/characters/character'
+require 'eve_online/esi/character'
+require 'eve_online/esi/character_portrait'
+require 'eve_online/esi/character_skills'
+require 'eve_online/esi/character_skill_queue'
+require 'eve_online/esi/character_loyalty_points'
+
+require 'eve_online/esi/models/loyalty_point'
+require 'eve_online/esi/models/skill_queue_entry'
+require 'eve_online/esi/models/skill'
+
+# SDE
+require 'eve_online/sde/base'
+
+require 'eve_online/sde/agt_agent_types'
+require 'eve_online/sde/agt_agents'
+require 'eve_online/sde/agt_research_agents'
+require 'eve_online/sde/chr_races'
+require 'eve_online/sde/inv_flags'
+require 'eve_online/sde/inv_items'
+require 'eve_online/sde/inv_names'
+require 'eve_online/sde/inv_positions'
+
+require 'eve_online/sde/models/agt_agent_type'
+require 'eve_online/sde/models/agt_agent'
+require 'eve_online/sde/models/agt_research_agent'
+require 'eve_online/sde/models/chr_race'
+require 'eve_online/sde/models/inv_flag'
+require 'eve_online/sde/models/inv_item'
+require 'eve_online/sde/models/inv_name'
+require 'eve_online/sde/models/inv_position'
 
 module EveOnline
 end