Project

esi-ruby

0.0
Bugfix fork ofesi_client
No commit activity in last 3 years
No release in over 3 years
esi-rubytarisatram/esi-rubyHomepageDocumentationSource CodeBug TrackerWiki
An OpenAPI for EVE Online
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,468
Stars
1
Forks
0
Watchers
2
 Releases
Current version
1.0.0
Total releases
1
First release
2017-07-18
Latest release
2017-07-18
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2017-07-16
Reverse Dependencies
0

 Dependencies

Development

autotest
>= 4.4.6, ~> 4.4
autotest-fsevent
>= 0.2.11, ~> 0.2
autotest-growl
>= 0.2.16, ~> 0.2
autotest-rails-pure
>= 4.1.2, ~> 4.1
rspec
>= 3.4.0, ~> 3.4
vcr
>= 3.0.1, ~> 3.0
webmock
>= 1.24.3, ~> 1.24

Runtime

json
>= 1.8.3, ~> 1.8
typhoeus
>= 1.0.1, ~> 1.0
 Project Readme

esi-ruby

EsiClient - the Ruby gem for the EVE Swagger Interface

An OpenAPI for EVE Online

This SDK is automatically generated by the Swagger Codegen project:

  • API version: 0.5.3
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build esi-ruby.gemspec

Then either install the gem locally:

gem install ./esi-ruby-1.0.0.gem

(for development, run gem install --dev ./esi-ruby-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'esi-ruby', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/tarisatram/esi-ruby, then add the following in the Gemfile:

gem 'esi-ruby', :git => 'https://github.com/tarisatram/esi-ruby.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'esi-ruby'

api_instance = EsiClient::AllianceApi.new

opts = { 
  datasource: "tranquility", # String | The server name you would like data from
  user_agent: "user_agent_example", # String | Client identifier, takes precedence over headers
  x_user_agent: "x_user_agent_example" # String | Client identifier, takes precedence over User-Agent
}

begin
  #List all alliances
  result = api_instance.get_alliances(opts)
  p result
rescue EsiClient::ApiError => e
  puts "Exception when calling AllianceApi->get_alliances: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://esi.tech.ccp.is/latest

Class Method HTTP request Description
EsiClient::AllianceApi get_alliances GET /alliances/ List all alliances
EsiClient::AllianceApi get_alliances_alliance_id GET /alliances/{alliance_id}/ Get alliance information
EsiClient::AllianceApi get_alliances_alliance_id_corporations GET /alliances/{alliance_id}/corporations/ List alliance's corporations
EsiClient::AllianceApi get_alliances_alliance_id_icons GET /alliances/{alliance_id}/icons/ Get alliance icon
EsiClient::AllianceApi get_alliances_names GET /alliances/names/ Get alliance names
EsiClient::AssetsApi get_characters_character_id_assets GET /characters/{character_id}/assets/ Get character assets
EsiClient::BookmarksApi get_characters_character_id_bookmarks GET /characters/{character_id}/bookmarks/ List bookmarks
EsiClient::BookmarksApi get_characters_character_id_bookmarks_folders GET /characters/{character_id}/bookmarks/folders/ List bookmark folders
EsiClient::CalendarApi get_characters_character_id_calendar GET /characters/{character_id}/calendar/ List calendar event summaries
EsiClient::CalendarApi get_characters_character_id_calendar_event_id GET /characters/{character_id}/calendar/{event_id}/ Get an event
EsiClient::CalendarApi put_characters_character_id_calendar_event_id PUT /characters/{character_id}/calendar/{event_id}/ Respond to an event
EsiClient::CharacterApi get_characters_character_id GET /characters/{character_id}/ Get character's public information
EsiClient::CharacterApi get_characters_character_id_agents_research GET /characters/{character_id}/agents_research/ Get agents research
EsiClient::CharacterApi get_characters_character_id_blueprints GET /characters/{character_id}/blueprints/ Get blueprints
EsiClient::CharacterApi get_characters_character_id_chat_channels GET /characters/{character_id}/chat_channels/ Get chat channels
EsiClient::CharacterApi get_characters_character_id_corporationhistory GET /characters/{character_id}/corporationhistory/ Get corporation history
EsiClient::CharacterApi get_characters_character_id_medals GET /characters/{character_id}/medals/ Get medals
EsiClient::CharacterApi get_characters_character_id_portrait GET /characters/{character_id}/portrait/ Get character portraits
EsiClient::CharacterApi get_characters_character_id_roles GET /characters/{character_id}/roles/ Get character corporation roles
EsiClient::CharacterApi get_characters_character_id_standings GET /characters/{character_id}/standings/ Get standings
EsiClient::CharacterApi get_characters_names GET /characters/names/ Get character names
EsiClient::CharacterApi post_characters_affiliation POST /characters/affiliation/ Character affiliation
EsiClient::CharacterApi post_characters_character_id_cspa POST /characters/{character_id}/cspa/ Calculate a CSPA charge cost
EsiClient::ClonesApi get_characters_character_id_clones GET /characters/{character_id}/clones/ Get clones
EsiClient::ContactsApi delete_characters_character_id_contacts DELETE /characters/{character_id}/contacts/ Delete contacts
EsiClient::ContactsApi get_characters_character_id_contacts GET /characters/{character_id}/contacts/ Get contacts
EsiClient::ContactsApi get_characters_character_id_contacts_labels GET /characters/{character_id}/contacts/labels/ Get contact labels
EsiClient::ContactsApi post_characters_character_id_contacts POST /characters/{character_id}/contacts/ Add contacts
EsiClient::ContactsApi put_characters_character_id_contacts PUT /characters/{character_id}/contacts/ Edit contacts
EsiClient::ContractsApi get_characters_character_id_contracts GET /characters/{character_id}/contracts/ Get contracts
EsiClient::ContractsApi get_characters_character_id_contracts_contract_id_bids GET /characters/{character_id}/contracts/{contract_id}/bids/ Get contract bids
EsiClient::ContractsApi get_characters_character_id_contracts_contract_id_items GET /characters/{character_id}/contracts/{contract_id}/items/ Get contract items
EsiClient::CorporationApi get_corporations_corporation_id GET /corporations/{corporation_id}/ Get corporation information
EsiClient::CorporationApi get_corporations_corporation_id_alliancehistory GET /corporations/{corporation_id}/alliancehistory/ Get alliance history
EsiClient::CorporationApi get_corporations_corporation_id_icons GET /corporations/{corporation_id}/icons/ Get corporation icon
EsiClient::CorporationApi get_corporations_corporation_id_members GET /corporations/{corporation_id}/members/ Get corporation members
EsiClient::CorporationApi get_corporations_corporation_id_roles GET /corporations/{corporation_id}/roles/ Get corporation member roles
EsiClient::CorporationApi get_corporations_corporation_id_structures GET /corporations/{corporation_id}/structures/ Get corporation structures
EsiClient::CorporationApi get_corporations_names GET /corporations/names/ Get corporation names
EsiClient::CorporationApi get_corporations_npccorps GET /corporations/npccorps/ Get npc corporations
EsiClient::CorporationApi put_corporations_corporation_id_structures_structure_id PUT /corporations/{corporation_id}/structures/{structure_id}/ Update structure vulnerability schedule
EsiClient::DogmaApi get_dogma_attributes GET /dogma/attributes/ Get attributes
EsiClient::DogmaApi get_dogma_attributes_attribute_id GET /dogma/attributes/{attribute_id}/ Get attribute information
EsiClient::DogmaApi get_dogma_effects GET /dogma/effects/ Get effects
EsiClient::DogmaApi get_dogma_effects_effect_id GET /dogma/effects/{effect_id}/ Get effect information
EsiClient::FittingsApi delete_characters_character_id_fittings_fitting_id DELETE /characters/{character_id}/fittings/{fitting_id}/ Delete fitting
EsiClient::FittingsApi get_characters_character_id_fittings GET /characters/{character_id}/fittings/ Get fittings
EsiClient::FittingsApi post_characters_character_id_fittings POST /characters/{character_id}/fittings/ Create fitting
EsiClient::FleetsApi delete_fleets_fleet_id_members_member_id DELETE /fleets/{fleet_id}/members/{member_id}/ Kick fleet member
EsiClient::FleetsApi delete_fleets_fleet_id_squads_squad_id DELETE /fleets/{fleet_id}/squads/{squad_id}/ Delete fleet squad
EsiClient::FleetsApi delete_fleets_fleet_id_wings_wing_id DELETE /fleets/{fleet_id}/wings/{wing_id}/ Delete fleet wing
EsiClient::FleetsApi get_fleets_fleet_id GET /fleets/{fleet_id}/ Get fleet information
EsiClient::FleetsApi get_fleets_fleet_id_members GET /fleets/{fleet_id}/members/ Get fleet members
EsiClient::FleetsApi get_fleets_fleet_id_wings GET /fleets/{fleet_id}/wings/ Get fleet wings
EsiClient::FleetsApi post_fleets_fleet_id_members POST /fleets/{fleet_id}/members/ Create fleet invitation
EsiClient::FleetsApi post_fleets_fleet_id_wings POST /fleets/{fleet_id}/wings/ Create fleet wing
EsiClient::FleetsApi post_fleets_fleet_id_wings_wing_id_squads POST /fleets/{fleet_id}/wings/{wing_id}/squads/ Create fleet squad
EsiClient::FleetsApi put_fleets_fleet_id PUT /fleets/{fleet_id}/ Update fleet
EsiClient::FleetsApi put_fleets_fleet_id_members_member_id PUT /fleets/{fleet_id}/members/{member_id}/ Move fleet member
EsiClient::FleetsApi put_fleets_fleet_id_squads_squad_id PUT /fleets/{fleet_id}/squads/{squad_id}/ Rename fleet squad
EsiClient::FleetsApi put_fleets_fleet_id_wings_wing_id PUT /fleets/{fleet_id}/wings/{wing_id}/ Rename fleet wing
EsiClient::IncursionsApi get_incursions GET /incursions/ List incursions
EsiClient::IndustryApi get_characters_character_id_industry_jobs GET /characters/{character_id}/industry/jobs/ List character industry jobs
EsiClient::IndustryApi get_industry_facilities GET /industry/facilities/ List industry facilities
EsiClient::IndustryApi get_industry_systems GET /industry/systems/ List solar system cost indices
EsiClient::InsuranceApi get_insurance_prices GET /insurance/prices/ List insurance levels
EsiClient::KillmailsApi get_characters_character_id_killmails_recent GET /characters/{character_id}/killmails/recent/ List kills and losses
EsiClient::KillmailsApi get_killmails_killmail_id_killmail_hash GET /killmails/{killmail_id}/{killmail_hash}/ Get a single killmail
EsiClient::LocationApi get_characters_character_id_location GET /characters/{character_id}/location/ Get character location
EsiClient::LocationApi get_characters_character_id_online GET /characters/{character_id}/online/ Get character online
EsiClient::LocationApi get_characters_character_id_ship GET /characters/{character_id}/ship/ Get current ship
EsiClient::LoyaltyApi get_characters_character_id_loyalty_points GET /characters/{character_id}/loyalty/points/ Get loyalty points
EsiClient::LoyaltyApi get_loyalty_stores_corporation_id_offers GET /loyalty/stores/{corporation_id}/offers/ List loyalty store offers
EsiClient::MailApi delete_characters_character_id_mail_labels_label_id DELETE /characters/{character_id}/mail/labels/{label_id}/ Delete a mail label
EsiClient::MailApi delete_characters_character_id_mail_mail_id DELETE /characters/{character_id}/mail/{mail_id}/ Delete a mail
EsiClient::MailApi get_characters_character_id_mail GET /characters/{character_id}/mail/ Return mail headers
EsiClient::MailApi get_characters_character_id_mail_labels GET /characters/{character_id}/mail/labels/ Get mail labels and unread counts
EsiClient::MailApi get_characters_character_id_mail_lists GET /characters/{character_id}/mail/lists/ Return mailing list subscriptions
EsiClient::MailApi get_characters_character_id_mail_mail_id GET /characters/{character_id}/mail/{mail_id}/ Return a mail
EsiClient::MailApi post_characters_character_id_mail POST /characters/{character_id}/mail/ Send a new mail
EsiClient::MailApi post_characters_character_id_mail_labels POST /characters/{character_id}/mail/labels/ Create a mail label
EsiClient::MailApi put_characters_character_id_mail_mail_id PUT /characters/{character_id}/mail/{mail_id}/ Update metadata about a mail
EsiClient::MarketApi get_characters_character_id_orders GET /characters/{character_id}/orders/ List orders from a character
EsiClient::MarketApi get_markets_groups GET /markets/groups/ Get item groups
EsiClient::MarketApi get_markets_groups_market_group_id GET /markets/groups/{market_group_id}/ Get item group information
EsiClient::MarketApi get_markets_prices GET /markets/prices/ List market prices
EsiClient::MarketApi get_markets_region_id_history GET /markets/{region_id}/history/ List historical market statistics in a region
EsiClient::MarketApi get_markets_region_id_orders GET /markets/{region_id}/orders/ List orders in a region
EsiClient::MarketApi get_markets_structures_structure_id GET /markets/structures/{structure_id}/ List orders in a structure
EsiClient::OpportunitiesApi get_characters_character_id_opportunities GET /characters/{character_id}/opportunities/ Get a character's completed tasks
EsiClient::OpportunitiesApi get_opportunities_groups GET /opportunities/groups/ Get opportunities groups
EsiClient::OpportunitiesApi get_opportunities_groups_group_id GET /opportunities/groups/{group_id}/ Get opportunities group
EsiClient::OpportunitiesApi get_opportunities_tasks GET /opportunities/tasks/ Get opportunities tasks
EsiClient::OpportunitiesApi get_opportunities_tasks_task_id GET /opportunities/tasks/{task_id}/ Get opportunities task
EsiClient::PlanetaryInteractionApi get_characters_character_id_planets GET /characters/{character_id}/planets/ Get colonies
EsiClient::PlanetaryInteractionApi get_characters_character_id_planets_planet_id GET /characters/{character_id}/planets/{planet_id}/ Get colony layout
EsiClient::PlanetaryInteractionApi get_universe_schematics_schematic_id GET /universe/schematics/{schematic_id}/ Get schematic information
EsiClient::RoutesApi get_route_origin_destination GET /route/{origin}/{destination}/ Get route
EsiClient::SearchApi get_characters_character_id_search GET /characters/{character_id}/search/ Search on a string
EsiClient::SearchApi get_search GET /search/ Search on a string
EsiClient::SkillsApi get_characters_character_id_attributes GET /characters/{character_id}/attributes/ Get character attributes
EsiClient::SkillsApi get_characters_character_id_skillqueue GET /characters/{character_id}/skillqueue/ Get character's skill queue
EsiClient::SkillsApi get_characters_character_id_skills GET /characters/{character_id}/skills/ Get character skills
EsiClient::SovereigntyApi get_sovereignty_campaigns GET /sovereignty/campaigns/ List sovereignty campaigns
EsiClient::SovereigntyApi get_sovereignty_map GET /sovereignty/map/ List sovereignty of systems
EsiClient::SovereigntyApi get_sovereignty_structures GET /sovereignty/structures/ List sovereignty structures
EsiClient::StatusApi get_status GET /status/ Retrieve the uptime and player counts
EsiClient::UniverseApi get_universe_bloodlines GET /universe/bloodlines/ Get bloodlines
EsiClient::UniverseApi get_universe_categories GET /universe/categories/ Get item categories
EsiClient::UniverseApi get_universe_categories_category_id GET /universe/categories/{category_id}/ Get item category information
EsiClient::UniverseApi get_universe_constellations GET /universe/constellations/ Get constellations
EsiClient::UniverseApi get_universe_constellations_constellation_id GET /universe/constellations/{constellation_id}/ Get constellation information
EsiClient::UniverseApi get_universe_factions GET /universe/factions/ Get factions
EsiClient::UniverseApi get_universe_graphics GET /universe/graphics/ Get graphics
EsiClient::UniverseApi get_universe_graphics_graphic_id GET /universe/graphics/{graphic_id}/ Get graphic information
EsiClient::UniverseApi get_universe_groups GET /universe/groups/ Get item groups
EsiClient::UniverseApi get_universe_groups_group_id GET /universe/groups/{group_id}/ Get item group information
EsiClient::UniverseApi get_universe_moons_moon_id GET /universe/moons/{moon_id}/ Get moon information
EsiClient::UniverseApi get_universe_planets_planet_id GET /universe/planets/{planet_id}/ Get planet information
EsiClient::UniverseApi get_universe_races GET /universe/races/ Get character races
EsiClient::UniverseApi get_universe_regions GET /universe/regions/ Get regions
EsiClient::UniverseApi get_universe_regions_region_id GET /universe/regions/{region_id}/ Get region information
EsiClient::UniverseApi get_universe_stargates_stargate_id GET /universe/stargates/{stargate_id}/ Get stargate information
EsiClient::UniverseApi get_universe_stations_station_id GET /universe/stations/{station_id}/ Get station information
EsiClient::UniverseApi get_universe_structures GET /universe/structures/ List all public structures
EsiClient::UniverseApi get_universe_structures_structure_id GET /universe/structures/{structure_id}/ Get structure information
EsiClient::UniverseApi get_universe_system_jumps GET /universe/system_jumps/ Get system jumps
EsiClient::UniverseApi get_universe_system_kills GET /universe/system_kills/ Get system kills
EsiClient::UniverseApi get_universe_systems GET /universe/systems/ Get solar systems
EsiClient::UniverseApi get_universe_systems_system_id GET /universe/systems/{system_id}/ Get solar system information
EsiClient::UniverseApi get_universe_types GET /universe/types/ Get types
EsiClient::UniverseApi get_universe_types_type_id GET /universe/types/{type_id}/ Get type information
EsiClient::UniverseApi post_universe_names POST /universe/names/ Get names and categories for a set of ID's
EsiClient::UserInterfaceApi post_ui_autopilot_waypoint POST /ui/autopilot/waypoint/ Set Autopilot Waypoint
EsiClient::UserInterfaceApi post_ui_openwindow_contract POST /ui/openwindow/contract/ Open Contract Window
EsiClient::UserInterfaceApi post_ui_openwindow_information POST /ui/openwindow/information/ Open Information Window
EsiClient::UserInterfaceApi post_ui_openwindow_marketdetails POST /ui/openwindow/marketdetails/ Open Market Details
EsiClient::UserInterfaceApi post_ui_openwindow_newmail POST /ui/openwindow/newmail/ Open New Mail Window
EsiClient::WalletApi get_characters_character_id_wallet GET /characters/{character_id}/wallet/ Get a character's wallet balance
EsiClient::WalletApi get_characters_character_id_wallet_journal GET /characters/{character_id}/wallet/journal/ Get character wallet journal
EsiClient::WalletApi get_characters_character_id_wallet_transactions GET /characters/{character_id}/wallet/transactions/ Get wallet transactions
EsiClient::WalletApi get_characters_character_id_wallets GET /characters/{character_id}/wallets/ List wallets and balances
EsiClient::WalletApi get_characters_character_id_wallets_journal GET /characters/{character_id}/wallets/journal/ Get character wallet journal
EsiClient::WarsApi get_wars GET /wars/ List wars
EsiClient::WarsApi get_wars_war_id GET /wars/{war_id}/ Get war information
EsiClient::WarsApi get_wars_war_id_killmails GET /wars/{war_id}/killmails/ List kills for a war

Documentation for Models

Documentation for Authorization

evesso

  • Type: OAuth
  • Flow: implicit
  • Authorization URL: https://login.eveonline.com/oauth/authorize
  • Scopes:
    • esi-assets.read_assets.v1: EVE SSO scope esi-assets.read_assets.v1
    • esi-bookmarks.read_character_bookmarks.v1: EVE SSO scope esi-bookmarks.read_character_bookmarks.v1
    • esi-calendar.read_calendar_events.v1: EVE SSO scope esi-calendar.read_calendar_events.v1
    • esi-calendar.respond_calendar_events.v1: EVE SSO scope esi-calendar.respond_calendar_events.v1
    • esi-characters.read_agents_research.v1: EVE SSO scope esi-characters.read_agents_research.v1
    • esi-characters.read_blueprints.v1: EVE SSO scope esi-characters.read_blueprints.v1
    • esi-characters.read_chat_channels.v1: EVE SSO scope esi-characters.read_chat_channels.v1
    • esi-characters.read_contacts.v1: EVE SSO scope esi-characters.read_contacts.v1
    • esi-characters.read_corporation_roles.v1: EVE SSO scope esi-characters.read_corporation_roles.v1
    • esi-characters.read_loyalty.v1: EVE SSO scope esi-characters.read_loyalty.v1
    • esi-characters.read_medals.v1: EVE SSO scope esi-characters.read_medals.v1
    • esi-characters.read_opportunities.v1: EVE SSO scope esi-characters.read_opportunities.v1
    • esi-characters.read_standings.v1: EVE SSO scope esi-characters.read_standings.v1
    • esi-characters.write_contacts.v1: EVE SSO scope esi-characters.write_contacts.v1
    • esi-clones.read_clones.v1: EVE SSO scope esi-clones.read_clones.v1
    • esi-contracts.read_character_contracts.v1: EVE SSO scope esi-contracts.read_character_contracts.v1
    • esi-corporations.read_corporation_membership.v1: EVE SSO scope esi-corporations.read_corporation_membership.v1
    • esi-corporations.read_structures.v1: EVE SSO scope esi-corporations.read_structures.v1
    • esi-corporations.write_structures.v1: EVE SSO scope esi-corporations.write_structures.v1
    • esi-fittings.read_fittings.v1: EVE SSO scope esi-fittings.read_fittings.v1
    • esi-fittings.write_fittings.v1: EVE SSO scope esi-fittings.write_fittings.v1
    • esi-fleets.read_fleet.v1: EVE SSO scope esi-fleets.read_fleet.v1
    • esi-fleets.write_fleet.v1: EVE SSO scope esi-fleets.write_fleet.v1
    • esi-industry.read_character_jobs.v1: EVE SSO scope esi-industry.read_character_jobs.v1
    • esi-killmails.read_killmails.v1: EVE SSO scope esi-killmails.read_killmails.v1
    • esi-location.read_location.v1: EVE SSO scope esi-location.read_location.v1
    • esi-location.read_online.v1: EVE SSO scope esi-location.read_online.v1
    • esi-location.read_ship_type.v1: EVE SSO scope esi-location.read_ship_type.v1
    • esi-mail.organize_mail.v1: EVE SSO scope esi-mail.organize_mail.v1
    • esi-mail.read_mail.v1: EVE SSO scope esi-mail.read_mail.v1
    • esi-mail.send_mail.v1: EVE SSO scope esi-mail.send_mail.v1
    • esi-markets.read_character_orders.v1: EVE SSO scope esi-markets.read_character_orders.v1
    • esi-markets.structure_markets.v1: EVE SSO scope esi-markets.structure_markets.v1
    • esi-planets.manage_planets.v1: EVE SSO scope esi-planets.manage_planets.v1
    • esi-search.search_structures.v1: EVE SSO scope esi-search.search_structures.v1
    • esi-skills.read_skillqueue.v1: EVE SSO scope esi-skills.read_skillqueue.v1
    • esi-skills.read_skills.v1: EVE SSO scope esi-skills.read_skills.v1
    • esi-ui.open_window.v1: EVE SSO scope esi-ui.open_window.v1
    • esi-ui.write_waypoint.v1: EVE SSO scope esi-ui.write_waypoint.v1
    • esi-universe.read_structures.v1: EVE SSO scope esi-universe.read_structures.v1
    • esi-wallet.read_character_wallet.v1: EVE SSO scope esi-wallet.read_character_wallet.v1