brawlstars 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db0f7033f39049ef0c73b45795a2785ff919d210c67c4cb13015b87706fb8158
-  data.tar.gz: 5596769126a3238f5ab7a5cd1aa8d2cfe060f07308aacfd80816286b2e8be229
+  metadata.gz: 8902a919795f60723f5a8f77e36569392a9b27e8878fe0e793055d41e3d2712f
+  data.tar.gz: 0c17121b5cd27736d9caf1f829c71ad2473180a28ccc2cdd99ecd2aab91cbe9f
 SHA512:
-  metadata.gz: 12f0ac279d0d76caa0386b1e33bd4ffa280f9f93d185572d96f65d0eccfd52161378083a11247f9c270e9a1bbeb32d3a4dc474ab2db5deb2ff90eb415e363e51
-  data.tar.gz: 2ebc2f83106133a9043e33253e2ba03dc9f352acc562efe76c6032a1ed9ae6d1b7f44f5e3516e5ea16a6caf47de966d0815fafde3d77f57dc69374e03b7d91e2
+  metadata.gz: 8777330e81cf08f1ab781d2beb0010b4c348ee17251d0399d3a5ae3f27ad9e9bfeaf630c3ebb5ff1b6839ac6219771ce89d9b0e30bc705c87eea52d8f736faa1
+  data.tar.gz: 804a12d588385539bd7cdb1a9629e694af9838c556499d75026b8776870d494c3b49c3b94df1fb2ad4ac5eb4bd10b76c4f0593b618fa2b84c23d825ad6332ca5

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+## [1.1.0]
+### Added
+- Custom Error Types
+
+## [1.0.0]
+Initial version
+
+[1.1.0]: https://github.com/Karthik99999/brawlstarsrb/tree/v1.1.0
+[1.0.0]: https://github.com/Karthik99999/brawlstarsrb/tree/v1.0.0

data/brawlstars.gemspec

@@ -20,6 +20,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = '>= 2.0.0'
   spec.post_install_message = "Brawlstarsrb is my name, GETting is my game!"
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/Karthik99999/brawlstarsrb/issues",
+    "changelog_uri"     => "https://github.com/Karthik99999/brawlstarsrb/CHANGELOG.md",
+    "documentation_uri" => "https://www.rubydoc.info/github/Karthik99999/brawlstarsrb",
+    "source_code_uri"   => "https://github.com/Karthik99999/brawlstarsrb"
+  }
   
   spec.add_dependency "httparty", "~> 0.17.0"
 

data/lib/brawlstars.rb

@@ -1,5 +1,6 @@
 require "httparty"
 require "brawlstars/tag"
+require "brawlstars/region"
 
 module Brawlstars
   class Error
@@ -13,6 +14,11 @@ module Brawlstars
         'The tag given was invalid.'
       end
     end
+    class RegionError < StandardError
+      def message
+        'The region must be a valid 2 character country code.'
+      end
+    end
     class NotFoundError < StandardError
       def message
         'The tag given was not found.'
@@ -37,35 +43,7 @@ module Brawlstars
   class Client
     def initialize(token: false)
       raise "No authorization token was given!" if !token
-      @@token = token
-    end
-    
-    # The method to send GET requests to the API
-    #
-    # @param ep [String] the endpoint to get.
-    # @return [Hash] the response returned by the endpoint.
-    
-    def self.get(ep)
-      url = "https://api.brawlapi.cf/v1#{ep}"
-      begin
-        res = HTTParty.get(url, {headers: {"Authorization" => @@token}})
-      rescue HTTParty::Error => e
-        puts e
-      end
-      case res.code
-        when 200
-          res
-        when 401
-          raise Error::Unauthorized
-        when 404
-          raise Error::NotFoundError
-        when 429
-          raise Error::RateLimitError
-        when 503
-          raise Error::MaintainanceError
-        when 500...600
-          raise Error::ServerError
-      end
+      @token = token
     end
     
     # Get info about the API
@@ -73,7 +51,7 @@ module Brawlstars
     # @return [Hash] info about the API
 
     def about
-      Client.get("/about")
+      get("/about")
     end
     
     # Get a player by their tag
@@ -83,7 +61,7 @@ module Brawlstars
 
     def getPlayer(tag)
       tag = validateTag(tag)
-      Client.get("/player?tag=#{tag}")
+      get("/player?tag=#{tag}")
     end
     
     # Search for players by their name
@@ -92,7 +70,17 @@ module Brawlstars
     # @return [Hash] players returned by the search.
     
     def playerSearch(name)
-      Client.get("/player/search?name=#{name.gsub(' ', '%20')}")
+      get("/player/search?name=#{name.gsub(' ', '%20')}")
+    end
+    
+    # Get a player's battle log by their tag
+    #
+    # @param tag [String] tag of the player to get.
+    # @return [Hash] data of the player's battle log that was searched.
+    
+    def getBattleLog(tag)
+      tag = validateTag(tag)
+      get("/player/battlelog?tag=#{tag}")
     end
     
     # Get a club by its tag
@@ -102,7 +90,7 @@ module Brawlstars
     
     def getClub(tag)
       tag = validateTag(tag)
-      Client.get("/club?tag=#{tag}")
+      get("/club?tag=#{tag}")
     end
     
     # Search for clubs by their name
@@ -111,7 +99,7 @@ module Brawlstars
     # @return [Hash] clubs returned by the search.
     
     def clubSearch(name)
-      Client.get("/club/search?name=#{name.gsub(' ', '%20')}")
+      get("/club/search?name=#{name.gsub(' ', '%20')}")
     end
     
     # Get upcoming events
@@ -119,7 +107,7 @@ module Brawlstars
     # @return [Hash] upcoming events
     
     def getUpcomingEvents
-      Client.get("/events?type=upcoming")
+      get("/events?type=upcoming")
     end
     
     # Get current events
@@ -127,7 +115,7 @@ module Brawlstars
     # @return [Hash] current events
     
     def getCurrentEvents
-      Client.get("/events?type=current")
+      get("/events?type=current")
     end
     
     # Get miscellaneous data, like shop/season reset
@@ -135,30 +123,64 @@ module Brawlstars
     # @return [Hash] miscellaneous data
     
     def getMisc
-      Client.get("/misc")
+      get("/misc")
     end
     
     # Get top global clubs
     #
     # @param count [Integer] number of clubs to return.
+    # @param region [String] 2 character country code for the region of leaderboard to return.
     # @return [Hash] clubs in order from 1st rank down.
     
-    def getTopClubs(count=200)
+    def getTopClubs(count=200, region="global")
       raise 'Count must be a number.' if !count.is_a? Integer
       raise 'Count must be between 1 and 200.' if !count.between?(1,200)
-      Client.get("/leaderboards/clubs?count=#{count}")
+      validateRegion(region)
+      get("/leaderboards/clubs?count=#{count}&region=#{region}")
     end
     
     # Get top global players
     #
     # @param count [Integer] number of players to return.
     # @param brawler [String] brawler leaderboard to return.
+    # @param region [String] 2 character country code for the region of leaderboard to return.
     # @return [Hash] players in order from 1st rank down.
     
-    def getTopPlayers(count=200, brawler="")
+    def getTopPlayers(count=200, brawler="", region="global")
       raise 'Count must be a number.' if !count.is_a? Integer
       raise 'Count must be between 1 and 200.' if !count.between?(1,200)
-      Client.get("/leaderboards/players?count=#{count}&brawler=#{brawler}")
+      validateRegion(region)
+      get("/leaderboards/players?count=#{count}&brawler=#{brawler}&region=#{region}")
+    end
+    
+    protected
+    
+    # The method to send GET requests to the API
+    #
+    # @param ep [String] the endpoint to get.
+    # @return [Hash] the response returned by the endpoint.
+      
+    def get(ep)
+      url = "https://api.brawlapi.cf/v1#{ep}"
+      begin
+        res = HTTParty.get(url, {headers: {"Authorization" => @token}})
+      rescue HTTParty::Error => e
+        puts e
+      end
+      case res.code
+        when 200
+          res
+        when 401
+          raise Error::Unauthorized
+        when 404
+          raise Error::NotFoundError
+        when 429
+          raise Error::RateLimitError
+        when 503
+          raise Error::MaintainanceError
+        when 500...600
+          raise Error::ServerError
+      end
     end
   end
 end

data/lib/brawlstars/region.rb

@@ -0,0 +1,3 @@
+def validateRegion(region)
+  raise Brawlstars::Error::RegionError if (region != "global" and region.length != 2)
+end

data/lib/brawlstars/version.rb

@@ -1,3 +1,3 @@
 module Brawlstars
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brawlstars
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Karthik99999
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-24 00:00:00.000000000 Z
+date: 2019-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -61,6 +61,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -69,12 +70,17 @@ files:
 - bin/setup
 - brawlstars.gemspec
 - lib/brawlstars.rb
+- lib/brawlstars/region.rb
 - lib/brawlstars/tag.rb
 - lib/brawlstars/version.rb
 homepage: https://github.com/Karthik99999/brawlstarsrb
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/Karthik99999/brawlstarsrb/issues
+  changelog_uri: https://github.com/Karthik99999/brawlstarsrb/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/github/Karthik99999/brawlstarsrb
+  source_code_uri: https://github.com/Karthik99999/brawlstarsrb
 post_install_message: Brawlstarsrb is my name, GETting is my game!
 rdoc_options: []
 require_paths:
@@ -90,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: BrawlAPI for Ruby