greeve 0.0.1 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (171) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +139 -0
  3. data/doc/Greeve.html +5 -5
  4. data/doc/Greeve/API.html +15 -3
  5. data/doc/Greeve/API/CallList.html +466 -0
  6. data/doc/Greeve/Account.html +130 -0
  7. data/doc/Greeve/Account/APIKeyInfo.html +599 -0
  8. data/doc/Greeve/Account/AccountStatus.html +579 -0
  9. data/doc/Greeve/Account/Characters.html +389 -0
  10. data/doc/Greeve/Application.html +428 -0
  11. data/doc/Greeve/Attributable.html +123 -0
  12. data/doc/Greeve/BaseItem.html +240 -210
  13. data/doc/Greeve/Character.html +15 -3
  14. data/doc/Greeve/Character/AccountBalance.html +420 -0
  15. data/doc/Greeve/Character/AssetList.html +480 -0
  16. data/doc/Greeve/Character/Blueprints.html +535 -0
  17. data/doc/Greeve/Character/CalendarEventAttendees.html +461 -0
  18. data/doc/Greeve/Character/CharacterSheet.html +3407 -0
  19. data/doc/Greeve/Character/Clones.html +1700 -0
  20. data/doc/Greeve/Character/ContactList.html +1047 -0
  21. data/doc/Greeve/Character/ContactNotifications.html +446 -0
  22. data/doc/Greeve/Character/ContractBids.html +446 -0
  23. data/doc/Greeve/Character/ContractItems.html +483 -0
  24. data/doc/Greeve/Character/Contracts.html +720 -0
  25. data/doc/Greeve/Character/FacWarStats.html +1075 -0
  26. data/doc/Greeve/Character/IndustryJobs.html +732 -0
  27. data/doc/Greeve/Character/IndustryJobsHistory.html +732 -0
  28. data/doc/Greeve/Character/Locations.html +503 -0
  29. data/doc/Greeve/Character/MailBodies.html +435 -0
  30. data/doc/Greeve/Character/MailMessages.html +485 -0
  31. data/doc/Greeve/Character/MailingLists.html +407 -0
  32. data/doc/Greeve/Character/MarketOrders.html +626 -0
  33. data/doc/Greeve/Character/Medals.html +665 -0
  34. data/doc/Greeve/Character/Notifications.html +459 -0
  35. data/doc/Greeve/Character/PlanetaryColonies.html +524 -0
  36. data/doc/Greeve/Character/PlanetaryLinks.html +444 -0
  37. data/doc/Greeve/Character/PlanetaryPins.html +587 -0
  38. data/doc/Greeve/Character/PlanetaryRoutes.html +548 -0
  39. data/doc/Greeve/Character/Research.html +446 -0
  40. data/doc/Greeve/Character/SkillInTraining.html +865 -0
  41. data/doc/Greeve/Character/SkillQueue.html +472 -0
  42. data/doc/Greeve/Character/Skills.html +516 -0
  43. data/doc/Greeve/Character/Standings.html +650 -0
  44. data/doc/Greeve/Character/UpcomingCalendarEvents.html +511 -0
  45. data/doc/Greeve/Character/WalletJournal.html +658 -0
  46. data/doc/Greeve/Character/WalletTransactions.html +631 -0
  47. data/doc/Greeve/Config.html +315 -0
  48. data/doc/Greeve/Corporation.html +15 -3
  49. data/doc/Greeve/Corporation/AccountBalance.html +324 -0
  50. data/doc/Greeve/Corporation/Contracts.html +700 -0
  51. data/doc/Greeve/Corporation/CorporationSheet.html +1285 -0
  52. data/doc/Greeve/Corporation/IndustryJobs.html +636 -0
  53. data/doc/Greeve/Corporation/IndustryJobsHistory.html +636 -0
  54. data/doc/Greeve/Corporation/Locations.html +452 -0
  55. data/doc/Greeve/Corporation/MarketOrders.html +609 -0
  56. data/doc/Greeve/Corporation/MemberTracking.html +596 -0
  57. data/doc/Greeve/Corporation/Standings.html +554 -0
  58. data/doc/Greeve/Corporation/StarbaseDetail.html +619 -0
  59. data/doc/Greeve/Corporation/StarbaseList.html +389 -0
  60. data/doc/Greeve/Corporation/WalletJournal.html +631 -0
  61. data/doc/Greeve/Corporation/WalletTransactions.html +657 -0
  62. data/doc/Greeve/Eve.html +3 -3
  63. data/doc/Greeve/Eve/AllianceList.html +476 -0
  64. data/doc/Greeve/Eve/CharacterAffiliation.html +491 -0
  65. data/doc/Greeve/Eve/CharacterID.html +413 -0
  66. data/doc/Greeve/Eve/CharacterInfo.html +1705 -52
  67. data/doc/Greeve/Eve/CharacterName.html +414 -0
  68. data/doc/Greeve/Eve/ConquerableStationList.html +402 -0
  69. data/doc/Greeve/Eve/ErrorList.html +311 -0
  70. data/doc/Greeve/Eve/RefTypes.html +312 -0
  71. data/doc/Greeve/Eve/TypeName.html +413 -0
  72. data/doc/Greeve/Helpers.html +130 -0
  73. data/doc/Greeve/Helpers/AddAttribute.html +124 -0
  74. data/doc/Greeve/Helpers/AttributeToHash.html +245 -0
  75. data/doc/Greeve/Helpers/DefineAttributeMethod.html +124 -0
  76. data/doc/Greeve/Helpers/DefineDSLMethods.html +124 -0
  77. data/doc/Greeve/Map.html +15 -3
  78. data/doc/Greeve/Map/FacWarSystems.html +404 -0
  79. data/doc/Greeve/Map/Jumps.html +313 -0
  80. data/doc/Greeve/Map/Kills.html +339 -0
  81. data/doc/Greeve/Map/Sovereignty.html +351 -0
  82. data/doc/Greeve/Namespace.html +586 -0
  83. data/doc/Greeve/ResponseError.html +521 -0
  84. data/doc/Greeve/Row.html +40 -161
  85. data/doc/Greeve/Rowset.html +28 -22
  86. data/doc/Greeve/Server.html +15 -3
  87. data/doc/Greeve/Server/ServerStatus.html +349 -0
  88. data/doc/_index.html +600 -4
  89. data/doc/class_list.html +1 -1
  90. data/doc/file.CONTRIBUTING.html +1 -1
  91. data/doc/file.LICENSE.html +1 -1
  92. data/doc/file.README.html +140 -1
  93. data/doc/index.html +140 -1
  94. data/doc/method_list.html +2024 -32
  95. data/doc/top-level-namespace.html +1 -1
  96. data/lib/greeve.rb +75 -0
  97. data/lib/greeve/account/account_status.rb +22 -0
  98. data/lib/greeve/account/api_key_info.rb +27 -0
  99. data/lib/greeve/account/characters.rb +23 -0
  100. data/lib/greeve/api/call_list.rb +27 -0
  101. data/lib/greeve/base_item.rb +41 -57
  102. data/lib/greeve/character/account_balance.rb +24 -0
  103. data/lib/greeve/character/asset_list.rb +32 -0
  104. data/lib/greeve/character/blueprints.rb +35 -0
  105. data/lib/greeve/character/calendar_event_attendees.rb +33 -0
  106. data/lib/greeve/character/character_sheet.rb +110 -0
  107. data/lib/greeve/character/clones.rb +60 -0
  108. data/lib/greeve/character/contact_list.rb +58 -0
  109. data/lib/greeve/character/contact_notifications.rb +26 -0
  110. data/lib/greeve/character/contract_bids.rb +26 -0
  111. data/lib/greeve/character/contract_items.rb +32 -0
  112. data/lib/greeve/character/contracts.rb +49 -0
  113. data/lib/greeve/character/fac_war_stats.rb +30 -0
  114. data/lib/greeve/character/industry_jobs.rb +48 -0
  115. data/lib/greeve/character/industry_jobs_history.rb +48 -0
  116. data/lib/greeve/character/locations.rb +36 -0
  117. data/lib/greeve/character/mail_bodies.rb +33 -0
  118. data/lib/greeve/character/mail_messages.rb +29 -0
  119. data/lib/greeve/character/mailing_lists.rb +23 -0
  120. data/lib/greeve/character/market_orders.rb +42 -0
  121. data/lib/greeve/character/medals.rb +40 -0
  122. data/lib/greeve/character/notifications.rb +27 -0
  123. data/lib/greeve/character/planetary_colonies.rb +32 -0
  124. data/lib/greeve/character/planetary_links.rb +30 -0
  125. data/lib/greeve/character/planetary_pins.rb +41 -0
  126. data/lib/greeve/character/planetary_routes.rb +38 -0
  127. data/lib/greeve/character/research.rb +26 -0
  128. data/lib/greeve/character/skill_in_training.rb +27 -0
  129. data/lib/greeve/character/skill_queue.rb +28 -0
  130. data/lib/greeve/character/skills.rb +28 -0
  131. data/lib/greeve/character/standings.rb +36 -0
  132. data/lib/greeve/character/upcoming_calendar_events.rb +31 -0
  133. data/lib/greeve/character/wallet_journal.rb +49 -0
  134. data/lib/greeve/character/wallet_transactions.rb +47 -0
  135. data/lib/greeve/config.rb +16 -0
  136. data/lib/greeve/corporation/account_balance.rb +18 -0
  137. data/lib/greeve/corporation/contracts.rb +46 -0
  138. data/lib/greeve/corporation/corporation_sheet.rb +43 -0
  139. data/lib/greeve/corporation/industry_jobs.rb +42 -0
  140. data/lib/greeve/corporation/industry_jobs_history.rb +42 -0
  141. data/lib/greeve/corporation/locations.rb +31 -0
  142. data/lib/greeve/corporation/market_orders.rb +39 -0
  143. data/lib/greeve/corporation/member_tracking.rb +38 -0
  144. data/lib/greeve/corporation/standings.rb +30 -0
  145. data/lib/greeve/corporation/starbase_detail.rb +58 -0
  146. data/lib/greeve/corporation/starbase_list.rb +23 -0
  147. data/lib/greeve/corporation/wallet_journal.rb +48 -0
  148. data/lib/greeve/corporation/wallet_transactions.rb +50 -0
  149. data/lib/greeve/eve/alliance_list.rb +29 -0
  150. data/lib/greeve/eve/character_affiliation.rb +34 -0
  151. data/lib/greeve/eve/character_id.rb +28 -0
  152. data/lib/greeve/eve/character_info.rb +4 -1
  153. data/lib/greeve/eve/character_name.rb +29 -0
  154. data/lib/greeve/eve/conquerable_station_list.rb +24 -0
  155. data/lib/greeve/eve/error_list.rb +17 -0
  156. data/lib/greeve/eve/ref_types.rb +18 -0
  157. data/lib/greeve/eve/type_name.rb +28 -0
  158. data/lib/greeve/helpers/add_attribute.rb +25 -0
  159. data/lib/greeve/helpers/attribute_to_hash.rb +24 -0
  160. data/lib/greeve/helpers/define_dsl_methods.rb +70 -0
  161. data/lib/greeve/map/fac_war_systems.rb +26 -0
  162. data/lib/greeve/map/jumps.rb +19 -0
  163. data/lib/greeve/map/kills.rb +21 -0
  164. data/lib/greeve/map/sovereignty.rb +21 -0
  165. data/lib/greeve/namespace.rb +74 -0
  166. data/lib/greeve/response_error.rb +21 -0
  167. data/lib/greeve/row.rb +11 -33
  168. data/lib/greeve/rowset.rb +6 -15
  169. data/lib/greeve/server/server_status.rb +15 -0
  170. data/lib/greeve/version.rb +1 -1
  171. metadata +165 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: c74e50f7c6af078c20a7fea2db5db8aa32d1c3ae
4
- data.tar.gz: 6d323febc65e84b6417819d3e37691218778aed8
3
+ metadata.gz: c27ae3c2262179cb4ac6568784078347d4191f78
4
+ data.tar.gz: f724f81120277061c0543f1de5fd632912a10048
5
5
  SHA512:
6
- metadata.gz: 502e933def950237206eed50377ef452d5aeda9a2c1439d52ff8dcaaec40308455d6ef2d80a45199a3d49fe362ed6673cb6751083fe3ef37ffc9ba09bea5df11
7
- data.tar.gz: cbe5c2dfbed637ff6bcd8c6f1979aa09b31bf8356b62bd9425eb207047909e37565f77c9d38c723130da267c55e9d277e2d1514b412ed1a03e09772a65fb6965
6
+ metadata.gz: 626e909d56f3f8189ef19a228b3923fa58876bec0d43a11405e0cc4fdd23b050a5605905034054b3498789cc4bdbb56b9a45874d80398d894c8adde554385151
7
+ data.tar.gz: 630bd8b773a08aefcfb3922bcfe94b9f2ad7ea5ff345585f95f84ea8fdebb712b013d8482bab88fd7e3bc609f27520eb5d60e4cc3a1d24d23e67d768588de613
data/README.md CHANGED
@@ -1,3 +1,142 @@
1
1
  # Greeve
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/greeve.svg)](https://badge.fury.io/rb/greeve)
4
+ [![Build Status](https://travis-ci.org/EVEolve/greeve.svg?branch=master)](https://travis-ci.org/EVEolve/greeve)
5
+ [![Coverage Status](https://coveralls.io/repos/github/EVEolve/greeve/badge.svg?branch=master)](https://coveralls.io/github/EVEolve/greeve?branch=master)
6
+ [![API Documentation](https://img.shields.io/badge/docs-api-blue.svg)](http://www.rubydoc.info/gems/greeve)
7
+ [![MIT License](https://img.shields.io/badge/license-MIT-yellowgreen.svg)](https://github.com/EVEolve/greeve/blob/master/LICENSE)
8
+
3
9
  A Ruby wrapper for the [EVE Online XML API](https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/index.html).
10
+
11
+ ```ruby
12
+ c = Greeve::Eve::CharacterInfo.new(462421468, key: 1234567, vcode: "abcdefg")
13
+ p c.character_name # => "Zaphoon"
14
+ p c.ship_type_name # => "Manticore"
15
+ ```
16
+
17
+ ## Installation
18
+
19
+ ```text
20
+ gem install greeve
21
+ ```
22
+
23
+ Greeve delegates HTTP requests to [Typheous](https://github.com/typhoeus/typhoeus),
24
+ which requires [libcurl](https://curl.haxx.se/libcurl/) to be installed.
25
+
26
+ **Linux**
27
+
28
+ This gem should work with zero or minimal setup on a Linux server. libcurl is
29
+ typically either preinstalled or easily obtainable from the package manager.
30
+
31
+ **Windows**
32
+
33
+ * Download and unzip **Win64 - Generic:** [Win64 2000/XP x86_64 zip 7.46.0](https://curl.haxx.se/download.html)
34
+ * Add the **absolute path** of `curl-7.46.0-win64\dlls` to the [PATH environment variable](https://www.java.com/en/download/help/path.xml)
35
+
36
+ Note that the `7.46.0` release seems to be the latest one with the precompiled
37
+ DLL. `7.50.1` was packaged differently and must be compiled first, which is out
38
+ of the scope of this documentation. Refer to [libcurl](https://curl.haxx.se/libcurl/)
39
+ for additional information about installation on Windows.
40
+
41
+ ## Documentation
42
+
43
+ Greeve's namespacing and attributes attempt to follow the [EVE Online Developer
44
+ Documentation](https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/index.html)
45
+ as closely as possible. Ideally this means you can figure out the Greeve API
46
+ if you're familiar with the developer docs. Of course, the [Greeve API](http://www.rubydoc.info/gems/greeve)
47
+ is also documented.
48
+
49
+ ### Reading The Source Code
50
+
51
+ The source code for each EVE XML API endpoint was designed to be easy to read
52
+ and self-documenting. This project implements a [domain-specific language](https://en.wikipedia.org/wiki/Domain-specific_language)
53
+ (DSL) to help make this possible. The DSL provides methods like `attribute` and
54
+ `rowset` to describe the XML and map it to a Ruby object.
55
+
56
+ ```ruby
57
+ module Greeve
58
+ module Server
59
+ class ServerStatus < Greeve::BaseItem
60
+ endpoint "server/ServerStatus"
61
+
62
+ attribute :server_open, xpath: "eveapi/result/serverOpen/?[0]", type: :boolean
63
+ attribute :online_players, xpath: "eveapi/result/onlinePlayers/?[0]", type: :integer
64
+ end
65
+ end
66
+ end
67
+ ```
68
+
69
+ Compare this code to the [ServerStatus developer documentation](https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/server/serv_serverstatus.html)
70
+ and it should be easy to see how the data is mapped.
71
+
72
+ ### Generating Offline Documentation
73
+
74
+ Unfortunately [rubydoc.info](http://www.rubydoc.info/gems/greeve) doesn't
75
+ execute custom handlers, which Greeve uses to document the DSL helpers like
76
+ `attribute` and `rowset`. This can make it difficult to see which attributes a
77
+ resource implements without looking at the source code. A better way is to
78
+ generate the API documentation locally on your computer.
79
+
80
+ First, clone down a copy of the Greeve repository:
81
+
82
+ ```text
83
+ git clone https://github.com/EVEolve/greeve.git
84
+ cd greeve
85
+ ```
86
+
87
+ Make sure [bundler](http://bundler.io/) is installed, and install the
88
+ gems for the repo:
89
+
90
+ ```text
91
+ gem install bundler
92
+ bundle install
93
+ ```
94
+
95
+ Generate the documentation:
96
+
97
+ ```text
98
+ bundle exec rake doc
99
+ ```
100
+
101
+ The documentation is now located at `doc/index.html`
102
+
103
+ ## Usage
104
+
105
+ Since Greeve mirrors the EVE XML API namespace, the server status can be queried
106
+ by instantiating the [Server::ServerStatus](https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/server/serv_serverstatus.html)
107
+ resource.
108
+
109
+ ```ruby
110
+ require "greeve"
111
+
112
+ server = Greeve::Server::ServerStatus.new
113
+ p server.server_open # => true
114
+ p server.online_players # => 27421
115
+ ```
116
+
117
+ One difference between the EVE developer documentation is that Greeve follows
118
+ Ruby naming conventions and therefore uses snake case (`server_open`) for the
119
+ attribute names instead of the camel case (`serverOpen`) convention used in
120
+ the XML.
121
+
122
+ ### Using An API Key
123
+
124
+ When accessing a resource that requires an API key, pass the `key` and `vcode`
125
+ into the constructor's `opts`. These parameters can be passed to any resource.
126
+ An API key can be obtained from the [EVE API Key Management webpage](https://community.eveonline.com/support/api-key/).
127
+
128
+ ```ruby
129
+ c = Greeve::Eve::CharacterInfo.new(462421468, key: 1234567, vcode: "abcdefg")
130
+ p c.character_name # => "Zaphoon"
131
+ p c.ship_type_name # => "Manticore"
132
+ ```
133
+
134
+ ### Custom User-Agent
135
+
136
+ CCP recommends that applications that consume from the API [pass a custom
137
+ user-agent](https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/intro.html#user-agent).
138
+ Greeve allows you to easily do this.
139
+
140
+ ```ruby
141
+ Greeve::Config.user_agent = "My App/1.0.0 - http://www.my-app.com"
142
+ ```
@@ -81,7 +81,7 @@
81
81
  <dl>
82
82
  <dt>Defined in:</dt>
83
83
  <dd>lib/greeve.rb<span class="defines">,<br />
84
- lib/greeve/row.rb,<br /> lib/greeve/rowset.rb,<br /> lib/greeve/version.rb,<br /> lib/greeve/base_item.rb,<br /> lib/greeve/eve/character_info.rb</span>
84
+ lib/greeve/row.rb,<br /> lib/greeve/rowset.rb,<br /> lib/greeve/config.rb,<br /> lib/greeve/version.rb,<br /> lib/greeve/base_item.rb,<br /> lib/greeve/map/jumps.rb,<br /> lib/greeve/map/kills.rb,<br /> lib/greeve/namespace.rb,<br /> lib/greeve/eve/ref_types.rb,<br /> lib/greeve/eve/type_name.rb,<br /> lib/greeve/api/call_list.rb,<br /> lib/greeve/response_error.rb,<br /> lib/greeve/eve/error_list.rb,<br /> lib/greeve/map/sovereignty.rb,<br /> lib/greeve/eve/character_id.rb,<br /> lib/greeve/character/medals.rb,<br /> lib/greeve/character/skills.rb,<br /> lib/greeve/character/clones.rb,<br /> lib/greeve/eve/alliance_list.rb,<br /> lib/greeve/character/research.rb,<br /> lib/greeve/account/characters.rb,<br /> lib/greeve/eve/character_name.rb,<br /> lib/greeve/eve/character_info.rb,<br /> lib/greeve/character/standings.rb,<br /> lib/greeve/map/fac_war_systems.rb,<br /> lib/greeve/character/locations.rb,<br /> lib/greeve/character/contracts.rb,<br /> lib/greeve/character/asset_list.rb,<br /> lib/greeve/server/server_status.rb,<br /> lib/greeve/character/blueprints.rb,<br /> lib/greeve/account/api_key_info.rb,<br /> lib/greeve/corporation/locations.rb,<br /> lib/greeve/corporation/standings.rb,<br /> lib/greeve/character/mail_bodies.rb,<br /> lib/greeve/character/skill_queue.rb,<br /> lib/greeve/corporation/contracts.rb,<br /> lib/greeve/helpers/add_attribute.rb,<br /> lib/greeve/account/account_status.rb,<br /> lib/greeve/character/contact_list.rb,<br /> lib/greeve/character/mailing_lists.rb,<br /> lib/greeve/character/market_orders.rb,<br /> lib/greeve/character/mail_messages.rb,<br /> lib/greeve/character/contract_bids.rb,<br /> lib/greeve/character/fac_war_stats.rb,<br /> lib/greeve/character/notifications.rb,<br /> lib/greeve/character/industry_jobs.rb,<br /> lib/greeve/character/wallet_journal.rb,<br /> lib/greeve/character/planetary_pins.rb,<br /> lib/greeve/character/contract_items.rb,<br /> lib/greeve/character/character_sheet.rb,<br /> lib/greeve/eve/character_affiliation.rb,<br /> lib/greeve/character/planetary_links.rb,<br /> lib/greeve/corporation/industry_jobs.rb,<br /> lib/greeve/character/account_balance.rb,<br /> lib/greeve/corporation/market_orders.rb,<br /> lib/greeve/helpers/attribute_to_hash.rb,<br /> lib/greeve/corporation/starbase_list.rb,<br /> lib/greeve/corporation/wallet_journal.rb,<br /> lib/greeve/helpers/define_dsl_methods.rb,<br /> lib/greeve/character/planetary_routes.rb,<br /> lib/greeve/corporation/starbase_detail.rb,<br /> lib/greeve/corporation/member_tracking.rb,<br /> lib/greeve/character/skill_in_training.rb,<br /> lib/greeve/corporation/account_balance.rb,<br /> lib/greeve/character/planetary_colonies.rb,<br /> lib/greeve/eve/conquerable_station_list.rb,<br /> lib/greeve/corporation/corporation_sheet.rb,<br /> lib/greeve/character/wallet_transactions.rb,<br /> lib/greeve/character/contact_notifications.rb,<br /> lib/greeve/character/industry_jobs_history.rb,<br /> lib/greeve/corporation/wallet_transactions.rb,<br /> lib/greeve/corporation/industry_jobs_history.rb,<br /> lib/greeve/character/upcoming_calendar_events.rb,<br /> lib/greeve/character/calendar_event_attendees.rb</span>
85
85
  </dd>
86
86
  </dl>
87
87
 
@@ -102,11 +102,11 @@
102
102
  <p class="children">
103
103
 
104
104
 
105
- <strong class="modules">Modules:</strong> <span class='object_link'><a href="Greeve/API.html" title="Greeve::API (module)">API</a></span>, <span class='object_link'><a href="Greeve/Character.html" title="Greeve::Character (module)">Character</a></span>, <span class='object_link'><a href="Greeve/Corporation.html" title="Greeve::Corporation (module)">Corporation</a></span>, <span class='object_link'><a href="Greeve/Eve.html" title="Greeve::Eve (module)">Eve</a></span>, <span class='object_link'><a href="Greeve/Map.html" title="Greeve::Map (module)">Map</a></span>, <span class='object_link'><a href="Greeve/Server.html" title="Greeve::Server (module)">Server</a></span>
105
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Greeve/API.html" title="Greeve::API (module)">API</a></span>, <span class='object_link'><a href="Greeve/Account.html" title="Greeve::Account (module)">Account</a></span>, <span class='object_link'><a href="Greeve/Character.html" title="Greeve::Character (module)">Character</a></span>, <span class='object_link'><a href="Greeve/Corporation.html" title="Greeve::Corporation (module)">Corporation</a></span>, <span class='object_link'><a href="Greeve/Eve.html" title="Greeve::Eve (module)">Eve</a></span>, <span class='object_link'><a href="Greeve/Helpers.html" title="Greeve::Helpers (module)">Helpers</a></span>, <span class='object_link'><a href="Greeve/Map.html" title="Greeve::Map (module)">Map</a></span>, <span class='object_link'><a href="Greeve/Server.html" title="Greeve::Server (module)">Server</a></span>
106
106
 
107
107
 
108
108
 
109
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="Greeve/BaseItem.html" title="Greeve::BaseItem (class)">BaseItem</a></span>, <span class='object_link'><a href="Greeve/Row.html" title="Greeve::Row (class)">Row</a></span>, <span class='object_link'><a href="Greeve/Rowset.html" title="Greeve::Rowset (class)">Rowset</a></span>
109
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Greeve/BaseItem.html" title="Greeve::BaseItem (class)">BaseItem</a></span>, <span class='object_link'><a href="Greeve/Config.html" title="Greeve::Config (class)">Config</a></span>, <span class='object_link'><a href="Greeve/Namespace.html" title="Greeve::Namespace (class)">Namespace</a></span>, <span class='object_link'><a href="Greeve/ResponseError.html" title="Greeve::ResponseError (class)">ResponseError</a></span>, <span class='object_link'><a href="Greeve/Row.html" title="Greeve::Row (class)">Row</a></span>, <span class='object_link'><a href="Greeve/Rowset.html" title="Greeve::Rowset (class)">Rowset</a></span>
110
110
 
111
111
 
112
112
  </p>
@@ -144,7 +144,7 @@
144
144
 
145
145
  </div>
146
146
  </dt>
147
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.1</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
147
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.0.0</span><span class='tstring_end'>&quot;</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
148
148
 
149
149
  </dl>
150
150
 
@@ -159,7 +159,7 @@
159
159
  </div>
160
160
 
161
161
  <div id="footer">
162
- Generated on Wed Aug 24 18:52:46 2016 by
162
+ Generated on Mon Dec 26 15:56:22 2016 by
163
163
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
164
164
  0.9.5 (ruby-2.1.7).
165
165
  </div>
@@ -80,7 +80,9 @@
80
80
 
81
81
  <dl>
82
82
  <dt>Defined in:</dt>
83
- <dd>lib/greeve.rb</dd>
83
+ <dd>lib/greeve.rb<span class="defines">,<br />
84
+ lib/greeve/api/call_list.rb</span>
85
+ </dd>
84
86
  </dl>
85
87
 
86
88
  </div>
@@ -96,7 +98,17 @@
96
98
  <div class="tags">
97
99
 
98
100
 
99
- </div>
101
+ </div><h2>Defined Under Namespace</h2>
102
+ <p class="children">
103
+
104
+
105
+
106
+
107
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="API/CallList.html" title="Greeve::API::CallList (class)">CallList</a></span>
108
+
109
+
110
+ </p>
111
+
100
112
 
101
113
 
102
114
 
@@ -108,7 +120,7 @@
108
120
  </div>
109
121
 
110
122
  <div id="footer">
111
- Generated on Wed Aug 24 18:52:46 2016 by
123
+ Generated on Mon Dec 26 15:56:22 2016 by
112
124
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
113
125
  0.9.5 (ruby-2.1.7).
114
126
  </div>
@@ -0,0 +1,466 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Greeve::API::CallList
8
+
9
+ &mdash; Documentation by YARD 0.9.5
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ pathId = "Greeve::API::CallList";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Greeve.html" title="Greeve (module)">Greeve</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../API.html" title="Greeve::API (module)">API</a></span></span>
41
+ &raquo;
42
+ <span class="title">CallList</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <iframe id="search_frame" src="../../class_list.html"></iframe>
63
+
64
+ <div id="content"><h1>Class: Greeve::API::CallList
65
+
66
+
67
+
68
+ </h1>
69
+ <div class="box_info">
70
+
71
+ <dl>
72
+ <dt>Inherits:</dt>
73
+ <dd>
74
+ <span class="inheritName"><span class='object_link'><a href="../BaseItem.html" title="Greeve::BaseItem (class)">BaseItem</a></span></span>
75
+
76
+ <ul class="fullTree">
77
+ <li>Object</li>
78
+
79
+ <li class="next"><span class='object_link'><a href="../BaseItem.html" title="Greeve::BaseItem (class)">BaseItem</a></span></li>
80
+
81
+ <li class="next">Greeve::API::CallList</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+ </dl>
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+
98
+
99
+ <dl>
100
+ <dt>Defined in:</dt>
101
+ <dd>lib/greeve/api/call_list.rb</dd>
102
+ </dl>
103
+
104
+ </div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+
109
+ <div class="note notetag">
110
+ <strong>Note:</strong>
111
+ <div class='inline'>
112
+ <p>Endpoint: <a
113
+ href="https://api.eveonline.com/api/CallList.xml.aspx">api.eveonline.com/api/CallList.xml.aspx</a></p>
114
+ </div>
115
+ </div>
116
+
117
+
118
+ <p>List of all selectable API endpoints/groups to which an API grants access
119
+ to.</p>
120
+
121
+
122
+ </div>
123
+ </div>
124
+ <div class="tags">
125
+
126
+
127
+ <p class="tag_title">See Also:</p>
128
+ <ul class="see">
129
+
130
+ <li><a href="https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/api/api_calllist.html" target="_parent" title="https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/api/api_calllist.html">https://eveonline-third-party-documentation.readthedocs.io/en/latest/xmlapi/api/api_calllist.html</a></li>
131
+
132
+ </ul>
133
+
134
+ </div>
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <h2>
143
+ Attributes
144
+ <small><a href="#" class="summary_toggle">collapse</a></small>
145
+ </h2>
146
+
147
+ <ul class="summary">
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#call_groups-instance_method" title="#call_groups (instance method)">#<strong>call_groups</strong> &#x21d2; Greeve::Rowset </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'></div></span>
167
+
168
+ </li>
169
+
170
+
171
+ <li class="public ">
172
+ <span class="summary_signature">
173
+
174
+ <a href="#calls-instance_method" title="#calls (instance method)">#<strong>calls</strong> &#x21d2; Greeve::Rowset </a>
175
+
176
+
177
+
178
+ </span>
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+ <span class="summary_desc"><div class='inline'></div></span>
189
+
190
+ </li>
191
+
192
+
193
+ </ul>
194
+
195
+
196
+
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../BaseItem.html" title="Greeve::BaseItem (class)">BaseItem</a></span></h3>
206
+ <p class="inherited"><span class='object_link'><a href="../BaseItem.html#attribute-class_method" title="Greeve::BaseItem.attribute (method)">attribute</a></span>, <span class='object_link'><a href="../BaseItem.html#cache_expired%3F-instance_method" title="Greeve::BaseItem#cache_expired? (method)">#cache_expired?</a></span>, <span class='object_link'><a href="../BaseItem.html#cached_until-instance_method" title="Greeve::BaseItem#cached_until (method)">#cached_until</a></span>, <span class='object_link'><a href="../BaseItem.html#endpoint-class_method" title="Greeve::BaseItem.endpoint (method)">endpoint</a></span>, <span class='object_link'><a href="../BaseItem.html#initialize-instance_method" title="Greeve::BaseItem#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../BaseItem.html#inspect-instance_method" title="Greeve::BaseItem#inspect (method)">#inspect</a></span>, <span class='object_link'><a href="../BaseItem.html#namespace-class_method" title="Greeve::BaseItem.namespace (method)">namespace</a></span>, <span class='object_link'><a href="../BaseItem.html#refresh-instance_method" title="Greeve::BaseItem#refresh (method)">#refresh</a></span>, <span class='object_link'><a href="../BaseItem.html#rowset-class_method" title="Greeve::BaseItem.rowset (method)">rowset</a></span>, <span class='object_link'><a href="../BaseItem.html#to_s-instance_method" title="Greeve::BaseItem#to_s (method)">#to_s</a></span></p>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="../Helpers/AttributeToHash.html" title="Greeve::Helpers::AttributeToHash (module)">Helpers::AttributeToHash</a></span></h3>
229
+ <p class="inherited"><span class='object_link'><a href="../Helpers/AttributeToHash.html#to_h-instance_method" title="Greeve::Helpers::AttributeToHash#to_h (method)">#to_h</a></span></p>
230
+ <div id="constructor_details" class="method_details_list">
231
+ <h2>Constructor Details</h2>
232
+
233
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../BaseItem.html#initialize-instance_method" title="Greeve::BaseItem#initialize (method)">Greeve::BaseItem</a></span></p>
234
+
235
+ </div>
236
+
237
+
238
+ <div id="instance_method_details" class="method_details_list">
239
+ <h2>Instance Method Details</h2>
240
+
241
+
242
+ <div class="method_details first">
243
+ <h3 class="signature first" id="call_groups-instance_method">
244
+
245
+ #<strong>call_groups</strong> &#x21d2; <tt><span class='object_link'><a href="../Rowset.html" title="Greeve::Rowset (class)">Greeve::Rowset</a></span></tt>
246
+
247
+
248
+
249
+
250
+
251
+ </h3><div class="docstring">
252
+ <div class="discussion">
253
+
254
+
255
+ </div>
256
+ </div>
257
+ <div class="tags">
258
+ <p class="tag_title">Parameters:</p>
259
+ <ul class="param">
260
+
261
+ <li>
262
+
263
+ <span class='name'>group_id</span>
264
+
265
+
266
+ <span class='type'>(<tt>Integer</tt>)</span>
267
+
268
+
269
+
270
+ </li>
271
+
272
+ <li>
273
+
274
+ <span class='name'>name</span>
275
+
276
+
277
+ <span class='type'>(<tt>String</tt>)</span>
278
+
279
+
280
+
281
+ </li>
282
+
283
+ <li>
284
+
285
+ <span class='name'>description</span>
286
+
287
+
288
+ <span class='type'>(<tt>String</tt>)</span>
289
+
290
+
291
+
292
+ </li>
293
+
294
+ </ul>
295
+
296
+ <p class="tag_title">Returns:</p>
297
+ <ul class="return">
298
+
299
+ <li>
300
+
301
+
302
+ <span class='type'>(<tt><span class='object_link'><a href="../Rowset.html" title="Greeve::Rowset (class)">Greeve::Rowset</a></span></tt>)</span>
303
+
304
+
305
+
306
+ </li>
307
+
308
+ </ul>
309
+
310
+ </div><table class="source_code">
311
+ <tr>
312
+ <td>
313
+ <pre class="lines">
314
+
315
+
316
+ 12
317
+ 13
318
+ 14
319
+ 15
320
+ 16</pre>
321
+ </td>
322
+ <td>
323
+ <pre class="code"><span class="info file"># File 'lib/greeve/api/call_list.rb', line 12</span>
324
+
325
+ <span class='id identifier rubyid_rowset'>rowset</span> <span class='symbol'>:call_groups</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>eveapi/result/rowset[@name=&#39;callGroups&#39;]</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
326
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:group_id</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@groupID</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:integer</span>
327
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@name</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:string</span>
328
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:description</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:string</span>
329
+ <span class='kw'>end</span></pre>
330
+ </td>
331
+ </tr>
332
+ </table>
333
+ </div>
334
+
335
+ <div class="method_details ">
336
+ <h3 class="signature " id="calls-instance_method">
337
+
338
+ #<strong>calls</strong> &#x21d2; <tt><span class='object_link'><a href="../Rowset.html" title="Greeve::Rowset (class)">Greeve::Rowset</a></span></tt>
339
+
340
+
341
+
342
+
343
+
344
+ </h3><div class="docstring">
345
+ <div class="discussion">
346
+
347
+
348
+ </div>
349
+ </div>
350
+ <div class="tags">
351
+ <p class="tag_title">Parameters:</p>
352
+ <ul class="param">
353
+
354
+ <li>
355
+
356
+ <span class='name'>access_mask</span>
357
+
358
+
359
+ <span class='type'>(<tt>Integer</tt>)</span>
360
+
361
+
362
+
363
+ </li>
364
+
365
+ <li>
366
+
367
+ <span class='name'>type</span>
368
+
369
+
370
+ <span class='type'>(<tt>String</tt>)</span>
371
+
372
+
373
+
374
+ </li>
375
+
376
+ <li>
377
+
378
+ <span class='name'>name</span>
379
+
380
+
381
+ <span class='type'>(<tt>String</tt>)</span>
382
+
383
+
384
+
385
+ </li>
386
+
387
+ <li>
388
+
389
+ <span class='name'>group_id</span>
390
+
391
+
392
+ <span class='type'>(<tt>Integer</tt>)</span>
393
+
394
+
395
+
396
+ </li>
397
+
398
+ <li>
399
+
400
+ <span class='name'>description</span>
401
+
402
+
403
+ <span class='type'>(<tt>String</tt>)</span>
404
+
405
+
406
+
407
+ </li>
408
+
409
+ </ul>
410
+
411
+ <p class="tag_title">Returns:</p>
412
+ <ul class="return">
413
+
414
+ <li>
415
+
416
+
417
+ <span class='type'>(<tt><span class='object_link'><a href="../Rowset.html" title="Greeve::Rowset (class)">Greeve::Rowset</a></span></tt>)</span>
418
+
419
+
420
+
421
+ </li>
422
+
423
+ </ul>
424
+
425
+ </div><table class="source_code">
426
+ <tr>
427
+ <td>
428
+ <pre class="lines">
429
+
430
+
431
+ 18
432
+ 19
433
+ 20
434
+ 21
435
+ 22
436
+ 23
437
+ 24</pre>
438
+ </td>
439
+ <td>
440
+ <pre class="code"><span class="info file"># File 'lib/greeve/api/call_list.rb', line 18</span>
441
+
442
+ <span class='id identifier rubyid_rowset'>rowset</span> <span class='symbol'>:calls</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>eveapi/result/rowset[@name=&#39;calls&#39;]</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
443
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:access_mask</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@accessMask</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:integer</span>
444
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:type</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@type</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:string</span>
445
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@name</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:string</span>
446
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:group_id</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@groupID</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:integer</span>
447
+ <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:description</span><span class='comma'>,</span> <span class='label'>xpath:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>@description</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='symbol'>:string</span>
448
+ <span class='kw'>end</span></pre>
449
+ </td>
450
+ </tr>
451
+ </table>
452
+ </div>
453
+
454
+ </div>
455
+
456
+ </div>
457
+
458
+ <div id="footer">
459
+ Generated on Mon Dec 26 15:56:23 2016 by
460
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
461
+ 0.9.5 (ruby-2.1.7).
462
+ </div>
463
+
464
+ </div>
465
+ </body>
466
+ </html>