cabul v0.0.22

Cabul

Cabul guide you to the NSFW world of reddit.

This module exist as a directory of all popular NSFW-related subreddits. The endpoints that cabul handle is hand-picked and curated by the whole community, data taken is always wholesome, and easy to use check your intelisense.

Table of Subreddit • Documentation • Add new endpoint

Features

• Featureful: resolves and interacts with ease
• Fancy functional: out of the box
• Curated by the whole community
• Arbitrary: GET request will be support as well
• Easy to use: check your intelisense
• All in one: packed with hentai, irl, and memes

Prerequisites

• Node.js v12 or above.
• Can parse JSON

Installation

npm install cabul / yarn add cabul

Example

Here I'll show you how to import either hentai, irl, or meme

const { Cabul } = require('cabul');
const reddit = new Cabul()

// To use and import hentai only
reddit.hentai("ahegao", "hot").then(res => {
    console.log(res); // Returns a object 
});

// To use and import irl only
reddit.irl("gonewild", "top").then(res => {
  console.log(res); // Returns a object 
});

// To use and import memes only
reddit.meme("hentaimemes", "controversial").then(res => {
  console.log(res); // Returns a object 
});

That above one will returns a single random posts object.

If you dont want to get random, you can set the third parameter to true

reddit.hentai("atago", "hot", true).then(res => {
  console.log(res); // Returns a object 
});

That above one will represents the 25 object posts.

Not sure what the parameter looks like? Check your intelisense.

Takes parameters:

• Required: type (String, Check endpoint.json) The related endpoint of subreddit.
  • If not provided, it will throw you an error.
• Optional: sortby (String, Should be: hot | new | top | controversial) Gets data according popularity.
  • If not provided, it will be random between hot, new, top, and controversial.
• Optional: no_random (Boolean) If true, will returns 25 list instead of 1 random.
  • If not provided, it will default to false.

Returns: Single object or 25 list of object (if third parameter is true) that represents the data.

Documentation

The documentation can be found https://sinkaroid.github.io/cabul

• reddit.hentai(options)

  • Gets random or list data from related hentai subreddit.

• reddit.irl(options)

  • Gets random or list data from related irl nsfw subreddit.

• reddit.memes(options)

  • Gets random or list data from related nsfw memes subreddit.

Table of subreddit

Here the list of popular subreddit that cabul can handle.
Sometime specific subreddit is not available or maybe is ban, it will throw you an error.

Hentai

IRL

Memes

Results:

no_random is default false and will return a single object. Otherwise it will return a list (25 posts) if no_random is true.

Useful keys:

• res.data parent object
• res.data.url_overridden_by_dest actionable image/videos/gifs
• res.data.permalink actionable links
• res.data.title title post
• res.data.subreddit_name_prefixed name of the subreddit. eg: /r/ahegao
• res.data.score number of score
• res.data.subreddit_subscribers number of subscribers
• res.data.num_comments number of comment in a post related
• res.data.ups number of upvotes
• res.data.downs number of downvotes
• ..and more, see below:

{
  kind: 't3',
  data: {
    approved_at_utc: null,
    subreddit: 'Atago',
    selftext: '',
    author_fullname: 't2_13mkmqwt',
    saved: false,
    mod_reason_title: null,
    gilded: 0,
    clicked: false,
    title: 'Atagos big behind',
    link_flair_richtext: [],
    subreddit_name_prefixed: 'r/Atago',
    hidden: false,
    pwls: null,
    link_flair_css_class: '',
    downs: 0,
    thumbnail_height: 78,
    top_awarded_type: null,
    hide_score: false,
    name: 't3_oh8uqe',
    quarantine: false,
    link_flair_text_color: 'dark',
    upvote_ratio: 0.99,
    author_flair_background_color: null,
    subreddit_type: 'public',
    ups: 534,
    total_awards_received: 3,
    media_embed: {},
    thumbnail_width: 140,
    author_flair_template_id: null,
    is_original_content: false,
    user_reports: [],
    secure_media: null,
    is_reddit_media_domain: true,
    is_meta: false,
    category: null,
    secure_media_embed: {},
    link_flair_text: 'Atago',
    can_mod_post: false,
    score: 534,
    approved_by: null,
    is_created_from_ads_ui: false,
    author_premium: false,
    thumbnail: 'https://b.thumbs.redditmedia.com/Rsh6Og-AsGTpfsAPlR1OOCr4voR3CAL5X0fX1IihAMM.jpg',
    edited: false,
    author_flair_css_class: null,
    author_flair_richtext: [],
    gildings: {},
    post_hint: 'image',
    content_categories: null,
    is_self: false,
    mod_note: null,
    created: 1625907932,
    link_flair_type: 'text',
    wls: null,
    removed_by_category: null,
    banned_by: null,
    author_flair_type: 'text',
    domain: 'i.redd.it',
    allow_live_comments: false,
    selftext_html: null,
    likes: null,
    suggested_sort: null,
    banned_at_utc: null,
    url_overridden_by_dest: 'https://i.redd.it/aabldcpvbaa71.jpg',
    view_count: null,
    archived: false,
    no_follow: false,
    is_crosspostable: false,
    pinned: false,
    over_18: true,
    preview: { images: [Array], enabled: true },
    all_awardings: [ [Object], [Object] ],
    awarders: [],
    media_only: false,
    link_flair_template_id: '15f3d18e-14cc-11eb-93fc-0e629d02b757',
    can_gild: false,
    spoiler: false,
    locked: false,
    author_flair_text: null,
    treatment_tags: [],
    visited: false,
    removed_by: null,
    num_reports: null,
    distinguished: null,
    subreddit_id: 't5_qdbs8',
    mod_reason_by: null,
    removal_reason: null,
    link_flair_background_color: '',
    id: 'oh8uqe',
    is_robot_indexable: true,
    report_reasons: null,
    author: 'verlene10',
    discussion_type: null,
    num_comments: 5,
    send_replies: true,
    whitelist_status: null,
    contest_mode: false,
    mod_reports: [],
    author_patreon_flair: false,
    author_flair_text_color: null,
    permalink: '/r/Atago/comments/oh8uqe/atagos_big_behind/',
    parent_whitelist_status: null,
    stickied: false,
    url: 'https://i.redd.it/aabldcpvbaa71.jpg',
    subreddit_subscribers: 24088,
    created_utc: 1625879132,
    num_crossposts: 1,
    media: null,
    is_video: false
  }
}

Todo

Since i've using this wrapper on Node.js application, hence the other language is not supported yet.

Feature support:

• Hentai
• Irl
• Memes

Multilingual support:

• Python modules
• Deno wrapper
• Ruby gem

Legal

This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel like this tool deserves an attribution, mention it. It won't hurt anybody :)

Please, read the license terms. Don't worry, it can be read in less than 30 seconds, unless you have some sort of reading disability - in that case, I'm wondering why you're still reading this text. Really. Stop. Please. I mean, seriously. Why are you still reading?

Pronunciation

id_ID • /ca·bul/ — sange dan kotor / melanggar kesopanan (?) offensive in a sexual way.

Acknowledgements

Since this tool includes some contributions, and I'm not an asshole, I'll publically thank the following users for their help:

• /r/Hentai actionable endpoints #hentai
• /r/NSFW411 actionable endpoints #irl