eve 1.0.0

data/spec/lib/eve/trust/igb_interface_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Eve::Trust::IgbInterface do
+  @@igb_headers = {
+          'HTTP_USER_AGENT' => 'eve-minibrowser',
+          'HTTP_EVE_TRUSTED' => 'yes',
+          'HTTP_EVE_SERVERIP' => '1.2.3.4',
+          'HTTP_EVE_CHARNAME' => 'Jolia Darkstrider',
+          'HTTP_EVE_CHARID' => '1234567890',
+          'HTTP_EVE_CORPNAME' => 'Frogs of Armageddon',
+          'HTTP_EVE_CORPID' => '9876543210',
+          'HTTP_EVE_ALLIANCENAME' => 'Afro Mexicans',
+          'HTTP_EVE_ALLIANCEID' => '1928374',
+          'HTTP_EVE_REGIONNAME' => 'Solitude',
+          'HTTP_EVE_CONSTELLATIONNAME' => 'Morbault',
+          'HTTP_EVE_SOLARSYSTEMNAME' => 'Elore',
+          'HTTP_EVE_STATIONNAME' => 'Caldari Navy Assembly Plant',
+          'HTTP_EVE_STATIONID' => '1234',
+          'HTTP_EVE_CORPROLE' => '0'
+  }
+  @@igb_requested_headers = {
+          'HTTP_EVE_MILITIANAME' => 'militia name',
+          'HTTP_EVE_MILITIAID' => '1234567',
+          'HTTP_EVE_REGIONID' => '1929',
+          'HTTP_EVE_CONSTELLATIONID' => '100',
+          'HTTP_EVE_SOLARSYSTEMID' => '101',
+          'HTTP_EVE_SHIPID' => '102',
+          'HTTP_EVE_SYSTEMSECURITY' => '0.9',
+          'HTTP_EVE_VALIDATION_STRING' => 'abcdefghijklmnopqrstuvwxyz'
+  }
+
+  subject { Eve::Trust::IgbInterface.new(ActionController::Request.new(@rack_env)) }
+
+  shared_examples_for "any igb with trust" do
+    it "should be trusted" do
+      subject.trusted?.should be_true
+    end
+
+    it "should convert strings to objects using YAML where possible" do
+      subject.char_id.should == 1234567890
+      subject.corp_id.should == 9876543210
+      subject.alliance_id.should == 1928374
+      subject.station_id.should == 1234
+      subject.corp_role.should == 0
+    end
+
+    it "should have all methods delegated properly" do
+      subject.server_ip.should == '1.2.3.4'
+      subject.char_name.should == 'Jolia Darkstrider'
+      subject.corp_name.should == 'Frogs of Armageddon'
+      subject.alliance_name.should == 'Afro Mexicans'
+      subject.region_name.should == 'Solitude'
+      subject.constellation_name.should == 'Morbault'
+      subject.solar_system_name.should == 'Elore'
+      subject.station_name.should == 'Caldari Navy Assembly Plant'
+    end
+  end
+
+  context "without any IGB headers" do
+    before(:all) do
+      @rack_env = Rack::MockRequest.env_for("/").merge('REQUEST_URI' => '', 'HTTP_USER_AGENT' => 'eve-minibrowser')
+    end
+
+    it("should not be trusted") { subject.trusted?.should_not be_true }
+  end
+
+  context "without trust" do
+    before(:all) do
+      @rack_env = Rack::MockRequest.env_for("/").merge('REQUEST_URI' => '',
+                                                       'HTTP_USER_AGENT' => 'eve-minibrowser',
+                                                       'HTTP_EVE_TRUST' => 'no')
+    end
+
+    it("should not be trusted") { subject.trusted?.should_not be_true }
+  end
+
+  context "with trust" do
+    it_should_behave_like "any igb with trust"
+    before(:all) do
+      @rack_env = Rack::MockRequest.env_for("/").merge('REQUEST_URI' => '').merge(@@igb_headers)
+    end
+
+    context "after requests are implemented" do
+      it_should_behave_like "any igb with trust"
+
+      before(:all) do
+        @rack_env = Rack::MockRequest.env_for("/").merge('REQUEST_URI' => '').merge(@@igb_headers).merge(@@igb_requested_headers)
+      end
+
+      it "should load the additional data" do
+        subject.militia_name.should == 'militia name'
+        subject.militia_id.should == 1234567
+        subject.region_id.should == 1929
+        subject.constellation_id.should == 100
+        subject.solar_system_id.should == 101
+        subject.ship_id.should == 102
+        subject.system_security.should == 0.9
+        subject.validation_string.should == 'abcdefghijklmnopqrstuvwxyz'
+      end
+    end
+  end
+end

data/spec/rcov.opts

@@ -0,0 +1,2 @@
+--exclude "spec/*,gems/*"
+--aggregate coverage.data

data/spec/readme_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+# Runs the examples found in the synopsis of the README.rdoc file. We need to verify that they work because they should
+# be copy-and-paste ready.
+
+if !$mock_services  # only run these if the credentials are (theoretically) valid
+  describe "Readme Examples" do
+    it "should be copy-and-paste ready" do
+      # Get the current server status
+      api = Eve::API.new()
+      server_status = api.server_status
+      puts "Server reports status #{server_status.server_open ? "ONLINE" : "OFFLINE"}"
+      puts "\tCurrent time is #{server_status.current_time}"
+      puts "\t#{server_status.online_players} players currently online"
+      puts
+
+      # Get a list of characters
+      api = Eve::API.new(:user_id => $user_id, :api_key => $limited_api_key)
+      result = api.account.characters
+      puts "Choose a character:"
+      result.characters.each_with_index { |char, index| puts "\t#{index}: #{char.name} (#{char.character_id})" }
+      choice = gets.chomp.to_i
+      puts
+
+      # Get the current training queue. Need a full API key and a character ID for that.
+      api.set(:api_key => $full_api_key, :character_id => result.characters[choice].character_id)
+      result = api.character.skill_queue
+      result.skillqueue.each do |skill|
+        result.skillqueue.columns.each do |column|
+          print column.ljust(20), ":\t", skill[column], "\n"
+        end
+        puts
+      end
+    end
+  end
+end

data/spec/sample_api_key.yml

@@ -0,0 +1,20 @@
+# This information can be retrieved from http://www.eveonline.com/api/default.asp
+#
+# ! IMPORTANT !
+# Copy this file to "api_key.yml" in the same directory. This file ("sample_api_key.yml")
+# is not even used, and if you put your real API info into it there's a fair chance you'll
+# wind up accidentally committing it. The "api_key.yml" file is already in .gitignore, so
+# you won't do so if you remember to copy this file first.
+#
+# Note that it doesn't really matter what any of this stuff is if $mock_services is true,
+# which it really always should be unless you need to test end-to-end connectivity.
+#
+# Note, also, that the tests were designed around mock data. They WILL fail if you use real
+# data. However, you should be able to judge pretty easily by the error messages whether
+# they're failing because of the data mismatch, or whether they're failing for some other
+# (more catastrophic) reason.
+#
+User ID: your_user_id
+Limited API Key: your_limited_api_key
+Full API Key: your_full_api_key
+Character ID: your_character_id

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format progress
+--loadby mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require 'lib/eve'
+
+# Set to false to disable mock web service responses. Real requests will be used
+# whenever Eve.cache does not suffice. The API information above must be real and
+# valid in this case.
+$mock_services  = true
+
+keyfile = File.join(File.dirname(__FILE__), 'api_key.yml')
+cred_hash = !$mock_services && File.file?(keyfile) ? YAML::load(File.read(keyfile)) || {} : {}
+
+# ! IMPORTANT !
+# It's a lot safer to put this information in a file called "api_key.yml" in the same
+# directory as spec_helper.rb. This file is in the .gitignore list and so you won't
+# accidentally commit your API key that way. Leave the hash below for FAKE data (which
+# is what you'll usually spec with anyways), unless $mock_services == false.
+#
+$user_id         = cred_hash['User ID']         || '01234567890'
+$limited_api_key = cred_hash['Limited API Key'] || 'a_valid_limited_api_key'
+$full_api_key    = cred_hash['Full API Key']    || 'a_valid_full_api_key'
+$character_id    = cred_hash['Character ID']    || '0123456789'
+
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each { |f| require f }

data/spec/support/behaves_like_rowset.rb

@@ -0,0 +1,50 @@
+class BehavesLikeRowset
+  attr_reader :failure_message, :negative_failure_message
+  
+  def initialize(columns, &block)
+    @expected_columns = (columns.kind_of?(Array) ? columns : columns.split(/,/)).collect { |c| c.strip }
+    @block = block if block_given?
+    @missing = []
+  end
+
+  def matches?(target)
+    @target = target
+    check_for_column_mismatches
+
+    @target.each_with_index do |row, index|
+      @expected_columns.each do |column|
+        check_column(row, column)
+      end
+      return false if !check_for_missing(index)
+      @block.call(row) if @block
+    end
+    true
+  end
+
+  private
+  def check_for_missing(id)
+    if !@missing.empty?
+      @failure_message = "expected row #{id} in #{@target.inspect} to respond_to each of #{@missing.inspect}"
+      @negative_failure_message = "expected row in #{@target.inspect} not to respond_to each of #{@missing.inspect}"
+      return false
+    end
+    true
+  end
+
+  def check_for_column_mismatches
+    @target.columns.should == @expected_columns
+  end
+
+  def check_column(row, column)
+    check_for_response(row, column)
+    check_for_response(row, column.underscore)
+  end
+
+  def check_for_response(row, method_name)
+    @missing << method_name if !row.respond_to?(method_name)
+  end
+end
+
+def behave_like_rowset(expected_columns, &block)
+  BehavesLikeRowset.new(expected_columns, &block)
+end

data/spec/support/controllers/trust_controller.rb

@@ -0,0 +1,7 @@
+class TrustController < ApplicationController
+  requires_trust
+
+  def index
+    render :nothing => true
+  end
+end

data/spec/support/mock_api_helpers.rb

@@ -0,0 +1,41 @@
+module MockAPIHelpers
+  def eve_api(options = {})
+    @eve_api ||= {}
+    @eve_api[ActiveSupport::Cache.expand_cache_key(options)] ||= ::Eve::API.new(options)
+  end
+  alias api eve_api
+
+  def mock_response_body(base, service = nil)
+    if service.nil?
+      fi = File.expand_path File.join("spec/support", base)
+    else
+      namespace = base
+      service = service.to_s.underscore
+      fi = File.expand_path File.join("spec/support/xml", namespace.to_s, "#{service}.xml")
+    end
+    raise "Cannot find mock request for (#{base}, #{service}) - expected it in #{fi}" unless File.file?(fi)
+    return File.read(fi)
+  end
+
+  def mock_http_response(base, service = nil)
+    mock = mock('Net::HTTPOK', :body => mock_response_body(base, service))
+  end
+
+  def mock_service(base, options = {}, more_options = {})
+    options = { :service => options } unless options.kind_of?(Hash)
+    options.merge! more_options
+    if $mock_services
+      Net::HTTP.should_receive(:post_form).any_number_of_times.and_return(mock_http_response(base,
+                                                                                             options[:service]))
+    end
+    if options[:service] && eve_api(options).respond_to?(base)
+      eve_api(options).send(base).send(options[:service], *(options[:args] || []))
+    else
+      eve_api(options)
+    end
+  end
+end
+
+Spec::Runner.configure do |config|
+  config.include(MockAPIHelpers)
+end

data/spec/support/xml/account/characters.xml

@@ -0,0 +1,15 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="1">
+  <currentTime>2007-12-12 11:48:50</currentTime>
+  <result>
+    <rowset name="characters" key="characterID" columns="name,characterID,corporationName,corporationID">
+      <row name="Mary" characterID="150267069"
+           corporationName="Starbase Anchoring Corp" corporationID="150279367" />
+      <row name="Marcus" characterID="150302299"
+           corporationName="Marcus Corp" corporationID="150333466" />
+      <row name="Dieinafire" characterID="150340823"
+           corporationName="Center for Advanced Studies" corporationID="1000169" />
+    </rowset>
+  </result>
+  <cachedUntil>2007-12-12 12:48:50</cachedUntil>
+</eveapi>

data/spec/support/xml/character/account_balance.xml

@@ -0,0 +1,10 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2007-12-16 11:55:31</currentTime>
+  <result>
+    <rowset name="accounts" key="accountID" columns="accountID,accountKey,balance">
+      <row accountID="4807144" accountKey="1000" balance="209127823.31" />
+    </rowset>
+  </result>
+  <cachedUntil>2007-12-16 12:10:31</cachedUntil>
+</eveapi>

data/spec/support/xml/character/asset_list.xml

@@ -0,0 +1,50 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="1">
+  <currentTime>2007-12-01 17:55:07</currentTime>
+  <result>
+    <rowset name="assets" key="itemID" columns="itemID,locationID,typeID,quantity,flag,singleton">
+      <row itemID="150354641" locationID="30000380" typeID="11019" quantity="1" flag="0" singleton="1">
+        <rowset name="contents" key="itemID" columns="itemID,typeID,quantity,flag,singleton">
+          <row itemID="150354709" typeID="16275" quantity="200000" flag="5" singleton="0" />
+          <row itemID="150354710" typeID="16272" quantity="150000" flag="5" singleton="0" />
+          <row itemID="150354711" typeID="16273" quantity="150000" flag="5" singleton="0" />
+          <row itemID="150354712" typeID="24597" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354713" typeID="24596" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354714" typeID="24595" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354715" typeID="24594" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354716" typeID="24593" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354717" typeID="24592" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354718" typeID="16274" quantity="450000" flag="5" singleton="0" />
+          <row itemID="150354719" typeID="9848" quantity="1000" flag="5" singleton="0" />
+          <row itemID="150354720" typeID="9832" quantity="8000" flag="5" singleton="0" />
+          <row itemID="150354721" typeID="3689" quantity="5000" flag="5" singleton="0" />
+          <row itemID="150354722" typeID="3683" quantity="25000" flag="5" singleton="0" />
+          <row itemID="150354723" typeID="44" quantity="4000" flag="5" singleton="0" />
+        </rowset>
+      </row>
+      <row itemID="150354706" locationID="30001984" typeID="11019" quantity="1" flag="0" singleton="1">
+        <rowset name="contents" key="itemID" columns="itemID,typeID,quantity,flag,singleton">
+          <row itemID="150354741" typeID="24593" quantity="400" flag="5" singleton="0" />
+          <row itemID="150354742" typeID="24592" quantity="400" flag="5" singleton="0" />
+          <row itemID="150354755" typeID="16275" quantity="199000" flag="5" singleton="0" />
+          <row itemID="150354837" typeID="24597" quantity="400" flag="5" singleton="0" />
+          <row itemID="150354838" typeID="24596" quantity="400" flag="5" singleton="0" />
+          <row itemID="150354839" typeID="24595" quantity="400" flag="5" singleton="0" />
+          <row itemID="150354840" typeID="24594" quantity="400" flag="5" singleton="0" />
+          <row itemID="150356329" typeID="14343" quantity="1" flag="5" singleton="0" />
+        </rowset>
+      </row>
+      <row itemID="150212056" locationID="60001078" typeID="25851" quantity="10" flag="4" singleton="0" />
+      <row itemID="150212057" locationID="60001078" typeID="20424" quantity="20" flag="4" singleton="0" />
+      <row itemID="150212058" locationID="60001078" typeID="20421" quantity="20" flag="4" singleton="0" />
+      <row itemID="150357641" locationID="30001984" typeID="23" quantity="1" flag="0" singleton="1">
+        <rowset name="contents" key="itemID" columns="itemID,typeID,quantity,flag,singleton">
+          <row itemID="150357740" typeID="16275" quantity="9166" flag="0" singleton="0" />
+        </rowset>
+      </row>
+      <row itemID="150212062" locationID="60001078" typeID="944" quantity="1" flag="4" singleton="1" />
+      <row itemID="150212063" locationID="60001078" typeID="597" quantity="1" flag="4" singleton="0" />
+    </rowset>
+  </result>
+  <cachedUntil>2007-12-02 16:55:07</cachedUntil>
+</eveapi>

data/spec/support/xml/character/character_sheet.xml

@@ -0,0 +1,65 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2009-08-26 12:00:09</currentTime>
+  <result>
+    <characterID>150337897</characterID>
+    <name>corpslave</name>
+    <race>Minmatar</race>
+    <bloodLine>Brutor</bloodLine>
+    <gender>Female</gender>
+    <corporationName>corpexport Corp</corporationName>
+    <corporationID>150337746</corporationID>
+    <cloneName>Clone Grade Pi</cloneName>
+    <cloneSkillPoints>54600000</cloneSkillPoints>
+    <balance>190210393.87</balance>
+    <attributeEnhancers>
+      <intelligenceBonus>
+        <augmentatorName>Snake Delta</augmentatorName>
+        <augmentatorValue>3</augmentatorValue>
+      </intelligenceBonus>
+      <memoryBonus>
+        <augmentatorName>Memory Augmentation - Basic</augmentatorName>
+        <augmentatorValue>3</augmentatorValue>
+      </memoryBonus>
+    </attributeEnhancers>
+    <attributes>
+      <intelligence>6</intelligence>
+      <memory>4</memory>
+      <charisma>7</charisma>
+      <perception>12</perception>
+      <willpower>10</willpower>
+    </attributes>
+    <rowset name="skills" key="typeID" columns="typeID,skillpoints,level,unpublished">
+      <row typeID="3431" skillpoints="8000" level="3"/>
+      <row typeID="3413" skillpoints="8000" level="3"/>
+      <row typeID="21059" skillpoints="500" level="1"/>
+      <row typeID="3416" skillpoints="8000" level="3"/>
+      <row typeID="3445" skillpoints="277578" unpublished="1"/>
+    </rowset>
+    <rowset name="certificates" key="certificateID" columns="certificateID">
+      <row certificateID="1"/>
+      <row certificateID="5"/>
+      <row certificateID="19"/>
+      <row certificateID="239"/>
+      <row certificateID="282"/>
+      <row certificateID="32"/>
+      <row certificateID="258"/>
+    </rowset>
+    <rowset name="corporationRoles" key="roleID" columns="roleID,roleName">
+      <row roleID="1" roleName="roleDirector" />
+    </rowset>
+    <rowset name="corporationRolesAtHQ" key="roleID" columns="roleID,roleName">
+      <row roleID="1" roleName="roleDirector" />
+    </rowset>
+    <rowset name="corporationRolesAtBase" key="roleID" columns="roleID,roleName">
+      <row roleID="1" roleName="roleDirector" />
+    </rowset>
+    <rowset name="corporationRolesAtOther" key="roleID" columns="roleID,roleName">
+      <row roleID="1" roleName="roleDirector" />
+    </rowset>
+    <rowset name="corporationTitles" key="titleID" columns="titleID,titleName">
+      <row titleID="1" titleName="Member" />
+    </rowset>
+  </result>
+  <cachedUntil>2009-08-26 13:00:09</cachedUntil>
+</eveapi>

data/spec/support/xml/character/fac_war_stats.xml

@@ -0,0 +1,20 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<eveapi version="2">
+  <currentTime>2008-07-10 13:12:49</currentTime>
+  <result>
+    <factionID>500001</factionID>
+    <factionName>Caldari State</factionName>
+    <enlisted>2008-06-10 22:10:00</enlisted>
+    <currentRank>4</currentRank>
+
+    <highestRank>4</highestRank>
+    <killsYesterday>0</killsYesterday>
+    <killsLastWeek>0</killsLastWeek>
+    <killsTotal>0</killsTotal>
+    <victoryPointsYesterday>0</victoryPointsYesterday>
+    <victoryPointsLastWeek>1044</victoryPointsLastWeek>
+
+    <victoryPointsTotal>0</victoryPointsTotal>
+  </result>
+  <cachedUntil>2008-07-10 14:12:49</cachedUntil>
+</eveapi>