riot_api 0.0.4 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7214fe007e576b2c2b1a9ba783eac5724e604fba
+  data.tar.gz: e2f652f3fcfc5baeaef9bfb7f1f3d2c00db9b4d8
+SHA512:
+  metadata.gz: 4801b1605ee7139ae8f732c952a9f0f2b91c30f31b3adb0e3379c990944877930b6cd1929b5d370500dee2de9bb10a2e4c61c8a4c4ddbd741d97cf87c00448f0
+  data.tar.gz: 0c73679b3532e020cab9c1a6e2fd2b6fa56c0cfd3ec8672b4c04956221be26750fd398c7e1efb128d3a7ac42efe43cce2f65a9a37bd2e9eb8a1f094439448f20

data/.gitignore

@@ -16,3 +16,5 @@ test/version_tmp
 tmp
 .rbenv-vars
 .coveralls.yml
+.ruby-version
+.ruby-gemset

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.0
+* Virtus models implemented for all end-points
+* Added custom log class for debug, which redacts API keys
+* Fix @raise_status_errors bug, will now raise error before trying to parse it as JSON
+
 ## 0.0.4
 * Yanked 0.0.3 release as Team method not implemented
 * Fixed team method

data/README.md

@@ -3,6 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/riot_api.png)](http://badge.fury.io/rb/riot_api)
 [![Coverage Status](https://coveralls.io/repos/petems/riot_api/badge.png)](https://coveralls.io/r/petems/riot_api)
 [![Build Status](https://travis-ci.org/petems/riot_api.png?branch=master)](https://travis-ci.org/petems/riot_api)
+[![Dependency Status](https://gemnasium.com/petems/riot_api.png)](https://gemnasium.com/petems/riot_api)
 
 A Ruby wrapper around connecting to the [Riot API](https://developer.riotgames.com)
 
@@ -109,7 +110,7 @@ rspec
 
 ### Contributors
 
-* [pcg79](https://github.com/pcg79)
+* [@pcg79](https://github.com/pcg79)
 
 For more information and a complete list see [the contributor page on GitHub](https://github.com/petems/riot_api/contributors).
 
@@ -119,5 +120,5 @@ For more information and a complete list see [the contributor page on GitHub](ht
 
 ## Thanks
 
-* @rmoriz - For the excellent [digital_ocean](https://github.com/rmoriz/digital_ocean) gem, which I used as a framework to setup this gem! :+1:
+* [@rmoriz](https://github.com/rmoriz) - For the excellent [digital_ocean](https://github.com/rmoriz/digital_ocean) gem, which I used as a framework to setup this gem! :+1:
 

data/lib/riot_api/api.rb

@@ -1,3 +1,5 @@
+require File.expand_path('../middleware/custom_logger', __FILE__)
+
 module RiotApi
   class API
 
@@ -22,7 +24,7 @@ module RiotApi
       @ssl                 = params[:ssl] || { :verify => true }
       @base_url            = params[:base_url]            || "http://prod.api.pvp.net/api/"
       @faraday_adapter     = params[:faraday_adapter]     || Faraday.default_adapter
-      @raise_status_errors = params[:raise_status_errors] || false
+      @raise_status_errors = params[:raise_status_errors] || true
       @faraday             = params[:faraday]             || default_faraday
       raise ArgumentError, ':api_key missing' unless @api_key
       raise ArgumentError, ':region missing' unless @region
@@ -55,11 +57,11 @@ module RiotApi
 
     def default_faraday
       Faraday.new(:url => @base_url, :ssl => @ssl) do |faraday|
-        faraday.use Faraday::Response::RaiseError if @raise_status_errors
+        faraday.use CustomLogger if @debug
         faraday.request  :url_encoded
         faraday.response :rashify
         faraday.response :json
-        faraday.response(:logger) if @debug
+        faraday.use Faraday::Response::RaiseError if @raise_status_errors
         faraday.adapter @faraday_adapter
         faraday.params['api_key'] = @api_key
         faraday.headers['User-Agent'] = "riot_api rubygem v#{RiotApi::VERSION}"

data/lib/riot_api/middleware/custom_logger.rb

@@ -0,0 +1,70 @@
+module RiotApi
+  class CustomLogger < Faraday::Middleware
+      extend Forwardable
+      def_delegators :@logger, :debug, :info, :warn, :error, :fatal
+
+      def initialize(app, options = {})
+        @app = app
+        @logger = options.fetch(:logger) {
+          require 'logger'
+          ::Logger.new($stdout)
+        }
+      end
+
+      def call(env)
+        start_time = Time.now
+        info  { request_info(env) }
+        debug { request_debug(env) }
+        @app.call(env).on_complete do
+          end_time = Time.now
+          response_time = end_time - start_time
+          info  { response_info(env, response_time) }
+          debug { response_debug(env) }
+        end
+      end
+
+      private
+
+      def filter(output)
+        unless ENV['DEBUG'] == '2'
+          output = output.to_s.gsub(/api_key=[a-zA-Z0-9-]*/,'api_key=[API-KEY]')
+        else
+          output
+        end
+      end
+
+      def request_info(env)
+        "Started %s request to: %s" % [ env[:method].to_s.upcase, filter(env[:url]) ]
+      end
+
+      def response_info(env, response_time)
+        "Response from %s; Status: %d; Time: %.1fms" % [ filter(env[:url]), env[:status], (response_time * 1_000.0) ]
+      end
+
+      def request_debug(env)
+        debug_message("Request", env[:request_headers], env[:body])
+      end
+
+      def response_debug(env)
+        debug_message("Response", env[:response_headers], env[:body])
+      end
+
+      def debug_message(name, headers, body)
+        <<-MESSAGE.gsub(/^ +([^ ])/m, '\\1')
+        #{name} Headers:
+        ----------------
+        #{format_headers(headers)}
+
+        #{name} Body:
+        -------------
+        #{body}
+        MESSAGE
+      end
+
+      def format_headers(headers)
+        length = headers.map {|k,v| k.to_s.size }.max
+        headers.map { |name, value| "#{name.to_s.ljust(length)} : #{filter(value)}" }.join("\n")
+      end
+
+  end
+end

data/lib/riot_api/model.rb

@@ -1,5 +1,13 @@
 require 'riot_api/model/base'
+require 'riot_api/model/champion'
+require 'riot_api/model/champion_stat'
+require 'riot_api/model/game'
+require 'riot_api/model/league'
+require 'riot_api/model/mastery_page'
+require 'riot_api/model/player_stat_summary'
+require 'riot_api/model/rune_page'
 require 'riot_api/model/summoner'
+require 'riot_api/model/team'
 
 module RiotApi
   module Model

data/lib/riot_api/model/champion.rb

@@ -0,0 +1,17 @@
+module RiotApi
+  module Model
+    class Champion < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :active, Boolean
+      attribute :attack_rank, Integer
+      attribute :bot_enabled, Boolean
+      attribute :bot_mm_enabled, Boolean
+      attribute :defense_rank, Integer
+      attribute :difficulty_rank, Integer
+      attribute :free_to_play, Boolean
+      attribute :magic_rank, Integer
+      attribute :ranked_play_enabled, Boolean
+    end
+  end
+end

data/lib/riot_api/model/champion_stat.rb

@@ -0,0 +1,13 @@
+require 'riot_api/model/statistic'
+
+module RiotApi
+  module Model
+    class ChampionStat < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :stats, Array[RiotApi::Model::Statistic]
+
+      alias :statistics :stats
+    end
+  end
+end

data/lib/riot_api/model/game.rb

@@ -0,0 +1,22 @@
+require 'riot_api/model/player'
+require 'riot_api/model/statistic'
+
+module RiotApi
+  module Model
+    class Game < Base
+      attribute :champion_id, Integer
+      attribute :create_date, String
+      attribute :create_date_str, String
+      attribute :fellow_players, Array[RiotApi::Model::Player]
+      attribute :game_id, Integer
+      attribute :game_mode, String
+      attribute :level, Integer
+      attribute :map_id, Integer
+      attribute :spell1, Integer
+      attribute :spell2, Integer
+      attribute :statistics, Array[RiotApi::Model::Statistic]
+      attribute :sub_type, String
+      attribute :team_id, Integer
+    end
+  end
+end

data/lib/riot_api/model/league.rb

@@ -0,0 +1,13 @@
+require 'riot_api/model/league_entry'
+
+module RiotApi
+  module Model
+    class League < Base
+      attribute :timestamp, Integer
+      attribute :name, String
+      attribute :tier, String
+      attribute :queue, String
+      attribute :entries, Array[RiotApi::Model::LeagueEntry]
+    end
+  end
+end

data/lib/riot_api/model/league_entry.rb

@@ -0,0 +1,21 @@
+module RiotApi
+  module Model
+    class LeagueEntry < Base
+      attribute :is_fresh_blood, Boolean
+      attribute :is_hot_streak, Boolean
+      attribute :is_inactive, Boolean
+      attribute :is_veteran, Boolean
+      attribute :last_played, Integer
+      attribute :league_name, String
+      attribute :league_points, Integer
+      attribute :losses, Integer
+      attribute :player_or_team_id, String
+      attribute :player_or_team_name, String
+      attribute :queue_type, String
+      attribute :rank, String
+      attribute :tier, String
+      attribute :time_until_decay, Integer
+      attribute :wins, Integer
+    end
+  end
+end

data/lib/riot_api/model/mastery_page.rb

@@ -0,0 +1,11 @@
+require 'riot_api/model/talent'
+
+module RiotApi
+  module Model
+    class MasteryPage < Base
+      attribute :current, Boolean
+      attribute :name, String
+      attribute :talents, Array[RiotApi::Model::Talent]
+    end
+  end
+end

data/lib/riot_api/model/match.rb

@@ -0,0 +1,17 @@
+module RiotApi
+  module Model
+    class Match < Base
+      attribute :assists, Integer
+      attribute :date, Integer
+      attribute :deaths, Integer
+      attribute :game_id, Integer
+      attribute :game_mode, String
+      attribute :invalid, Boolean
+      attribute :kills, Integer
+      attribute :map_id, Integer
+      attribute :opposing_team_kills, Integer
+      attribute :opposing_team_name, String
+      attribute :win, Boolean
+    end
+  end
+end

data/lib/riot_api/model/member.rb

@@ -0,0 +1,10 @@
+module RiotApi
+  module Model
+    class Member < Base
+      attribute :invite_date, Integer
+      attribute :join_date, Integer
+      attribute :player_id, Integer
+      attribute :status, String
+    end
+  end
+end

data/lib/riot_api/model/player.rb

@@ -0,0 +1,9 @@
+module RiotApi
+  module Model
+    class Player < Base
+      attribute :summoner_id, Integer
+      attribute :team_id,     Integer
+      attribute :champion_id, Integer
+    end
+  end
+end

data/lib/riot_api/model/player_stat_summary.rb

@@ -0,0 +1,12 @@
+module RiotApi
+  module Model
+    class PlayerStatSummary < Base
+      attribute :aggregated_stats, Array[RiotApi::Model::Statistic]
+      attribute :losses, Integer
+      attribute :modify_date, Integer
+      attribute :modify_date_str, String
+      attribute :player_stat_summary_type, String
+      attribute :wins, Integer
+    end
+  end
+end

data/lib/riot_api/model/roster.rb

@@ -0,0 +1,10 @@
+require 'riot_api/model/member'
+
+module RiotApi
+  module Model
+    class Roster < Base
+      attribute :member_list, Array[RiotApi::Model::Member]
+      attribute :owner_id, Integer
+    end
+  end
+end

data/lib/riot_api/model/rune.rb

@@ -0,0 +1,10 @@
+module RiotApi
+  module Model
+    class Rune < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :description, String
+      attribute :tier, Integer
+    end
+  end
+end

data/lib/riot_api/model/rune_page.rb

@@ -0,0 +1,12 @@
+require 'riot_api/model/rune_slot'
+
+module RiotApi
+  module Model
+    class RunePage < Base
+      attribute :current, Boolean
+      attribute :id, Integer
+      attribute :name, String
+      attribute :slots, Array[RiotApi::Model::RuneSlot]
+    end
+  end
+end

data/lib/riot_api/model/rune_slot.rb

@@ -0,0 +1,10 @@
+require 'riot_api/model/rune'
+
+module RiotApi
+  module Model
+    class RuneSlot < Base
+      attribute :rune, RiotApi::Model::Rune
+      attribute :rune_slot_id, Integer
+    end
+  end
+end

data/lib/riot_api/model/statistic.rb

@@ -0,0 +1,12 @@
+module RiotApi
+  module Model
+    class Statistic < Base
+      attribute :c,     Integer
+      attribute :id,    Integer
+      attribute :name,  String
+      attribute :value, Integer
+
+      alias :count :c
+    end
+  end
+end

data/lib/riot_api/model/talent.rb

@@ -0,0 +1,9 @@
+module RiotApi
+  module Model
+    class Talent < Base
+      attribute :id, Integer
+      attribute :name, String
+      attribute :rank, Integer
+    end
+  end
+end

data/lib/riot_api/model/team.rb

@@ -0,0 +1,26 @@
+require 'riot_api/model/match'
+require 'riot_api/model/roster'
+require 'riot_api/model/team_id'
+require 'riot_api/model/team_stat_summary'
+
+module RiotApi
+  module Model
+    class Team < Base
+      attribute :create_date, Integer
+      attribute :last_game_date, Integer
+      attribute :last_join_date, Integer
+      attribute :last_joined_ranked_team_queue_date, Integer
+      attribute :match_history, Array[RiotApi::Model::Match]
+      attribute :modify_date, Integer
+      attribute :name, String
+      attribute :roster, RiotApi::Model::Roster
+      attribute :second_last_join_date, Integer
+      attribute :status, String
+      attribute :tag, String
+      attribute :team_id, RiotApi::Model::TeamId
+      attribute :team_stat_summary, RiotApi::Model::TeamStatSummary
+      attribute :third_last_join_date, Integer
+      attribute :timestamp, Integer
+    end
+  end
+end

data/lib/riot_api/model/team_id.rb

@@ -0,0 +1,7 @@
+module RiotApi
+  module Model
+    class TeamId < Base
+      attribute :full_id, String
+    end
+  end
+end

data/lib/riot_api/model/team_stat_detail.rb

@@ -0,0 +1,13 @@
+require 'riot_api/model/team_id'
+
+module RiotApi
+  module Model
+    class TeamStatDetail < Base
+      attribute :average_games_played, Integer
+      attribute :losses, Integer
+      attribute :team_id, RiotApi::Model::TeamId
+      attribute :team_stat_type, String
+      attribute :wins, Integer
+    end
+  end
+end