Skip to content

Commit

Permalink
💥 The big bang
Browse files Browse the repository at this point in the history
  • Loading branch information
ovac committed Feb 26, 2018
0 parents commit d94b6de
Show file tree
Hide file tree
Showing 35 changed files with 4,745 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .coveralls.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
coverage_clover: build/phpunit-clover-coverage.xml
json_path: build/phpunit-coveralls-upload.json
service_name: travis-ci
15 changes: 15 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# http://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.php]
indent_size = 4

[*.md]
trim_trailing_whitespace = false
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto
83 changes: 83 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
/vendor
/.phpintel
/.couscous
/build
composer.phar
/composer.lock
couscous.phar
sami.phar

# -- Bower -- #
*bower_components

# -- Npm -- #

*node_modules

# -- generic files to ignore -- #

*~
*.lock
!composer.lock

# -- Compiled source -- #

*.com
*.class
*.dll
*.exe
*.o
*.so

# -- Logs -- #

*.log

# -- Packages -- #

# it's better to unpack these files and commit the raw source
# git has its own built in compression methods

*.7z
*.dmg
*.gz
*.iso
*.rar
*.tar
*.zip

# -- OS generated files -- #

.DS_Store?
ehthumbs.db
Icon?
Thumbs.db
*.DS_Store
.Spotlight-V100
.Trashes

# -- Eclipse -- #

.classpath
.project
.settings
.buildpath

# -- WS & IntelliJ -- #
.idea

# -- Other source repository archive directories (protects when importing) -- #

.hg
*.svn
CVS

# -- sass -- #

.sass-cache/
.sass_cache_*.css
_sass_cache_*.css
.sass-cache

# -- dotfiles extra -- #
.extra
10 changes: 10 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
language: php
php: 7.1
install:
- composer install --prefer-source
script:
- composer test
- composer coverage
env:
global:
secure: DIJcMzOTWEmGTMQ0u5WC0BFqfXT+JGoWuKBx+t2zp6cWdub7X9XgcvxMrJpHs92YSRGWpmyvKTpQiK6T4sipnMATmcFEPMWCdhodTIRM94DyuRq+9pBhXvjd0Yr706mD3rP3I5P9NIQULLbZREH9cuZgtjLbtynrddYERiYyvrLV57Fx8O9GeiS6qXTti+yXD1LT/KB+OEuYYgC0xzt38EMxPGy6OrOWz3vYBk9k+2lvpo/0jg5MUivZpG2Q/0bdF5m0qvsyAzhRH2tLH6KFYntUeEA/g5xjntkEZ1o5R/M5Mo4uzMa0nk5ZbKfga3aaELTX/nAGgxq7AlYwYP02oOQHMyKHW/A8EZq+N56X0LWqqM16ayC5b2fTcpqfOOppQhOZWH4jhnEjzPWT7h1iSD+E0opk3lIW0aT52dhCoW1h/fywQ1JPQMUOuRT8Rfw1LHpmO/pg3wNQlRTkVWv4qfXVDUSk5mshMRldd6cg7zIchAe61vpeS7yoAJpHviubuhPUMDIwmRlW1D51Z8cW+Tyi9ZQyc9J9LbIkOHiYdFhiL/vQPyG/84eX+0PBKF33n1mrRqixvAfZsVn1O0UFH+ZYbMDjtpEiVB2T7+lCeIln1h4x93ccwB8NZiptqWNWymSEYO8KvjnrSjmBPeFTu9L3veR+deXxjQ1wwGQNybY=
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

We accept contributions via Pull Requests on [Github](https://github.com/qodehub/bitgo-php).

## Pull Requests

- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](http://pear.php.net/package/PHP_CodeSniffer).

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.

- **Create feature branches** - Don't ask us to pull from your master branch.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.


## Running Tests

``` bash
$ composer test
```


**Happy coding**!
50 changes: 50 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@

---

# QodeHub PHP SDK for Bitgo v2

#TODO - Completed
TODO: Clear out table for this project. ✅

#TODO - In progress
TODO: Study the BitGo API in depth.
- Looks like this will walk with me through out the development phase. 📝
TODO: Code implementation for the required use cases based on src. 🎬
- Currently in action 🎉
TODO: Conventional programmer's big-bang (Initial commit)

#TODO - TODO - TODO
```
TODO: Flesh out documentation (100% coverage)
TODO: Write Tests for all methods (at least 85% Coverage)
TODO: Ask management to move Codebase to Github for CASE tools and build process to work
TODO: Automate CI Testing
TODO: Automate Documentation Build
TODO: Automate Documentation Deployment.
TODO: Pass scrutinizers tests.
TODO: Pass code qality check (at least 85%)
TODO: Pass Dependency and version management tests (at least 85%)
TODO: Pass Integration tests (at least 85%)
TODO: Pass human documentation readability test. (This one hard oh! people still don't understand Laravel)
```


Allocated Hours:
- Dedicated Hours:
+ 40 Hrs/Week ⏰

Checkpoints:
- Keep test coverage at 60% minimum. 👩‍⚕️
- Keep documentaton coverage at 90% minimum on codebase. ⛏
- Keep Code quality at 60% minimum. 🐞
- Check this ceckpoints Nightly! 💋
- Don't forget to eat, sleep and step out a bit to meet with regular humans that dont code! (if possible)
- Check this checkpoints again and update todos and
- 😂🤣You thought there was more. lol. That's it for now!


#Signed
- Victor Ariama (a.k.a ovac4u) (a.k.a OVAC BOYA)
+ Programmer with a life. #pwal
+ Life of a programmer. #loap

18 changes: 18 additions & 0 deletions bin/ci.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/sh

# system infos
pwd;
php --version;

# get composer
curl -sS https://getcomposer.org/installer | php;
php composer.phar update;

# create the build dir if doesn't exist
mkdir -p build;

# run ci tasks
php composer.phar phpunit;
php composer.phar phpcs-ci;
php composer.phar phpcpd-ci;
php composer.phar phpmd-ci;
48 changes: 48 additions & 0 deletions bin/document.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
#!/bin/sh
bin/ci.sh

echo ""
# get sami if it does not exist.
[ -e sami.phar ] && echo "Sami found\r\n" || curl -O http://get.sensiolabs.org/sami.phar | php;

# get couscous if it does not exist.
[ -e couscous.phar ] && echo "Couscous found\r\n" || curl -O http://couscous.io/couscous.phar | php;

echo "Generating Documentation\r\n";

# Run the sami generator
php sami.phar update ./sami.config.php -v;

# Run the couscous static site generator
php couscous.phar generate --target=./build/couscous;

# clone the project and climb into the directory and switch to the gh-pages branch
git clone https://www.github.com/qodehub/bitgo-php;

cd bitgo-php;

git checkout gh-pages;

# Remove all files from the github pages folder
shopt -s extglob;
shopt -s dotglob nullglob;
rm -rf !(*.git);

# Make a directory for the sami generated doc and test coverage
mkdir -p ./api;
mkdir -p ./coverage;
touch .nojekyll;

# copy all files from the couscous generated folder into the empty github-pages branch folder
mv -v ../build/couscous/* ./;

# copy all files from the sami generated folder into the api folder
mv -v ../build/sami/* ./api/;

# copy all files from the coverage generated folder into the coverage folder
mv -v ../build/coverage/* ./coverage/;

# Add all and commit to github if deploy was enabled
git add --all . && git add **/.* && git commit -m 'Documentation Updated' && git push origin gh-pages;

rm -rf ../bitgo-php;
43 changes: 43 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
{
"name": "qodehub/bitgo",
"description": "Carefully crafted Bitgo PHP SDK from the Qodehub team.",
"license": "MIT",
"authors": [
{
"name": "Ariama Victor (ovac4u)",
"email": "[email protected]"
}
],
"autoload" : {
"psr-4": {
"qodehub\\bitgo-php\\" : "src/"
}
},
"require": {
"php": ">=5.4.0",
"guzzlehttp/guzzle": "^6.0.0"
},
"require-dev": {
"phpunit/phpunit": "^6.3.0",
"squizlabs/php_codesniffer": "^2.9.1",
"leaphub/phpcs-symfony2-standard": "^2.0.3",
"phpmd/phpmd" : "^2.6.0",
"sebastian/phpcpd": "*",
"mockery/mockery": "~1.0.0",
"satooshi/php-coveralls": "^1.0"
},
"scripts" : {
"phpunit" : "phpunit",
"phpcpd" : "phpcpd src",
"phpcs" : "phpcs --standard=./vendor/leaphub/phpcs-symfony2-standard/leaphub/phpcs/Symfony2/ --extensions=php ./src",
"phpcbf" : "phpcbf",
"phpmd" : "phpmd ./src text phpmd.xml",
"phpcpd-ci": "phpcpd --log-pmd=./build/phpcpd-report.xml ./src",
"phpmd-ci" : "phpmd ./src xml phpmd.xml --reportfile ./build/phpmd-report.xml",
"phpcs-ci" : "phpcs --standard=./vendor/leaphub/phpcs-symfony2-standard/leaphub/phpcs/Symfony2/ --report=checkstyle --report-file=./build/phpcs-checkstyle-report.xml --extensions=php src",
"test" : "phpunit; composer phpcs; composer phpmd; composer phpcpd;",
"sami" : "sami.phar build ./sami.config.php -v",
"document" : "bin/document.sh;",
"coverage" : "coveralls -v"
}
}
Loading

0 comments on commit d94b6de

Please sign in to comment.