halcyon_api 0.0.5

data/spec/lib/halcyon_api/client_spec.rb

@@ -0,0 +1,249 @@
+require 'spec_helper'
+
+describe HalcyonAPI::Client, vcr: true do
+  let(:valid_api_key) { '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' }}
+
+  it 'validates the region' do
+    expect { subject.new('API KEY', 'QQ') }.to raise_error HalcyonAPI::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 = subject.new('invalid-api-key').samples
+        expects_error_response(response, 401)
+      end
+    end
+
+    it 'returns success and API rate limit information' do
+      VCR.use_cassette('samples', record: :new_episodes) do
+        response = client.samples
+
+        expects_success_response(response)
+        expects_presence(response, :data)
+        expect(response.rate_limit).to be_a(Integer)
+        expect(response.rate_remaining).to be_a(Integer)
+        expect(response.rate_reset).to be_a(Integer)
+      end
+    end
+
+    it 'supports multiple regions' do
+      VCR.use_cassette('samples', record: :new_episodes) do
+        %w(eu sa ea sg).each do |region|
+          response = subject.new(valid_api_key, region).samples
+          expects_success_response(response)
+        end
+      end
+    end
+  end
+
+  describe '#status' do
+    it 'returns a status object' do
+      VCR.use_cassette('status') do
+        response = client.status
+
+        expects_success_response(response)
+        expects_presence(response, :data)
+        expect(response.data.type).to be_a(String)
+        expect(response.data.id).to be_a(String)
+        expect(response.data.attributes.releasedAt).to be_a(String)
+        expect(response.data.attributes.version).to be_a(String)
+      end
+    end
+  end
+
+  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 }
+        response = client.players(*valid_names)
+
+        expects_success_response(response)
+        expects_presence(response, :data, :links, :meta)
+        expect(response.data).to be_a(Array)
+        expect(response.data.length).to be > 0
+      end
+    end
+
+    it 'returns error with an valid name' do
+      VCR.use_cassette('players', record: :new_episodes) do
+        response = client.players('TheRealKrul')
+        expects_error_response(response)
+      end
+    end
+  end
+
+  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
+        response = client.player(cached_player_id)
+
+        player = response.data
+
+        expects_success_response(response)
+        expects_presence(response, :data, :links, :meta)
+
+        expect(player.type).to eq 'player'
+        expect(player.id).to eq cached_player_id
+        expect(player.attributes.createdAt).to be_a(String)
+        expect(player.attributes.name).to be_a(String)
+        expect(player.attributes.shardId).to be_a(String)
+        expect(player.attributes.stats.level).to be_a(Integer)
+        expect(player.attributes.stats.lifetimeGold).to be_a(Float)
+        expect(player.attributes.stats.lossStreak).to be_a(Integer)
+        expect(player.attributes.stats.played).to be_a(Integer)
+        expect(player.attributes.stats.played_ranked).to be_a(Integer)
+        expect(player.attributes.stats.winStreak).to be_a(Integer)
+        expect(player.attributes.stats.wins).to be_a(Integer)
+        expect(player.attributes.stats.xp).to be_a(Integer)
+        expect(player.attributes.titleId).to be_a(String)
+      end
+    end
+
+    it 'returns an error with an invalid ID' do
+      VCR.use_cassette('players', record: :new_episodes) do
+        response = client.player('invalid-id')
+        expects_error_response(response)
+      end
+    end
+  end
+
+  describe '#matches' do
+    it 'returns an array of matches' do
+      VCR.use_cassette('matches', record: :new_episodes) do
+        response = client.matches
+
+        expects_success_response(response)
+        expects_presence(response, :data, :included, :links, :meta)
+        expect(response.data).to be_a(Array)
+        expect(response.data.length).to be > 0
+      end
+    end
+
+    it 'returns the number of matches specified by a filter' do
+      VCR.use_cassette('matches', record: :new_episodes) do
+        response = client.matches('page[limit]' => 1)
+
+        expects_success_response(response)
+        expects_presence(response, :data, :included, :links, :meta)
+        expect(response.data).to be_a(Array)
+        expect(response.data.length).to eq 1
+      end
+    end
+
+    it 'returns an array of matches with valid player name filter' do
+      player_name = cached_players.first.attributes.name
+      VCR.use_cassette('matches', record: :new_episodes) do
+        response = client.matches('filter[playerNames]' => player_name)
+
+        expects_success_response(response)
+        expects_presence(response, :data, :included, :links, :meta)
+        expect(response.data).to be_a(Array)
+        expect(response.data.length).to be > 0
+      end
+    end
+
+    it 'returns an error with invalid player name filter' do
+      VCR.use_cassette('matches', record: :new_episodes) do
+        response = client.matches('filter[playerNames]' => 'TheRealKrul')
+        expects_error_response(response)
+      end
+    end
+  end
+
+  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
+        response = client.match(cached_match_id)
+        game_match = response.data
+
+        expects_success_response(response)
+        expects_presence(response, :data, :included, :links, :meta)
+        expect(game_match.type).to eq 'match'
+        expect(game_match.id).to eq cached_match_id
+        expect(game_match.attributes.createdAt).to be_a(String)
+        expect(game_match.attributes.duration).to be_a(Integer)
+        expect(game_match.attributes.gameMode).to be_a(String)
+        expect(game_match.attributes.patchVersion).to be_a(String)
+        expect(game_match.attributes.shardId).to be_a(String)
+        expect(game_match.attributes.stats.endGameReason).to be_a(String)
+        expect(game_match.attributes.stats.queue).to be_a(String)
+        expect(game_match.attributes.titleId).to be_a(String)
+        expect(game_match.relationships.assets.data).to be_a(Array)
+        expect(game_match.relationships.assets.data[0].type).to be_a(String)
+        expect(game_match.relationships.assets.data[0].id).to be_a(String)
+        expect(game_match.relationships.rosters.data).to be_a(Array)
+        expect(game_match.relationships.rosters.data.length).to be_a(Integer)
+        expect(game_match.relationships.rounds.data).to be_a(Array)
+        expect(game_match.relationships.rounds.data.length).to be_a(Integer)
+      end
+    end
+
+    it 'returns an error with an invalid ID' do
+      VCR.use_cassette('match', record: :new_episodes) do
+        response = client.match('invalid-id')
+        expects_error_response(response)
+      end
+    end
+  end
+
+  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')
+
+        expects_success_response(response)
+        expect(response.data).to be_a Array
+        expect(response.data[0].time).to be_a(String)
+        expect(response.data[0].type).to be_a(String)
+        expect(response.data[0].payload.Team).to be_a(String)
+        expect(response.data[0].payload.Actor).to be_a(String)
+      end
+    end
+  end
+
+  describe '#teams' do
+    it 'raises error' do
+      expect { client.teams }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#team' do
+    it 'raises error' do
+      expect { client.team('team_id') }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe '#link' do
+    it 'raises error' do
+      expect { client.link('link_id') }.to raise_error(NotImplementedError)
+    end
+  end
+
+  def expects_presence(obj, *attrs)
+    attrs.each do |attr_name|
+      expect(obj.send(attr_name)).to_not be_nil
+    end
+  end
+
+  def expects_success_response(response)
+    expect(response.code).to eq 200
+    expect(response.success?).to be true
+  end
+
+  def expects_error_response(response, response_code = 404)
+    expect(response.code).to eq response_code
+    expect(response.success?).to be false
+  end
+
+  def let_cassette(cassette_name)
+    VCR.use_cassette(cassette_name, record: :new_episodes) do
+      yield
+    end
+  end
+end

data/spec/lib/halcyon_api/region_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe HalcyonAPI::Region do
+  describe '#abbreviation' do
+    it 'returns the short name' do
+      region = subject.new('ea')
+      expect(region.abbreviation).to eq region.short_name
+    end
+  end
+
+  describe '#eql?' do
+    let(:region) { HalcyonAPI::Region['na'] }
+
+    it 'returns TRUE when all attributes match' do
+      expect(region.eql?(HalcyonAPI::Region.new('na'))).to be true
+    end
+
+    it 'returns FALSE when any attribute does not match' do
+      expect(region.eql?(HalcyonAPI::Region.new('eu'))).to be false
+    end
+  end
+
+  describe '.new' do
+    it 'instantiates a Region from the DB matching the identifier' do
+      expect(subject.new('North America')).to be_an_instance_of(subject)
+    end
+
+    it 'find a region by short name (abbreviation)' do
+      expect(subject.new('eu')).to be_an_instance_of(subject)
+    end
+
+    it 'raises an error when region identifier not found' do
+      expect { subject.new('QQ') }.to raise_error HalcyonAPI::RegionNameError
+    end
+  end
+
+  describe '.find' do
+    it 'aliases .new' do
+      expect(subject.find('na')).to eql subject.new('na')
+    end
+  end
+
+  describe '.[]' do
+    it 'aliases .new' do
+      expect(subject['na']).to eql subject.new('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 '.detect_region_info' do
+    it 'returns an Array of region data when identifier is found' do
+      region_info = subject.detect_region_info('na')
+      expect(region_info).to be_an_instance_of(Array)
+    end
+
+    it 'returns nil when identifier is not found' do
+      region_info = subject.detect_region_info('QQ')
+      expect(region_info).to be_nil
+    end
+  end
+end

data/spec/lib/halcyon_api_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe HalcyonAPI do
+  it 'allows instantiation of a Client' do
+    client = subject.new('API_KEY')
+    expect(client).to be_an_instance_of(subject::Client)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,117 @@
+require 'webmock/rspec'
+require 'vcr'
+require 'rspec'
+require 'support/klasses'
+require 'simplecov'
+require 'halcyon_api'
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+end
+
+SimpleCov.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

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

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: halcyon_api
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Ethan Tang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: A Ruby libary wrapper for the Vainglory API
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- halcyon_api.gemspec
+- lib/halcyon_api.rb
+- lib/halcyon_api/client.rb
+- lib/halcyon_api/region.rb
+- lib/halcyon_api/version.rb
+- spec/cassettes/api_key.yml
+- spec/cassettes/match.yml
+- spec/cassettes/matches.yml
+- spec/cassettes/player.yml
+- spec/cassettes/players.yml
+- spec/cassettes/samples.yml
+- spec/cassettes/status.yml
+- spec/cassettes/telemetry.yml
+- spec/lib/halcyon_api/client_spec.rb
+- spec/lib/halcyon_api/region_spec.rb
+- spec/lib/halcyon_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/klasses.rb
+homepage: https://github.com/shikatadev/halcyon_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: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Vainglory API
+test_files:
+- spec/cassettes/api_key.yml
+- spec/cassettes/match.yml
+- spec/cassettes/matches.yml
+- spec/cassettes/player.yml
+- spec/cassettes/players.yml
+- spec/cassettes/samples.yml
+- spec/cassettes/status.yml
+- spec/cassettes/telemetry.yml
+- spec/lib/halcyon_api/client_spec.rb
+- spec/lib/halcyon_api/region_spec.rb
+- spec/lib/halcyon_api_spec.rb
+- spec/spec_helper.rb
+- spec/support/klasses.rb