codepunker / codepunkerapi
A package that exploits the free web development tools API provided by (codepunker.com)[https://www.codepunker.com/tools]
1.1.4
2018-03-16 14:56 UTC
Requires
- php: >=5.5.0
- fzaninotto/faker: ^1.5
- guzzlehttp/guzzle: ^6.1
Requires (Dev)
- phpunit/phpunit: 4.*
- scrutinizer/ocular: ~1.1
- squizlabs/php_codesniffer: ~2.3
README
A package that exploits the free web development tools API provided by codepunker.com
Install
Via Composer
$ composer require codepunker/codepunkerapi
Usage
<?php //1. Generate Sitemaps $key = getenv('codepunker_api_key'); //set it as an env var or in the config file if (!$key) { $keys = parse_ini_file(__DIR__ . '/../src/Config/config.ini'); $key = $keys['codepunker_api_key']; } $params = [ 'api_key'=>$key, 'domain'=>'the url of the domain you want the sitemap generated for', 'callbackuri'=>'the url you want to receive a notification on when the sitemap is ready for downloading', ]; $client = new \Codepunker\CodepunkerApi\SitemapGen; $client->setParams($params); $client->getToken(); $outcome = $client->run(); //2. Encode/Decode/Hash/Unhash strings $key = getenv('codepunker_api_key'); if (!$key) { $keys = parse_ini_file(__DIR__ . '/../src/Config/config.ini'); $key = $keys['codepunker_api_key']; } $methods = ["encode"=>"a& b=", "decode"=>"cXdlMTIzNCAm", "hash"=>"qwe1234", "unhash"=>"020a66797188c675989262ffff701e11"]; foreach ($methods as $method=>$string) { $params = [ 'api_key'=>$key, 'method'=>$method, 'string'=>$string, ]; $client = new \Codepunker\CodepunkerApi\StringConverter; $client->setParams($params); $client->getToken(); $outcome = $client->run(); } ?>
Testing
$ composer test
Security
If you discover any security related issues, please email info@codepunker.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.