lolesports-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 402fad071f4b0f27a2c731639413bcfb082bd079
+  data.tar.gz: 11f981a8700e4c7094cb6e95bd89f55ce2d56dac
+SHA512:
+  metadata.gz: 4907a696a6a1fa4ae76479431b7a737e8cefcdf1e30e7ffdf4b8a90bd1831965735cb12dbcc6a6f3bc107482a29d3badb0aa0e9782a4fed16c81a4e074f06a3b
+  data.tar.gz: 2fc292e31cba432fad126ccaa1160204fe3b2b067a6cc731ca6fd84351139b7aaf9845bf3a857a86f9cc7cc0740c96642ee0329a4bd75dbd750fb80d1ba4402d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Documentation:
+  Enabled: false
+
+MethodLength:
+  Max: 20
+
+AbcSize:
+  Enabled: false
+
+FileName:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lolesports-api.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,25 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard :rubocop, all_on_start: false do
+  watch(/.+\.rb$/)
+  watch(/lolesports-api\.gemspec$/)
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jake Mays
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Lolesports::Api
+
+An easier API wrapper for the [lolesports.com](http://na.lolesports.com) API.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lolesports-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lolesports-api
+
+
+## Usage
+Remember, anywhere you'd like to use it:
+
+```ruby
+require 'lolesports-api'
+```
+### Base Methods
+
+A common rule throughout the API to keep in mind, is that no single command does multiple API calls.
+
+#### .find(id)
+
+Any given `LolesportsApi` class(apart from `LolesportsApi::Play`) has the find method. It returns a new instance of that class, with all related properties and objects.
+
+```ruby
+hai = LolesportsApi::Player.find(330)
+# => #<LolesportsApi::Player:0x007f9fb3509998 @name="Hai"...>
+```
+
+#### #reload
+From any given API object with an `@id` attribute, you can use reload to either update the object or load it with all of its endpoint data.
+
+```ruby
+hai.reload
+# => #<LolesportsApi::Player:0x007f9fb3509998 @name="Hai"...>
+```
+
+### Object Specific Methods
+
+#### .all
+
+This only exists for Leagues and Series. Returns an array of all instances of the object.
+
+```ruby
+leagues = LolesportsApi::League.all
+# => [#<LolesportsApi::League:0x007fd152dfe7f8>, #<LolesportsApi::League:0x00...]
+```
+
+## TODO
+* `LolesportsApi::Tournament.all`, since the API doesn't currently actually return all tournaments. [API Link](http://na.lolesports.com/api/swagger#!/api/getTournaments)
+* `LolesportsApi::Team` list of games. [API Link](http://na.lolesports.com/api/swagger#!/api/getSchedule)
+* Other less useful API objects.
+
+## Special Thanks
+* Thanks [@levi](https://twitter.com/levi) for [this](https://gist.github.com/levi/e7e5e808ac0119e154ce) documentation.
+* And obviously, thanks Riot. <3
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lolesports-api/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write tests.
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

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

data/lib/lolesports-api.rb

@@ -0,0 +1,14 @@
+require 'lolesports-api/version'
+require 'lolesports-api/base'
+require 'lolesports-api/player'
+require 'lolesports-api/team'
+require 'lolesports-api/game'
+require 'lolesports-api/play'
+require 'lolesports-api/match'
+require 'lolesports-api/tournament'
+require 'lolesports-api/league'
+require 'lolesports-api/series'
+
+module LolesportsApi
+  # Your code goes here...
+end

data/lib/lolesports-api/base.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'json'
+require 'date'
+
+module LolesportsApi
+  class BaseApiObject
+    SCHEDULE_URL = 'http://na.lolesports.com/api/schedule.json'
+
+    def self.find(base_id)
+      response = Faraday.get("#{self::API_URL}/#{base_id}.json")
+      @attributes = JSON.parse(response.body)
+      @attributes['id'] = base_id
+      @base_object = new(@attributes)
+    end
+
+    def reload
+      response = Faraday.get("#{self.class::API_URL}/#{@id}.json")
+      @attributes = JSON.parse(response.body)
+      initialize(@attributes)
+      self
+    end
+  end
+end

data/lib/lolesports-api/game.rb

@@ -0,0 +1,50 @@
+module LolesportsApi
+  class Game < LolesportsApi::BaseApiObject
+    attr_reader :id, :date_time, :game_length, :game_number,
+                :legs_url, :match_id, :max_games, :no_vods,
+                :platform_game_id, :platform_id, :players,
+                :tournament, :vods, :winner_id, :has_vod
+
+    attr_accessor :blue_team, :red_team
+
+    API_URL = 'http://na.lolesports.com/api/game'
+
+    def initialize(attributes = {})
+      @id = attributes['id'].to_i
+      @game_length = attributes['gameLength'].to_i
+      @game_number = attributes['gameNumber'].to_i
+      @legs_url = attributes['legsUrl']
+      @match_id = attributes['matchId'].to_i
+      @max_games = attributes['maxGames'].to_i
+      @no_vods = attributes['noVods']
+      @platform_game_id = attributes['platformGameId']
+      @platform_id = attributes['platformId']
+      @players = []
+      @tournament = attributes['tournament'] || {}
+      @vods = attributes['vods'] || {}
+      @winner_id = attributes['winnerId'].to_i
+      @has_vod = attributes['hasVod']
+      @date_time =
+        DateTime.parse(attributes['dateTime']) if attributes['dateTime']
+
+      prepare_teams(attributes)
+
+      self
+    end
+
+    def self.find(game_id)
+      super
+      @attributes['players'].each_value do |player|
+        @base_object.players << LolesportsApi::Play.new(player)
+      end
+      @base_object.prepare_teams(@attributes)
+      @base_object
+    end
+
+    def prepare_teams(attrs)
+      return unless attrs['contestants']
+      @blue_team = LolesportsApi::Team.new(attrs['contestants']['blue'])
+      @red_team = LolesportsApi::Team.new(attrs['contestants']['red'])
+    end
+  end
+end

data/lib/lolesports-api/league.rb

@@ -0,0 +1,66 @@
+module LolesportsApi
+  class League < LolesportsApi::BaseApiObject
+    attr_reader :id, :color, :default_series_id,
+                :default_tournament_id, :international_live_stream,
+                :label, :league_image, :league_series,
+                :league_tournaments, :menu_weight, :no_vods,
+                :published, :short_name, :url
+
+    API_URL = 'http://na.lolesports.com/api/league'
+
+    def initialize(attributes)
+      @id = attributes['id'].to_i
+      @color = attributes['color']
+      @default_series_id = attributes['defaultSeriesId'].to_i
+      @default_tournament_id = attributes['defaultTournamentId'].to_i
+      # International Live Stream is one giant cluster, watch out.
+      @international_live_stream = attributes['internationalLiveStream']
+      @label = attributes['label']
+      @league_image = attributes['leagueImage']
+      @league_series = []
+      @league_tournaments = []
+      @menu_weight = attributes['menuWeight']
+      @no_vods = attributes['noVods']
+      @published = attributes['published']
+      @short_name = attributes['shortName']
+      @url = attributes['url']
+
+      self
+    end
+
+    def self.find(league_id)
+      super
+      @attributes['leagueTournaments'].each do |tournament|
+        @base_object.league_tournaments <<
+          LolesportsApi::Tournament.new('id' => tournament)
+      end
+      @attributes['leagueSeries'].each do |series|
+        @base_object.league_series <<
+          LolesportsApi::Series.new('id' => series)
+      end
+      @base_object
+    end
+
+    def self.all
+      response = Faraday.get("#{API_URL}.json?parameters%5Bmethod%5D=all")
+      leagues_json = JSON.parse(response.body)
+      leagues = []
+      leagues_json['leagues'].each do |league|
+        leagues << new(league)
+      end
+      leagues
+    end
+
+    def name
+      @label
+    end
+
+    def series
+      @league_series
+    end
+
+    def tournaments
+      @league_tournaments
+    end
+  end
+end

data/lib/lolesports-api/match.rb

@@ -0,0 +1,52 @@
+module LolesportsApi
+  class Match < LolesportsApi::BaseApiObject
+    attr_reader :id, :blue_team, :red_team, :date_time, :games,
+                :is_finished, :is_live, :live_streams,
+                :max_games, :name, :polldaddy_id, :url,
+                :winner_id
+
+    attr_accessor :tournament
+
+    API_URL = 'http://na.lolesports.com/api/match'
+
+    def initialize(attributes = {})
+      @id = (attributes['id'] || attributes['matchId']).to_i
+      @date_time =
+        DateTime.parse(attributes['dateTime']) if attributes['dateTime']
+      @is_finished = attributes['isFinished']
+      @is_live = attributes['isLive']
+      @live_streams = attributes['liveStreams']
+      @max_games = attributes['maxGames']
+      @name = attributes['name']
+      @polldaddy_id = attributes['polldaddyId']
+      @tournament = LolesportsApi::Tournament.new(attributes['tournament'])
+      @url = attributes['url']
+      @winner_id = attributes['winnerId']
+
+      prepare_teams(attributes)
+      prepare_games(attributes)
+
+      self
+    end
+
+    def self.find(match_id)
+      super
+      @base_object.prepare_games(@attributes)
+      @base_object
+    end
+
+    def prepare_games(attrs)
+      return unless attrs['games']
+      @games = []
+      attrs['games'].each_value do |game|
+        @games << LolesportsApi::Game.new(game)
+      end
+    end
+
+    def prepare_teams(attrs)
+      return unless attrs['contestants']
+      @blue_team = LolesportsApi::Team.new(attrs['contestants']['blue'])
+      @red_team = LolesportsApi::Team.new(attrs['contestants']['red'])
+    end
+  end
+end

data/lib/lolesports-api/play.rb

@@ -0,0 +1,47 @@
+module LolesportsApi
+  class Play
+    attr_reader :assists, :champion_id, :deaths, :end_level,
+                :player_id, :items, :kda, :kills, :minions_killed,
+                :name, :photo_url, :spell0, :spell1, :team_id,
+                :total_gold, :player
+
+    def initialize(attributes = {})
+      @assists = attributes['assists']
+      @champion_id = attributes['championId']
+      @deaths = attributes['deaths']
+      @end_level = attributes['endLevel']
+      @player_id = attributes['id']
+      @items = processed_items(attributes)
+      @kda = attributes['kda']
+      @kills = attributes['kills']
+      @minions_killed = attributes['minionsKilled']
+      @name = attributes['name']
+      @photo_url = attributes['photoURL']
+      @spell0 = attributes['spell0'].to_i
+      @spell1 = attributes['spell1'].to_i
+      @team_id = attributes['teamId']
+      @total_gold = attributes['totalGold']
+
+      @player = prepare_player
+    end
+
+    private
+
+    def processed_items(attrs)
+      collected_items = []
+      attrs.each do |key, value|
+        collected_items << value.to_i if key.match(/^items\d$/)
+      end
+      collected_items
+    end
+
+    def prepare_player
+      LolesportsApi::Player.new(
+        'id' => @player_id,
+        'name' => @name,
+        'photoUrl' => @photo_url,
+        'teamId' => @team_id
+      )
+    end
+  end
+end

data/lib/lolesports-api/player.rb

@@ -0,0 +1,31 @@
+module LolesportsApi
+  class Player < LolesportsApi::BaseApiObject
+    attr_reader :id, :name, :bio, :first_name, :last_name,
+                :team_id, :role, :role_id, :is_starter,
+                :hometown, :contract_expiration, :photo_url,
+                :profile_url, :residency, :api_url
+
+    API_URL = 'http://na.lolesports.com/api/player'
+
+    def initialize(attributes = {})
+      @id = attributes['id'] || attributes['playerId'].to_i
+      @name = attributes['name']
+      @bio = attributes['bio']
+      @first_name = attributes['firstname']
+      @last_name = attributes['lastname']
+      @team_id = attributes['teamId']
+      @role = attributes['role']
+      @role_id = attributes['roleId']
+      @is_starter = attributes['isStarter']
+      @hometown = attributes['hometown']
+      @contract_expiration = attributes['contractExpiration']
+      @photo_url = attributes['photoUrl']
+      @profile_url = attributes['profileUrl']
+      @residency = attributes['residency']
+    end
+
+    def self.all
+      fail StandardError, 'No API endpoint available.'
+    end
+  end
+end