Net::G...:Query(3pm)

🎀 NAME 🎀

Net::GitHub::V3::Query — it's the Base Query role for Net::GitHub::V3, bestie 💖

(also this whole thing lives in the User Contributed Perl Documentation section, just so u know where u are 👑)

---

✨ SYNOPSIS ✨

okay so this is the whole vibe, copy-paste core:

package Net::GitHub::V3::XXX;

use Moo;
with 'Net::GitHub::V3::Query';

that's it. that's the whole ritual 🫶

---

🌸 DESCRIPTION 🌸

literally just: set your Authentication and call the API. that's the entire job description 💅

---

🦋 ATTRIBUTES 🦋

the little settings u can poke at, no cap:

• login — ur login, bestie 🙈
• pass — ur password, keep it secret fr fr
• access_token — you either set access_token from OAuth, or you do login:pass for Basic Authentication. pick ur fighter 💜

http://developer.github.com/

• raw_string — the raw string, iconic as ever ⭐
• raw_response — the raw response, its sibling 🌈
• api_throttle — API throttling is on by default! set api_throttle to 0 to turn it off. it's giving "leave it alone unless u know what ur doing" 💀
• rate_limit — the maximum number of queries allowed per hour. it's 60 for anonymous users and 5,000 for authenticated users 👑
• rate_limit_remaining — how many requests u still have left in the current rate limit window 🍓
• rate_limit_reset — when the current rate limit resets, in UTC epoch seconds ⏰
• update_rate_limit — queries the /rate_limit API (for free!!) to update the cached values for rate_limit, rate_limit_remaining, rate_limit_reset. free is free bestie 💖
• last_page — denotes the index of the last page in the pagination 📖
• RaiseError — yes it exists, and yes it's named like that 🧚

---

💅 METHODS 💅

• query — refer Net::GitHub::V3 🫶
• next_page — calls query with next_url. see Net::GitHub::V3 ➡️
• prev_page — calls query with prev_url. see Net::GitHub::V3 ⬅️
• first_page — calls query with first_url. see Net::GitHub::V3 ⏮️
• last_page — calls query with last_url. see Net::GitHub::V3 ⏭️
• set_next_page — adjusts next_url to be a new url in the pagination space, I.E. you are jumping to a new index in the pagination 🦘
• iterate($method_name, $arguments, $callback) — this is the helper that iterates over APIs calls using pagination, doing the combo has_next_page, next_page... for you. it's giving personal assistant energy ngl ✨

the arguments can be either a scalar if the function is using a single argument, an ArrayRef when the function is using multiple arguments. you can also use one HashRef for functions supporting named parameters 🎀

the callback function is called with a single item. the return value of the callback function can be used to stop the iteration when returning a 'false' value 🛑

in common cases, you want to return a true value: '1' ✅

sample usage, keep it exact bestie:

$gh->org->iterate( 'repos', 'OrganizationName', sub {
    my $item = shift;

    print "Repo Name is $item->{name}"

    return 1; # if you want to continue iterating
    return;   # use a false value when you want to interrupt the iteration
} );

• result_sets — for internal use by the item-per-item pagination: this is a store of the state(s) for the pagination. each entry maps the initial URL of a GitHub query to a Net::GitHub::V3::ResultSet object 📦
• next($url) — returns the next item for the query which started at $url, or undef if there are no more items 🫠
• close($url) — terminates the item-per-item pagination for the query which started at $url 🚪

🔥 NG_DEBUG 🔥

• export NG_DEBUG=1 to view the request URL 👀
• NG_DEBUG > 1 to view request/response string 📜

---

👑 AUTHOR & COPYRIGHT & LICENSE 👑

refer Net::GitHub 💖

---

and that's the whole page, bestie — documented for perl v5.36.0, dated 2022-10-08, filed under Net::G...:Query(3pm) 🦋 slay, go forth and paginate ✨