sc2cli 0.1.1

data/lib/sc2cli/subcommands/league/leaguetiers.rb

@@ -0,0 +1,79 @@
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Subcommands
+
+###############################################################################
+
+    module LeagueShared
+
+###############################################################################
+
+      class LeagueTiers
+
+###############################################################################
+
+        @tiers
+
+###############################################################################
+
+        attr_reader :colour
+        attr_reader :name
+
+###############################################################################
+
+        def initialize(name:, colour:, json:)
+          @name   = name
+          @colour = colour
+          @tiers  = Array.new
+
+          if json.key?("tier") then
+            tiers = json["tier"]
+            @@console.fatal("Returned league information for: #{name} tiers is not an array!") unless tiers.kind_of?(Array)
+
+            tiers.each do |tier|
+              tier = LeagueTier.new(league: @name, colour: @colour, json: tier)
+              add(tier: tier)
+            end
+          end
+        end
+
+###############################################################################
+
+        def add(tier:)
+          @tiers << tier if tier.kind_of?(LeagueTier)
+          @tiers.sort_by!{ |tier| tier.id }
+        end
+
+###############################################################################
+
+        def to_s
+          result = String.new
+
+          @tiers.each do |tier|
+            result += tier.to_s
+          end
+
+          return result
+        end
+
+###############################################################################
+
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/subcommands/raw.rb

@@ -0,0 +1,89 @@
+###############################################################################
+
+require 'json'
+require 'optparse'
+
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Subcommands
+
+###############################################################################
+
+    class Raw
+
+###############################################################################
+
+      @@console = Shared::Console.instance
+
+###############################################################################
+
+      @configuration
+      @path
+      @region
+
+###############################################################################
+
+      def initialize(configuration:, options:)
+        @configuration = configuration
+
+        path   = nil
+        region = nil
+
+        OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} #{self.class.name.split("::").last.downcase} [options]"
+
+          opts.on("-h", "--help", "Prints this help") do
+            @@console.info(opts)
+            exit
+          end
+
+          opts.on("-p", "--path PATH", String, "The API path to query.") do |value|
+            path = value
+          end
+
+          opts.on("-r", "--region REGION", String, "Region name, such as 'eu' or 'us'. Use configuration region by default.") do |value|
+            region = Shared::Region.new(name: value)
+          end
+        end.parse!
+
+        region ||= @configuration.region
+
+        @@console.fatal("Raw path must be specified!") unless path.kind_of?(String)
+        @@console.fatal("Raw path must not be blank!") if path.empty?
+        @@console.fatal("Raw path must begin with '/'!") unless path.chars.first == "/"
+
+        @path   = path
+        @region = region
+      end
+
+###############################################################################
+
+      def run
+        @@console.info("Running raw API request:")
+        @@console.info(" - Path  : #{@path}")
+        @@console.info(" - Region: #{@region.description}")
+
+        api = Shared::Api.new(configuration: @configuration, region: @region)
+
+        result = api.get(path: @path)
+
+        @@console.info(JSON.pretty_generate(result))
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/subcommands/season.rb

@@ -0,0 +1,74 @@
+###############################################################################
+
+require 'optparse'
+
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Subcommands
+
+###############################################################################
+
+    class Season
+
+###############################################################################
+
+      @@console = Shared::Console.instance
+
+###############################################################################
+
+      @configuration
+      @region
+
+###############################################################################
+
+      def initialize(configuration:, options:)
+        @configuration = configuration
+
+        region = nil
+
+        OptionParser.new do |opts|
+          opts.banner = "Usage: #{$0} #{self.class.name.split("::").last.downcase} [options]"
+
+          opts.on("-h", "--help", "Prints this help") do
+            @@console.info(opts)
+            exit
+          end
+
+          opts.on("-r", "--region REGION", String, "Region name, such as 'eu' or 'us'. Use configuration region by default.") do |value|
+            region = Shared::Region.new(name: value)
+          end
+        end.parse!
+
+        region ||= @configuration.region
+
+        @region = region
+      end
+
+###############################################################################
+
+      def run
+        @@console.info("Running season API request:")
+        @@console.info(" - Region: #{@region.description}")
+
+        season = Shared::Season.new(configuration: @configuration, region: @region)
+
+        @@console.info(season.to_s)
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/version.rb

@@ -0,0 +1,13 @@
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  VERSION = "0.1.1"
+
+###############################################################################
+
+end
+
+###############################################################################

data/sc2cli.gemspec

@@ -0,0 +1,36 @@
+###############################################################################
+
+# frozen_string_literal: true
+
+###############################################################################
+
+require_relative "lib/sc2cli/version"
+
+###############################################################################
+
+Gem::Specification.new do |spec|
+  spec.name        = "sc2cli"
+  spec.version     = SC2Cli::VERSION
+  spec.authors     = ["Richard Lees"]
+  spec.email       = ["git0@bitservices.io"]
+
+  spec.summary     = "A command line utility for accessing the StarCraft 2 API written in Ruby."
+  spec.description = "A command line utility for accessing the StarCraft 2 API written in Ruby. Supports league boundaries, player league details, player match history and more."
+  spec.homepage    = "https://gitlab.com/rlees85-ruby/sc2cli/"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.metadata["homepage_uri"]    = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:archlinux|test|spec|features)/}) or f.match(%r{\Aavatar(?:_group)?\.png\z}) }
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end
+
+###############################################################################

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: sc2cli
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Richard Lees
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-27 00:00:00.000000000 Z
+dependencies: []
+description: A command line utility for accessing the StarCraft 2 API written in Ruby.
+  Supports league boundaries, player league details, player match history and more.
+email:
+- git0@bitservices.io
+executables:
+- sc2
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sc2
+- lib/sc2cli.rb
+- lib/sc2cli/shared.rb
+- lib/sc2cli/shared/api.rb
+- lib/sc2cli/shared/cache.rb
+- lib/sc2cli/shared/configuration.rb
+- lib/sc2cli/shared/console.rb
+- lib/sc2cli/shared/names.rb
+- lib/sc2cli/shared/region.rb
+- lib/sc2cli/shared/season.rb
+- lib/sc2cli/shared/token.rb
+- lib/sc2cli/subcommands.rb
+- lib/sc2cli/subcommands/history.rb
+- lib/sc2cli/subcommands/history/historymatch.rb
+- lib/sc2cli/subcommands/history/historymatches.rb
+- lib/sc2cli/subcommands/ladder.rb
+- lib/sc2cli/subcommands/ladder/ladderdetails.rb
+- lib/sc2cli/subcommands/ladder/ladderdetailsmembership.rb
+- lib/sc2cli/subcommands/ladder/ladderdetailsrank.rb
+- lib/sc2cli/subcommands/ladder/ladderdetailsteam.rb
+- lib/sc2cli/subcommands/ladder/ladderdetailsteammember.rb
+- lib/sc2cli/subcommands/ladder/ladderdetailsteammembers.rb
+- lib/sc2cli/subcommands/ladder/ladderdetailsteams.rb
+- lib/sc2cli/subcommands/ladder/laddersummary.rb
+- lib/sc2cli/subcommands/league.rb
+- lib/sc2cli/subcommands/league/leaguetier.rb
+- lib/sc2cli/subcommands/league/leaguetiers.rb
+- lib/sc2cli/subcommands/raw.rb
+- lib/sc2cli/subcommands/season.rb
+- lib/sc2cli/version.rb
+- sc2cli.gemspec
+homepage: https://gitlab.com/rlees85-ruby/sc2cli/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://gitlab.com/rlees85-ruby/sc2cli/
+  source_code_uri: https://gitlab.com/rlees85-ruby/sc2cli/
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: A command line utility for accessing the StarCraft 2 API written in Ruby.
+test_files: []