blizzard_api 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bf4766a30de47652d2693fb7480ef30e5ef6559fbc6f3bb7cad50a35ab4b1a6
-  data.tar.gz: 447d04397f442f5b7ad4fab941bf54fba397f7b855a26bfd62e67cefad30f78f
+  metadata.gz: bf8d2354d8c5693db38cc06fb9a531ea3088c2ef03df14de07369e7b3bf30e3b
+  data.tar.gz: 05fd0395084f152722138b93bed892ceb5cbb826563aae96830b5f4d85acfd0b
 SHA512:
-  metadata.gz: 851bdad8472fcaf5e385b8caba51376636ea30be09ee79ecb5a383971196945574b8a3073b465f940a3aee123f885ab5358d3f2ba6bcf5eb38fb59da5bcdb660
-  data.tar.gz: 48bfe00c18fea3f3d296f1b49e800e54c67ff1a6b8e5972086e4d2f95cc014b5751e53c10a526a4e2bf103342cdea6c441a2987e59e00b5c0cfdc2d3d16d4334
+  metadata.gz: fcc914e44f283a236eccd316601f175925d0304b34a6dae3dd5a69c5c441cbd5b8f7ba9e7f4b1080375a7b53f82bb93e5e273deedeba1586e612ea7eb6368066
+  data.tar.gz: 5a28789fa6f1839f4a81a8de96756a6d8b7a6ae5ae7c25f9b6f9747f4acd9fd0e7a762ed29f0578465141a278510bf7a211308e4701c1aca1f6d16b8d53bd600

data/.github/workflows/ruby.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+        with:
+          ruby-version: 2.6
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          BNET_APPLICATION_ID: ${{ secrets.BNET_APPLICATION_ID }}
+          BNET_APPLICATION_SECRET: ${{ secrets.BNET_APPLICATION_SECRET }}
+          USE_CACHE: false

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.5.3**
+
+Added missing legacy SC2 endpoints
+
+See https://github.com/francis-schiavo/blizzard_api/pull/2
+
 **Version 0.5.2**
 
 Added new endpoints: https://us.forums.blizzard.com/en/blizzard/t/wow-shadowlands-api-update-covenenats-soulbinds-more/13385

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.5.1)
+    blizzard_api (0.5.2)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
@@ -10,24 +10,24 @@ GEM
     ast (2.4.1)
     dotenv (2.7.6)
     minitest (5.14.2)
-    parallel (1.19.2)
-    parser (2.7.1.5)
+    parallel (1.20.1)
+    parser (2.7.2.0)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.2.2)
-    regexp_parser (1.8.0)
+    redis (4.2.5)
+    regexp_parser (2.0.0)
     rexml (3.2.4)
-    rubocop (0.92.0)
+    rubocop (0.93.1)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.5.0)
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.6.0)
+    rubocop-ast (1.3.0)
       parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
     unicode-display_width (1.7.0)

data/README.md

@@ -1,9 +1,7 @@
 # Blizzard Api
 
-[![pipeline status](https://gitlab.com/francisschiavo/blizzard_api/badges/master/pipeline.svg)](https://gitlab.com/francisschiavo/blizzard_api/commits/master)
 [![Gem Version](https://badge.fury.io/rb/blizzard_api.svg)](https://badge.fury.io/rb/blizzard_api)
 
-
 This gem allow you to interface with the new blizzard api (2018) using the OAuth2 protocol for every request.
 
 **Important**: This gem does not support, nor will support China endpoints. 
@@ -351,7 +349,7 @@ Every endpoint requiring a *region_id* parameter will accepts either the integer
 
 ## Contributing
 
-Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/francisschiavo/blizzard_api/issues
+Bug reports and pull requests are welcome on Github at https://github.com/francis-schiavo/blizzard_api/issues
 
 ## License
 

data/blizzard_api.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |spec|
   spec.name = 'blizzard_api'
   spec.version = BlizzardApi::VERSION
   spec.authors = ['Francis Schiavo']
-  spec.email = ['francis.schiavo@francisschiavo.com']
+  spec.email = ['francis@schiavo.dev']
   spec.summary = 'Unofficial Ruby client for Blizzard Entertainment API'
   spec.description = 'This is a simple interface to obtain data from Blizzard API'
-  spec.homepage = 'https://gitlab.com/francisschiavo/blizzard_api'
+  spec.homepage = 'https://github.com/francis-schiavo/blizzard_api'
   spec.license = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://gitlab.com/francisschiavo/blizzard_api'
-  spec.metadata['changelog_uri'] = 'https://gitlab.com/francisschiavo/blizzard_api/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/francis-schiavo/blizzard_api'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/francis-schiavo/blizzard_api/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/francis-schiavo/blizzard_api/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/blizzard_api'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/blizzard_api/request.rb

@@ -17,7 +17,7 @@
 
 ##
 # @!macro [new] response
-#   @return [OpenStruct,Array] API Response. The actual type of the returned object depends on the *format* option
+#   @return [Hash] API Response. The actual type of the returned object depends on the *format* option
 #   in the configuration module
 
 ##

data/lib/blizzard_api/starcraft.rb

@@ -19,6 +19,7 @@ module BlizzardApi
     require_relative 'starcraft/community/profile'
     require_relative 'starcraft/community/ladder'
     require_relative 'starcraft/community/account'
+    require_relative 'starcraft/community/legacy'
 
     ##
     # @param region [String] API Region
@@ -40,5 +41,11 @@ module BlizzardApi
     def self.account(region = BlizzardApi.region)
       BlizzardApi::Starcraft::Account.new(region)
     end
+    
+    ##
+    # @return {Legacy}
+    def self.legacy
+      BlizzardApi::Starcraft::Legacy.new
+    end
   end
 end

data/lib/blizzard_api/starcraft/community/legacy.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II legacy data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.legacy
+    class Legacy < Starcraft::Request
+      
+      ##
+      # Profile data
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def profile(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+      end
+
+      ##
+      # Ladders
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def ladders(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", opts
+      end
+
+      ##
+      # Match History
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def match(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", opts
+      end
+      
+      ##
+      # Ladder
+      #
+      # @!macro sc2_regions
+      # @param [Integer] ladder_id Ladder ID
+      # @!macro request_options
+      def ladder(region_id, ladder_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", opts
+      end
+      
+      ##
+      # Achievement data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def achievements(region_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", opts
+      end
+      
+      ##
+      # Rewards data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def rewards(region_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", opts
+      end
+    end
+  end
+end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-18 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -102,13 +102,13 @@ dependencies:
         version: '0'
 description: This is a simple interface to obtain data from Blizzard API
 email:
-- francis.schiavo@francisschiavo.com
+- francis@schiavo.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
@@ -146,6 +146,7 @@ files:
 - lib/blizzard_api/starcraft.rb
 - lib/blizzard_api/starcraft/community/account.rb
 - lib/blizzard_api/starcraft/community/ladder.rb
+- lib/blizzard_api/starcraft/community/legacy.rb
 - lib/blizzard_api/starcraft/community/profile.rb
 - lib/blizzard_api/starcraft/game_data/league.rb
 - lib/blizzard_api/starcraft/request.rb
@@ -192,13 +193,15 @@ files:
 - lib/blizzard_api/wow/search/search_composer.rb
 - lib/blizzard_api/wow/search/search_request.rb
 - lib/blizzard_api/wow/slug.rb
-homepage: https://gitlab.com/francisschiavo/blizzard_api
+homepage: https://github.com/francis-schiavo/blizzard_api
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/francisschiavo/blizzard_api
-  source_code_uri: https://gitlab.com/francisschiavo/blizzard_api
-  changelog_uri: https://gitlab.com/francisschiavo/blizzard_api/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/francis-schiavo/blizzard_api
+  source_code_uri: https://github.com/francis-schiavo/blizzard_api
+  bug_tracker_uri: https://github.com/francis-schiavo/blizzard_api/issues
+  changelog_uri: https://github.com/francis-schiavo/blizzard_api/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/blizzard_api
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.gitlab-ci.yml

@@ -1,12 +0,0 @@
-image: ruby:2.6
-
-stages:
-  - test
-
-test:
-  stage: test
-  script:
-    - gem install bundler -v 2.1.2
-    - bundle install
-    - rubocop
-    - rake