eve_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,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eve_api.gemspec
+gemspec
+
+gem 'awesome_print'
+gem 'addressable'

data/LICENSE.txt

@@ -0,0 +1,16 @@
+EveApi: Library to access eve online api
+Copyright (C) 2013 Femaref
+femaref@googlemail.com
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; limited to version 2.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

data/README.md

@@ -0,0 +1,29 @@
+# EveApi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'eve_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eve_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/eve_api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eve_api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "eve_api"
+  gem.version       = EveApi::VERSION
+  gem.authors       = ["Femaref"]
+  gem.email         = ["femaref@googlemail.com"]
+  gem.description   = %q{Generic way to query the eve online api }
+  gem.summary       = %q{Generic way to query the eve online api }
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency("addressable", "~> 2.3.5")
+  gem.add_dependency("nokogiri", "~> 1.6.0")
+  gem.add_dependency("faraday", "~> 0.8.8") 
+end

data/lib/eve_api/api.rb

@@ -0,0 +1,84 @@
+module EveApi
+  class Api
+    BASE_URI = "https://api.eveonline.com"
+  
+    def initialize(keyID, vCode)
+      @keyID = keyID
+      @vCode = vCode
+    end
+    
+    def account
+      ScopedApi.new(@keyID, @vCode, :account)
+    end
+    
+    def char
+      ScopedApi.new(@keyID, @vCode, :char)
+    end
+    
+    def corp
+      ScopedApi.new(@keyID, @vCode, :corp)
+    end
+    
+    def eve
+      ScopedApi.new(@keyID, @vCode, :eve)
+    end
+    
+    def map
+      ScopedApi.new(@keyID, @vCode, :map)
+    end    
+    
+    def server
+      ScopedApi.new(@keyID, @vCode, :map)
+    end
+    
+    def self.canonic_path(path)
+      path.to_s.downcase.split("_").map{ |m| m.capitalize }.reduce(:+)
+    end
+    
+    def self.uri(path, scope)
+      scope_uri = Addressable::URI.parse("/#{scope.to_s}/")
+      
+      path_capitalized = self.canonic_path(path)
+      path_capitalized += ".xml.aspx"
+      
+      path_uri = Addressable::URI.parse(path_capitalized)
+      
+      final_uri = scope_uri + path_uri
+      
+      return final_uri
+    end
+    
+    protected
+        
+    def call(path, scope, args)
+      canonic_name = self.class.canonic_path(path)
+      uri = self.class.uri(path, scope)
+      args = args.merge({ :keyID => @keyID, :vCode => @vCode })
+      
+      characterID = (args[:characterID] || args[:character_id] || 0)
+      
+      if cache = EveApi.cache.retrieve(@keyID, scope, canonic_name, characterID)
+        document= Nokogiri::XML(cache)
+      else
+        @connection ||= Faraday.new(:url => BASE_URI) do |faraday|
+          faraday.request :url_encoded
+          faraday.response :logger
+          faraday.adapter Faraday.default_adapter
+        end
+      
+        result = @connection.get uri, args
+      
+        if result.status != 200
+          raise "Status Code not equal 200"
+        end
+        
+        cache = result.body
+        EveApi.cache.store!(@keyID, scope, canonic_name, characterID, cache)
+        
+        document = Nokogiri::XML(cache)
+      end
+      
+      EveApi::Parsers::Default.new(canonic_name, document).parse   
+    end
+  end
+end

data/lib/eve_api/caches/default.rb

@@ -0,0 +1,24 @@
+module EveApi
+  module Caches
+    class Default
+      def initialize
+      end
+    
+      def path(keyID, scope, canonic_name, characterID)
+        "#{keyID}/#{scope}/#{canonic_name}/#{characterID}"
+      end
+      
+      def cached?(keyID, scope, canonic_name, characterID)
+        return false
+      end
+      
+      def retrieve(keyID, scope, canonic_name, characterID)
+        return nil
+      end
+      
+      def store!(keyID, scope, canonic_name, characterID, content)
+        return false
+      end
+    end
+  end
+end

data/lib/eve_api/caches/file.rb

@@ -0,0 +1,58 @@
+module EveApi
+  module Caches
+    class File < Default
+      def initialize(cache_path)
+        @root = cache_path
+      end
+      
+      def cached?(keyID, scope, canonic_name, characterID)
+        file_path = render_path(keyID, scope, canonic_name, characterID)
+        
+        return false if !::File.exists?(file_path)
+        
+        cached = ::File.open(file_path) do |f|
+          parser = EveApi::Parsers::Cache.new(f.read)
+          
+          cached_until, _ = parser.parse
+          
+          Time.now <= cached_until
+        end
+        
+        return cached
+      end
+      
+      def retrieve(keyID, scope, canonic_name, characterID)
+        rendered_path = render_path(keyID, scope, canonic_name, characterID)
+        
+        if cached?(keyID, scope, canonic_name, characterID)
+          return ::File.open(rendered_path) do |f|
+            f.read
+          end
+        else
+          return nil
+        end
+      end
+      
+      def store!(keyID, scope, canonic_name, characterID, content)
+        rendered_path = render_path(keyID, scope, canonic_name, characterID)
+        
+        FileUtils.mkdir_p(::File.dirname(rendered_path))
+        
+        ::File.open(rendered_path, "w+") do |f|
+          f.write(content.to_s)
+        end
+        
+        return true
+      end
+      
+      private
+      
+      def render_path(keyID, scope, canonic_name, characterID)
+        rendered_path = path(keyID, scope, canonic_name, characterID)
+        
+        return ::File.join(@root, rendered_path)
+      end
+      
+    end
+  end
+end

data/lib/eve_api/data.rb

@@ -0,0 +1,98 @@
+module EveApi  
+  module Data
+    class Generic
+      def initialize(data)
+        @data = data
+      end
+      
+      def method_missing(name, *args)
+        if !@data.has_key?(name.to_sym)
+          return super
+        end
+        
+        return @data[name.to_sym]
+      end
+      
+      def keys
+        @data.keys
+      end
+      
+      def inspect
+        "<# EveApi::Data::Generic keys: #{keys} >"
+      end
+    end
+  
+    class Result < Generic
+      attr_accessor :current_time, :cached_until, :outdated      
+     
+      def initialize(current_time, cached_until, data, outdated = false)
+        @current_time = current_time
+        @cached_until = cached_until
+        @outdated = outdated
+        super(data)
+      end
+    end
+    
+    class Rowset
+      include Enumerable
+      extend Forwardable
+      
+      def_delegator :@rows, :each, :each
+    
+      def initialize(rows)          
+        @rows = rows
+      end
+    end
+    
+    class Row < Generic
+    end
+      
+    def self.result(canonic_name)
+      name = "#{canonic_name}Result".to_sym
+      
+      if const_defined?(name)
+        return const_get name
+      end
+      
+      klass = Class.new(Result)
+            
+      const_set name, klass
+      
+      return klass
+    end
+  
+    def self.rowset(canonic_name, keys, fields = [])
+      name = "#{canonic_name}Rowset".to_sym
+      if const_defined?(name)
+        return const_get name
+      end
+      
+      klass = Class.new(Rowset)
+      
+      klass.const_set("NAME", canonic_name)
+      klass.const_set("FIELDS", fields)
+      klass.const_set("KEYS", keys)
+      
+      const_set name, klass
+      
+      return klass
+    end
+    
+    def self.row(canonic_name, keys, fields = [])
+      name = "#{canonic_name}Row".to_sym
+      if const_defined?(name)
+        return const_get name
+      end
+      
+      klass = Class.new(Row)
+      
+      klass.const_set("NAME", canonic_name)
+      klass.const_set("FIELDS", fields)
+      klass.const_set("KEYS", keys)
+      
+      const_set name, klass
+      
+      return klass
+    end
+  end
+end

data/lib/eve_api/parsers/cache.rb

@@ -0,0 +1,16 @@
+module EveApi
+  module Parsers
+    class Cache
+      def initialize(result)
+        @document = result.is_a?(Nokogiri::XML::Document) ? result : Nokogiri::XML(result)
+      end
+      
+      def parse
+        cached_until = Time.parse(@document.css("cachedUntil").first.inner_text + " UTC")
+        current_time = Time.parse(@document.css("currentTime").first.inner_text + " UTC")
+        
+        return [cached_until, current_time]
+      end
+    end
+  end
+end

data/lib/eve_api/parsers/default.rb

@@ -0,0 +1,107 @@
+module EveApi
+  module Parsers
+    class Default < Cache
+      STRING_DETECTION = /[^\d.]+/
+    
+      def initialize(canonic_name, result)
+        @canonic_name = canonic_name
+        super(result)
+      end
+    
+      def parse
+        rowsets = @document.css("result > rowset").map do |rowset|
+          parsed = parse_rowset(rowset) 
+          [ parsed.class::NAME.downcase.to_sym, parsed ]
+        end
+        
+        cached_until, current_time = super
+        
+        result_klass = EveApi::Data.result(@canonic_name)
+        
+        data = rowsets
+        
+        single_fields = @document.css("result > *").select do |node|
+          node.name != "rowset"
+        end
+        
+        single_fields = single_fields.map do |node|
+          parse_node(node)
+        end
+        
+        data += single_fields
+        
+        data = Hash[data]
+        
+        result_klass.new(current_time, cached_until, data)
+      end
+      
+      private
+      
+      def parse_rowset(data)
+        fields = data.attribute("columns").value.split(",")
+        keys = data.attribute("key").value.split(",")
+        name = data.attribute("name").value.capitalize
+        
+        rowset_klass = EveApi::Data.rowset(name, keys, fields)
+        
+        rows = data.css("> row").map do |row|
+          parse_row(name, keys, fields, row)
+        end
+        
+        rowset_klass.new(rows)
+      end
+      
+      def parse_row(rowset_name, keys, fields, data)
+        row_klass = EveApi::Data.row(rowset_name, keys, fields)
+        
+        ary = data.map do |k, v|
+          [k.to_sym, parse_attribute(k, v)]
+        end
+        
+        hash = Hash[ary]
+        
+        row_klass.new(hash)
+      end
+      
+      def parse_attribute(key, value)
+        sym_key = key.to_sym
+        
+        if value == nil || value == ""
+          return EveApi.default_for_empty
+        end
+      
+        if sym_key == :date
+          return Time.parse(value)
+        end
+        
+        if key.downcase.include?("singleton")
+          return value == "1"
+        end
+        
+        if self.class::STRING_DETECTION.match(value) 
+          return value
+        end
+        
+        value = value.to_f
+        
+        if value.to_i == value
+          return value.to_i  
+        end
+         
+        return value
+      end
+      
+      def parse_node(node)
+        if node.children.count == 0
+          return [node.name.to_sym, nil ]
+        end
+      
+        if node.children.count == 1 && node.children.first.text?
+          return [node.name.to_sym, parse_attribute(node.name, node.inner_text)]
+        end
+        
+        return [ node.name.to_sym, EveApi::Data::Generic.new(Hash[node.css(" > *").map{ |m| parse_node(m) }]) ]
+      end
+    end
+  end
+end

data/lib/eve_api/scoped_api.rb

@@ -0,0 +1,12 @@
+module EveApi
+  class ScopedApi < Api
+    def initialize(keyID, vCode, scope)
+      @scope = scope
+      super(keyID, vCode)
+    end
+    
+    def method_missing(method, args = {})      
+      self.call(method, @scope, args)
+    end
+  end
+end

data/lib/eve_api/version.rb

@@ -0,0 +1,3 @@
+module EveApi
+  VERSION = "0.0.1"
+end

data/lib/eve_api.rb

@@ -0,0 +1,41 @@
+require 'eve_api/version'
+require 'addressable/uri'
+require 'faraday'
+require 'nokogiri'
+
+module EveApi
+
+  autoload :Api, 'eve_api/api.rb'
+  autoload :ScopedApi, 'eve_api/scoped_api.rb'
+  
+  autoload :Data, 'eve_api/data.rb'
+  
+  module Parsers
+    autoload :Default, 'eve_api/parsers/default.rb'
+    autoload :Cache, 'eve_api/parsers/cache.rb'
+  end
+  
+  module Caches
+    autoload :Default, 'eve_api/caches/default.rb'
+    autoload :File, 'eve_api/caches/file.rb'
+  end
+  
+  def self.cache
+    @cache
+  end
+  
+  def self.cache=(value)
+    @cache = value
+  end
+  
+  def self.default_for_empty
+    @default_for_empty
+  end
+  
+  def self.default_for_empty=(value)
+    @default_for_empty = value
+  end
+   
+  @cache ||= EveApi::Caches::Default.new
+  @default_for_empty = nil
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: eve_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Femaref
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.5
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+description: ! 'Generic way to query the eve online api '
+email:
+- femaref@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- eve_api.gemspec
+- lib/eve_api.rb
+- lib/eve_api/api.rb
+- lib/eve_api/caches/default.rb
+- lib/eve_api/caches/file.rb
+- lib/eve_api/data.rb
+- lib/eve_api/parsers/cache.rb
+- lib/eve_api/parsers/default.rb
+- lib/eve_api/scoped_api.rb
+- lib/eve_api/version.rb
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Generic way to query the eve online api
+test_files: []