sc2cli 0.1.1

data/lib/sc2cli/shared/console.rb

@@ -0,0 +1,69 @@
+###############################################################################
+
+require 'singleton'
+
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Console
+
+###############################################################################
+
+      include Singleton
+
+###############################################################################
+
+      @@colour_warn  = 3
+      @@colour_error = 9
+
+###############################################################################
+
+      def info(message)
+        puts(message)
+      end
+
+###############################################################################
+
+      def warn(message)
+        puts(format(colour: @@colour_warn, message: message))
+      end
+
+###############################################################################
+
+      def error(message)
+        puts(format(colour: @@colour_error, message: message))
+      end
+
+###############################################################################
+
+      def fatal(message)
+        error(message)
+        exit(1)
+      end
+
+###############################################################################
+
+      def format(colour:, message:)
+        return "\u001b[38;5;" + colour.to_s + "m" + message + "\u001b[0m"
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/shared/names.rb

@@ -0,0 +1,101 @@
+###############################################################################
+
+require 'yaml'
+
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Names
+
+###############################################################################
+
+      @@console = Console.instance
+
+###############################################################################
+
+      @@file = "names.yaml"
+
+###############################################################################
+
+      @configuration
+      @path
+
+###############################################################################
+
+      attr_reader :base
+      attr_reader :id
+      attr_reader :name
+      attr_reader :region
+
+###############################################################################
+
+      def initialize(configuration:, name:)
+        @configuration = configuration
+        @base          = @configuration.base
+
+        @path = File.join(@base, @@file)
+
+        load(name: name)
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def load(name:)
+        id      = nil
+        region  = nil
+
+        @@console.fatal("Player names file: #{@path} not found!") unless File.file?(@path)
+
+        @@console.info("Reading player names file: #{@path}")
+        yaml = YAML.load(File.read(@path))
+
+        @@console.fatal("Player: #{name} not found in names file!") unless yaml.key?(name)
+
+        player = yaml[name]
+
+        @@console.fatal("Player: #{name} is not stored as a valid hash in the names file!") unless player.kind_of?(Hash)
+        @@console.fatal("Player: #{name} has no ID associated with it!") unless player.key?("id")
+
+        id = player["id"]
+
+        @@console.fatal("Player: #{name} has an ID associated that is not an integer!") unless id.kind_of?(Integer)
+        @@console.fatal("Player: #{name} has an ID associated that is not valid!") unless id > 0
+
+        if player.key?("region") then
+          region = player["region"]
+
+          @@console.fatal("Player: #{name} has a region associated that is not a string!") unless region.kind_of?(String)
+          @@console.fatal("Player: #{name} has a region associated that is blank!") if region.empty?
+
+          region = Region.new(name: region)
+        end
+
+        @id     = id
+        @name   = name
+        @region = region || @configuration.region
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/shared/region.rb

@@ -0,0 +1,112 @@
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Region
+
+###############################################################################
+
+      @@console = Console.instance
+
+###############################################################################
+
+      @@name = "eu"
+
+###############################################################################
+
+      @@regions = {
+        "cn" => {
+          "api_server"   => "gateway.battlenet.com.cn",
+          "description"  => "China",
+          "id"           => 5,
+          "oauth_server" => "www.battlenet.com.cn",
+          "realm"        => 1
+        },
+        "eu" => {
+          "api_server"   => "eu.api.blizzard.com",
+          "description"  => "Europe",
+          "id"           => 2,
+          "oauth_server" => "eu.battle.net",
+          "realm"        => 1
+        },
+        "la" => {
+          "api_server"   => "us.api.blizzard.com",
+          "description"  => "Latin America",
+          "id"           => 1,
+          "oauth_server" => "us.battle.net",
+          "realm"        => 2
+        },
+        "kr" => {
+          "api_server"   => "kr.api.blizzard.com",
+          "description"  => "Korea",
+          "id"           => 3,
+          "oauth_server" => "kr.battle.net",
+          "realm"        => 1
+        },
+        "ru" => {
+          "api_server"   => "eu.api.blizzard.com",
+          "description"  => "Russia",
+          "id"           => 2,
+          "oauth_server" => "eu.battle.net",
+          "realm"        => 2
+        },
+        "tw" => {
+          "api_server"   => "tw.api.blizzard.com",
+          "description"  => "Taiwan",
+          "id"           => 3,
+          "oauth_server" => "apac.battle.net",
+          "realm"        => 2
+        },
+        "us" => {
+          "api_server"   => "us.api.blizzard.com",
+          "description"  => "United States",
+          "id"           => 1,
+          "oauth_server" => "us.battle.net",
+          "realm"        => 1
+        }
+      }
+
+###############################################################################
+
+      attr_reader :api_server
+      attr_reader :description
+      attr_reader :id
+      attr_reader :name
+      attr_reader :oauth_server
+      attr_reader :realm
+
+###############################################################################
+
+      def initialize(name: nil)
+        name = name || @@name
+
+        @@console.fatal("Invalid region: #{name}!") unless @@regions.key?(name)
+
+        @name = name
+
+        @api_server   = @@regions[name]["api_server"]
+        @description  = @@regions[name]["description"]
+        @id           = @@regions[name]["id"]
+        @oauth_server = @@regions[name]["oauth_server"]
+        @realm        = @@regions[name]["realm"]
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/shared/season.rb

@@ -0,0 +1,123 @@
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Season
+
+###############################################################################
+
+      @@console = Console.instance
+
+###############################################################################
+
+      @@prefix = "/sc2/ladder/season"
+
+###############################################################################
+
+      attr_reader :ends
+      attr_reader :id
+      attr_reader :number
+      attr_reader :region
+      attr_reader :starts
+      attr_reader :year
+
+###############################################################################
+
+      def initialize(configuration:, region: nil)
+        @region = region || configuration.region
+
+        @@console.info("Finding current season information...")
+
+        path = "#{@@prefix}/#{@region.id.to_s}"
+
+        api = Shared::Api.new(configuration: configuration, region: @region)
+
+        result = api.get(path: path)
+
+        parse(json: result)
+      end
+
+###############################################################################
+
+      def to_s
+        result = String.new
+
+        result += "-------------------------------------------------------------------------------\n"
+        result += "Season: #{@id.to_s}\n"
+        result += "-------------------------------------------------------------------------------\n"
+        result += "Year  : #{@year.to_s}\n"
+        result += "Number: #{@number.to_s}\n"
+        result += "Began : #{@starts.to_s}\n"
+        result += "Ends  : #{@ends.to_s}\n\n"
+
+        return result
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def parse(json:)
+        @@console.fatal("Returned season information is missing an end date!") unless json.key?("endDate")
+        @@console.fatal("Returned season information is missing an ID!") unless json.key?("seasonId")
+        @@console.fatal("Returned season information is missing a season number!") unless json.key?("number")
+        @@console.fatal("Returned season information is missing a start date!") unless json.key?("startDate")
+        @@console.fatal("Returned season information is missing a year!") unless json.key?("year")
+
+        ends = json["endDate"]
+
+        ends = ends.to_i if ends.kind_of?(String)
+
+        @@console.fatal("Returned season information has an end date that is not an integer!") unless ends.kind_of?(Integer)
+        @@console.fatal("Returned season information has an end date that is invalid!") unless ends > 0
+
+        id = json["seasonId"]
+
+        @@console.fatal("Returned season information has an ID that is not an integer!") unless id.kind_of?(Integer)
+        @@console.fatal("Returned season information has an ID that is invalid!") unless id >= 0
+
+        number = json["number"]
+
+        @@console.fatal("Returned season information has a number that is not an integer!") unless number.kind_of?(Integer)
+        @@console.fatal("Returned season information has a number that is invalid!") unless number > 0
+
+        starts = json["startDate"]
+
+        starts = starts.to_i if starts.kind_of?(String)
+
+        @@console.fatal("Returned season information has a start date that is not an integer!") unless starts.kind_of?(Integer)
+        @@console.fatal("Returned season information has a start date that is invalid!") unless starts > 0
+
+        year = json["year"]
+
+        @@console.fatal("Returned season information has a year that is not an integer!") unless year.kind_of?(Integer)
+        @@console.fatal("Returned season information has a year that is invalid!") unless year > 2000
+
+        @ends   = Time.at(ends)
+        @id     = id
+        @number = number
+        @starts = Time.at(starts)
+        @year   = year
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################

data/lib/sc2cli/shared/token.rb

@@ -0,0 +1,139 @@
+###############################################################################
+
+require 'json'
+require 'net/http'
+
+###############################################################################
+
+module SC2Cli
+
+###############################################################################
+
+  module Shared
+
+###############################################################################
+
+    class Token
+
+###############################################################################
+
+      @@console = Console.instance
+
+###############################################################################
+
+      @@cutoff = 3600
+
+###############################################################################
+
+      @cache
+      @configuration
+
+###############################################################################
+
+      attr_reader :expires
+      attr_reader :region
+      attr_reader :token
+
+###############################################################################
+
+      def initialize(configuration:, region: nil)
+        @configuration = configuration
+        @region        = region || @configuration.region
+
+        @@console.info("Finding token for region: #{@region.name} (#{@region.description})")
+
+        @cache = Cache.new(configuration: @configuration, region: @region)
+
+        begin
+          from_cache
+        rescue
+          refresh
+        end
+      end
+
+###############################################################################
+
+      def check
+        return valid(expires: @expires)
+      end
+
+###############################################################################
+
+      def refresh
+        from_server
+        @cache.update(token: @token, expires: @expires)
+      end
+
+###############################################################################
+
+      private
+
+###############################################################################
+
+      def from_cache
+        raise "Cache 'token' or 'expires' objects are not set!" if @cache.token.nil? or @cache.expires.nil?
+        raise "Cached token has already expired!" unless valid(expires: @cache.expires)
+
+        @token   = @cache.token
+        @expires = @cache.expires
+      end
+
+###############################################################################
+
+      def from_server
+        @@console.fatal("No client/secret in configuration and no usable token in cache!") unless @configuration.auth
+
+        server = @region.oauth_server
+        @@console.info("Refreshing token from: #{server}")
+
+        uri     = URI("https://#{server}/oauth/token")
+        request = Net::HTTP::Post.new(uri)
+
+        request.basic_auth(@configuration.client, @configuration.secret)
+        request.set_form_data("grant_type" => "client_credentials")
+
+        http = Net::HTTP.new(uri.hostname, uri.port)
+        http.use_ssl = true
+
+        response = http.request(request)
+
+        @@console.fatal("Blizzard OAuth did not return status 200 for token reqest!") if response.code != "200"
+        @@console.fatal("Response body from Blizzard OAuth is not permitted!")        if not response.class.body_permitted?
+        @@console.fatal("Response body from Blizzard OAuth is empty!")                if response.body.nil?
+
+        body = JSON.parse(response.body)
+
+        @@console.fatal("Blizzard OAuth JSON response did not include an access token!") if not body.key?("access_token")
+        @@console.fatal("Blizzard OAuth gave a blank access token!")                     if body["access_token"].empty?
+
+        @@console.fatal("Blizzard OAuth JSON response did not include an expiry time!") if not body.key?("expires_in")
+
+        token      = body["access_token"]
+        expires_in = body["expires_in"]
+        expires    = Time.now + expires_in
+
+        @@console.fatal("Token received from Blizzard appears to have already expired!") unless valid(expires: expires)
+
+        @token   = token
+        @expires = expires
+      end
+
+###############################################################################
+
+      def valid(expires:, cutoff: @@cutoff)
+        return (expires - @@cutoff) > Time.now
+      end
+
+###############################################################################
+
+    end
+
+###############################################################################
+
+  end
+
+###############################################################################
+
+end
+
+###############################################################################