eoat 0.1.0

data/lib/eoat/request.rb

@@ -0,0 +1,82 @@
+module EOAT
+  # Request class. Returns an instance of the class-result from the cache or performs http request.
+  # @author Ivan Kotov {mailto:i.s.kotov.ws e-mail}
+  # @example Call to get result from https://api.eveonline.com/eve/CharacterInfo.xml.aspx?characterID=208974814
+  #   EOAT::Request.new(
+  #       'https://api.eveonline.com',
+  #       '/eve/CharacterInfo.xml.aspx?characterID=208974814',
+  #       EOAT::Result::EveType::Result
+  #   ).get
+  # @return
+  #   The instance of the class specified in the attributes.
+  # @raise
+  #   [EOAT::Exception::HTTP404Error] the request path not found
+  # @raise
+  #   [EOAT::Exception::HTTPError] response status code is not 200, 404.
+  #   Contain status code and response headers
+  # @raise
+  #   [EOAT::Exception::EveApiError] if response status code is 0.
+  #   Contain a parsed error page message and error code
+  class Request
+
+    # @param host [String] the request host string
+    # @param uri [String] the request query string
+    # @param result_class [Class] the class to contain result of request
+    def initialize(host, uri, result_class)
+      @host = host
+      @uri = uri
+      @result = result_class
+    end
+
+    # Method-collector of private methods. Performs basic algorithm of output.
+    def get
+      cache = cache_get
+      if cache
+        cache
+      else
+        result = @result.new(http_request)
+        cache_save(result)
+        result
+      end
+    end
+
+    private
+
+    # HTTP request method. It is used when the data were not obtained from the cache.
+    # Uses only global variables and instance variables.
+    # @return
+    #   [Hash, Array] if response body is XML or JSON
+    #   [String] if response body is HTML
+    def http_request
+      r = HTTParty.get("#{@host}/#{@uri}", :headers => EOAT.headers)
+      case r.response.code.to_i
+        when 200
+          return r.parsed_response
+        when 0
+          EOAT::Exception.parse_error_page(r.parsed_response)
+        when 404
+          raise EOAT::Exception::HTTP404Error.new "Request url path '/#{@uri}' not found"
+        else
+          raise EOAT::Exception::HTTPError.new(
+                    r.response.code.to_i,
+                    r.headers.to_h
+                ),
+                "Request host '#{@host}' return error: '#{r.response.code} - #{r.response.message}'"
+      end
+    end
+
+    # Request cached result from cache handler.
+    # If the request is successful, the result will
+    # be changed parameter 'from_cache' to true.
+    def cache_get
+      result = EOAT.cache.get(@host, @uri)
+      result.from_cache = true if result
+      result
+    end
+
+    # Save parsed result to cache handler.
+    def cache_save(content)
+      EOAT.cache.save(@host, @uri, content)
+    end
+  end
+end

data/lib/eoat/result/eve_type.rb

@@ -0,0 +1,163 @@
+module EOAT
+  # Collection of response parser classes
+  # @author Ivan Kotov {mailto:i.s.kotov.ws e-mail}
+  module Result
+    # EveApi XML parser classes.
+    # Is used to parse the query result from the EVE API and ZKillboard API
+    # @author Ivan Kotov {mailto:i.s.kotov.ws e-mail}
+    # @note
+    #  I'm not proud written below. But I pursued only would it
+    #  be convenient to use. Thank for this xml structure from EVE API.
+    module EveType
+      # Parser class of of EVE API xml.
+      # Has the structure of the xml root. Starting from ['eveapi']
+      # @example
+      #   eve = EOAT::Result::EveType::Result.new(xml_to_hash)
+      #   eve.from_cache #=> false
+      # @attribute from_cache [FalseClass, TrueClass] Return `true` if data from cache
+      # @attribute cached_until [Time] Return `cachedUntil` as time
+      # @attribute request_time [Time] Alias to xml `currentTime` as time
+      # @attribute result [Array] List of children
+      class Result
+        attr_accessor :from_cache
+        attr_reader :cached_until, :request_time, :result
+
+        # @param [Hash] hash the xml body parsed to hash
+        def initialize(hash)
+          hash = hash.key?('eveapi') ? hash['eveapi'] : EOAT::Exception::ParseError.new('Wrong parse data')
+          @from_cache = false
+          @cached_until = Time.parse(hash['cachedUntil'] + 'UTC')
+          @request_time = Time.parse(hash['currentTime'] + 'UTC')
+          @result = hash['result'].keys - Array.new(1, 'rowset')
+          hash['result'].keys.each do |key|
+            value = hash['result'][key]
+            case value
+              when Hash
+                if value.key? 'row'
+                  var_name = value['name']
+                  var_value = RowSet.new(value)
+                  @result << var_name
+                else
+                  var_name = key
+                  var_value = Row.new(value)
+                end
+                self.instance_variable_set("@#{var_name}", var_value)
+                self.class.send(
+                    :define_method,
+                    var_name,
+                    proc{self.instance_variable_get("@#{var_name}")}
+                )
+              when Array
+                value.each do |v|
+                  self.instance_variable_set("@#{v['name']}", RowSet.new(v))
+                  self.class.send(
+                      :define_method,
+                      v['name'],
+                      proc{self.instance_variable_get("@#{v['name']}")}
+                  )
+                  @result << v['name']
+                end
+              when String
+                self.instance_variable_set("@#{key}", value)
+                self.class.send(
+                    :define_method,
+                    key,
+                    proc{self.instance_variable_get("@#{key}")}
+                )
+              else
+                raise EOAT::Exception::ParseError.new "Unable to parse the the value of #{value}"
+            end
+          end
+        end
+      end
+
+      # Rowset container for xml data.
+      # Usually not called directly
+      # @attribute key [String] The value of key for indexing
+      # @attribute columns [Array] The array of methods names for Row class
+      # @attribute name [String] The name of rowset
+      # @attribute entries [Array] The array of Row objects
+      class RowSet
+        attr_accessor :key, :columns, :entries
+
+        # @param [Hash] hash the roset value from xml as hash
+        def initialize(hash)
+          @key = hash['key']
+          @columns = hash['columns'].split(',')
+          @name = hash['name']
+          if hash.key? 'row'
+            case hash['row']
+              when Array
+                @entries = Array.new(hash['row'].map.each {|row| Row.new(row)})
+              when Hash
+                @entries = Array.new(1, Row.new(hash['row']))
+              else
+                raise EOAT::Exception::ParseError.new "Unable to parse the the value of #{hash['row']}"
+            end
+          else
+            @entries = Array.new
+          end
+        end
+
+        # TODO: Correct method. Eliminate return of only the first result.
+
+        # Get method for entries. Used attribute `key` for indexing.
+        # Return first fount Row.
+        # @param [Integer, String] key the value that been search
+        def get(key)
+          @entries.at(@entries.index {|x| x.send(@key) == key.to_s})
+        end
+      end
+
+      # Key-values container. All methods generated automatically.
+      class Row
+
+        # @param [Hash] hash the xml row value from xml as hash
+        def initialize(hash)
+          hash.each do |key, value|
+            case value
+              when Hash
+                if value.key? 'row'
+                  var_name = value['name']
+                  var_value = RowSet.new(value)
+                else
+                  var_name = key
+                  var_value = Row.new(value)
+                end
+                self.instance_variable_set("@#{var_name}",var_value)
+                self.class.send(
+                    :define_method,
+                    var_name,
+                    proc {
+                      self.instance_variable_get("@#{var_name}")
+                    }
+                )
+              when String, NilClass
+                self.instance_variable_set("@#{key}", value)
+                self.class.send(
+                    :define_method,
+                    key,
+                    proc {
+                      self.instance_variable_get("@#{key}")
+                    }
+                )
+              when Array
+                value.each do |element|
+                  self.instance_variable_set("@#{element['name']}", RowSet.new(element))
+                  self.class.send(
+                      :define_method,
+                      element['name'],
+                      proc {
+                        self.instance_variable_get("@#{element['name']}")
+                      }
+                  )
+                end
+              else
+                raise EOAT::Exception::ParseError.new "Unable to parse the the key: #{key}, value: #{value.class}; hash: #{hash}."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eoat/version.rb

@@ -0,0 +1,4 @@
+module EOAT
+  # Current gem version
+  VERSION = '0.1.0'
+end

data/lib/eoat/zk_api.rb

@@ -0,0 +1,33 @@
+module EOAT
+  # ZKApi class - call class. Collects user input, building a url request
+  # and passes it  to the Request class.
+  # @author Ivan Kotov {mailto:i.s.kotov.ws e-mail}
+  # @example Get last 10 solo kills
+  # solo_kills = EOAT::ZKApi.new('solo').kills(:limit => 10)
+  # solo_kills.kills.entries.first.killID #=> "32966816"
+  class ZKApi
+
+    # @param [Array] args the array of request parameters without value
+    # @param [String] host the request host, default: https://zkillboard.com
+    def initialize(*args, host: 'http://zkillboard.com')
+      @host = host
+      @uri_part = args.empty? ? '' : '/'.concat(args.join('/'))
+    end
+
+    # Create an request according to the method called.
+    # This is used to dynamically create api calls.
+    def method_missing(method, **kwargs)
+      uri = create_uri(method.id2name, kwargs)
+      EOAT::Request.new(@host, uri, EOAT::Result::EveType::Result).get
+    end
+
+    # Collect all request parameters and combine it to query string.
+    # @param [String] fake_method the name of missing method
+    # @param [Hash] kwargs the keyword arguments
+    # @return [String]
+    def create_uri(fake_method, **kwargs)
+      @uri_part += kwargs ? kwargs.map {|k, v| "/#{k}/#{v}"}.join : ''
+      "api/#{fake_method}#{@uri_part}/xml"
+    end
+  end
+end

data/spec/eoat/eve_api_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe EOAT::EveApi do
+  before :each do
+    EOAT.cache = EOAT::Cache::NoneCache.new
+  end
+
+  describe 'initialization' do
+    it 'can accept empty data to the input' do
+      EOAT::EveApi.new
+    end
+
+    it 'takes a key_id, v_code, scope, host as input' do
+      EOAT::EveApi.new('keyID', 'vCode', scope: 'account', host: 'http://test.com')
+    end
+
+    it 'takes only scope as input' do
+      EOAT::EveApi.new(scope: 'account')
+      EOAT::EveApi.new(:scope => 'account')
+    end
+
+    it 'takes only host as input' do
+      EOAT::EveApi.new(host: 'http://test.com')
+      EOAT::EveApi.new(:host => 'http://test.com')
+    end
+
+    it 'raise an ArgumentError if vCode not specify' do
+      expect { EOAT::EveApi.new('test keyID') }.to raise_error ArgumentError
+    end
+
+    let(:v_code) { Symbol 'vCode'}
+    it 'raise an ArgumentError if vCode not String' do
+      expect { EOAT::EveApi.new('test keyID', :v_code) }.to raise_error ArgumentError
+    end
+  end
+
+  describe 'API requests' do
+    it 'was return EOAT::Result::EveType::Result class' do
+      stub_eve_request('/server/ServerStatus.xml.aspx')
+      EOAT::EveApi.new(:scope => 'server').ServerStatus.class.should == EOAT::Result::EveType::Result
+    end
+
+    it 'was accept arguments for the method and return EOAT::Result::EveType::Result class' do
+      stub_eve_request('/eve/CharacterInfo.xml.aspx?characterID=208974814')
+      EOAT::EveApi.new.CharacterInfo(:characterID => 208974814).class.should == EOAT::Result::EveType::Result
+      stub_eve_request('/eve/CharacterName.xml.aspx?IDs=208974814,797400947')
+      EOAT::EveApi.new.CharacterName(:IDs => '208974814,797400947').class.should == EOAT::Result::EveType::Result
+    end
+
+    it 'was accept keyID and vCode and return EOAT::Result::EveType::Result class' do
+      stub_eve_request('/account/APIKeyInfo.xml.aspx?keyID=123&vCode=test')
+      EOAT::EveApi.new(123, 'test', :scope => 'account').APIKeyInfo.key.accessMask.should == '268435455'
+    end
+
+    it 'raise EOAT::Exception::HTTP404Error' do
+      stub_request(
+          :get,
+          'https://api.eveonline.com/eve/Characters.xml.aspx?keyID=123&vCode=test'
+      ).with(
+          :headers => EOAT.headers
+      ).to_return(:status => 404, :body => '', :headers => {})
+      expect { EOAT::EveApi.new(123, 'test').Characters }.to raise_error EOAT::Exception::HTTP404Error
+    end
+
+    it 'raise EOAT::Exception::HTTPError' do
+      stub_request(
+          :get,
+          'https://api.eveonline.com/account/Characters.xml.aspx?keyID=123&vCode=test'
+      ).with(
+          :headers => EOAT.headers
+      ).to_return(:status => 403, :body => '', :headers => {})
+      expect { EOAT::EveApi.new(123, 'test', :scope => 'account').Characters }.to raise_error EOAT::Exception::HTTPError
+    end
+
+    it 'raise EOAT::Exception::EveApiError' do
+      stub_eve_request('/corp/KillLog.xml.aspx?keyID=123&vCode=test', 0)
+      expect { EOAT::EveApi.new(123, 'test', :scope => 'corp').KillLog }.to raise_error EOAT::Exception::EveApiError
+    end
+  end
+end

data/spec/eoat/eve_result_spec.rb

@@ -0,0 +1,127 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe EOAT::Result::EveType::Result do
+  before :each do
+    EOAT.cache = EOAT::Cache::NoneCache.new
+  end
+
+  it 'should have the Result->RowSet->Row classes structure' do
+    stub_eve_request('/eve/ErrorList.xml.aspx')
+    response = EOAT::EveApi.new.ErrorList
+    response.class.should == EOAT::Result::EveType::Result
+    response.result.class.should == Array
+    response.errors.class.should == EOAT::Result::EveType::RowSet
+    response.errors.entries.class.should == Array
+    response.errors.entries.first.class.should == EOAT::Result::EveType::Row
+  end
+
+  it 'should have the Result->RowSet->Row->RowSet->Row->RowSet->Row classes structure' do
+    stub_eve_request('/eve/CertificateTree.xml.aspx')
+    response = EOAT::EveApi.new.CertificateTree
+    response.class.should == EOAT::Result::EveType::Result
+    response.result.class.should == Array
+    response.categories.class.should == EOAT::Result::EveType::RowSet
+    response.categories.columns.class.should == Array
+    category = response.categories.entries.first
+    category.class.should == EOAT::Result::EveType::Row
+    category.categoryID.class.should == String
+    category.categoryName.class.should == String
+    category.classes.class.should == EOAT::Result::EveType::RowSet
+    category.classes.columns.class.should == Array
+    category.classes.entries.class.should == Array
+    classe = category.classes.entries.first
+    classe.class.should == EOAT::Result::EveType::Row
+    classe.classID.class.should == String
+    classe.className.class.should == String
+    classe.certificates.class.should == EOAT::Result::EveType::RowSet
+    classe.certificates.columns.class == Array
+    certificate = classe.certificates.entries.first
+    certificate.class.should == EOAT::Result::EveType::Row
+    certificate.certificateID.class.should == String
+    certificate.grade.class.should == String
+    certificate.corporationID.class.should == String
+    certificate.description.class.should == String
+    certificate.requiredSkills.class.should == EOAT::Result::EveType::RowSet
+    certificate.requiredSkills.entries.class == Array
+    certificate.requiredCertificates.class.should == EOAT::Result::EveType::RowSet
+    certificate.requiredCertificates.entries.class == Array
+    certificate.requiredSkills.entries.first.class.should == EOAT::Result::EveType::Row
+    certificate.requiredCertificates.entries.size.should == 0
+  end
+
+  it 'should have Result->(Row,RowSets)->Row structure' do
+    stub_eve_request('/eve/FacWarStats.xml.aspx')
+    factions_wars = EOAT::EveApi.new.FacWarStats
+    factions_wars.result.class.should == Array
+    factions_wars.totals.class.should == EOAT::Result::EveType::Row
+    factions_wars.factions.class.should == EOAT::Result::EveType::RowSet
+    factions_wars.factions.entries.class.should == Array
+    factions_wars.factions.entries.first.class.should == EOAT::Result::EveType::Row
+    factions_wars.factionWars.class.should == EOAT::Result::EveType::RowSet
+    factions_wars.factionWars.entries.class.should == Array
+    factions_wars.factionWars.entries.first.class.should == EOAT::Result::EveType::Row
+  end
+
+  it 'should have Result->Row->RowSets->Row structure' do
+    stub_eve_request('/eve/FacWarTopStats.xml.aspx')
+    stats = EOAT::EveApi.new.FacWarTopStats
+    stats.result.class.should == Array
+    stats.characters.class.should == EOAT::Result::EveType::Row
+    stats.characters.KillsYesterday.class.should == EOAT::Result::EveType::RowSet
+    stats.characters.KillsYesterday.entries.class.should == Array
+    stats.characters.KillsYesterday.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.characters.KillsLastWeek.class.should == EOAT::Result::EveType::RowSet
+    stats.characters.KillsLastWeek.entries.class.should == Array
+    stats.characters.KillsLastWeek.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.characters.KillsTotal.class.should == EOAT::Result::EveType::RowSet
+    stats.characters.KillsTotal.entries.class.should == Array
+    stats.characters.KillsTotal.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.characters.VictoryPointsYesterday.class.should == EOAT::Result::EveType::RowSet
+    stats.characters.VictoryPointsYesterday.entries.class.should == Array
+    stats.characters.VictoryPointsYesterday.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.characters.VictoryPointsLastWeek.class.should == EOAT::Result::EveType::RowSet
+    stats.characters.VictoryPointsLastWeek.entries.class.should == Array
+    stats.characters.VictoryPointsLastWeek.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.characters.VictoryPointsTotal.class.should == EOAT::Result::EveType::RowSet
+    stats.characters.VictoryPointsTotal.entries.class.should == Array
+    stats.characters.VictoryPointsTotal.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.corporations.class.should == EOAT::Result::EveType::Row
+    stats.corporations.KillsYesterday.class.should == EOAT::Result::EveType::RowSet
+    stats.corporations.KillsYesterday.entries.class.should == Array
+    stats.corporations.KillsYesterday.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.corporations.KillsLastWeek.class.should == EOAT::Result::EveType::RowSet
+    stats.corporations.KillsLastWeek.entries.class.should == Array
+    stats.corporations.KillsLastWeek.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.corporations.KillsTotal.class.should == EOAT::Result::EveType::RowSet
+    stats.corporations.KillsTotal.entries.class.should == Array
+    stats.corporations.KillsTotal.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.corporations.VictoryPointsYesterday.class.should == EOAT::Result::EveType::RowSet
+    stats.corporations.VictoryPointsYesterday.entries.class.should == Array
+    stats.corporations.VictoryPointsYesterday.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.corporations.VictoryPointsLastWeek.class.should == EOAT::Result::EveType::RowSet
+    stats.corporations.VictoryPointsLastWeek.entries.class.should == Array
+    stats.corporations.VictoryPointsLastWeek.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.corporations.VictoryPointsTotal.class.should == EOAT::Result::EveType::RowSet
+    stats.corporations.VictoryPointsTotal.entries.class.should == Array
+    stats.corporations.VictoryPointsTotal.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.factions.class.should == EOAT::Result::EveType::Row
+    stats.factions.KillsYesterday.class.should == EOAT::Result::EveType::RowSet
+    stats.factions.KillsYesterday.entries.class.should == Array
+    stats.factions.KillsYesterday.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.factions.KillsLastWeek.class.should == EOAT::Result::EveType::RowSet
+    stats.factions.KillsLastWeek.entries.class.should == Array
+    stats.factions.KillsLastWeek.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.factions.KillsTotal.class.should == EOAT::Result::EveType::RowSet
+    stats.factions.KillsTotal.entries.class.should == Array
+    stats.factions.KillsTotal.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.factions.VictoryPointsYesterday.class.should == EOAT::Result::EveType::RowSet
+    stats.factions.VictoryPointsYesterday.entries.class.should == Array
+    stats.factions.VictoryPointsYesterday.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.factions.VictoryPointsLastWeek.class.should == EOAT::Result::EveType::RowSet
+    stats.factions.VictoryPointsLastWeek.entries.class.should == Array
+    stats.factions.VictoryPointsLastWeek.entries.first.class.should == EOAT::Result::EveType::Row
+    stats.factions.VictoryPointsTotal.class.should == EOAT::Result::EveType::RowSet
+    stats.factions.VictoryPointsTotal.entries.class.should == Array
+    stats.factions.VictoryPointsTotal.entries.first.class.should == EOAT::Result::EveType::Row
+  end
+end