ruby-esi 0.1.0

data/spec/api/user_interface_api_spec.rb

@@ -0,0 +1,117 @@
+=begin
+#EVE Swagger Interface
+
+#An OpenAPI for EVE Online
+
+OpenAPI spec version: 0.6.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ESI::UserInterfaceApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'UserInterfaceApi' do
+  before do
+    # run before each test
+    @instance = ESI::UserInterfaceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UserInterfaceApi' do
+    it 'should create an instance of UserInterfaceApi' do
+      expect(@instance).to be_instance_of(ESI::UserInterfaceApi)
+    end
+  end
+
+  # unit tests for post_ui_autopilot_waypoint
+  # Set Autopilot Waypoint
+  # Set a solar system as autopilot waypoint  --- 
+  # @param add_to_beginning Whether this solar system should be added to the beginning of all waypoints
+  # @param clear_other_waypoints Whether clean other waypoints beforing adding this one
+  # @param destination_id The destination to travel to, can be solar system, station or structure's id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [nil]
+  describe 'post_ui_autopilot_waypoint test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_ui_openwindow_contract
+  # Open Contract Window
+  # Open the contract window inside the client  --- 
+  # @param contract_id The contract to open
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [nil]
+  describe 'post_ui_openwindow_contract test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_ui_openwindow_information
+  # Open Information Window
+  # Open the information window for a character, corporation or alliance inside the client  --- 
+  # @param target_id The target to open
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [nil]
+  describe 'post_ui_openwindow_information test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_ui_openwindow_marketdetails
+  # Open Market Details
+  # Open the market details window for a specific typeID inside the client  --- 
+  # @param type_id The item type to open in market window
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [nil]
+  describe 'post_ui_openwindow_marketdetails test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for post_ui_openwindow_newmail
+  # Open New Mail Window
+  # Open the New Mail window, according to settings from the request if applicable  --- 
+  # @param new_mail The details of mail to create
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [nil]
+  describe 'post_ui_openwindow_newmail test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/wallet_api_spec.rb

@@ -0,0 +1,137 @@
+=begin
+#EVE Swagger Interface
+
+#An OpenAPI for EVE Online
+
+OpenAPI spec version: 0.6.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ESI::WalletApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'WalletApi' do
+  before do
+    # run before each test
+    @instance = ESI::WalletApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WalletApi' do
+    it 'should create an instance of WalletApi' do
+      expect(@instance).to be_instance_of(ESI::WalletApi)
+    end
+  end
+
+  # unit tests for get_characters_character_id_wallet
+  # Get a character's wallet balance
+  # Returns a character's wallet balance  ---  This route is cached for up to 120 seconds
+  # @param character_id An EVE character ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Float]
+  describe 'get_characters_character_id_wallet test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_characters_character_id_wallet_journal
+  # Get character wallet journal
+  # Retrieve character wallet journal  ---  This route is cached for up to 3600 seconds
+  # @param character_id An EVE character ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<GetCharactersCharacterIdWalletJournal200Ok>]
+  describe 'get_characters_character_id_wallet_journal test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_characters_character_id_wallet_transactions
+  # Get wallet transactions
+  # Get wallet transactions of a character  ---  This route is cached for up to 3600 seconds
+  # @param character_id An EVE character ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [Integer] :from_id Only show transactions happened before the one referenced by this id
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<GetCharactersCharacterIdWalletTransactions200Ok>]
+  describe 'get_characters_character_id_wallet_transactions test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_corporations_corporation_id_wallets
+  # Returns a corporation&#39;s wallet balance
+  # Get a corporation&#39;s wallets  ---  This route is cached for up to 300 seconds
+  # @param corporation_id An EVE corporation ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<GetCorporationsCorporationIdWallets200Ok>]
+  describe 'get_corporations_corporation_id_wallets test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_corporations_corporation_id_wallets_division_journal
+  # Get corporation wallet journal
+  # Retrieve corporation wallet journal  ---  This route is cached for up to 3600 seconds
+  # @param corporation_id An EVE corporation ID
+  # @param division Wallet key of the division to fetch journals from
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<GetCorporationsCorporationIdWalletsDivisionJournal200Ok>]
+  describe 'get_corporations_corporation_id_wallets_division_journal test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_corporations_corporation_id_wallets_division_transactions
+  # Get corporation wallet transactions
+  # Get wallet transactions of a corporation  ---  This route is cached for up to 3600 seconds
+  # @param corporation_id An EVE corporation ID
+  # @param division Wallet key of the division to fetch journals from
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [Integer] :from_id Only show journal entries happened before the transaction referenced by this id
+  # @option opts [String] :token Access token to use if unable to set a header
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<GetCorporationsCorporationIdWalletsDivisionTransactions200Ok>]
+  describe 'get_corporations_corporation_id_wallets_division_transactions test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api/wars_api_spec.rb

@@ -0,0 +1,81 @@
+=begin
+#EVE Swagger Interface
+
+#An OpenAPI for EVE Online
+
+OpenAPI spec version: 0.6.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ESI::WarsApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'WarsApi' do
+  before do
+    # run before each test
+    @instance = ESI::WarsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WarsApi' do
+    it 'should create an instance of WarsApi' do
+      expect(@instance).to be_instance_of(ESI::WarsApi)
+    end
+  end
+
+  # unit tests for get_wars
+  # List wars
+  # Return a list of wars  ---  This route is cached for up to 3600 seconds
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [Integer] :max_war_id Only return wars with ID smaller than this.
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<Integer>]
+  describe 'get_wars test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_wars_war_id
+  # Get war information
+  # Return details about a war  ---  This route is cached for up to 3600 seconds
+  # @param war_id ID for a war
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [GetWarsWarIdOk]
+  describe 'get_wars_war_id test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_wars_war_id_killmails
+  # List kills for a war
+  # Return a list of kills related to a war  ---  This route is cached for up to 3600 seconds
+  # @param war_id A valid war ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :datasource The server name you would like data from
+  # @option opts [Integer] :page Which page of results to return
+  # @option opts [String] :user_agent Client identifier, takes precedence over headers
+  # @option opts [String] :x_user_agent Client identifier, takes precedence over User-Agent
+  # @return [Array<GetWarsWarIdKillmails200Ok>]
+  describe 'get_wars_war_id_killmails test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#EVE Swagger Interface
+
+#An OpenAPI for EVE Online
+
+OpenAPI spec version: 0.6.2
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe ESI::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          ESI.configure { |c| c.host = 'http://example.com' }
+          expect(ESI::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          ESI.configure { |c| c.host = 'https://wookiee.com' }
+          expect(ESI::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          ESI.configure { |c| c.host = 'hobo.com/v4' }
+          expect(ESI::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          ESI.configure { |c| c.base_path = 'v4/dog' }
+          expect(ESI::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          ESI.configure { |c| c.base_path = '/v4/dog' }
+          expect(ESI::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          ESI.configure { |c| c.base_path = nil }
+          expect(ESI::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { ESI::Configuration.new }
+    let(:api_client) { ESI::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(ESI::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it "can be customized" do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { ESI::Configuration.new }
+    let(:api_client) { ESI::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(ESI::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it "can be customized" do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe "#deserialize" do
+    it "handles Array<Integer>" do
+      api_client = ESI::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it "handles Array<Array<Integer>>" do
+      api_client = ESI::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it "handles Hash<String, String>" do
+      api_client = ESI::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq({:message => 'Hello'})
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      # uncomment below to test object_to_hash for model
+      #api_client = ESI::ApiClient.new
+      #_model = ESI::ModelName.new
+      # update the model attribute below
+      #_model.id = 1 
+      # update the expected value (hash) below
+      #expected = {id: 1, name: '', tags: []}
+      #expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { ESI::ApiClient.new }
+
+    it "works for csv" do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it "works for ssv" do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it "works for tsv" do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it "works for pipes" do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it "works for multi" do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it "fails for invalid collection format" do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe "#json_mime?" do
+    let(:api_client) { ESI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe "#select_header_accept" do
+    let(:api_client) { ESI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe "#select_header_content_type" do
+    let(:api_client) { ESI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe "#sanitize_filename" do
+    let(:api_client) { ESI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end