Module: NeonRAW

Defined in:

lib/NeonRAW.rb,
lib/NeonRAW/errors.rb,
lib/NeonRAW/version.rb,
lib/NeonRAW/objects/me.rb,
lib/NeonRAW/clients/web.rb,
lib/NeonRAW/objects/all.rb,
lib/NeonRAW/clients/base.rb,
lib/NeonRAW/objects/rule.rb,
lib/NeonRAW/objects/user.rb,
lib/NeonRAW/objects/thing.rb,
lib/NeonRAW/clients/script.rb,
lib/NeonRAW/objects/access.rb,
lib/NeonRAW/objects/trophy.rb,
lib/NeonRAW/objects/comment.rb,
lib/NeonRAW/objects/listing.rb,
lib/NeonRAW/objects/wikipage.rb,
lib/NeonRAW/clients/installed.rb,
lib/NeonRAW/objects/subreddit.rb,
lib/NeonRAW/objects/modloguser.rb,
lib/NeonRAW/objects/submission.rb,
lib/NeonRAW/objects/multireddit.rb,
lib/NeonRAW/clients/base/listing.rb,
lib/NeonRAW/objects/inboxcomment.rb,
lib/NeonRAW/objects/modlogaction.rb,
lib/NeonRAW/objects/morecomments.rb,
lib/NeonRAW/objects/thing/votable.rb,
lib/NeonRAW/clients/base/utilities.rb,
lib/NeonRAW/objects/privatemessage.rb,
lib/NeonRAW/objects/subreddit/wiki.rb,
lib/NeonRAW/objects/thing/editable.rb,
lib/NeonRAW/objects/thing/gildable.rb,
lib/NeonRAW/objects/thing/saveable.rb,
lib/NeonRAW/objects/subreddit/flair.rb,
lib/NeonRAW/objects/thing/inboxable.rb,
lib/NeonRAW/objects/thing/repliable.rb,
lib/NeonRAW/objects/thing/createable.rb,
lib/NeonRAW/objects/wikipagerevision.rb,
lib/NeonRAW/objects/thing/refreshable.rb,
lib/NeonRAW/clients/base/objectbuilder.rb,
lib/NeonRAW/objects/thing/moderateable.rb,
lib/NeonRAW/objects/subreddit/utilities.rb,
lib/NeonRAW/objects/subreddit/moderation.rb

Overview

rubocop:disable Style/AccessorMethodName, Metrics/LineLength

Defined Under Namespace

Modules: Clients, Errors, Objects

Constant Summary

VERSION =

'0.1.1'.freeze

Class Method Summary

• .installed(client_id, redirect_uri, opts = {}) ⇒ NeonRAW::Clients::Installed

  Creates the Installed client.

• .script(username, password, client_id, secret, opts = {}) ⇒ NeonRAW::Clients::Script

  Creates the Script client.

• .web(client_id, secret, redirect_uri, opts = {}) ⇒ NeonRAW::Clients::Web

  Creates the Web client.

Class Method Details

.installed(client_id, redirect_uri, opts = {}) ⇒ NeonRAW::Clients::Installed

Creates the Installed client.

Parameters:

• client_id (String) —

  The client_id of the app.

• redirect_uri (String) —

  The redirect_uri of the app.

• opts (Hash) (defaults to: {}) —

  Optional parameters.

Options Hash (opts):

• :user_agent (String) —

  The user_agent of the app.

Returns:

• (NeonRAW::Clients::Installed) —

  Returns the Installed client.

# File 'lib/NeonRAW.rb', line 15

def self.installed(client_id, redirect_uri, opts = {})
  Clients::Installed.new(client_id, redirect_uri, opts)
end

.script(username, password, client_id, secret, opts = {}) ⇒ NeonRAW::Clients::Script

Creates the Script client.

Parameters:

• username (String) —

  The username of the user.

• password (String) —

  The password of the user.

• client_id (String) —

  The client_id of the app.

• secret (String) —

  The secret of the app.

• opts (Hash) (defaults to: {}) —

  Optional parameters.

Options Hash (opts):

• :user_agent (String) —

  The user_agent of the app.

• :redirect_uri (String) —

  The redirect_uri (defaults to 127.0.0.1:).

Returns:

• (NeonRAW::Clients::Script) —

  Returns the Script client.

# File 'lib/NeonRAW.rb', line 29

def self.script(username, password, client_id, secret, opts = {})
  Clients::Script.new(username, password, client_id, secret, opts)
end

.web(client_id, secret, redirect_uri, opts = {}) ⇒ NeonRAW::Clients::Web

Creates the Web client.

Parameters:

• client_id (String) —

  The client_id of the app.

• secret (String) —

  The secret of the app.

• redirect_uri (String) —

  The redirect_uri of the app.

• opts (Hash) (defaults to: {}) —

  Optional parameters.

Options Hash (opts):

• :user_agent (String) —

  The user_agent of the app.

Returns:

• (NeonRAW::Clients::Web) —

  Returns the Web client.

# File 'lib/NeonRAW.rb', line 40

def self.web(client_id, secret, redirect_uri, opts = {})
  Clients::Web.new(client_id, secret, redirect_uri, opts)
end