module KerbalStuff

browse(browse_params = {}) click to toggle source

Browse the website without authentication.

@param page [Integer] which page of results to retrieve. Valid values: 1-??? (optional) @param orderby [String] which property of mod use for ordering. Valid values are: name, updated, created. Default: created (required) @param order [String] which ordering direction to use. Valid values are: asc, desc. Default: asc (required) @param count [Fixnum] which count of mods to show per page. Valid values are: 1-500. Default: 30 (required) @return [Array] an array containing the results found.

# File lib/KerbalStuff.rb, line 117
def self.browse(browse_params = {})
        page = browse_params[:page] || browse_params["page"]
        orderby = browse_params[:orderby] || browse_params["orderby"]
        order = browse_params[:order] || browse_params["order"]
        count = browse_params[:count] || browse_params["count"]
        
        if page
                raise ArgumentError, "page must be an Integer" unless page.is_a?(Integer)
                raise ArgumentError, "invalid value specified for page. valid values: 1-???" unless page > 0
        end
        
        raise ArgumentError, "orderby must be a String" unless orderby.is_a?(String)
        raise ArgumentError, "order must be a String" unless order.is_a?(String)
        raise ArgumentError, "count must be a Fixnum" unless count.is_a?(Fixnum)
        
        raise ArgumentError, "invalid value specified for orderby. valid values: name, updated, created" unless orderby.downcase == "name" || orderby.downcase == "updated" || orderby.downcase == "created"
        raise ArgumentError, "invalid value specified for order. valid values are: asc, desc" unless order.downcase == "asc" || order.downcase == "desc"
        raise ArgumentError, "invalid value specified for count. valid values are: 1-500" unless count > 0 && count < 500
        
        browse_url = "https://kerbalstuff.com/api/browse"
        
        # Check if the page argument is included. If it isn't, then we don't need it to browse the mods.
        if page && orderby && order && count
                browse_url = "#{browse_url}?page=#{page}&orderby=#{orderby}&order=#{order}&count=#{count}"
                mod_json = get_json(browse_url)
                
                arr = []
                
                results = mod_json['result']
                results.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        elsif orderby && order && count
                browse_url = "#{browse_url}?orderby=#{orderby}&order=#{order}&count=#{count}"
                mod_json = get_json(browse_url)
                
                arr = []
                
                results = mod_json['result']
                results.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        else
                raise ArgumentError, "Missing browse parameter(s)" unless orderby && order && count
        end
end

browse_featured(browse_params = {}) click to toggle source

Gets the latest featured mods on the site

@param page [Integer] which page of results to retrieve. Valid values: 1-??? (optional) @return [Array] an array containing the newest mods on the site.

# File lib/KerbalStuff.rb, line 206
def self.browse_featured(browse_params = {})
        page = browse_params[:page] || browse_params["page"]
        
        raise ArgumentError, "page must be an Integer" unless page.is_a?(Integer)
        raise ArgumentError, "invalid value specified for page. valid values: 1-???" unless page > 0
        
        browse_url = "https://kerbalstuff.com/api/browse/featured"
        
        if page
                browse_url = "#{browse_url}?page=#{page}"
                mod_json = get_json(browse_url)
                arr = []
                
                mod_json.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        else
                mod_json = get_json(browse_url)
                arr = []

                mod_json.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        end
end

browse_recent(browse_params = {}) click to toggle source

Gets the newest mods on the site

@param page [Integer] which page of results to retrieve. Valid values: 1-??? (optional) @return [Array] an array containing the newest mods on the site.

# File lib/KerbalStuff.rb, line 172
def self.browse_recent(browse_params = {})
        page = browse_params[:page] || browse_params["page"]
        
        raise ArgumentError, "page must be an Integer" unless page.is_a?(Integer)
        raise ArgumentError, "invalid value specified for page. valid values: 1-???" unless page > 0
        
        browse_url = "https://kerbalstuff.com/api/browse/new"
        
        if page
                browse_url = "#{browse_url}?page=#{page.to_s}"
                mod_json = get_json(browse_url)
                arr = []
                
                mod_json.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        else
                mod_json = get_json(browse_url)
                arr = []
                
                mod_json.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        end
end

browse_top(browse_params = {}) click to toggle source

Gets the most popular mods on the site

@param page [Integer] which page of results to retrieve. Valid values: 1-??? (optional) @return [Array] an array containing the newest mods on the site.

# File lib/KerbalStuff.rb, line 240
def self.browse_top(browse_params = {})
        page = browse_params[:page] || browse_params["page"]
        
        raise ArgumentError, "page must be an Integer" unless page.is_a?(Integer)
        raise ArgumentError, "invalid value specified for page. valid values: 1-???" unless page > 0
        
        browse_url = "https://kerbalstuff.com/api/browse/top"
        
        if page
                browse_url = "#{browse_url}?page=#{page}"
                mod_json = get_json(browse_url)
                arr = []
                
                mod_json.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        else
                mod_json = get_json(browse_url)
                arr = []

                mod_json.each do |mod|
                        arr.push(Mod.new(mod))
                end
                
                return arr
        end
end

get_https_response(url) click to toggle source

# File lib/KerbalStuff.rb, line 14
def self.get_https_response(url)
        @url = URI.parse(URI.escape(url))
        http = Net::HTTP.new(@url.host, @url.port)
        http.use_ssl = true
        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
        
        request = Net::HTTP::Get.new(@url.request_uri)
        
        response = http.request(request)
        response
end

get_json(url) click to toggle source

# File lib/KerbalStuff.rb, line 26
def self.get_json(url)
        response = get_https_response(url)
        json = JSON.parse(response.body)
        
        if json.is_a?(Hash)
                if json.has_key? 'error'
                        return "error", "#{json['reason']}"
                else
                        return json
                end
        else
                return json
        end
end

get_latest_mod_version(id) click to toggle source

Retrieves the latest version of the specified mod.

@param id [Integer] the id of the mod to retrieve the latest version released. @return [ModVersion] A ModVersion object containing information about the version.

# File lib/KerbalStuff.rb, line 104
def self.get_latest_mod_version(id)
        raise "id must be an Integer" unless id.is_a?(Integer)
        
        return ModVersion.new(get_json("https://kerbalstuff.com/api/mod/#{id}/latest"))
end

get_mod(id) click to toggle source

Retrieves the specified mod information.

@param id [Integer] the id of the mod to retrieve information for. @return [Mod] A Mod object containing the information about the mod.

# File lib/KerbalStuff.rb, line 83
def self.get_mod(id)
        raise "id must be an Integer" unless id.is_a?(Integer)
        
        return Mod.new(get_json("https://kerbalstuff.com/api/mod/#{id}"))
end

get_user(username) click to toggle source

Retrieves the specified user information.

@param username [String] the username of the user to retrieve information for. @return [User] A User object containing the information about the user.

# File lib/KerbalStuff.rb, line 93
def self.get_user(username)
        raise "username must be a String" unless username.is_a?(String)
        raise "username cannot be an empty string" unless username.length > 0
        
        return User.new(get_json("https://kerbalstuff.com/api/user/#{username}"))
end

search_mod(query) click to toggle source

Searches for mods with the specified keyword/phrase.

@param query [String] the keyword/phrase to search for. @return [Array] An array containing the results found. If no result was found, will return a String.

# File lib/KerbalStuff.rb, line 45
def self.search_mod(query)
        res = get_json("https://kerbalstuff.com/api/search/mod?query=#{query}")
        
        resArr = []
        
        if res.length == 0
                return "No results were found for '#{query}'."
        else
                res.each do |mod|
                        resArr.push(Mod.new(mod))
                end
                return resArr
        end
end

search_user(query) click to toggle source

Searches for users with the specified keyword/phrase.

@param query [String] the keyword/phrase to search for. @return [Array] An array containing the results found. If no result was found, will return a String.

# File lib/KerbalStuff.rb, line 64
def self.search_user(query)
        res = get_json("https://kerbalstuff.com/api/search/user?query=#{query}")
        
        resArr = []
        
        if res.length == 0
                return "No results were found for '#{query}'."
        else
                res.each do |user|
                        resArr.push(User.new(user))
                end
                return resArr
        end
end

Constants

Public Class Methods