eoat 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb299a1e63f9fbfeb1d14973543051a7d29a9d78
+  data.tar.gz: 49356a6cdf04d1a1869978fa7ab6a2c1113d0efd
+SHA512:
+  metadata.gz: 08f5cc071c753a44048c7ddb7fae84b618fd9356c3c895b7b1e9edc6360bcd887e6cdff6e3ddcde878c778eb7aefd6173648d561385c55c4dc697374bdad5b95
+  data.tar.gz: f165d361a4e3dc3bf37cbc8fa331ece1a34334cbde8fcf7c92e5e3cd493560ab1d07d03c36f4f96f45a1e142e1eef19ec91f864d4f67a095607500e93316ea1f

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.yardoc/
+spec/fixtures/cache/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+notifications:
+  email: true

data/.yardopts

@@ -0,0 +1,8 @@
+--type-name-tag 'attribute:Attributes'
+--markup markdown
+--markup-provider redcarpet
+--charset utf-8
+--readme README.md
+-
+README.md
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eoat.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ivan Kotov
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,361 @@
+# EOAT
+
+**EVE Online API Toolbox** a single tool to access the API of a variety resources for the EVE Online.
+
+### Support of:
+
+  * [EVE API](https://wiki.eveonline.com/en/wiki/EVE_API_Functions)
+  * [ZKilloard API](https://zkillboard.com/information/api/)
+
+## Requirements
+
+* Ruby 2.0.0
+* httparty
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eoat'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eoat
+
+## Usage
+
+### Fast links
+
+  * [EVE API](#eve-api)
+    * [Requests without authorization](#requests-without-authorization)
+    * [Authorized requests](#authorized-requests)
+  * [ZKillboard API](#zkillboard-api)
+    * [Examples](#examples)
+  * [Response errors](#response-errors)
+  * [Caching](#caching)
+    * [File](#file)
+    * [Memcached](#memcached)
+    * [Redis](#redis)
+    * [Additional options](#additional-options)
+    * [Data checking](#data-checking)
+  * [Additional request parameters](#additional-request-parameters)
+
+### EVE API
+
+Use `EOAT::EveApi` class to retrieve data from the EVE API.
+
+#### Requests without authorization
+
+Example, get [skill tree](https://api.eveonline.com/eve/SkillTree.xml.aspx)
+
+```ruby
+require 'eoat'
+skill_tree = EOAT::EveApi.new.SkillTree
+skill_tree.result # EOAT::Result::EveType::Result class instance
+=> ["skillGroups"]
+skill_tree.skillGroups # EOAT::Result::EveType::RowSet class instance
+skill_tree.skillGroups.columns
+=> ["groupName", "groupID"]
+skill_tree.skillGroups.key
+=> "groupID"
+skill_tree.skillGroups.entries # Array class instance
+group = skill_tree.skillGroups.get 1241 # EOAT::Result::EveType::Row class instance or
+group = skill_tree.skillGroups.entries.first
+group.groupID
+=> "1241"
+group.groupName
+=> "Planet Management"
+group.skills # EOAT::Result::EveType::RowSet class instance
+group.skills.key
+=> "typeID"
+group.skills.columns
+=> ["typeName", "groupID", "typeID", "published"]
+group.skills.get(2403).typeName
+=> "Advanced Planetology"
+group.skills.entries.each { |skill| puts skill.typeName }
+Advanced Planetology
+Planetology
+Interplanetary Consolidation
+Command Center Upgrades
+```
+
+Example, get [server status](https://api.eveonline.com/server/ServerStatus.xml.aspx/)
+
+```ruby
+api = EOAT::EveApi.new(:scope => 'server')
+server_status = api.ServerStatus
+server_status.result
+=> ["serverOpen", "onlinePlayers"]
+server_status.serverOpen # String
+=> "True"
+server_status.onlinePlayers # String
+=> "6361"
+```
+
+Example, get [character info for characterID=208974814](https://api.eveonline.com/eve/CharacterInfo.xml.aspx?characterID=208974814)
+
+```ruby
+api = EOAT::EveApi.new
+char_info = api.CharacterInfo(characterID: 208974814)
+char_info.result
+=> ["characterID", "characterName", "race", "bloodline", "corporationID", "corporation", ...]
+char_info.characterName # String
+=> "Evor Endo"
+char_info.corporation # String
+=> "NeoCorteX Industry"
+char_info.employmentHistory # EOAT::Result::EveType::RowSet class instance
+char_info.employmentHistory.entries.last # EOAT::Result::EveType::Row class instance
+```
+
+Example, get [factional warfare top stats](https://api.eveonline.com/eve/FacWarTopStats.xml.aspx)
+
+```ruby
+fw_stats = EOAT::EveApi.new.FacWarTopStats
+fw_stats.result
+=> ["characters", "corporations", "factions"]
+fw_stats.characters # EOAT::Result::EveType::Row class instance
+fw_stats.characters.KillsYesterday # EOAT::Result::EveType::RowSet class instance
+fw_stats.characters.KillsYesterday.key
+=> "characterID"
+fw_stats.characters.KillsYesterday.columns
+=> ["characterID", "characterName", "kills"]
+fw_stats.characters.KillsYesterday.entries.first # EOAT::Result::EveType::Row class instance
+fw_stats.characters.KillsYesterday.entries.first.characterName
+=> "trigger99"
+```
+
+#### Authorized requests
+
+Example, get [API key info](https://wiki.eveonline.com/en/wiki/EVE_API_Account_APIKeyInfo)
+
+```ruby
+key_info = EOAT::EveApi.new(keyID, 'vCode', scope: 'account').APIKeyInfo
+key_info.result
+=> ["key"]
+key_info.key # EOAT::Result::EveType::Row class instance
+key_info.key.expires
+=> ""
+key_info.key.characters # EOAT::Result::EveType::RowSet class instance
+key_info.key.characters.key
+=> "characterID"
+key_info.key.characters.columns
+=> ["characterID", "characterName", "corporationID", "corporationName"]
+key_info.key.characters.get(208974814).characterName
+=> "Evor Endo"
+```
+
+Example, get [members tracking](https://wiki.eveonline.com/en/wiki/EVE_API_Corporation_Member_Tracking)
+
+```ruby
+api = EOAT::EveApi.new(keyID, 'vCode', :scope => 'corp')
+tracking = api.MemberTracking(extended: true)
+tracking.result
+=> ["members"]
+member = tracking.members.get(208974814)
+member.name
+=> "Evor Endo"
+```
+
+### ZKillboard API
+
+Use `EOAT::ZKApi` class to retrieve data from the EVE API.
+
+#### Examples
+
+Get latest solo kill ([url](http://zkillboard.com/api/solo/xml))
+
+```ruby
+require 'eoat'
+solo = EOAT::ZKApi.new.solo
+solo.result
+=> ["kills"]
+solo.kills.entries.size
+=> 200
+solo.kills.entries.first.killID
+=> "33070118"
+solo.kills.entries.first.victim.characterName
+=> "Glorfinda Elundario"
+```
+
+or only 10 records ([url](http://zkillboard.com/api/solo/limit/10/xml))
+
+```ruby
+solo = EOAT::ZKApi.new.solo(:limit => 10)
+solo.kills.entries.size
+=> 10
+```
+
+Get the last 50 kill of a alliance No Value with no items and api verified ([url](http://zkillboard.com/api/kills/no-items/api-only/alliance/99002003/limit/50/xml)).
+
+```ruby
+result = EOAT::ZKApi.new('no-items', 'api-only').kills(allianceID: 99002003, limit: 50)
+result.kills.entries.size
+=> 50
+```
+
+### Response errors
+
+All specific errors for gem are described in the module `EOAT::Exception`. Three of these will be described in detail.
+
+<dl>
+    <dt><b>HTTP404Error</b></dt>
+    <dd>The error occurs when the response comes back with code 404.</dd>
+    <dt><b>HTTPError</b></dt>
+    <dd>
+        The error occurs when the response comes back with a code other than 200 and 404.
+        To get the error code and response headers, use methods <code>status</code> and <code>headers</code>
+    </dd>
+    <dt><b>EveApiError</b></dt>
+    <dd>
+        The error occurs when EVE API returns the custom XML error.
+        To determine the number of error, use the method <code>number</code>
+        For a complete list of errors can be found
+        <a href="https://api.eveonline.com/eve/ErrorList.xml.aspx" target="_blank">here</a>.
+    </dd>
+</dl>
+
+Example `EOAT::Exception::HTTP404Error`
+
+```ruby
+EOAT::EveApi.new.foo
+EOAT::Exception::HTTP404Error: Request url path '/eve/foo.xml.aspx' not found
+```
+
+Example `EOAT::Exception::HTTPError`
+
+```ruby
+begin
+  EOAT::EveApi.new(123, 'bar', scope: 'account').APIKeyInfo
+rescue EOAT::Exception::HTTPError => e
+  puts e.status
+  puts e.headers
+  puts e.message
+end
+403
+{"content-type"=>["text/html"], "date"=>["Wed, 04 Sep 2013 17:10:05 GMT"], "connection"=>["close"], "content-length"=>["1233"]}
+Request host 'https://api.eveonline.com' return error: '403 - Forbidden'
+```
+
+Example `EOAT::Exception::EveApiError`
+
+```ruby
+begin
+  EOAT::EveApi.new(keyID, 'vCode', :scope => 'corp').KillLog
+rescue EOAT::Exception::EveApiError => e
+  puts e.number
+  puts e.message
+end
+120
+Expected beforeKillID [33012983] but supplied [0]. Please supply the expected killID!
+If you are not expecting this message it is possible that some other application is using this key!
+```
+
+### Caching
+
+To cache the result can be used three types of storage: file, memcached and redis.
+In the default configuration is used stub cache `EOAT::Cache::NoneCache` class.
+
+
+#### File
+
+The easiest way to cache the result. Since only used space on your hard disk.
+The default uses the path to store: `~/.eoat/cache`.
+
+Set store cache to files in the default path
+
+```ruby
+EOAT.cache = EOAT::Cache::FileCache.new
+```
+
+or set custom path
+
+```ruby
+EOAT.cache = EOAT::Cache::FileCache.new('new/path')
+```
+
+#### Memcached
+
+Memcached popular key-value database in memory. This is a good choice of places to store the cache.
+To use it, you must also install an additional dependence `gem memcache` and of course to have a running memcached.
+
+Set store cache in Memcached using standard connectivity options
+
+```ruby
+EOAT.cache = EOAT::Cache::MemcachedCache.new
+```
+
+or set custom address / port
+
+```ruby
+EOAT.cache = EOAT::Cache::MemcachedCache.new('address:port')
+```
+
+#### Redis
+
+Redis is a key-value journaling database in memory. Prevents you from losing data after a reboot.
+To use it, you must also install an additional dependence `gem redis` and running Redis daemon.
+
+Set store cache in Redis using standard connectivity options
+
+```ruby
+EOAT.cache = EOAT::Cache::RedisCache.new
+```
+
+or set custom address / port or socket
+
+```ruby
+EOAT.cache = EOAT::Cache::RedisCache.new(:host => 'address', :port => port)
+EOAT.cache = EOAT::Cache::RedisCache.new(:path => 'path/to/socket')
+```
+
+#### Additional options
+
+You can set the maximum cache lifetime in seconds. By default, the maximum TTL is set to 30 days.
+I do not recommend set it in a larger value than the default, if you use Memcached.
+
+```ruby
+EOAT.max_ttl = 259200 # 3 days
+```
+
+#### Data checking
+
+You can check the relevance of the result. For this purpose there is a boolean parameter `from_cache` in Result class
+
+Example
+
+```ruby
+require 'eoat'
+EOAT.cache = EOAT::Cache::MemcachedCache.new
+errors = EOAT::EveApi.new.ErrorList
+errors.from_cache
+=> false
+errors = EOAT::EveApi.new.ErrorList
+errors.from_cache
+=> true
+```
+
+### Additional request parameters
+
+You can also change or add request headers.
+It may happen that you will be denied to provide data if you do not specify them.
+
+```ruby
+EOAT.headers
+=> {"User-Agent"=>"EOAT/0.0.1 (Eve Online Api Toolbox;+https://github.com/elDante/eoat)", "Accept-Encoding"=>"gzip", "Accept-Charset"=>"utf-8"}
+EOAT.headers['User-Agent'] = 'Custom User-Agent'
+EOAT.headers['Host'] = 'example.com'
+EOAT.headers['From'] = 'user@example.com'
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec