eveapi 0.0.4.pre → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDA5NDcwZDRmMGI0MTMzZDJlMDQ0N2QyZDZhMDg4NDQ2YTM0NjcxMg==
+    NGQ0N2YxMGJkY2I2ODBkMWJiZDRiOWMyOTZhYmM5ZGQwOWIwODU2Nw==
   data.tar.gz: !binary |-
-    YWQxZDRjZTNmOGNlODM4YThiMGIxYjY3ZTc5MmRhYTBkZGE2MWIzNA==
+    MzdiOWFhOTI3ZDRhZDkwYTZkNjBjYzAwOWFlZTMwMzFhY2M2NmZjMA==
 SHA512:
   metadata.gz: !binary |-
-    MjAyOTRkMzExY2VmNDNhNjdiYjYyZjBkYmFmYWVjNDFlMjc0NWZkMDY5ZjI3
-    NDA5ZjMyNTdlZmE5YmE4ODBlMzU1NmVkNjNlOWFhOTY3ZGQ1M2FhOGU1ZDJh
-    OGZhOGU2OWUzZDgyNTU4MjljN2ZjNjQyZjI2MjdlODViMTViZTM=
+    Y2ZjZDllZGVkNmYzZDAwMWJkM2E1MGRmZjczZGQ3MmZiZmRmODVlNDc0ZmU3
+    OWViMmFjMzQwOGQxZjY3OGI2NDUxOGQwYzUzY2YwOWZhM2NjOGM2N2YyY2Qy
+    ZTc3ZDUyMWY1YmRmMTU1YWFlMTI5Mjc1OTNmZjlkYmI5ZjgxODU=
   data.tar.gz: !binary |-
-    OTA4ZTJmYzNiYWE2ZDVjZDU1MzdhZWY2ZDBjNmM0ZjA3ZGY0NmJmN2NmOThk
-    NjJmMzFlNmQzOTAxZWQxZjY3OWE1ZjA3MDAwMTA1MjRiOTg4MjMwMzYyZWRh
-    NWQwM2U3NTg2YzI4Y2YxOTIzMDJkMTE1NTQwZTljY2FhODFiMWE=
+    ZmIzYjM1M2IyMDQwY2Q1OWMzZmUyMzIwYzE3ZDkzYTQxMDJiM2MxMzE3OWRh
+    MzZjMmMyZjQxN2U1YzhiNDM0YmJjZDJjZTE3MTNkNWY4OTQ0NzU5NWRmOWI0
+    MzU4M2EwODYyMzUzYTU2NTYzMjJhM2YwOTRkM2I0ODYzNTNmYTQ=

data/.rubocop.yml

@@ -0,0 +1,6 @@
+AllCops:
+  Exclude:
+    - eveapi.gemspec
+  RunRailsCops: true
+Metrics/LineLength:
+  Max: 99

data/README.md

@@ -2,9 +2,12 @@
 
 *EVE API for ruby*
 
+[![Gem Version](https://badge.fury.io/rb/eveapi.svg)](http://badge.fury.io/rb/eveapi)
 [![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)
+[![Downloads](http://ruby-gem-downloads-badge.herokuapp.com/eveapi?type=total)](https://rubygems.org/gems/eveapi)
+
 
 ## Disclaimer!
 This work in progress in a very early stage. Not documented. Only a couple of methods are tested.
@@ -29,27 +32,27 @@ Because of the way the paths are being built from the method names - some method
 
 | Method Name   | Requires      |  Output Class             |
 | ------------- | ------------- | ------------- |
-| [account_api_key_info](account_api_key_info) | - | `Hash` |
-| [account_account_status](account_account_status) | `key_id`, `vcode` | `Hash` |
-| [account_characters](account_characters) | `key_id`, `vcode` | `Array` |
-| [server_server_status](server_server_status) | - | `Hash` |
-| [char_wallet_transactions](char_wallet_transactions) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_wallet_journal](char_wallet_journal) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_standings](char_standings) | `key_id`, `vcode`, `character_id` | `Array` |
-| [char_skill_queue](char_skill_queue) | | |
-| [char_skill_in_training](char_skill_in_training) | | |
-| [char_research](char_research) | | |
-| [char_notifications](char_notifications) | | |
-| [char_medals](char_medals) | | |
-| [char_market_orders](char_market_orders) | | |
-| [char_mail_messages](char_mail_messages) | | |
-| [char_mailing_lists](char_mailing_lists) | | |
-| [char_industry_jobs](char_industry_jobs) | | |
-| [char_contact_notifications](char_contact_notifications) | | |
-| [char_contact_list](char_contact_list) | | |
-| [char_character_sheet](char_character_sheet) | | |
-| [char_asset_list](char_asset_list) | | |
-| [char_account_balance](char_account_balance) | | |
+| [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` |
 
 ## Description
 

data/Rakefile

@@ -14,7 +14,7 @@ require 'bundler/gem_tasks'
 
 require 'rdoc/task'
 RDoc::Task.new
-task :doc => :rdoc
+task doc: :rdoc
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
@@ -35,12 +35,12 @@ task :methods do
   EVEApi::Client.new.working_methods.each do |m|
     p m
     @client = EVEApi::Client.new
-    @client.key_id = 4278167
-    @client.vcode = "supersecretstuff"
+    @client.key_id = 4_278_167
+    @client.vcode = 'supersecretstuff'
     @client.character_id = '95512059'
-    out = ""
+    out = ''
     begin
-      out << @client.api_methods_hash.select { |me| me[:name] == m }.first[:desc]
+      out << @client.api_methods_hash.find { |me| me[:name] == m }[:desc]
     rescue
       out << "TODO Description (#{m})"
     end
@@ -52,15 +52,15 @@ task :methods do
     begin
       out << @client.send(m).pretty_inspect
       out << '```'
-      f = File.new("eveapi.wiki/#{m.to_s}.md","w")
+      f = File.new("./doc/wiki/#{m}.md", 'w')
       f.puts out
       f.close
-    rescue
+    rescue => e
+      puts e.message
     end
   end
 end
 
-
-task :c => :console
-task :test    => :spec
-task :default => :spec
+task c: :console
+task test: :spec
+task default: :spec

data/eveapi.gemspec

@@ -7,12 +7,12 @@ Gem::Specification.new do |gem|
 
   gem.name    = gemspec.fetch('name')
   gem.version = gemspec.fetch('version') do
-                  lib_dir = File.join(File.dirname(__FILE__),'lib')
-                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+    lib_dir = File.join(File.dirname(__FILE__), 'lib')
+    $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
 
-                  require 'eveapi/version'
-                  EVEApi::VERSION
-                end
+    require 'eveapi/version'
+    EVEApi::VERSION
+  end
 
   gem.summary     = gemspec['summary']
   gem.description = gemspec['description']
@@ -23,7 +23,7 @@ Gem::Specification.new do |gem|
 
   glob = lambda { |patterns| gem.files & Dir[*patterns] }
 
-  gem.files = `git ls-files`.split($/)
+  gem.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   gem.files = glob[gemspec['files']] if gemspec['files']
 
   gem.executables = gemspec.fetch('executables') do
@@ -36,7 +36,7 @@ Gem::Specification.new do |gem|
   gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
 
   gem.require_paths = Array(gemspec.fetch('require_paths') {
-    %w[ext lib].select { |dir| File.directory?(dir) }
+    %w(ext lib).select { |dir| File.directory?(dir) }
   })
 
   gem.requirements              = Array(gemspec['requirements'])
@@ -47,14 +47,14 @@ Gem::Specification.new do |gem|
   split = lambda { |string| string.split(/,\s*/) }
 
   if gemspec['dependencies']
-    gemspec['dependencies'].each do |name,versions|
-      gem.add_dependency(name,split[versions])
+    gemspec['dependencies'].each do |name, versions|
+      gem.add_dependency(name, split[versions])
     end
   end
 
   if gemspec['development_dependencies']
-    gemspec['development_dependencies'].each do |name,versions|
-      gem.add_development_dependency(name,split[versions])
+    gemspec['development_dependencies'].each do |name, versions|
+      gem.add_development_dependency(name, split[versions])
     end
   end
 end

data/lib/eveapi.rb

@@ -10,23 +10,32 @@ require 'crack'
 
 include EVEApi::Util
 
-class String
-  def camelize
-    self.split("_").each {|s| s.capitalize! }.join("")
-  end
-
-  # Stolen from ActiveSupport::Inflector
-  def underscore
-    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
-
+# EVEApi namespace
 module EVEApi
   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/client.rb

@@ -1,4 +1,5 @@
 module EVEApi
+  # Client instance and HTTP method handling
   class Client
     attr_accessor :connection
     attr_accessor :key_id
@@ -6,7 +7,7 @@ module EVEApi
     attr_accessor :character_id
     attr_accessor :row_count
 
-    def initialize(key_id=nil, vcode=nil, character_id=nil)
+    def initialize(key_id = nil, vcode = nil, character_id = nil)
       @connection ||= Excon.new(API_ENDPOINT)
       @key_id = key_id
       @character_id = character_id
@@ -20,7 +21,12 @@ module EVEApi
     end
 
     def params
-      { 'rowCount' => row_count, 'keyID' => key_id, 'vCode' => vcode, 'characterID' => character_id }.select { |k,v| v }
+      {
+        'rowCount'    => row_count,
+        'keyID'       => key_id,
+        'vCode'       => vcode,
+        'characterID' => character_id
+      }.select { |_k, v| v }
     end
 
     def api_methods
@@ -28,45 +34,22 @@ module EVEApi
     end
 
     def ruby_method_name(m)
-      ( m[:type][0..3].downcase + '_' + m[:name].underscore ).to_sym
+      (m[:type][0..3].downcase + '_' + m[:name].underscore).to_sym
     end
 
     def api_methods_hash
       api_call_list[:calls].map { |m| { name: ruby_method_name(m), desc: m[:description] } }
     end
 
-    def method_missing(name, *args, &block)
-      raise 'Invalid Method Name' if check_path(name).empty?
+    def method_missing(name, *_args, &_block)
+      fail 'Invalid Method Name' if check_path(name).empty?
       check_path(name)
       request = EVEApi::Request.new @connection.get(path: check_path(name), query: params)
       request.result
     end
+
     def 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,
-      ]
+      EVEApi::WORKING_METHODS
     end
   end
 end

data/lib/eveapi/console.rb

@@ -1,5 +1,5 @@
 include EVEApi
 @client = Client.new
-@client.key_id = "4278167"
-@client.vcode = "supersecretstuff"
+@client.key_id = '4278167'
+@client.vcode = 'supersecretstuff'
 @client.character_id = '95512059'

data/lib/eveapi/request.rb

@@ -1,19 +1,20 @@
 module EVEApi
+  # Handling of requests and response from the EVE Online API
   class Request
     attr_accessor :data
     attr_accessor :result
     attr_accessor :response
 
-    def initialize(response=nil)
+    def initialize(response = nil)
       @response = response
-      raise "HTTP: #{response.status}" unless response.status == 200
+      fail "HTTP: #{response.status}" unless response.status == 200
       @data = parse_xml
-      @result = convert_hash_keys(self.parse_result)
-      raise error if error
+      @result = convert_hash_keys(parse_result)
+      fail error if error
     end
 
     def error
-      data['eveapi'].has_key?('error') ? data['eveapi']['error'] : false
+      data['eveapi'].key?('error') ? data['eveapi']['error'] : false
     end
 
     def parse_xml

data/lib/eveapi/util.rb

@@ -1,21 +1,52 @@
+# Utility Hash methods
 class Hash
   def process_rows
     case self['rowset']
     when Hash
-      self.merge!(self['rowset']['name'] => self['rowset']['row'])
-      self.delete('rowset')
+      normalize_hash_rowset
     when Array
-      self['rowset'].each do |rowset|
-        self[rowset['name']] = rowset['row']
-      end
-      self.delete('rowset')
+      normalize_array_rowset
     end
-    self.merge!(self.delete(self.keys.first)) if self.length == 1
-    return self
+    collapse_key
+  end
+
+  def collapse_key
+    length == 1 ? self.merge!(delete(keys.first)) : self
+  end
+
+  def normalize_hash_rowset
+    self.merge!(self['rowset']['name'] => self['rowset']['row'])
+    delete('rowset')
+  end
+
+  def normalize_array_rowset
+    self['rowset'].each do |rowset|
+      self[rowset['name']] = rowset['row']
+    end
+    delete('rowset')
+  end
+end
+
+# Utility String methods
+class String
+  def camelize
+    split('_').each(&:capitalize!).join('')
+  end
+
+  # Stolen from ActiveSupport::Inflector
+  def underscore
+    return self unless self =~ /[A-Z-]|::/
+    word = 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
 
 module EVEApi
+  # Utility methods
   module Util
     def underscore_key(k)
       k.to_s.underscore.to_sym

data/lib/eveapi/version.rb

@@ -1,4 +1,5 @@
+# EVEApi namespace
 module EVEApi
   # eveapi version
-  VERSION = "0.0.4.pre"
+  VERSION = '0.1.0'
 end

data/spec/eveapi_spec.rb

@@ -5,44 +5,44 @@ describe EVEApi, :vcr do
   before :each do
     @client = Client.new
   end
-  it "there should be a connection class" do
+  it 'there should be a connection class' do
     expect { @client }.not_to raise_error
   end
 
-  it "connection instance variable should be of class Excon::Connection" do
+  it 'connection instance variable should be of class Excon::Connection' do
     expect(@client.connection).to be_a(Excon::Connection)
   end
 
-  it "check_path method should return an empty string when name contains of 1 part" do
+  it 'check_path method should return an empty string when name contains of 1 part' do
     expect(@client.check_path('name')).to eq('')
   end
 
-  it "check_path method should return a path string when name contains of 2 or more parts" do
+  it 'check_path method should return a path string when name contains of 2 or more parts' do
     expect(@client.check_path('name_name')).to be_a(String)
     expect(@client.check_path('name_name')).not_to be_empty
   end
 
-  it "params should return an empty hash when no param variables present" do
+  it 'params should return an empty hash when no param variables present' do
     expect(Client.new.params).to be_a(Hash)
     expect(Client.new.params).to be_empty
   end
 
-  it "calling a method present in the EVEApi should success" do
+  it 'calling a method present in the EVEApi should success' do
     expect { @client.server_server_status }.not_to raise_error
   end
 
-  it "calling a method not present in the EVEApi should fail" do
+  it 'calling a method not present in the EVEApi should fail' do
     expect { @client.some_bs_method }.to raise_error(RuntimeError)
   end
 
-  it "calling api_methods should return an Array of method symobls" do
+  it 'calling api_methods should return an Array of method symobls' do
     expect(@client.api_methods).to be_an(Array)
   end
 
   Client.new.working_methods.each do |m|
     before :each do
-      @client.key_id = "4278167"
-      @client.vcode = "supersecretstuff"
+      @client.key_id = '4278167'
+      @client.vcode = 'supersecretstuff'
       @client.character_id = '95512059'
     end
     it "calling api method #{m}" do

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ unless ENV['CODECLIMATE_REPO_TOKEN']
   require 'simplecov'
   SimpleCov.start
 end
-require "codeclimate-test-reporter"
+require 'codeclimate-test-reporter'
 CodeClimate::TestReporter.start
 require 'rspec'
 require 'eveapi/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: eveapi
 version: !ruby/object:Gem::Version
-  version: 0.0.4.pre
+  version: 0.1.0
 platform: ruby
 authors:
 - Adam Ladachowski
@@ -175,9 +175,9 @@ extra_rdoc_files:
 files:
 - .document
 - .gitignore
-- .gitmodules
 - .rdoc_options
 - .rspec
+- .rubocop.yml
 - .travis.yml
 - ChangeLog.md
 - Gemfile

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "eveapi.wiki"]
-	path = eveapi.wiki
-	url = https://github.com/aladac/eveapi.wiki.git