codewizz / laravel-reddit-api Goto Github PK

View Code? Open in Web Editor NEW

22.0 4.0 23.0 59 KB

Laravel Reddit API wrapper

License: MIT License

PHP 100.00%

reddit-api laravel-wrapper

laravel-reddit-api's Introduction

Laravel-Reddit-API

Using this package you can easily retrieve data from Reddit API.

Laravel wrapper for https://github.com/rotorcowboy/Phapper

Supports Laravel 5.x - 8.x.

Here are a few examples of the provided methods:

use RedditAPI;

//fetch top Reddit posts
RedditAPI::getTop();

//fetch top picture posts of Margot Robbie, limit to 100
RedditAPI::search('Margot Robbie ', null, 'top', null, 'pics', 100);

Install

This package can be installed through Composer.

composer require codewizz/laravel-reddit-api

If you are using Laravel 5.5+, the service provider and alias will be registered automatically. You can proceed to "Publish config".

Manually register services

You must install this service provider.

// config/app.php
'providers' => [
    ...
    CodeWizz\RedditAPI\RedditAPIServiceProvider::class,
    ...
];

This package also comes with a facade, which provides an easy way to call the the class.

// config/app.php
'aliases' => [
    ...
    'RedditAPI' => CodeWizz\RedditAPI\RedditAPIFacade::class,
    ...
];

Publish config

You should publish the config file of this package with this command:

php artisan vendor:publish --provider="CodeWizz\RedditAPI\RedditAPIServiceProvider"

The following config file will be published in config/reddit-api.php

return [
    'endpoint_standard' => 'https://www.reddit.com',
    'endpoint_oauth' => 'https://oauth.reddit.com',
    
    'username' => env('REDDIT_USERNAME', ''),
    'password' => env('REDDIT_PASSWORD', ''),
    'app_id' => env('REDDIT_APP_ID', ''),
    'app_secret' => env('REDDIT_APP_SECRET', ''),
    
    'response_format' => 'STD', // STD | ARRAY
    
    'scopes' => 'save,modposts,identity,edit,flair,history,modconfig,modflair,modlog,modposts,modwiki,mysubreddits,privatemessages,read,report,submit,subscribe,vote,wikiedit,wikiread'
];

About CodeWizz

CodeWizz is a web development agency based in Lithuania. You'll find more information on our website.

License

The MIT License (MIT). Please see License File for more information.

laravel-reddit-api's People

Contributors

Stargazers

Watchers

laravel-reddit-api's Issues

Support for php 8.1

Hey guys,
Can you please add php support 8.1 for laravel 9 ?

- codewizz/laravel-reddit-api 0.3.0 requires php ^7.2 -> your php version (8.1.13) does not satisfy that requirement.

Not compatible with Laravel 6

Laravel now has semantic versioning, so the requirements for this package don't allow installations with Laravel 6 or greater.

Problem with composer

When I try to install this awesome vendor via composer: $ composer require codewizz/laravel-reddit-api

The result is:


Using version ^0.2.0 for codewizz/laravel-reddit-api
./composer.json has been updated
Running composer update codewizz/laravel-reddit-api
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - Root composer.json requires codewizz/laravel-reddit-api ^0.2.0 -> satisfiable by codewizz/laravel-reddit-api[0.2.0].
    - codewizz/laravel-reddit-api 0.2.0 requires illuminate/support ^6.0|^7.0 -> found illuminate/support[v6.0.0, ..., 6.x-dev, v7.0.0, ..., 7.x-dev] but these were not loaded, likely because it conflicts with another require.


Installation failed, reverting ./composer.json and ./composer.lock to their original content.

And I don' know how to fix it. Thank you for your help.

Unable to install on Laravel 5.7

daniel@daniel-VirtualBox:~/DragonZapFinal/DragonZap$ php7.4 ../../composer.phar require codewizz/laravel-reddit-api
Using version ^0.3.0 for codewizz/laravel-reddit-api
./composer.json has been updated
Running composer update codewizz/laravel-reddit-api
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

Problem 1
- Root composer.json requires codewizz/laravel-reddit-api ^0.3.0 -> satisfiable by codewizz/laravel-reddit-api[0.3.0].
- codewizz/laravel-reddit-api 0.3.0 requires illuminate/support ^6.0|^7.0|^8.0|^9.0 -> found illuminate/support[v6.0.0, ..., v6.20.42, v7.0.0, ..., v7.30.6, v8.0.0, ..., v8.75.0] but these were not loaded, likely because it conflicts with another require.

No documentation on getCaptchaResponse(...)

I really, really like this package and I'm interested in using it. However, I tried out to integrate it but I'm not able to pass through getCaptchaResponse(). How exactly am I supposed to pass a valid ReCaptcha confirmation on a running Laravel instance?