smite_ruby 1.4.3 → 1.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7cc4f043f27ebe004f8229cced90833f57b4a9d
-  data.tar.gz: e5da84e81525ac97b6eb90a7e9328ddbccd02149
+  metadata.gz: 25feb61882b2f684c7b2c3a719151693dd57f673
+  data.tar.gz: 935a446bc3a1d8688d254de67faf4c8a43c1d9a8
 SHA512:
-  metadata.gz: c8c26832c6684d221ee1fb1a996d1a13115ea28e184be0f4a1ccd02b6e3ddf83efbb4d0862be79b94eaeef14aca0610dacad19f4f81989be57c53125a60ed137
-  data.tar.gz: 7c3a974eb29097b4798f47340c28da5af0379c39217ae5ec47d4e68bfba3dfad1c0a78120f792d7e95481f649eb50568ed705faf7e7da0b03be09c20db15b4e2
+  metadata.gz: ccccf5f6c6bc2c47de9ad36bfba1a811a794d958fe4a92c1762d79b65ca91f406d4919b9cfd54443ab9e31398d0b614235a5d7e877002db765f08a9610139c96
+  data.tar.gz: d82637008babe01c8a05129083c20dcb69a10918bd0b2ce5faf42431e8eb75e3b45c74337834f372d917b03847f65b18a3d86e48e71732e55c808721919539d5

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    smite_ruby (1.4.5)
+      activesupport
+      httparty
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (4.2.3)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    hashdiff (0.2.3)
+    httparty (0.13.5)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.3)
+    multi_xml (0.5.5)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.1)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    safe_yaml (1.0.4)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    webmock (1.22.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rspec
+  smite_ruby!
+  webmock
+
+BUNDLED WITH
+   1.10.5

data/README.md

@@ -1,15 +1,32 @@
 # Smite API Client for Ruby
 ---
+A simple gem for consuming Smite's API data that includes a lightweight client (Smite::Client) and a slightly heavier object wrapper (Smite::Game)
 1. `gem install smite_ruby`
 2. `require 'smite'`
 
-# Examples --  Smite::Game
+## Examples --  Smite::Game
 ---
 
 ### Creating a session
+A session can be created through `Smite::Client` to manipulate API data directly in its raw form.
+```
+> client = Smite::Client.new(<dev_id>, <auth_key>)
+#<Smite::Client:0x007fca3343c948
+ @auth_key="<auth_key>",
+ @dev_id=<dev_id>,
+ @session_id="<session_id>">
+ 
+> client.test_session
+"This was a successful test with the following parameters added: developer: <dev_id> time: 1/30/2016 6:14:25 PM signature: <signature> session: <session_id>"
+
+> client.get_gods
+(huge amount of json/xml god data)
+```
+
+You can also create a session through `Smite::Game`, which will provide extensive convenience methods for manipulating the data. The rest of this documentation will assume authentication was done in this way.
 ```
 > Smite::Game.authenticate!(<dev_id>, <auth_key>)
-Smite::Game
+true
 ```
 
 ### Finding a player
@@ -49,7 +66,7 @@ Smite::Game
 > Smite::Game.item(7526)
 #<Smite::Item 'Iron Mail'>
 ```
-# Examples --  Smite::Player
+## Examples --  Smite::Player
 ---
 ```
 > player = Smite::Game.player('adapting')
@@ -86,20 +103,17 @@ Smite::Game
  ...]
  ```
  
- ### Listing achievements (WIP)
-```
- > player.achievements
- {"DoubleKills"=>5275,
- "FirstBloods"=>1430,
- "Id"=>2784051,
- "Name"=>"Adapting",
- "PentaKills"=>21,
- "QuadraKills"=>137,
- "TowerKills"=>5183,
- "TripleKills"=>803,
- "ret_msg"=>nil}
+### Listing achievements
+```
+> achievements = player.achievements
+#<Smite::Achievements 'Adapting'>
+
+> achievements.double_kills
+5280
+> achievements.penta_kills
+21
  ```
-  ### Listing match history
+### Listing match history
 ```
 > player.match_history
 [#<Smite::Match 'Leagues: Conquest' 'Win'>,
@@ -109,8 +123,8 @@ Smite::Game
  #<Smite::Match 'Leagues: Conquest' 'Loss'>,
  #<Smite::Match 'Leagues: Conquest' 'Win'>,
  ... ]
- ```
-# Examples --  Smite::Match
+```
+## Examples --  Smite::Match
 ---
 ```
 > match = player.match_history[0]
@@ -132,7 +146,7 @@ Smite::Game
  > match.killing_spree
  2
  ```
-# Examples --  Smite::God
+## Examples --  Smite::God
 ---
 ```
 > merc = Smite::Game.god('Mercury')
@@ -148,7 +162,7 @@ Smite::Game
 > merc.speed
 375
  ```
-# Examples --  Smite::GodRank
+## Examples --  Smite::GodRank
 ---
 ```
 > rank = player.god_ranks[0]
@@ -163,7 +177,7 @@ Smite::Game
  > rank.worshippers
  4517
   ```
-# Examples --  Smite::Item
+## Examples --  Smite::Item
 ---
 ```
 > bov = Smite::Game.item('Breastplate of Valor')

data/lib/smite.rb

@@ -4,17 +4,21 @@ require 'active_support'
 module Smite
 end
 
-require 'smite/object.rb'
-require 'smite/achievements.rb'
-require 'smite/ability.rb'
-require 'smite/god_rank.rb'
-require 'smite/god_stats.rb'
-require 'smite/god.rb'
-require 'smite/item_effect.rb'
-require 'smite/item.rb'
-require 'smite/friend.rb'
-require 'smite/data_transform.rb'
-require 'smite/match.rb'
-require 'smite/player.rb'
-require 'smite/game.rb'
-require 'smite/client.rb'
+require_relative './smite/object.rb'
+require_relative './smite/queue.rb'
+require_relative './smite/motd.rb'
+require_relative './smite/recommended_items.rb'
+require_relative './smite/achievements.rb'
+require_relative './smite/ability.rb'
+require_relative './smite/god_rank.rb'
+require_relative './smite/god_stats.rb'
+require_relative './smite/god.rb'
+require_relative './smite/item_effect.rb'
+require_relative './smite/item.rb'
+require_relative './smite/friend.rb'
+require_relative './smite/data_transform.rb'
+require_relative './smite/match.rb'
+require_relative './smite/recent_match.rb'
+require_relative './smite/player.rb'
+require_relative './smite/game.rb'
+require_relative './smite/client.rb'

data/lib/smite/client.rb

@@ -1,26 +1,108 @@
 module Smite
   class Client
-    attr_reader :dev_id, :auth_key, :session_id
+    attr_reader :dev_id, :auth_key, :session_id, :lang
     include HTTParty
     base_uri 'http://api.smitegame.com/smiteapi.svc/'
 
-    def initialize(dev_id, auth_key)
+    def initialize(dev_id, auth_key, lang = 1)
       @dev_id     = dev_id
       @auth_key   = auth_key
+      @lang       = [1,2,3,7,9,10,11,12,13].include?(lang) ? lang : 1
       create_session
     end
 
-    # /testsessionjson/{developerId}/{signature}/{session}/{timestamp}
+    def esports_pro_league_details
+      api_call('getesportsproleaguedetails')
+    end
+
+    def god_recommended_items(god_id)
+      api_call('getgodrecommendeditems', [god_id, lang])
+    end
+
+    def match_player_details(match_id)
+      api_call('getmatchplayerdetails', [match_id])
+    end
+
+    def match_ids_by_queue(queue, date, hour)
+      api_call('getmatchidsbyqueue', [queue, date, hour])
+    end
+
+    def league_seasons(queue)
+      api_call('getleagueseasons', [queue])
+    end
+
+    def league_leaderboard(queue, tier, season)
+      api_call('getleagueleaderboard', [queue, tier, season])
+    end
+
+    def motd
+      api_call('getmotd')
+    end
+
+    def player_status(player_name)
+      api_call('getplayerstatus', [player_name])
+    end
+
+    def queue_stats(player_name, queue)
+      api_call('getqueuestats', [player_name, queue])
+    end
+
+    def team_details(clan_id)
+      api_call('getteamdetails', [clan_id])
+    end
+
+    def team_players(clan_id)
+      api_call('getteamplayers', [clan_id])
+    end
+
+    def top_matches
+      api_call('gettopmatches')
+    end
+
+    def match_details(match_id)
+      api_call('getmatchdetails', [match_id])
+    end
+
+    def gods
+      api_call('getgods', [lang])
+    end
+
+    def items
+      api_call('getitems', [lang])
+    end
+
+    def achievements(player_id)
+      api_call('getplayerachievements', [player_id])
+    end
+
+    def friends(player_name)
+      api_call('getfriends', [player_name])
+    end
+
+    def god_ranks(player_name)
+      api_call('getgodranks', [player_name])
+    end
+
+    def player(player_name)
+      api_call('getplayer', [player_name])
+    end
+
+    def match_history(player_name)
+      api_call('getmatchhistory', [player_name])
+    end
+
+    def search_teams(team_name)
+      api_call('searchteams', [team_name])
+    end
+
     def test_session
-      api_call('testsession', [])
+      api_call('testsession')
     end
 
-    # /getdatausedjson/{developerId}/{signature}/{session}/{timestamp}
-    def get_data_used
-      api_call('getdataused', [])
+    def data_used
+      api_call('getdataused')
     end
 
-    # /createsessionjson/{developerId}/{signature}/{timestamp}
     def create_session
       return @session_id if valid_session?
 
@@ -28,17 +110,17 @@ module Smite
       @session_id = response['session_id']
     end
 
-    def api_call(method, params = [], session = true)
-      request = request_str(method, params, session)
-      self.class.get(request)
-    end
-
     def valid_session?
       !!(test_session =~ /successful/i)
     end
 
     private
 
+    def api_call(method, params = [], session = true)
+      request = request_str(method, params, session)
+      self.class.get(request)
+    end
+
     def signature(method)
       Digest::MD5.hexdigest("#{dev_id}#{method}#{auth_key}#{timestamp}")
     end

data/lib/smite/data_transform.rb

@@ -6,7 +6,7 @@ module Smite
         item_fields = data.slice(*item_map_fields)
         return data if item_fields.empty?
 
-        data['items'] = item_fields.values.map { |id| Smite::Game.item(id.to_i) }
+        data['items'] = item_fields.values.map { |id| Smite::Game.item(id) }
         data.except(*item_filter_fields)
       end
 
@@ -14,7 +14,7 @@ module Smite
         god_fields = data.slice(*god_map_fields)
         return data if god_fields.empty?
 
-        data['god'] = god_fields.values.map { |id| Smite::Game.god(id.to_i) }[0]
+        data['god'] = god_fields.values.map { |id| Smite::Game.god(id) }[0]
         data.except(*god_filter_fields)
       end
 
@@ -32,13 +32,13 @@ module Smite
         data.except(*ability_filter_fields)
       end
 
-      def transform_match(data)
-        return data unless data['Queue']
+      def transform_recent_match(data)
+        return data unless data['queue']
 
-        if data['Queue'] =~ /League/
+        if data['queue'] =~ /League/
           data
         else
-          data.except(*match_filter_fields)
+          data.except(*recent_match_filter_fields)
         end
       end
 
@@ -98,7 +98,7 @@ module Smite
         )
       end
 
-      def match_filter_fields
+      def recent_match_filter_fields
         %w(
           ban1 ban2 ban3 ban4 ban5 ban6
           ban1_id ban2_id ban3_id
@@ -129,7 +129,7 @@ module Smite
       end
 
       def god_filter_fields
-        god_map_fields + %w(god)
+        god_map_fields
       end
     end
   end

data/lib/smite/game.rb

@@ -1,39 +1,67 @@
 module Smite
   class Game
     class << self
-      attr_reader :client, :lang_code
+      attr_reader :client
 
-      def authenticate!(dev_id, auth_key, lang_code = 1)
-        @client     = Smite::Client.new(dev_id, auth_key)
-        @lang_code  = lang_code
-        !client.session_id.empty?
+      def authenticate!(dev_id, auth_key, format = 'json', lang = 1)
+        @client = Smite::Client.new(dev_id, auth_key, lang)
+        !client.session_id.nil?
       end
 
       def device(name_or_id)
-        devices[device_hash[name_or_id]]
+        idx = device_hash[name_or_id.to_s.downcase]
+        idx.nil? ? nil : devices[idx]
       end
       alias_method :item, :device
       alias_method :consumable, :device
       alias_method :active, :device
 
       def god(name_or_id)
-        gods[god_hash[name_or_id]]
+        idx = god_hash[name_or_id.to_s.downcase]
+        idx.nil? ? nil : gods[idx]
       end
 
       def match(match_id)
-        Match.new(match_details(match_id))
+        @matches           ||= {}
+        @matches[match_id] ||= Match.new(client.match_details(match_id))
       end
 
       def player(player_name)
-        Player.new(client, player_name)
+        Player.new(player_name)
+      end
+
+      def motd_now
+        motd_list[0]
+      end
+
+      def motd_list
+        @motds ||= client.motd.map(&MOTD.method(:new))
+      end
+
+      def queues
+        @queues ||= Smite::Queue::QUEUES.map(&Queue.method(:new))
+      end
+
+      def god_recommended_items(name_or_id)
+        god = god(name_or_id)
+        @rec_items ||= {}
+        return @rec_items[god.id] unless @rec_items[god.id].nil?
+
+        @rec_items[god.id] = []
+        recommended = client.god_recommended_items(god.id)
+        recommended.group_by { |r| r['Role'] }.each do |role, items|
+          @rec_items[god.id] << Smite::RecommendedItems.new(god.name, items, role)
+        end
+
+        @rec_items[god.id]
       end
 
       def gods
-        @gods ||= get_gods.map(&God.method(:new))
+        @gods ||= client.gods.map(&God.method(:new))
       end
 
       def devices
-        @devices ||= get_items.map(&Item.method(:new))
+        @devices ||= client.items.map(&Item.method(:new))
       end
 
       def items
@@ -52,32 +80,17 @@ module Smite
 
       def device_hash
         @device_hash ||= (0...devices.count).each_with_object({}) do |idx, hash|
-          hash[devices[idx].item_id]      = idx
-          hash[devices[idx].device_name]  = idx
+          hash[devices[idx].item_id.to_s]          = idx
+          hash[devices[idx].device_name.downcase]  = idx
         end
       end
 
       def god_hash
         @god_hash ||= (0...gods.count).each_with_object({}) do |idx, hash|
-          hash[gods[idx].id]    = idx
-          hash[gods[idx].name]  = idx
+          hash[gods[idx].id.to_s]        = idx
+          hash[gods[idx].name.downcase]  = idx
         end
       end
-
-      # /getmatchdetails[ResponseFormat]/{developerId}/{signature}/{session}/{timestamp}/{match_id}
-      def match_details(match_id)
-        client.api_call('getmatchdetails', [match_id])
-      end
-
-      # /getgodsjson/{developerId}/{signature}/{session}/{timestamp}/{languageCode}
-      def get_gods
-        client.api_call('getgods', [lang_code])
-      end
-
-      # /getitemsjson/{developerId}/{signature}/{session}/{timestamp}/{languagecode}
-      def get_items
-        client.api_call('getitems', [lang_code])
-      end
     end
   end
 end