eve-api 0.0.1 → 0.0.5

data/History.txt

@@ -0,0 +1,36 @@
+== 0.0.5 2007-06-26
+
+* Enhancements
+  * None
+* Fixes
+  * Fixed Transport debugging support
+
+== 0.0.4 2007-06-26
+
+* Enhancements
+  * Added debug option to Transport layer
+* Fixes
+  * None
+
+== 0.0.3 2007-06-26
+
+* Enhancements
+  * None
+* Fixes
+  * Renamed Character::attributes to Character:: skills to be friendlier (though slightly less accurate)
+
+== 0.0.2 2007-06-26
+
+* Enhancements
+  * Reworked gem infrastructure
+  * Completed objectiness(tm)
+  * Added unit tests
+* Fixes
+  * None
+
+== 0.0.1 2007-06-22
+
+* Enhancements
+  * Initial release
+* Fixes
+  * None

data/License.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2007 David Dollar
+
+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/Manifest.txt

@@ -0,0 +1,21 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/eve-api.rb
+lib/eve-api/common.rb
+lib/eve-api/eve-api.rb
+lib/eve-api/exceptions.rb
+lib/eve-api/transport.rb
+lib/eve-api/version.rb
+scripts/txt2html
+setup.rb
+test/config.yml.dist
+test/test_eve-api.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.rhtml

data/README.txt

@@ -0,0 +1,33 @@
+Eve API Support
+===============
+
+Some docs will go here. See tests/general.rb for usage examples
+
+Run general.rb using the following command:
+  cd lib && ruby ../tests/general.rb
+  
+Basic example:
+
+require 'eve-api'
+
+api = EveAPI::API.new(:id => 'user id', :api_key => 'api key')
+api.users.each do |user|
+  user.characters.each do |character|
+    character.accounts.each do |account|
+      account.transactions.each do |transaction|
+        puts "transaction: #{transaction.id} [date=#{transaction.date.strftime("%Y-%m-%d %H:%m")}]"
+      end
+      account.journal.each do |entry|
+        puts "journal entry: #{entry.id} [balance=#{entry.balance}]"
+      end
+    end
+    character.corporation.members.each do |member|
+      puts "corp member: #{member.id} [name=#{member.name}]"
+    end
+    character.corporation.accounts.each do |account|
+      account.transactions.each do |transaction|
+        puts "corp transaction: #{transaction.id} [date=#{transaction.date.strftime("%Y-%m-%d %H:%m")}]"
+      end
+    end
+  end
+end

data/Rakefile

@@ -0,0 +1,123 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'eve-api', 'version')
+
+AUTHOR = 'David Dollar'  # can also be an array of Authors
+EMAIL = "ddollar@gmail.com"
+DESCRIPTION = "EVE API Support"
+GEM_NAME = 'eve-api' # what ppl will type to install your gem
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}"
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  @rubyforge_username ||= @config["username"]
+end
+
+RUBYFORGE_PROJECT = 'eve-api' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+NAME = "eve-api"
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = EveAPI::VERSION::STRING + (REV ? ".#{REV}" : "")
+CLEAN.include ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
+RDOC_OPTS = ['--quiet', '--title', 'eve-api documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = []     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\n\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+
+desc 'Generate website files'
+task :website_generate do
+  Dir['website/**/*.txt'].each do |txt|
+    sh %{ ruby scripts/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]
+
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+

data/lib/eve-api.rb

@@ -1,5 +1,7 @@
-require 'pp'
+module EveAPI
+end
 
+require 'eve-api/version'
 require 'eve-api/common'
 require 'eve-api/exceptions'
 require 'eve-api/transport'

data/lib/eve-api/eve-api.rb

@@ -67,6 +67,33 @@ module EveAPI
       end
       return characters
     end
+    def skill_tree
+      groups = []
+      skills = {}
+      skilltree = @api.skilltree
+      skilltree[:groups].each do |raw_group_id, raw_group|
+        group_skills = {}
+        skilltree[:skills].each do |raw_skill_id, raw_skill|
+          group_skills[raw_skill_id] = Skill.new(raw_skill, @api) if raw_skill[:group_id] == raw_group_id
+        end
+        groups << SkillGroup.new(raw_group.merge({:skills => group_skills}), @api)
+      end
+      return groups
+    end
+    def sovereignty
+      systems = {}
+      @api.sovereignty.each do |raw_system_id, raw_system|
+        systems[raw_system_id] = System.new(raw_system, @api)
+      end
+      return systems
+    end
+    def ref_types
+      ref_types = {}
+      @api.reftypes.each do |raw_reftype_id, raw_reftype|
+        ref_types[raw_reftype_id] = ReferenceType.new(raw_reftype, @api)
+      end
+      return ref_types
+    end
   end
     
   class Character < Base
@@ -80,6 +107,12 @@ module EveAPI
       end
       return accounts
     end
+    def skill_in_training
+      return SkillInTraining.new(@api.skill_in_training(id), @api)
+    end
+    def skills
+      return CharacterSkills.new(@api.skills(id), @api)
+    end
   end
 
   class Corporation < Base
@@ -135,4 +168,22 @@ module EveAPI
   class Member < Base
   end
   
+  class SkillGroup < Base
+  end
+  
+  class Skill < Base
+  end
+  
+  class SkillInTraining < Base
+  end
+  
+  class CharacterSkills < Base
+  end
+  
+  class System < Base
+  end
+  
+  class ReferenceType < Base
+  end
+  
 end

data/lib/eve-api/transport.rb

@@ -93,7 +93,7 @@ module EveAPI
       
       def skilltree
         result = {
-          :skillgroups => {},
+          :groups => {},
           :skills => {}
         }
         doc = @transport.call('eve/SkillTree.xml.aspx')
@@ -106,6 +106,7 @@ module EveAPI
           row.each_element('rowset[@name="skills"]/row') do |skill_row|
             skill = {
               :id => skill_row.attributes['typeID'].to_i,
+              :group_id => skill_row.attributes['groupID'].to_i,
               :name => skill_row.attributes['typeName'],
               :rank => skill_row.elements['rank'].text.to_i,
               :description => skill_row.elements['description'].text
@@ -119,8 +120,7 @@ module EveAPI
             result[:skills][skill[:id]] = skill
           end
           skillgroup[:skills] = skills
-          result[:skillgroups][skillgroup[:id]] = skillgroup
-          break
+          result[:groups][skillgroup[:id]] = skillgroup
         end
         return result
       end
@@ -257,20 +257,20 @@ module EveAPI
       EVE_API_URI_BASE = "http://api.eve-online.com/"
     
       def initialize(*args)
-        options = extract_options_from_args!(args)
+        @options = extract_options_from_args!(args)
         @base_params = {}
-        @base_params[:userID] = options[:id] or raise Exceptions::OptionsException, "id is missing"
-        @base_params[:apiKey] = options[:api_key] or raise Exceptions::OptionsException, "api_key is missing"
-        @base_params[:betaAccess] = options[:beta_key] if options[:beta_key]
+        @base_params[:userID] = @options[:id] or raise Exceptions::OptionsException, "id is missing"
+        @base_params[:apiKey] = @options[:api_key] or raise Exceptions::OptionsException, "api_key is missing"
+        @base_params[:betaAccess] = @options[:beta_key] if @options[:beta_key]
       end
     
       def call(uri, *args)
         params = extract_options_from_args!(args).merge(@base_params)
-        #pp params
+        pp params if @options[:debug]
         res = Net::HTTP.post_form(URI.parse("#{EVE_API_URI_BASE}#{uri}"), params)
         xml = '<?xml version="1.0"?>' + res.body
         doc = REXML::Document.new(xml)
-        #puts doc
+        puts doc if @options[:debug]
         if error = doc.elements['//error']
           case error.attributes['code'][0,1]
             when '1': raise Exceptions::InputException, error.text

data/lib/eve-api/version.rb

@@ -0,0 +1,9 @@
+module EveAPI #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 5
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/scripts/txt2html

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+require File.dirname(__FILE__) + '/../lib/eve-api/version.rb'
+
+version  = EveAPI::VERSION::STRING
+download = 'http://rubyforge.org/projects/eve-api'
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.dirname(__FILE__) + '/../website/template.rhtml'
+  
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.rhtml] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text = fsrc.read
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</
>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)