Merge pull request #20 from fhasanaj/RCB-230_home_on_github

Rcb 230 home on GitHub

Author: cp2boston

README.md

@@ -6,7 +6,7 @@ PHP client binding for Rosette API
 Installation
 ------------
 
-`composer require "rosette/api: ~0.7.4"`
+`composer require "rosette/api: ~0.8.0"`
 
 Basic Usage
 -----------

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "rosette/api",
-  "version": "0.7.4",
+  "version": "0.8.0",
   "description": "Rosette API PHP client SDK",
   "license": "Apache",
   "keywords": [

docker/Dockerfile

@@ -1,27 +1,31 @@
 FROM php:5.5-cli
-MAINTAINER Sam Hausmann
+MAINTAINER Fiona Hasanaj
+ENV TZ=America/New_York
 
 # install necessary software
-RUN apt-get -y update && apt-get install -y vim  && apt-get install -y git
+RUN apt-get -y update && apt-get install -y vim  && apt-get install -y git && apt-get install -y libxslt1-dev
 
-# clone the Rosette API repo from github
-RUN git clone https://github.com/rosette-api/php.git
-COPY composer.json /php/examples/composer.json
-WORKDIR /php/examples
+# copy over the necessary files
+COPY composer.json /php-dev/examples/composer.json
+COPY composer.json /php-dev/composer.json
+WORKDIR /php-dev
 
 # install mbstring
 RUN docker-php-ext-install mbstring
 
+#Add xsl in PHP containers image
+RUN docker-php-ext-install xsl
+
 # install composer.phar
 RUN curl -sS https://getcomposer.org/installer | php && mv composer.phar /usr/local/bin/composer
-RUN composer install
+RUN composer install && cp -r vendor /php-dev/examples
 
-# copy API script
-COPY run_php.sh /php/examples/run_php.sh 
-RUN chmod 755 /php/examples/run_php.sh
+# copy over the necessary files
+COPY run_php.sh /php-dev/run_php.sh 
+RUN chmod 755 /php-dev/run_php.sh
 
 # specify docker volume
 VOLUME ["/source"]
 
 # allow interactive bash inside docker container
-CMD ./run_php.sh $API_KEY $FILENAME $ALT_URL
+CMD ./run_php.sh $API_KEY $FILENAME $ALT_URL $GIT_USERNAME $VERSION

docker/README.md

@@ -7,8 +7,6 @@ To simplify the running of the PHP examples, the Dockerfile will build an image
 ### Basic Usage
 Build the docker image, e.g. `docker build -t basistech/php:1.1 .`
 
-Run an example as `docker run -e API_KEY=api-key -v "path-to-example-source:/source" basistech/php:1.1`
+Run an example as `docker run -e API_KEY=api-key -v "path-to-php-dir:/source" basistech/php:1.1`
 
-To test against a specific source file, add `-e FILENAME=filename` before the `-v`
-
-Also, to test against an alternate url, add `-e ALT_URL=alternate_url` before the `-v`
+To test against a specific source file, add `-e FILENAME=filename` before the `-v`, to test against an alternate url, add `-e ALT_URL=alternate_url`, and optionally if you would like to regenerate gh-pages from the changes made to the development source you can add `-e GIT_USERNAME=git-username -e VERSION=version` before the `-v`. In order to push the gh-pages to git remember to mount .ssh and .gitconfig to the root dir `-v path-to-.ssh-dir:/root/.ssh -v path-to-.gitconfig:/root/.gitconfig`.

docker/composer.json

@@ -1,4 +1,25 @@
 {
+  "name": "rosette/api",
+  "version": "0.8.0",
+  "description": "Rosette API PHP client SDK",
+  "license": "Apache",
+  "keywords": [
+    "rosette",
+    "basis",
+    "nlp",
+    "text analytics"
+  ],
+  "authors": [
+    {
+      "name": "Basis Technology Corp",
+      "homepage": "https://developer.rosette.com"
+    }
+  ],
+  "require-dev": {
+    "phpunit/phpunit": ">=4.6",
+    "fabpot/php-cs-fixer": ">=1.9",
+    "phpdocumentor/phpdocumentor": "~2.8"
+  },
   "autoload": {
     "psr-4": {"rosette\\": "/source/source/rosette"}
   }

docker/run_php.sh

@@ -3,14 +3,16 @@
 #Gets called when the user doesn't provide any args
 function HELP {
     echo -e "\nusage: source_file.php --key API_KEY [--url ALT_URL]"
-    echo "  API_KEY      - Rosette API key (required)"
-    echo "  FILENAME     - PHP source file (optional)"
-    echo "  ALT_URL      - Alternate service URL (optional)"
+    echo "  API_KEY       - Rosette API key (required)"
+    echo "  FILENAME      - PHP source file (optional)"
+    echo "  ALT_URL       - Alternate service URL (optional)"
+    echo "  GIT_USERNAME  - Git username where you would like to push regenerated gh-pages (optional)"
+    echo "  VERSION       - Build version (optional)"
     echo "Compiles and runs the source file(s) using the local development source."
     exit 1
 }
 
-#Gets API_KEY, FILENAME and ALT_URL if present
+#Gets API_KEY, FILENAME, ALT_URL, GIT_USERNAME and VERSION if present
 while getopts ":API_KEY:FILENAME:ALT_URL" arg; do
     case "${arg}" in
         API_KEY)
@@ -25,6 +27,14 @@ while getopts ":API_KEY:FILENAME:ALT_URL" arg; do
             FILENAME=${OPTARG}
             usage
             ;;
+        GIT_USERNAME)
+            GIT_USERNAME=${OPTARG}
+            usage
+            ;;
+        VERSION)
+            VERSION={OPTARG}
+            usage
+            ;;
     esac
 done
 
@@ -37,9 +47,13 @@ function checkAPI {
     fi  
 }
 
+#Copy the mounted content in /source to current WORKDIR
+cp -r -n /source/* .
+
 #Run the examples
 if [ ! -z ${API_KEY} ]; then
     checkAPI
+    cd /php-dev/examples
 	if [ ! -z ${FILENAME} ]; then
 	    if [ ! -z ${ALT_URL} ]; then
 	        php ${FILENAME} --key ${API_KEY} --url=${ALT_URL} 
@@ -53,4 +67,28 @@ if [ ! -z ${API_KEY} ]; then
     fi
 else 
     HELP
+fi
+
+#Run unit tests
+cd /php-dev && ./vendor/bin/phpunit -v --bootstrap ./vendor/autoload.php ./tests/rosette/api/ApiTest.php
+
+#Run php-cs-fixer
+./vendor/bin/php-cs-fixer fix . --dry-run --diff
+
+#Generate gh-pages and push them to git account (if git username is provided)
+if [ ! -z ${GIT_USERNAME} ] && [ ! -z ${VERSION} ]; then
+    #clone php git repo to the root dir
+    cd /
+    git clone [email protected]:${GIT_USERNAME}/php.git
+    cd php
+    git checkout origin/gh-pages -b gh-pages
+    git branch -d develop
+    #generate gh-pages from development source and output the contents to php repo
+    cd /php-dev
+    ./vendor/bin/phpdoc -d ./source/rosette/api -t /php
+    cd /php
+    find -name 'phpdoc-cache-*' -exec rm -rf {} \;
+    git add .
+    git commit -a -m "publish php apidocs ${VERSION}"
+    git push
 fi

examples/composer.json

@@ -1,5 +1,5 @@
 {
     "require": {
-        "rosette/api": "0.7.*"
+        "rosette/api": "0.8.*"
     }
 }