vainglory-api 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77529bebc4c054437e5568b468cab881c10e4c45
-  data.tar.gz: 0e605b5f0f1291c6b5ad72b5883c1b2a60087605
+  metadata.gz: 0a0ec37c93f459878f197bea42a61daa99ce355e
+  data.tar.gz: 5ba5b4926902a7b78449a519efb35a40d486a135
 SHA512:
-  metadata.gz: e3b5a08e3ee00f30e09f182b074a090f5944a74c863e8c0e0b38743394667f4d52b250216ab0f4f6d8e0bc5d463cd02a533486c86efeba5cbd3592955fd6da38
-  data.tar.gz: dd326e89fe122bbdaa7fe6cb92c5e7c29cdd49e4a64d5914b7b31f74b766b7e4f823824971009a4c832732d60f9fa8eb630f6b7559a9cafaf8c1289d2b4d032a
+  metadata.gz: b5092d4f44ef16a1238a4a6da6158fed310eaf52c1de5a1375f349f1035d22f39215a30cec0c518d85f1790eabdb4ec86b5b4ecca382d096e62182d84eed110d
+  data.tar.gz: a3ee5bbe1b1b1fa6e3ebdb8561ee46cbd284086ef1a12dd299e3f8b2ef38d5ea0466c1702f50576ccccf5508d9b204aadbf488519382c4f7596dc67374babbf3

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --require spec_helper
+--format d

data/CHANGELOG.md

@@ -1,6 +1,33 @@
-### 0.0.3 - 2017-03-28
+### 0.1.0
+_2017-06-16_
+
+- Adds `VaingloryAPI::Region` object
+- Validates `VaingloryAPI::Client` region at instantiation
+- Moves Gem date to `VaingloryAPI::RELEASE_DATE`
+- Adds shared RSpec example group for all lib specs
+- Changes default RSpec format to "documentation"
+- Updates README
+
+### 0.0.4
+_2017-06-23_
+
+- Adds a `CHANGELOG.md` to the repository
+- Adds Rubocop configurations
+- Adds YARD documentation
+- Removes and ignores `Gemfile.lock`
+- - Refreshes stored VCR cassettes
+- Splits `VaingloryAPI` and `VaingloryAPI::Client` specs
+
+#### Fixes
+- Fixes bug where where some match data was missing (see: https://github.com/cbortz/vainglory-api-ruby/issues/7)
+
+### 0.0.3
+_2017-03-28_
 - Ruby version >= 2.0 is required
 
-### 0.0.2 - 2017-03-28
+### 0.0.2
+_2017-03-28_
+
+### 0.0.1
+_2017-03-28_
 
-### 0.0.1 - 2017-03-28

data/Gemfile

@@ -1,2 +1,2 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 gemspec

data/README.md

@@ -1,12 +1,21 @@
-# vainglory-api
-[![Gem Version](https://badge.fury.io/rb/vainglory-api.svg)](https://badge.fury.io/rb/vainglory-api)
 [![Travis CI](https://travis-ci.org/cbortz/vainglory-api-ruby.svg?branch=master)](https://travis-ci.org/cbortz/vainglory-api-ruby)
 [![Code Climate](https://codeclimate.com/github/cbortz/vainglory-api-ruby/badges/gpa.svg)](https://codeclimate.com/github/cbortz/vainglory-api-ruby)
 [![Test Coverage](https://codeclimate.com/github/cbortz/vainglory-api-ruby/badges/coverage.svg)](https://codeclimate.com/github/cbortz/vainglory-api-ruby/coverage)
+[![Gem Version](https://img.shields.io/gem/v/vainglory-api.svg)](https://rubygems.org/gems/vainglory-api)
 [![Inline docs](http://inch-ci.org/github/cbortz/vainglory-api-ruby.svg?branch=master)](http://inch-ci.org/github/cbortz/vainglory-api-ruby)
+[![MIT License](https://img.shields.io/github/license/cbortz/vainglory-api-ruby.svg)](https://github.com/cbortz/vainglory-api-ruby/blob/master/LICENSE)
+
+# vainglory-api
+
+A Ruby libary wrapper for the Vainglory API
+
+- [Getting Started](https://github.com/cbortz/vainglory-api-ruby#getting-started)
+- [Installation](https://github.com/cbortz/vainglory-api-ruby#installation)
+- [Usage](https://github.com/cbortz/vainglory-api-ruby#usage)
+- [Contributing](https://github.com/cbortz/vainglory-api-ruby#contributing)
+- [License](https://github.com/cbortz/vainglory-api-ruby#license)
 
-- [YARD Documentation](http://www.rubydoc.info/github/cbortz/vainglory-api-ruby)
-- [Official Vainglory API Documentation](https://developer.vainglorygame.com/docs)
+See also: [YARD Documentation](http://www.rubydoc.info/github/cbortz/vainglory-api-ruby), [Official Vainglory API Documentation](https://developer.vainglorygame.com/docs)
 
 ---
 
@@ -14,7 +23,7 @@
 
 VaingloryAPI works with Ruby 2.0 onwards. Please refer to the [YARD Documentation](http://www.rubydoc.info/github/cbortz/vainglory-api-ruby) for a better understanding of how everything works.
 
-### Installation
+## Installation
 
 You can add it to your Gemfile with:
 
@@ -30,7 +39,7 @@ You can also install it manually with:
 gem install vainglory-api
 ```
 
-### Usage
+## Usage
 
 You can create an instance of the API client by initializing with your API key and [specified region](https://developer.vainglorygame.com/docs#regions) (`na` is the default):
 
@@ -38,7 +47,11 @@ You can create an instance of the API client by initializing with your API key a
 client = VaingloryAPI.new('YOUR_API_KEY', 'na')
 ```
 
-#### Helper Attributes
+### Region Errors
+
+A valid region short name is required when instantiating a client. Providing an invalid region short name will raise `VaingloryAPI::RegionNameError`.
+
+### Helper Attributes
 
 All client methods return an `OpenStruct` object containing the response attributes with some additional helper attributes.
 
@@ -50,7 +63,7 @@ response.success? # Returns true if the response code is less than 300
 response.raw      # The complete HTTP response
 ```
 
-#### Rate Limits
+### Rate Limits
 
 Each request will return data about your rate limits.
 
@@ -62,7 +75,7 @@ response.rate_reset     # The remaining window before the rate limit is refilled
 
 More information: https://developer.vainglorygame.com/docs#rate-limits
 
-#### Filtering
+### Filtering
 
 Currently, filters are supported by these client methods:
 
@@ -76,7 +89,7 @@ You can pass filters in as a hash using the exact Query Parameter key names outl
 client.matches('filter[playerNames]' => 'boombastic04,IHaveNoIdea')
 ```
 
-#### Methods
+### Methods
 
 To get __multiple matches__:
 
@@ -108,5 +121,10 @@ To get __Telemetry__ data, you must provide the data URL:
 client.telemetry('https://gl-prod-us-east-1.s3.amazonaws.com/assets/semc-vainglory/na/2017/03/28/03/07/b0bb7faf-1363-11e7-b11e-0242ac110006-telemetry.json')
 ```
 
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cbortz/vainglory-api-ruby.
+
 ## License
+
 [MIT License](LICENSE). Copyright 2017 Chet Bortz

data/lib/vainglory_api/client.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'ostruct'
 require 'openssl'
 require 'net/http'
+require 'vainglory_api/region'
 
 module VaingloryAPI
   # Used to interface with the official Vainglory API
@@ -20,9 +21,13 @@ module VaingloryAPI
     # @example Initialize a new client
     #   client = VaingloryAPI::Client.new('API_KEY', 'na')
     # @return [Client] a new instance of the client
+    # @note Requires a valid region short name.
+    # @see VaingloryAPI::Region::SHORT_NAMES
     def initialize(api_key, region = 'na')
       @api_key = api_key
       @region = region
+
+      validate_region
     end
 
     # Gets batches of random match data
@@ -73,11 +78,11 @@ module VaingloryAPI
     end
 
     # Gets data for a single match
+    #
     # @param [String] match_id the ID of the requested match
     # @example Get a single match
     #   client = VaingloryAPI::Client.new('API_KEY', 'na')
     #   client.match('MATCH_ID')
-    #
     # @return [OpenStruct] the response and metadata
     # @see https://developer.vainglorygame.com/docs#get-a-single-match Vainglory API "Get a single Match"
     # @see https://developer.vainglorygame.com/docs#rosters Vainglory API "Rosters"
@@ -168,6 +173,10 @@ module VaingloryAPI
 
     private
 
+    def validate_region
+      VaingloryAPI::Region.validate_short_name! @region
+    end
+
     def get_request_without_headers(uri)
       get_request(uri, false)
     end

data/lib/vainglory_api/region.rb

@@ -0,0 +1,125 @@
+require 'ostruct'
+
+module VaingloryAPI
+  # Helper class for metadata pertaining to regions
+  #
+  # @see https://developer.vainglorygame.com/docs#regions Vainglory API "Regions"
+  class Region
+    # Arrays of metadata about each region
+    DB = [
+      ['general', 'na', 'North America'],
+      ['general', 'eu', 'Europe'],
+      ['general', 'sa', 'South America'],
+      ['general', 'ea', 'East Asia'],
+      ['general', 'sg', 'Southeast Asia (SEA)'],
+      ['tournament', 'tournament-na', 'North America Tournaments'],
+      ['tournament', 'tournament-eu', 'Europe Tournaments'],
+      ['tournament', 'tournament-sa', 'South America Tournaments'],
+      ['tournament', 'tournament-ea', 'East Asia Tournaments'],
+      ['tournament', 'tournament-sg', 'Southeast Asia Tournaments']
+    ].freeze
+
+    # Unique Region types (general, tournament, etc...) extracted from DB metadata
+    TYPES = DB.map { |region_data| region_data[0] }.uniq.freeze
+
+    # Valid short names (na, eu, etc...) extracted from DB metadata
+    SHORT_NAMES = DB.map { |region_data| region_data[1] }.freeze
+
+    # @return [String] the name of the region
+    attr_reader :name
+
+    # @return [String] the short name of the region
+    attr_reader :short_name
+
+    # @return [String] the type of region
+    attr_reader :type
+
+    # A new instance of Region.
+    #
+    # @param (String) type the type of region (general, tournament, etc...)
+    # @param (String) short_name the short name of the region
+    # @param (String) name the name of the region
+    # @return [Region] a new instance of a Region
+    # @note Instantiation is private
+    def initialize(type, short_name, name)
+      @type = type
+      @short_name = short_name
+      @name = name
+    end
+
+    # Alias method for short name
+    #
+    # @return [String] the "short name" of the region
+    def abbreviation
+      @short_name
+    end
+
+    # Compares region to another region.
+    #
+    # @example Compare two regions
+    #   VaingloryAPI::Region['na'].eql? VaingloryAPI::Region['na'] # => true
+    #   VaingloryAPI::Region['na'].eql? VaingloryAPI::Region['sg'] # => false
+    # @param [VaingloryAPU::Region] other another region to compare for quality
+    # @return [Boolean] whether all attributes match
+    def eql?(other)
+      %i(name short_name type).all? { |a| send(a) == other.send(a) }
+    end
+
+    class << self
+      # Makes the contructor private
+      private :new
+
+      # Find a region by name or abbreviation ("short name")
+      #
+      # @example Finding a region
+      #   VaingloryAPI::Region.find('eu')
+      # @example Finding a region (alternative syntax)
+      #   VaingloryAPI::Region['eu'] # => <VaingloryAPI::Region ...>
+      # @param [String] identifier the target name or abbreviation of the region
+      # @return [Region] if the identifier is found
+      # @raise [VaingloryAPI::RegionNameError] if the identifier is not found
+      # @see DB
+      # @see SHORT_NAMES
+      def find(identifier)
+        new(*find_region_data(identifier)) rescue name_error(identifier)
+      end
+      alias [] find
+
+      # Checks if short name is known
+      #
+      # @example Checking if a short name is valid
+      #   VaingloryAPI::Region.valid_short_name?('na') # => true
+      #   VaingloryAPI::Region.valid_short_name?('QQ') # => false
+      # @param [String] short_name the short name of a desired region
+      # @return [Boolean] whether the short name is known
+      def valid_short_name?(short_name)
+        SHORT_NAMES.include?(short_name)
+      end
+
+      # Validates a short name
+      #
+      # @example Validating a short name
+      #   VaingloryAPI::Region.validate_short_name!('na') # => true
+      #   VaingloryAPI::Region.validate_short_name!('QQ') # VaingloryAPI::RegionNameError
+      # @param [String] short_name the short name of a desired region
+      # @return [True] if the short name is valid
+      # @raise [VaingloryAPI::RegionNameError] if the short name is invalid
+      def validate_short_name!(short_name)
+        valid_short_name?(short_name) or name_error(short_name)
+      end
+
+      private
+
+      def find_region_data(identifier)
+        DB.detect { |data| data[1, 2].include?(identifier) }
+      end
+
+      def name_error(identifier)
+        raise(RegionNameError, "Couldn't find region for '#{identifier}'")
+      end
+    end
+  end
+
+  # Helper exception class used to notify user of invalid names
+  class RegionNameError < ArgumentError; end
+end

data/lib/vainglory_api/version.rb

@@ -1,4 +1,7 @@
 module VaingloryAPI
   # Current gem version
-  VERSION = '0.0.4'.freeze
+  VERSION = '0.1.0'.freeze
+
+  # Release date of current version
+  RELEASE_DATE = '2017-06-16'.freeze
 end

data/spec/lib/vainglory_api/client_spec.rb

@@ -1,16 +1,19 @@
 require 'spec_helper'
 
 describe VaingloryAPI::Client, vcr: true do
-  subject(:klass) { Object.const_get(self.class.top_level_description) }
   let(:valid_api_key) { 'valid_api_key' }
-  let(:client) { klass.new(valid_api_key) }
+  let(:client) { subject.new(valid_api_key) }
   let(:cached_matches) { let_cassette('matches') { client.matches } }
   let(:cached_players) { cached_matches.included.select { |i| i.type == 'player' }}
 
-  context 'metadata' do
+  it 'validates the region' do
+    expect { subject.new('API KEY', 'QQ') }.to raise_error VaingloryAPI::RegionNameError
+  end
+
+  describe 'metadata' do
     it 'returns an error with an invalid API key' do
       VCR.use_cassette('api_key', record: :new_episodes) do
-        response = klass.new('invalid-api-key').samples
+        response = subject.new('invalid-api-key').samples
         expects_error_response(response, 401)
       end
     end
@@ -30,14 +33,14 @@ describe VaingloryAPI::Client, vcr: true do
     it 'supports multiple regions' do
       VCR.use_cassette('samples', record: :new_episodes) do
         %w(eu sa ea sg).each do |region|
-          response = klass.new(valid_api_key, region).samples
+          response = subject.new(valid_api_key, region).samples
           expects_success_response(response)
         end
       end
     end
   end
 
-  context '#status' do
+  describe '#status' do
     it 'returns a status object' do
       VCR.use_cassette('status') do
         response = client.status
@@ -52,7 +55,7 @@ describe VaingloryAPI::Client, vcr: true do
     end
   end
 
-  context '#players' do
+  describe '#players' do
     it 'returns an array of players with a valid name' do
       VCR.use_cassette('players', record: :new_episodes) do
         valid_names = cached_players[0, 2].map { |p| p.attributes.name }
@@ -73,7 +76,7 @@ describe VaingloryAPI::Client, vcr: true do
     end
   end
 
-  context '#player' do
+  describe '#player' do
     it 'returns a player with a valid ID' do
       VCR.use_cassette('player', record: :new_episodes) do
         cached_player_id = cached_players.first.id
@@ -109,7 +112,7 @@ describe VaingloryAPI::Client, vcr: true do
     end
   end
 
-  context '#matches' do
+  describe '#matches' do
     it 'returns an array of matches' do
       VCR.use_cassette('matches', record: :new_episodes) do
         response = client.matches
@@ -152,7 +155,7 @@ describe VaingloryAPI::Client, vcr: true do
     end
   end
 
-  context '#match' do
+  describe '#match' do
     it 'returns a match with a valid ID' do
       VCR.use_cassette('match', record: :new_episodes) do
         cached_match_id = cached_matches.data.first.id
@@ -189,7 +192,7 @@ describe VaingloryAPI::Client, vcr: true do
     end
   end
 
-  context 'telemetry' do
+  describe '#telemetry' do
     it 'returns telemetry data for a valid URL' do
       VCR.use_cassette('telemetry', record: :new_episodes) do
         response = client.telemetry('https://gl-prod-us-east-1.s3.amazonaws.com/assets/semc-vainglory/na/2017/03/28/03/07/b0bb7faf-1363-11e7-b11e-0242ac110006-telemetry.json')
@@ -204,19 +207,19 @@ describe VaingloryAPI::Client, vcr: true do
     end
   end
 
-  context '#teams' do
+  describe '#teams' do
     it 'raises error' do
       expect { client.teams }.to raise_error(NotImplementedError)
     end
   end
 
-  context '#team' do
+  describe '#team' do
     it 'raises error' do
       expect { client.team('team_id') }.to raise_error(NotImplementedError)
     end
   end
 
-  context '#link' do
+  describe '#link' do
     it 'raises error' do
       expect { client.link('link_id') }.to raise_error(NotImplementedError)
     end

data/spec/lib/vainglory_api/region_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe VaingloryAPI::Region do
+  describe '#abbreviation' do
+    it 'returns the short name' do
+      region = subject.find('ea')
+      expect(region.abbreviation).to eq region.short_name
+    end
+  end
+
+  describe '#eql?' do
+    let(:region) { VaingloryAPI::Region['na'] }
+
+    it 'returns TRUE when all attributes match' do
+      expect(region.eql?(VaingloryAPI::Region.find('na'))).to be true
+    end
+
+    it 'returns FALSE when any attribute does not match' do
+      expect(region.eql?(VaingloryAPI::Region.find('eu'))).to be false
+    end
+  end
+
+  describe '.new' do
+    it 'does not allow instantiation publicly' do
+      expect { subject.new(nil, nil, nil) }.to raise_error NoMethodError
+    end
+  end
+
+  describe '.find' do
+    it 'finds a region by name' do
+      expect(subject.find('North America')).to be_an_instance_of(subject)
+    end
+
+    it 'find a region by short name (abbreviation)' do
+      expect(subject.find('eu')).to be_an_instance_of(subject)
+    end
+
+    it 'raises an error when region not found' do
+      expect { subject.find('QQ') }.to raise_error VaingloryAPI::RegionNameError
+    end
+  end
+
+  describe '.[]' do
+    it 'aliases .find' do
+      expect(subject['na']).to eql subject.find('na')
+    end
+  end
+
+  describe '.valid_short_name?' do
+    it 'returns TRUE when the short name is found' do
+      expect(subject.valid_short_name?('tournament-sa')).to be true
+    end
+
+    it 'returns FALSE when the short name is not found' do
+      expect(subject.valid_short_name?('QQ')).to be false
+    end
+  end
+
+  describe '.validate_short_name!' do
+    it 'returns TRUE when the short name is found' do
+      expect(subject.validate_short_name!('tournament-sg')).to be true
+    end
+
+    it 'raises an error when the short name is not found' do
+      expect { subject.validate_short_name!('QQ') }.to raise_error VaingloryAPI::RegionNameError
+    end
+  end
+end

data/spec/lib/vainglory_api_spec.rb

@@ -1,10 +1,8 @@
 require 'spec_helper'
 
 describe VaingloryAPI do
-  subject(:klass) { Object.const_get(self.class.top_level_description) }
-
   it 'allows instantiation of a Client' do
-    client = klass.new('API_KEY')
-    expect(client).to be_an_instance_of(klass::Client)
+    client = subject.new('API_KEY')
+    expect(client).to be_an_instance_of(subject::Client)
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'webmock/rspec'
 require 'vcr'
 require 'rspec'
+require 'support/klasses'
 require 'simplecov'
 require 'vainglory_api'
 

data/spec/support/klasses.rb

@@ -0,0 +1,18 @@
+module KlassExampleGroup
+  def self.included(base)
+    base.instance_eval do
+      # Make the class available as `subject` in your examples:
+      subject { Object.const_get(self.class.top_level_description) }
+    end
+  end
+end
+
+
+RSpec.configure do |config|
+  # Tag service specs with `:service` metadata or put them in the spec/services dir
+  config.define_derived_metadata(:file_path => %r{/spec/lib/}) do |metadata|
+    metadata[:type] = :klass
+  end
+
+  config.include KlassExampleGroup, type: :klass
+end

data/vainglory_api.gemspec

@@ -4,8 +4,8 @@ require 'vainglory_api/version'
 Gem::Specification.new do |s|
   s.name        = 'vainglory-api'
   s.version     = VaingloryAPI::VERSION.dup
+  s.date        = VaingloryAPI::RELEASE_DATE.dup
   s.platform    = Gem::Platform::RUBY
-  s.date        = '2017-03-28'
   s.summary     = 'Vainglory API'
   s.description = 'A Ruby libary wrapper for the Vainglory API'
   s.authors     = ['Chet Bortz']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vainglory-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Chet Bortz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: webmock
@@ -96,6 +96,7 @@ files:
 - README.md
 - lib/vainglory_api.rb
 - lib/vainglory_api/client.rb
+- lib/vainglory_api/region.rb
 - lib/vainglory_api/version.rb
 - spec/cassettes/api_key.yml
 - spec/cassettes/match.yml
@@ -106,8 +107,10 @@ files:
 - spec/cassettes/status.yml
 - spec/cassettes/telemetry.yml
 - spec/lib/vainglory_api/client_spec.rb
+- spec/lib/vainglory_api/region_spec.rb
 - spec/lib/vainglory_api_spec.rb
 - spec/spec_helper.rb
+- spec/support/klasses.rb
 - vainglory_api.gemspec
 homepage: https://github.com/cbortz/vainglory-api-ruby
 licenses:
@@ -143,5 +146,7 @@ test_files:
 - spec/cassettes/status.yml
 - spec/cassettes/telemetry.yml
 - spec/lib/vainglory_api/client_spec.rb
+- spec/lib/vainglory_api/region_spec.rb
 - spec/lib/vainglory_api_spec.rb
 - spec/spec_helper.rb
+- spec/support/klasses.rb