module Redd
The main Redd
module.
rubocop:disable Metrics/ClassLength, Metrics/ParameterLists rubocop:disable Metrics/MethodLength, Metrics/AbcSize
The main Redd
module.
Constants
- VERSION
The semantic version number.
Public Class Methods
it(type, *args, **kwargs)
click to toggle source
@overload it(:installed, client_id, redirect_uri, **kwargs)
Authorize a user via an installed app. @param [String] client_id The client ID provided by reddit. @param [String] redirect_uri The exact uri you provided to reddit. @param [Hash] kwargs The keyword arguments provided to the client. @return [Clients::Installed]
@overload it(:script, client_id, secret, username, password, **kwargs)
Authorize a user that you have full access to, i.e. a bot. @param [String] client_id The client ID provided by reddit. @param [String] secret The client secret provided by reddit. @param [String] username The username. @param [String] password The password of the user. @param [Hash] kwargs The keyword arguments provided to the client. @return [Clients::Script]
@overload it(:userless, client_id, secret, **kwargs)
Connect to reddit from a web-app or a script without a specific user. @param [String] client_id The client ID provided by reddit. @param [String] secret The client secret provided by reddit. @param [Hash] kwargs The keyword arguments provided to the client. @return [Clients::Userless]
@overload it(:web, client_id, secret, redirect_uri, **kwargs)
Authorize a user from a website. @param [String] client_id The client ID provided by reddit. @param [String] secret The client secret provided by reddit. @param [String] redirect_uri The exact uri you provided to reddit. @param [Hash] kwargs The keyword arguments provided to the client. @return [Clients::Web]
# File lib/redd.rb, line 40 def self.it(type, *args, **kwargs) types = { installed: Clients::Installed, script: Clients::Script, userless: Clients::Userless, web: Clients::Web } types[type].new(*args, **kwargs) end