eveapi 0.0.2.pre → 0.0.3.pre

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWNhNTExNGQyZjM0ODdkOGEwNGU5ZDg3N2Y5ZmEwMDk1NzZiNDg3OA==
+    Yzc3MDRlZTIwNjE5MWQ0YzcxN2YyMTE2MTA3NTcyNTY0NGJlNWFlNg==
   data.tar.gz: !binary |-
-    OTUxNjIyODRkOTliYTJmYTdjNmRmMTZiZmFlMjViM2QxYjQzMmY5OQ==
+    NmIyZjYwMjhiYjBkNzBlNGU4NjI2Njg2M2QwMWY0YmQ2Y2ZmODIyMA==
 SHA512:
   metadata.gz: !binary |-
-    MTY5NjAyNjZiZjU4NDJiMjBhYjMzMWMzZGJhNjdhMjMxNGI1ZTNjMDdiNWYy
-    OTNkYWMyMDZiODFiODU0ZTMwYjNmOGQwZGM3MzA0MmJjOTg0ZTYxZmU4Mjhj
-    Y2E2NzU2MzE4ZmVmMDJkODg5ZWQ4NWQxZjQxNWNlOWEwNDBkYTk=
+    Nzk1YmMyMjBhZmY2NGNiM2I5ZjRmM2RkMGQ4MjEwYTdiOWFlZjg5NjVmMzRj
+    MTI3NDkwY2VkMGJmYjlhNGJlN2U1N2QyMzRlY2E0YzY4NjE3MjNiZmE2NGMw
+    MDBkOGUyYTBiOWQ4MTAzMDk1OTkxZTM3YzgyYTdjNWFmYjUzZTA=
   data.tar.gz: !binary |-
-    ZWQxM2M3M2FkZGNhY2JmM2VhZmNjMzM4ZTBlYThkMzRjYzNjOGQ2OGUyNWFh
-    MTY1MDUyMWMxODYzNzI2Y2E3Y2YxN2E4MzU3NGEzNTM3MzJiN2M1Y2JhZWYz
-    MTZlNDQzMDZkZTY2YzkxYzNlNmY3MGY1OWQ1MWY4NDFkZDdjNDQ=
+    MGY3YWI0MDQ1N2MyMDZiYTE0Y2I3NWFhMmM5NDIwMGU3ZjcyMmUzYjYzYzE1
+    MzI5OThmYmI4NWVjMzNmZGVmODg0MDA1ZDk0NWEzZDU4MjkzMzM1OWJiZWZl
+    YzA4Yzg3Mjg0ZWJjZGFiODQ5MzE3YjkwODM3YjRmMmRiNTlhM2I=

data/README.md

@@ -1,24 +1,56 @@
-# eveapi
+![EVEApi for ruby](https://github.com/aladac/eveapi/raw/master/doc/eveapi.png)
 
-* [Homepage](https://rubygems.org/gems/eveapi)
-* [Documentation](http://rubydoc.info/gems/eveapi/frames)
-* [Email](mailto:adam at saiden.pl)
+*EVE API for ruby*
 
 [![Build Status](https://secure.travis-ci.org/aladac/eveapi.svg?branch=master)](https://travis-ci.org/aladac/eveapi)
 [![Code Climate](https://codeclimate.com/github/aladac/eveapi/badges/gpa.svg)](https://codeclimate.com/github/aladac/eveapi)
 [![Test Coverage](https://codeclimate.com/github/aladac/eveapi/badges/coverage.svg)](https://codeclimate.com/github/aladac/eveapi/coverage)
 
+## Disclaimer!
+This work in progress in a very early stage. Not documented. Only a couple of methods are tested.
+
+Most methods names can be listed by calling `EVEApi::Client#api_methods`
+```ruby
+pry(main)> EVEApi::Client.new.api_methods[0..5]
+=> [
+    [0] :char_chat_channels,
+    [1] :char_bookmarks,
+    [2] :char_locations,
+    [3] :char_contracts,
+    [4] :char_account_status,
+    [5] :char_character_info
+]
+```
+Most methods requiring arguments other than `character_id`, `key_id`, `vcode` and `row_count` probably will not function correctly.
+
+Because of the way the paths are being built from the method names - some methods may look funky eq. `server_server_status`.
+
+`account_characters`, `char_character_sheet`, `char_wallet_journal`, `server_server_status`, `account_api_key_info`, `api_call_list` should work.
+
 ## Description
 
-TODO: Description
+EVE Online API Client for ruby
 
 ## Features
 
+Uses [excon](https://github.com/excon/excon),  [crack](https://github.com/jnunemaker/crack), `method_missing` and a couple of rescue blocks to automate access to EVE Online API.
+- returns results as `Hash` or `Array`
+- raises exceptions with messages from the API itself
+- converts ruby methods like `account_api_info` to an EVE Online API request like `GET /account/APIKeyInfo.xml.aspx` along with query params.
+
 ## Examples
 
-    require 'eveapi'
+```ruby
+require 'eveapi'
+client = EVEApi::Client.new
+client.key_id = YOUR_API_KEY_ID
+client.vcode = YOUR_API_VCODE
+client.account_characters
+# [{"name"=>"CHARACTER_NAME1", "characterID"=>"CHARACTER_ID1", "corporationName"=>"CORPORATION_NAME1", "corporationID"=>"CORPORATION_ID1", "allianceID"=>"0", "allianceName"=>"", "factionID"=>"0", "factionName"=>""}, {"name"=>"CHARACTER_NAME2", "characterID"=>"CHARACTER_ID2", "corporationName"=>"CORPORATION_NAME2", "corporationID"=>"CORPORATION_ID2", "allianceID"=>"0", "allianceName"=>"", "factionID"=>"0", "factionName"=>""}]
+```
 
 ## Requirements
+`excon` and `crack` automatically installed as dependencies during `gem install`, or `bundle install` in development.
 
 ## Install
 
@@ -29,5 +61,3 @@ TODO: Description
 Copyright (c) 2015 Adam Ladachowski
 
 See LICENSE.txt for details.
-
-foobar

data/lib/eveapi.rb

@@ -11,8 +11,16 @@ class String
   def camelize
     self.split("_").each {|s| s.capitalize! }.join("")
   end
+
+  # Stolen from ActiveSupport::Inflector
   def underscore
-    self.scan(/[A-Z][a-z]*/).join("_").downcase
+    return self unless self =~ /[A-Z-]|::/
+    word = self.to_s.gsub(/::/, '/')
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
   end
 end
 

data/lib/eveapi/client.rb

@@ -24,7 +24,7 @@ module EVEApi
     end
 
     def api_methods
-      api_call_list[:methods].map { |m| m['type'][0..3].downcase + '_' + m['name'].underscore }
+      api_call_list[:calls].map { |m| ( m['type'][0..3].downcase + '_' + m['name'].underscore ).to_sym }
     end
 
     def method_missing(name, *args, &block)

data/lib/eveapi/request.rb

@@ -26,10 +26,11 @@ module EVEApi
       rescue NoMethodError
         data['eveapi']['result']
       rescue TypeError
-        {
-          groups: data['eveapi']['result']['rowset'].first['row'],
-          methods: data['eveapi']['result']['rowset'].last['row']
-        }
+        output = {}
+        data['eveapi']['result']['rowset'].each do |r|
+          output.merge!({ r['name'].underscore.to_sym => r['row'] })
+        end
+        output
       end
     end
   end

data/lib/eveapi/version.rb

@@ -1,4 +1,4 @@
 module EVEApi
   # eveapi version
-  VERSION = "0.0.2.pre"
+  VERSION = "0.0.3.pre"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eveapi
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre
+  version: 0.0.3.pre
 platform: ruby
 authors:
 - Adam Ladachowski
@@ -127,6 +127,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/eveapi.png
 - eveapi.gemspec
 - gemspec.yml
 - lib/eveapi.rb