brawlstars 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b439c0a3393ef502fa11f7dbebf6829bb328c25b9560292645fa341fbc18b15a
+  data.tar.gz: da99ada392dc99c10cc72e0f8501c6dedf7dbdf8646ec93d4ebfc697424e74b1
+SHA512:
+  metadata.gz: 9d364c8c2055703d946cb7117700899492ae3f389edfff3541f7f94746644c304a0c342fdf4fe60837271fa750135a20bb6252a0a627c9f039a14a5a707df45b
+  data.tar.gz: a47b21ab4c381eaee62ba9d86c5bb555838903a93b23807b50a13bc570e27920dc056edbd38dbf88556351a008d0dbb8f0a66099ace6ae44310538c531a102fc

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Karthik99999
+
+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,41 @@
+# brawlstarsrb
+
+brawlstarsrb is a Ruby implementation of [BrawlAPI](https://docs.brawlapi.cf), the unofficial Brawl Stars API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brawlstars'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brawlstars
+
+## Usage
+
+Example usage:
+```ruby
+require 'brawlstars'
+
+client = Brawlstars::Client.new(token: "token") # get this from discord.me/BrawlAPI
+player = client.getPlayer("LQL")
+puts player["name"]
+```
+More documentation can be found at [rubydoc](https://www.rubydoc.info/github/Karthik99999/brawlstarsrb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brawlapirb"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brawlstars.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "brawlstars/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "brawlstars"
+  spec.version       = Brawlstars::VERSION
+  spec.authors       = ["Karthik99999"]
+  spec.email         = ["bandagondak0217@gmail.com"]
+
+  spec.summary       = "BrawlAPI for Ruby"
+  spec.description   = "A Ruby implementation for BrawlAPI (https://docs.brawlapi.cf), the unofficial Brawl Stars API."
+  spec.homepage      = "https://github.com/Karthik99999/brawlstarsrb"
+  spec.license       = "MIT"
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  spec.add_dependency "httparty", "~> 0.17.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/brawlstars.rb

@@ -0,0 +1,123 @@
+require "httparty"
+require "brawlstars/tag"
+
+module Brawlstars
+  class Error < StandardError; end
+  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 400...600
+          raise "Error on request; Status code: #{res.code}; Message: #{res["message"]}"
+      end
+    end
+    
+    # Get info about the API
+    #
+    # @return [Hash] info about the API
+
+    def about
+      Client.get("/about")
+    end
+    
+    # Get a player by their tag
+    #
+    # @param tag [String] tag of the player to get.
+    # @return [Hash] data of the player that was searched.
+
+    def getPlayer(tag)
+      tag = validateTag(tag)
+      Client.get("/player?tag=#{tag}")
+    end
+    
+    # Search for players by their name
+    #
+    # @param name [String] name to search for.
+    # @return [Hash] players returned by the search.
+    
+    def playerSearch(name)
+      Client.get("/player/search?name=#{name.gsub(' ', '%20')}")
+    end
+    
+    # Get a club by its tag
+    #
+    # @param tag [String] tag of the club to get.
+    # @return [Hash] data of the club that was searched.
+    
+    def getClub(tag)
+      tag = validateTag(tag)
+      Client.get("/club?tag=#{tag}")
+    end
+    
+    # Search for clubs by their name
+    #
+    # @param name [String] name to search for.
+    # @return [Hash] clubs returned by the search.
+    
+    def clubSearch(name)
+      Client.get("/club/search?name=#{name.gsub(' ', '%20')}")
+    end
+    
+    # Get upcoming events
+    #
+    # @return [Hash] upcoming events
+    
+    def getUpcomingEvents
+      Client.get("/events?type=upcoming")
+    end
+    
+    # Get current events
+    #
+    # @return [Hash] current events
+    
+    def getCurrentEvents
+      Client.get("/events?type=current")
+    end
+    
+    # Get miscellaneous data, like shop/season reset
+    #
+    # @return [Hash] miscellaneous data
+    
+    def getMisc
+      Client.get("/misc")
+    end
+    
+    # Get top global clubs
+    #
+    # @param count [Integer] number of clubs to return.
+    # @return [Hash] clubs in order from 1st rank down.
+    
+    def getTopClubs(count=200)
+      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}")
+    end
+    
+    # Get top global clubs
+    #
+    # @param count [Integer] number of clubs to return.
+    # @param brawler [String] brawler leaderboard to return.
+    # @return [Hash] players in order from 1st rank down.
+    
+    def getTopPlayers(count=200, brawler="")
+      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}")
+    end
+  end
+end

data/lib/brawlstars/tag.rb

@@ -0,0 +1,9 @@
+def cleanTag(tag)
+  tag.upcase.sub('#', '').gsub('O', '0')
+end
+
+def validateTag(tag)
+  tag = cleanTag(tag)
+  raise "An invalid tag was given!" if !tag.match(/^[0289CGJLPQRUVY]+$/)
+  tag
+end

data/lib/brawlstars/version.rb

@@ -0,0 +1,3 @@
+module Brawlstars
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: brawlstars
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Karthik99999
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A Ruby implementation for BrawlAPI (https://docs.brawlapi.cf), the unofficial
+  Brawl Stars API.
+email:
+- bandagondak0217@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brawlstars.gemspec
+- lib/brawlstars.rb
+- lib/brawlstars/tag.rb
+- lib/brawlstars/version.rb
+homepage: https://github.com/Karthik99999/brawlstarsrb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: BrawlAPI for Ruby
+test_files: []