albion-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e270371de44a7af735659f767d31c8a24820385f
+  data.tar.gz: 1c21d9ea0beaab949b04d3ac6e48310120dae7d0
+SHA512:
+  metadata.gz: 90260faab449f607d55b9019f98b1adb4062c32290efb4b87eb4166cfbce553cf713a39f5f6590e2ae1ac7863d55ea3cbfa43c081789fd73bc05600da7919e20
+  data.tar.gz: 62b7ee5085a557c573f91ba6bcd94b55de18db8393c7d317a50750cc3f4ad8198d128ea60f773b60428b8c4f7f10c64563ea86b4469fd49e77dabca21eceb7a1

data/lib/albion-api.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+
+BASE_API_URL = "https://gameinfo.albiononline.com/api/gameinfo".freeze
+
+# this module contains all of the classes needed to make requests to the Albion Online API
+module AlbionApi
+  class AlbionRequest
+    include HTTParty
+    base_uri BASE_API_URL
+  end
+
+  def self.base_api_url
+    BASE_API_URL
+  end
+end
+
+# require all of our classes that belong to this module
+require 'albion-api/user_killboard.rb'
+require 'albion-api/user_search.rb'
+require 'albion-api/guild_search.rb'

data/lib/albion-api/guild_search.rb

@@ -0,0 +1,43 @@
+module AlbionApi
+  # this class is used to look up information about a guild
+  class GuildSearch < AlbionRequest
+    def initialize(guild_name)
+      @guild_name = guild_name
+    end
+
+    def find
+      response = self.class.get("/search?q=#{guild_name}")
+      Response.new(response)
+    end
+
+    private
+
+    attr_accessor :guild_name
+
+    # the response class for the GuildSearch request
+    class Response
+      def initialize(response)
+        guild_info = response['guilds'][0]
+        @_guild_api_id = guild_info['Id']
+        @_alliance_name = guild_info['AllianceName']
+        @_alliance_api_id = guild_info['AllianceId']
+      end
+
+      def guild_api_id
+        @_guild_api_id
+      end
+
+      def alliance_name
+        @_alliance_name
+      end
+
+      def alliance_api_id
+        @_alliance_api_id
+      end
+
+      private
+
+      attr_accessor :_guild_api_id, :_alliance_name, :_alliance_api_id
+    end
+  end
+end

data/lib/albion-api/user_killboard.rb

@@ -0,0 +1,83 @@
+module AlbionApi
+  # this class can make the calls to the UserKillboard APIs
+  class UserKillboard < AlbionRequest
+    def initialize(character_api_id)
+      @character_api_id = character_api_id
+    end
+
+    def top_kills_in_range(start_time, end_time)
+      # get the difference between the end and start time
+      # determine how long ago it was from now, likely 1 day max
+      # make the top kills request with teh proper `range` param
+      # filter the raw response down to only those kills within the timestamp range
+      # return a response class
+      @raw_kills = []
+      page = 0
+      resp = top_kills
+      until resp.empty? do
+        @raw_kills.concat JSON.parse(resp.body)
+        page += 1
+        resp = top_kills(page)
+      end
+      Response.new(filter_kills(start_time, end_time))
+    end
+
+    private
+
+    attr_accessor :character_api_id, :raw_kills
+
+    def top_kills(page = 0)
+      offset = page * 51
+      self.class.get("/players/#{@character_api_id}/topkills?range=month&limit=51&offset=#{offset}")
+    end
+
+    def filter_kills(start_time, end_time)
+      @raw_kills.select do |kill|
+        Time.parse(kill['TimeStamp']).between?(start_time, end_time) && kill['GvGMatch'].nil?
+      end.flatten
+    end
+
+    # class that contains the relevant information about a killboard API response
+    class Response
+      def initialize(response)
+        @_group_members = extract_group_members(response)
+        @_items_dropped = extract_dropped_items(response)
+        @_players_killed = extract_players_killed(response)
+      end
+
+      def group_members
+        _group_members
+      end
+
+      def items_dropped
+        _items_dropped
+      end
+
+      def players_killed
+        _players_killed
+      end
+
+      private
+
+      attr_accessor :_group_members, :_items_dropped, :_players_killed
+
+      def extract_group_members(response)
+        response.collect { |kill| kill['GroupMembers'] }.flatten.collect do |member|
+          member['Name']
+        end
+      end
+
+      def extract_dropped_items(response)
+        response.collect { |kill| kill['Victim'] }.flatten.collect do |victim|
+          victim['Inventory'].concat(victim['Equipment'].values).compact
+        end
+      end
+
+      def extract_players_killed(response)
+        response.collect { |kill| kill['Victim'] }.flatten.collect do |victim|
+          victim['Name']
+        end
+      end
+    end
+  end
+end

data/lib/albion-api/user_search.rb

@@ -0,0 +1,32 @@
+module AlbionApi
+  # this is the class used to search for users, namely to get their API ID
+  class UserSearch < AlbionRequest
+    def initialize(character_name)
+      @character_name = character_name
+    end
+
+    def find
+      response = self.class.get("/search?q=#{character_name}")
+      Response.new(response)
+    end
+
+    private
+
+    attr_accessor :character_name
+
+    # this class wraps the response from the API
+    class Response
+      def initialize(response)
+        @_api_id = response['players'][0]['Id']
+      end
+
+      def api_id
+        @_api_id
+      end
+
+      private
+
+      attr_accessor :_api_id
+    end
+  end
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: albion-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kyle Montag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-02 00:00:00.000000000 Z
+dependencies: []
+description: This is a gem that wraps the Albion Online API.
+email: thekylemontag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/albion-api.rb
+- lib/albion-api/guild_search.rb
+- lib/albion-api/user_killboard.rb
+- lib/albion-api/user_search.rb
+homepage: https://github.com/kmontag42/albion-api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A Ruby Library for the Albion Online API
+test_files: []