eve_online-api 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Craig R Webster
+
+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,29 @@
+# Eve Online API
+
+I want to play with some of the data in EVE. CCP provide an API. Yay!
+
+This README is a little lame because this code doesn't do much yet.
+You can pull the SOV info and the skill tree. I'll (slowly) be working on exposing the other parts of the API, but of course, patches would be lovely.
+
+
+## Example use
+
+    require 'eve_online/api'
+
+    require 'logger'
+    logger = Logger.new STDOUT
+    logger.level = Logger::DEBUG
+
+    client = EveOnline::Api::Client.new :logger => logger
+    puts client.sovereignty.to_s
+    puts client.skill_tree.to_s
+
+
+## Licence
+
+MIT. See LICENSE.
+
+
+## Authors
+
+Craig R Webster <http://barkingiguana.com/>

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/eve_online-api.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/eve_online/api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Craig R Webster"]
+  gem.email         = ["craig@barkingiguana.com"]
+  gem.description   = %q{Ruby interface to the EVE Online API}
+  gem.summary       = %q{Ruby interface to the EVE Online API}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "eve_online-api"
+  gem.require_paths = ["lib"]
+  gem.version       = EveOnline::Api::VERSION
+
+  gem.add_runtime_dependency 'null_logger'
+  gem.add_runtime_dependency 'active_support', '~> 3.0'
+  gem.add_runtime_dependency 'nokogiri', '~> 1.5'
+end

data/lib/eve_online-api.rb

@@ -0,0 +1 @@
+require "eve_online/api"

data/lib/eve_online/api.rb

@@ -0,0 +1,16 @@
+require 'tmpdir'
+require 'digest/sha1'
+require 'null_logger'
+require 'net/http'
+require 'nokogiri'
+require 'active_support/inflector'
+
+require 'eve_online/api/version'
+require 'eve_online/api/skill_groups'
+require 'eve_online/api/skill_group'
+require 'eve_online/api/skills'
+require 'eve_online/api/skill'
+require 'eve_online/api/solar_systems'
+require 'eve_online/api/solar_system'
+require 'eve_online/api/file_cache'
+require 'eve_online/api/client'

data/lib/eve_online/api/client.rb

@@ -0,0 +1,68 @@
+module EveOnline
+  module Api
+    class Client
+      attr_accessor :api_base
+      private :api_base=, :api_base
+
+      attr_accessor :cache
+      private :cache=, :cache
+
+      attr_accessor :logger
+      private :logger=, :logger
+
+      def initialize options = {}
+        self.api_base = options[:api_base] || 'http://api.eve-online.com'
+        logger = options[:logger] || NullLogger.instance
+        self.cache = options[:cache] || FileCache.new(:logger => logger)
+        self.logger = logger
+      end
+
+      def skill_tree
+        logger.debug "Fetching skill tree"
+        results = get '/eve/SkillTree.xml.aspx'
+      end
+
+      def sovereignty
+        logger.debug "Fetching sovereignty information"
+        results = get '/map/Sovereignty.xml.aspx'
+      end
+
+      def get path
+        uri = URI.parse api_base + path
+        logger.debug "Asking cache for #{uri}"
+        cached_document = cache.get uri
+        logger.debug "Cache returned #{cached_document ? 'document' : 'nothing'}"
+        return results_from cached_document if cached_document
+        logger.debug "Making request to EVE API"
+        response = Net::HTTP.get uri
+        logger.debug "Parsing response"
+        doc = Nokogiri::XML response
+        expiration_string = doc.at_xpath '/eveapi/cachedUntil/text()'
+        expiration_date = Time.parse expiration_string.to_s
+        logger.debug "Told response is cached until #{expiration_date}"
+        cache.set uri, response, expiration_date
+        logger.debug "Returning response"
+        results_from response
+      end
+      private :get
+
+      def results_from xml
+        doc = Nokogiri::XML xml
+        result = doc.at_xpath '/eveapi/result/rowset'
+        evaluate_result result
+      end
+
+      def evaluate_result row
+        container_name = row['name']
+        container_name[0] = container_name[0].upcase
+        const_defined = EveOnline::Api.const_defined? container_name
+        logger.debug "#{const_defined ? 'Found' : 'Unknown'} container: #{container_name}"
+        return unless const_defined
+        logger.debug "Using container #{container_name}"
+        container_class = EveOnline::Api.const_get container_name
+        logger.debug "Class instance = #{container_class.inspect}"
+        container_class.new row
+      end
+    end
+  end
+end

data/lib/eve_online/api/file_cache.rb

@@ -0,0 +1,78 @@
+module EveOnline
+  module Api
+    class FileCache
+      attr_accessor :directory
+      private :directory=, :directory
+
+      attr_accessor :logger
+      private :logger=, :logger
+
+      attr_accessor :boundary
+      private :boundary=, :boundary
+
+      def initialize options = {}
+        self.directory = options[:directory] || Dir.tmpdir
+        self.logger = options[:logger] || NullLogger.instance
+        self.boundary = options[:boundary] || '_FILE_CACHE_'
+      end
+
+      def get key
+        logger.debug "Cache asked for #{key}"
+        file = file_for key
+        return unless file
+        logger.debug "Reading from cache at #{file}"
+        File.read file
+      end
+
+      def set key, data, expiration_date
+        logger.debug "Asked to cache #{key} until #{expiration_date}"
+        request_time = Time.now
+        return unless expiration_date > request_time
+        hex = Digest::SHA1.hexdigest key.to_s
+        file_name = "#{expiration_date.to_i}#{boundary}#{hex}"
+        file_path = File.join directory, file_name
+        logger.debug "Realising cache instance as #{file_path}"
+        File.open file_path, 'w' do |file|
+          file.print data
+        end
+        logger.debug "Cached #{key} in #{file_path}"
+      end
+
+      def file_for key
+        logger.debug "Finding cache instances for #{key}"
+        hex = Digest::SHA1.hexdigest key.to_s
+        pattern = File.join directory, "*#{boundary}#{hex}"
+        logger.debug "Glob for #{pattern} on disk"
+        files = Dir.glob pattern
+        logger.debug "Found #{files.size} cache instances"
+        return unless files.any?
+        request_time = Time.now
+        logger.debug "Excluding expired instanced"
+        live = files.select { |file_name|
+          expiration_date = expiration_date file_name
+          expiration_date > request_time
+        }
+        logger.debug "Found #{live.size} live cache instances"
+        return unless live.any?
+        logger.debug "Selecting most recent live instance"
+        instance = live.sort_by { |file_name|
+          expiration_date file_name
+        }[-1]
+        expiration_date = expiration_date instance
+        logger.debug "Instance is #{instance}, expires = #{expiration_date}"
+        instance
+      end
+
+      def expiration_date file_path
+        logger.debug "Finding expiration date from #{file_path}"
+        file_name = File.basename file_path
+        logger.debug "File name = #{file_name}"
+        timestamp, _ = file_name.split %r{#{boundary}}, 2
+        logger.debug "Timestamp = #{timestamp}"
+        time = Time.at timestamp.to_i
+        logger.debug "Time = #{time}"
+        time
+      end
+    end
+  end
+end

data/lib/eve_online/api/skill.rb

@@ -0,0 +1,29 @@
+module EveOnline
+  module Api
+    class Skill
+      attr_accessor :fragment
+      private :fragment=, :fragment
+
+      def initialize fragment
+        self.fragment = fragment
+      end
+
+      def id
+        fragment['typeID']
+      end
+
+      def name
+        fragment['typeName']
+      end
+
+      def <=> other
+        name <=> other.name
+      end
+      include Comparable
+
+      def to_s indent = 0
+        "#{' ' * indent}#{name} Skill (id:#{id})"
+      end
+    end
+  end
+end

data/lib/eve_online/api/skill_group.rb

@@ -0,0 +1,43 @@
+module EveOnline
+  module Api
+    class SkillGroup
+      attr_accessor :fragment
+      private :fragment=, :fragment
+
+      def initialize fragment
+        self.fragment = fragment
+      end
+
+      def id
+        fragment['groupID']
+      end
+
+      def name
+        fragment['groupName']
+      end
+
+      def <=> other
+        name <=> other.name
+      end
+      include Comparable
+
+      def merge other
+        other.skills_fragment.children.each do |child|
+          skills_fragment.add_child child
+        end
+      end
+
+      def skills
+        Skills.new skills_fragment
+      end
+
+      def skills_fragment
+        fragment.at_xpath './rowset'
+      end
+
+      def to_s indent = 0
+        "#{' ' * indent}#{name} Skill Group (id:#{id})\n#{skills.to_s(indent + 2)}"
+      end
+    end
+  end
+end

data/lib/eve_online/api/skill_groups.rb

@@ -0,0 +1,36 @@
+module EveOnline
+  module Api
+    class SkillGroups
+      attr_accessor :fragment
+      private :fragment=, :fragment
+
+      def initialize fragment
+        self.fragment = fragment
+      end
+
+      def each
+        rows = fragment.xpath './row'
+        skill_groups = rows.map do |row|
+          skill_group = SkillGroup.new row
+        end
+        skill_groups.group_by { |sg| sg.id }.each do |id, groups|
+          group = groups.pop
+          while next_group = groups.pop
+            group.merge next_group
+          end
+          yield group
+        end
+      end
+      include Enumerable
+
+      def to_s indent = 0
+        margin = " " * indent
+        ["#{margin}Skill Groups (#{to_a.size})"].tap do |s|
+          sort.each do |skill_group|
+            s << skill_group.to_s(indent + 2)
+          end
+        end.join "\n"        
+      end
+    end
+  end
+end

data/lib/eve_online/api/skills.rb

@@ -0,0 +1,30 @@
+module EveOnline
+  module Api
+    class Skills
+      attr_accessor :fragment
+      private :fragment=, :fragment
+
+      def initialize fragment
+        self.fragment = fragment
+      end
+
+      def each
+        rows = fragment.xpath './row'
+        rows.each do |row|
+          skill = Skill.new row
+          yield skill
+        end
+      end
+      include Enumerable
+
+      def to_s indent = 0
+        margin = " " * indent
+        [ "#{margin}Skills (#{to_a.size})" ].tap do |s|
+          sort.each do |skill|
+            s << skill.to_s(indent + 2)
+          end
+        end.join "\n"
+      end
+    end
+  end
+end

data/lib/eve_online/api/solar_system.rb

@@ -0,0 +1,42 @@
+module EveOnline
+  module Api
+    class SolarSystem
+      attr_accessor :fragment
+      private :fragment=, :fragment
+
+      def initialize fragment
+        self.fragment = fragment
+      end
+
+      def id
+        fragment['solarSystemID']
+      end
+
+      def name
+        fragment['solarSystemName']
+      end
+
+      def alliance_id
+        fragment['allianceID']
+      end
+
+      def corporation_id
+        fragment['corporationID']
+      end
+
+      def faction_id
+        fragment['factionID']
+      end
+
+      def <=> other
+        name <=> other.name
+      end
+      include Comparable
+
+      def to_s indent = 0
+        margin = " " * indent
+        "#{margin}#{name} Solar System (id:#{id}, alliance:#{alliance_id}, corporation:#{corporation_id}, faction:#{faction_id})"
+      end
+    end
+  end
+end

data/lib/eve_online/api/solar_systems.rb

@@ -0,0 +1,30 @@
+module EveOnline
+  module Api
+    class SolarSystems
+      attr_accessor :fragment
+      private :fragment=, :fragment
+
+      def initialize fragment
+        self.fragment = fragment
+      end
+
+      def each
+        rows = fragment.xpath './row'
+        rows.each do |row|
+          solar_system = SolarSystem.new row
+          yield solar_system
+        end
+      end
+      include Enumerable
+
+      def to_s indent = 0
+        margin = " " * indent
+        ["#{margin}Solar Systems (#{to_a.size})"].tap do |s|
+          sort.each do |solar_system|
+            s << solar_system.to_s(indent + 2)
+          end
+        end.join "\n"        
+      end
+    end
+  end
+end

data/lib/eve_online/api/version.rb

@@ -0,0 +1,5 @@
+module EveOnline
+  module Api
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: eve_online-api
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Craig R Webster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-31 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: null_logger
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.5"
+  type: :runtime
+  version_requirements: *id003
+description: Ruby interface to the EVE Online API
+email: 
+- craig@barkingiguana.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- eve_online-api.gemspec
+- lib/eve_online-api.rb
+- lib/eve_online/api.rb
+- lib/eve_online/api/client.rb
+- lib/eve_online/api/file_cache.rb
+- lib/eve_online/api/skill.rb
+- lib/eve_online/api/skill_group.rb
+- lib/eve_online/api/skill_groups.rb
+- lib/eve_online/api/skills.rb
+- lib/eve_online/api/solar_system.rb
+- lib/eve_online/api/solar_systems.rb
+- lib/eve_online/api/version.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the EVE Online API
+test_files: []
+