eveapi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmY0MjNhN2NlZmU0NmRlMmJlYzlkNGFlOTY4NDZkOTA4NzU0MDk2NA==
+    YjcxM2EzYTRlNzY2ZTY4MmJkZDRiYWUyOTUxMjc5YTRhYmFkNWY5Ng==
   data.tar.gz: !binary |-
-    YWJmOWI0MDUyMzVkOGQyZDM1NjljNzE1N2Q4NTgyNTJmOTk0YTM5MQ==
+    NjZhMWI5ZjYwNjVlNzQzYjkwNDI4YTZiZDJmNjRmYmI0ZmU1NWVlNw==
 SHA512:
   metadata.gz: !binary |-
-    MjczYTQwYmE1OWI5NDY0OGE3ODYzMjhjMmUxMGU5MWM2MzJkODU4MjU0MGQ1
-    NDE2ZTdiYzVjZDBlYjZiNzRmODY3ZWRmOGYxM2U4MTQyZmI3Y2IxMzAxY2U4
-    MTU2ZmM5NGFkNmM2NzA1ZTNiM2E0ZGJjYzg5ZGQ0ZmJiMjAzMWI=
+    MDExYTlhZGE4MGJhYTExZGYyNzYyMDlmYjUzMTgzOWE5MWJlNWVlOTMxNGE2
+    YzhiODc2NTRjNDdhYjQxOWU5Y2ZlN2Q5YmMzNTIxZjkwYWM2YWE0NzEyZTZk
+    MjY4ZmIyODU1NzhiYmIxMTU5MWU5ZjgyZTVkYzIzYzViYTU1NmM=
   data.tar.gz: !binary |-
-    ODY5MzMyNDVlZjllNTA4NWE1ODdmYmE1OTM4ODQ2ZDNlN2YwYzFjYmNmMjA2
-    NTZhMDQxNGYzMzVkNDZmNDE3NzZlNDkyNmM0NGUzNmIyNmZmYzU3NWRmNjVj
-    MjI0YzMzMTA4NzE0NmFlYzMwYzFjOWE2NjExNWVmMDY1OGY4YTg=
+    YWM1NjVkNzBhODg2MDQ0ZWYwMWYxYzNkYTE4NzI4MjdkOWM4M2QyMzVmYmM2
+    M2JlYjNkOTljYjFiZDA1ZjI0ZmVjMWE3NDIyMjg5ZDNjMWQ0MzU4ZDNmN2Rm
+    M2M1MzJhNGE0NzI1OTM0N2Q4NjQzNDY4MWI0NjVkNDg0MWVhNDQ=

data/.document

@@ -1,5 +1 @@
 lib/**/*.rb
-README.md
-ChangeLog.md
-
-LICENSE.txt

data/.gitignore

@@ -1,6 +1,8 @@
+/.yardoc
 /.bundle
 /Gemfile.lock
 /html/
 /pkg/
 /vendor/cache/*.gem
 /coverage
+/doc/yard

data/.yardopts

@@ -0,0 +1 @@
+--output-dir ./doc/yard

data/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+1. Fork the repo <iframe src="https://ghbtns.com/github-btn.html?user=aladac&repo=eveapi&type=fork&count=true" frameborder="0" scrolling="0" width="170px" height="20px"></iframe>
+2. Create a feature branch with a reasonable name like `add_client_foobar_method`
+
+```
+$ git checkout -b add_client_foobar_method
+
+```
+
+3. Push your changes to your repo
+
+```
+$ git push
+Counting objects: 7, done.
+Delta compression using up to 4 threads.
+Compressing objects: 100% (2/2), done.
+Writing objects: 100% (3/3), 269 bytes | 0 bytes/s, done.
+Total 3 (delta 1), reused 0 (delta 0)
+To git@github.com:saidenpl/eveapi.git
+* [new branch]      add_client_foobar_method -> add_client_foobar_method
+```
+
+4. Make a pull request to this repos `master`
+  - Click on `Compare & pull request`
+
+    ![pull request 1](https://i.imgur.com/8YUuQ76.png)
+
+  - Make sure that `aladac/eveapi` and your feature branch are selectedd
+  - Write a comment
+  - Click `Create pull request`
+
+    ![pull request 2](https://i.imgur.com/WNvaMsm.png)

data/README.md

@@ -10,51 +10,57 @@
 [![Latest Version Downloads](https://img.shields.io/gem/dtv/eveapi.svg)](https://rubygems.org/gems/eveapi)
 
 
-## Disclaimer!
-*This work in progress in a very early stage. Not documented. Only a couple of methods are tested.*
-
-~~Most~~ working methods names can be listed by calling ~~`EVEApi::Client#api_methods`~~ `EVEApi::Client#working_methods`
-
-Because of the way the paths are being built from the method names - some methods may look funky eq. `server_server_status`.
-
-## Auto Methods
-These methods are procedurally handled.
-
-```ruby
-def method_missing(name, *_args, &_block)
-  fail 'Invalid Method Name' if check_path(name).empty?
-  check_path(name)
-  http = connection.get(path: check_path(name), query: params)
-  request = EVEApi::Request.new(http)
-  request.result
-end
-```
-
-The ones listed below are known to work, provided the instance variables listed in the *Requires* column are supplied.
-
-| Method Name   | Requires      |  Output Class             |
-| ------------- | ------------- | ------------- |
-| [account_api_key_info](https://github.com/aladac/eveapi/wiki/account_api_key_info) |  `key_id`, `vcode`  | `Hash` |
-| [account_account_status](https://github.com/aladac/eveapi/wiki/account_account_status) | `key_id`, `vcode` | `Hash` |
-| [account_characters](https://github.com/aladac/eveapi/wiki/account_characters) | `key_id`, `vcode` | `Array` |
-| [server_server_status](https://github.com/aladac/eveapi/wiki/server_server_status) | - | `Hash` |
-| [char_wallet_transactions](https://github.com/aladac/eveapi/wiki/char_wallet_transactions) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_wallet_journal](https://github.com/aladac/eveapi/wiki/char_wallet_journal) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_standings](https://github.com/aladac/eveapi/wiki/char_standings) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_skill_queue](https://github.com/aladac/eveapi/wiki/char_skill_queue) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_skill_in_training](https://github.com/aladac/eveapi/wiki/char_skill_in_training) | `key_id`, `vcode`, `character_id` | `Hash` |
-| [char_research](https://github.com/aladac/eveapi/wiki/char_research) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_notifications](https://github.com/aladac/eveapi/wiki/char_notifications) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_medals](https://github.com/aladac/eveapi/wiki/char_medals) |  `key_id`, `vcode`, `character_id` | `Hash` |
-| [char_market_orders](https://github.com/aladac/eveapi/wiki/char_market_orders)  | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_mail_messages](https://github.com/aladac/eveapi/wiki/char_mail_messages) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_mailing_lists](https://github.com/aladac/eveapi/wiki/char_mailing_lists) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_industry_jobs](https://github.com/aladac/eveapi/wiki/char_industry_jobs)  | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_contact_notifications](https://github.com/aladac/eveapi/wiki/char_contact_notifications)  | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_contact_list](https://github.com/aladac/eveapi/wiki/char_contact_list) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_character_sheet](https://github.com/aladac/eveapi/wiki/char_character_sheet) | `key_id`, `vcode`, `character_id` | `Hash` |
-| [char_asset_list](https://github.com/aladac/eveapi/wiki/char_asset_list) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_account_balance](https://github.com/aladac/eveapi/wiki/char_account_balance)  | `key_id`, `vcode`, `character_id` | `Array` |
+## General
+
+Working methods names can be listed by calling `EVEApi::Client#working_methods`.
+
+## Working methods
+
+Check out [rubydoc.info](http://www.rubydoc.info/github/aladac/eveapi) for the documentation.
+
+*Legacy methods are available [here](https://github.com/aladac/eveapi/wiki)*
+
+#### Client
+- `EVEApi::Client.new`
+- `EVEApi::Client#characters`
+- `EVEApi::Client#server_status`
+- `EVEApi::Client#call_list`
+- `EVEApi::Client#working_methods`
+- `EVEApi::Client#account_status`
+- `EVEApi::Client#key_info`
+
+#### Character
+
+- `EVEApi::Character#wallet_journal`
+- `EVEApi::Character#contracts`
+- `EVEApi::Character#wallet_transactions`
+- `EVEApi::Character#upcoming_calendar_events`
+- `EVEApi::Character#standings`
+- `EVEApi::Character#skill_queue`
+- `EVEApi::Character#skill_in_training`
+- `EVEApi::Character#research`
+- `EVEApi::Character#notifications`
+- `EVEApi::Character#medals`
+- `EVEApi::Character#market_orders`
+- `EVEApi::Character#mail_messages`
+- `EVEApi::Character#mailing_lists`
+- `EVEApi::Character#industry_jobs`
+- `EVEApi::Character#contact_notifications`
+- `EVEApi::Character#contact_list`
+- `EVEApi::Character#character_sheet`
+- `EVEApi::Character#asset_list`
+- `EVEApi::Character#account_balance`
+
+#### Crest
+- `EVEApi::Crest.new`
+- `EVEApi::Crest#allainces`
+- `EVEApi::Crest#types`
+
+#### Alliance
+- `EVEApi::Alliance.find(id = nil)`
+- `EVEApi::Alliance#info`
+- `EVEApi::Alliance#corporations`
+- `EVEApi::Alliance#to_h`
 
 ## CREST
 Rudimentary CREST support is added via the `EVEApi::Crest` class.
@@ -110,22 +116,50 @@ Uses [excon](https://github.com/excon/excon),  [crack](https://github.com/jnunem
 
 ## Examples
 
+### Getting Implant names for character
+```ruby
+require 'eveapi'
+# initialize the client with key_id, vcode, character_id
+client = Client.new(4278167, "supersecretstuff", 95512059)
+# => #<EVEApi::Client:0x007fe349ad0d48 ... >
+client.characters.first.character_sheet[:implants].map { |i| i[:type_name] }
+# => [
+#     [0] "Social Adaptation Chip - Basic",
+#     [1] "Cybernetic Subprocessor - Standard",
+#     [2] "Memory Augmentation - Standard",
+#     [3] "Neural Boost - Standard",
+#     [4] "Ocular Filter - Standard"
+# ]
+```
+
+### Server status
+```ruby
+require 'eveapi'
+client.server_status
+# => {
+#        :server_open => "True",
+#     :online_players => "32500"
+# }
+```
+
+### Showing accounts characters
+
 ```ruby
 require 'eveapi'
 client = EVEApi::Client.new
 client.key_id = 4278167
 client.vcode = "7QJg6p5BZNpDBp2FIz39dGwa7jnNaXAuYyLUVitlTQ3rY60VPBcaTpJVfYIkiW5l"
-client.account_characters
-=> {
-                :name => "Quint Slade",
-        :character_id => "95512059",
-    :corporation_name => "Imperial Academy",
-      :corporation_id => "1000166",
-         :alliance_id => "0",
-       :alliance_name => "",
-          :faction_id => "0",
-        :faction_name => ""
-}
+client.characters
+# => {
+#                 :name => "Quint Slade",
+#         :character_id => "95512059",
+#     :corporation_name => "Imperial Academy",
+#       :corporation_id => "1000166",
+#          :alliance_id => "0",
+#        :alliance_name => "",
+#           :faction_id => "0",
+#         :faction_name => ""
+# }
 ```
 
 ## Requirements

data/Rakefile

@@ -1,7 +1,4 @@
 # encoding: utf-8
-
-require 'rubygems'
-
 begin
   require 'bundler/setup'
 rescue LoadError => e
@@ -9,12 +6,12 @@ rescue LoadError => e
 end
 
 require 'rake'
-
+require 'rubygems'
 require 'bundler/gem_tasks'
 
-require 'rdoc/task'
-RDoc::Task.new
-task doc: :rdoc
+require 'yard'
+YARD::Rake::YardocTask.new
+task doc: :yard
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
@@ -37,39 +34,6 @@ task :console do
   Pry.start
 end
 
-desc 'Generate method docs'
-task :methods do
-  Bundler.require
-  require 'awesome_print'
-  EVEApi::Client.new.working_methods.each do |m|
-    p m
-    @client = EVEApi::Client.new
-    @client.key_id = 4_278_167
-    @client.vcode = 'supersecretstuff'
-    @client.character_id = '95512059'
-    out = ''
-    begin
-      out << @client.api_methods_hash.find { |me| me[:name] == m }[:desc]
-    rescue
-      out << "TODO Description (#{m})"
-    end
-    out << "\n\n"
-    out << "```ruby\n@client = EVEApi::Client.new\n"
-    out << "@client.key_id = 4278167\n"
-    out << "@client.vcode = 'supersecretstuff'\n\n"
-    out << "@client.#{m}\n\n"
-    begin
-      out << @client.send(m).pretty_inspect
-      out << '```'
-      f = File.new("./doc/wiki/#{m}.md", 'w')
-      f.puts out
-      f.close
-    rescue => e
-      puts e.message
-    end
-  end
-end
-
 task c: :console
 task test: :spec
-task default: [:spec, :rubocop]
+task default: [:spec, :"rubocop:auto_correct", :rubocop]

data/gemspec.yml

@@ -18,9 +18,9 @@ development_dependencies:
   bundler: ~> 1
   codeclimate-test-reporter: ~> 0.1
   rake: ~> 10.0
-  rdoc: ~> 4.0
   rspec: ~> 3.0
   vcr: ~> 2.9
   webmock: ~> 1
   pry: ~> 0.10
   awesome_print: ~> 1.6
+  yard: ~> 0.8

data/lib/eveapi.rb

@@ -1,6 +1,23 @@
 lib_dir = File.dirname(__FILE__)
 $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
+# EVEApi namespace
+module EVEApi
+  # CREST API endpoint
+  CREST_ENDPOINT = 'https://public-crest.eveonline.com/'
+  # v2 API endpoint
+  API_ENDPOINT = 'https://api.eveonline.com'
+  # Client methods implemented
+  WORKING_METHODS = [
+    :account_status,
+    :server_status,
+    :characters,
+    :api_methods,
+    :key_info,
+    :call_list
+  ]
+end
+
 require 'eveapi/version'
 require 'eveapi/client'
 require 'eveapi/request'
@@ -12,34 +29,3 @@ require 'excon'
 require 'crack'
 
 include EVEApi::Util
-
-# EVEApi namespace
-module EVEApi
-  CREST_ENDPOINT = 'https://public-crest.eveonline.com/'
-  API_ENDPOINT = 'https://api.eveonline.com'
-  WORKING_METHODS = [
-    :account_api_key_info,
-    :account_account_status,
-    :account_characters,
-    :server_server_status,
-    :char_contracts,
-    :char_wallet_transactions,
-    :char_wallet_journal,
-    :char_upcoming_calendar_events,
-    :char_standings,
-    :char_skill_queue,
-    :char_skill_in_training,
-    :char_research,
-    :char_notifications,
-    :char_medals,
-    :char_market_orders,
-    :char_mail_messages,
-    :char_mailing_lists,
-    :char_industry_jobs,
-    :char_contact_notifications,
-    :char_contact_list,
-    :char_character_sheet,
-    :char_asset_list,
-    :char_account_balance
-  ]
-end

data/lib/eveapi/alliance.rb

@@ -1,14 +1,15 @@
 module EVEApi
   # Alliance CREST object
   class Alliance
-    BASE_URI = 'https://public-crest.eveonline.com/alliances/'
+    # CREST alliances endpoint
+    BASE_URI = CREST_ENDPOINT + 'alliances/'
 
-    attr_accessor :href
-    attr_accessor :id_str
-    attr_accessor :short_name
-    attr_accessor :name
-    attr_accessor :id
-    attr_accessor :info
+    attr_accessor :href       # @return [String] href
+    attr_accessor :id_str     # @return [String] String ID
+    attr_accessor :short_name # @return [String] Short name
+    attr_accessor :name       # @return [String] Name
+    attr_accessor :id         # @return [Fixnum] ID
+    attr_accessor :info       # @return [Hash] Info
 
     def initialize(args)
       case args
@@ -23,20 +24,32 @@ module EVEApi
       end
     end
 
+    # Get detailed Alliance info from CREST
+    #
+    # @return [Hash] Alliance info
     def info
-      @info ||= convert_hash_keys json_get(href)
+      @info ||= json_get(href)
     end
 
+    # Show corporations belonging to the Alliance
+    #
+    # @return [Array] List of corporations
     def corporations
       info[:corporations]
     end
 
+    # Get Alliance from CREST by ID
+    #
+    # @return [Alliance] Alliance object
     def find
       @short_name = info[:short_name]
       @name = info[:name]
       self
     end
 
+    # Converts {Alliance} to {Hash}
+    #
+    # @return [Hash] Alliance in {Hash} format
     def to_h
       h = {}
       instance_variables.each do |var|

data/lib/eveapi/character.rb

@@ -1,17 +1,17 @@
 module EVEApi
   # Character class
   class Character
-    attr_accessor :name
-    attr_accessor :character_id
-    attr_accessor :corporation_name
-    attr_accessor :corporation_id
-    attr_accessor :alliance_id
-    attr_accessor :alliance_name
-    attr_accessor :faction_id
-    attr_accessor :faction_name
-    attr_accessor :key_id
-    attr_accessor :vcode
-    attr_accessor :client
+    attr_accessor :name             # @return [String] Character name
+    attr_accessor :character_id     # @return [String] Character ID
+    attr_accessor :corporation_name # @return [String] Corporation name
+    attr_accessor :corporation_id   # @return [String] Corporation ID
+    attr_accessor :alliance_id      # @return [String] Alliance ID
+    attr_accessor :alliance_name    # @return [String] Alliance name
+    attr_accessor :faction_id       # @return [String] Faction ID
+    attr_accessor :faction_name     # @return [String] Faction name
+    attr_accessor :key_id           # @return [String] API key ID
+    attr_accessor :vcode            # @return [String] API key verification code
+    attr_accessor :client           # @return [Client] {EVEApi::Client} instance
 
     def initialize(args = {})
       @key_id           = args[:key_id]
@@ -30,10 +30,11 @@ module EVEApi
       @client ||= Client.new(key_id, vcode, character_id)
     end
 
+    # Character methods known to work
     METHODS = [
+      :wallet_journal,
       :contracts,
       :wallet_transactions,
-      :wallet_journal,
       :upcoming_calendar_events,
       :standings,
       :skill_queue,
@@ -52,9 +53,38 @@ module EVEApi
       :account_balance
     ]
 
+    # Converts the {Character} method name to {Client} method name
+    #
+    # @param [Symbol] method_name +Character+ method name
+    # @return [Symbol] {Client} method name
+    def client_method(method_name)
+      "char_#{method_name}".to_sym
+    end
+    private :client_method
+
+    # Process arguments for Client method
+    #
+    # @param [Hash] args = {} Client method arguments
+    def process_args(args = {})
+      args.each_pair do |k, v|
+        fail ArgumentError unless client.respond_to?(k)
+        client.instance_variable_set("@#{k}".to_sym, v)
+      end
+    end
+    private :process_args
+
+    # Send a method to a {Client} instance
+    #
+    # @param [String] method_name Method name
+    # @param [Hash] args = {} Method arguments
+    def send_client_method(method_name, args = {})
+      process_args(args)
+      client.send(client_method(method_name))
+    end
+    private :send_client_method
+
     METHODS.each do |m|
-      name = "char_#{m}".to_sym
-      define_method(m) { client.send(name) }
+      define_method(m) { |args = {}| send_client_method(m, args) }
     end
   end
 end