feat: add User-Agent request header, use Makefile Targets as a base f…

…or commands (#9)

* feat: remove hardcoded version from composer.json - https://getcomposer.org/doc/02-libraries.md#library-versioning
* feat: move scripts into Makefile (#4)
* feat: add User-Agent request header, add release command to Makefile
* docs: added CHANGELOG.md

.codecov.yml

@@ -1,2 +1,3 @@
 ignore:
-  - "src/InfluxDB2Generated/**/*"
+  - "src/InfluxDB2/Model/*"
+  - "src/InfluxDB2/Model/**/*"

.gitignore

@@ -4,3 +4,5 @@ composer.lock
 build/
 .idea/
 coverage.xml
+/scripts/.m2/
+/generated/

CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0 [unreleased]
+
+### Features
+1. [#4](https://github.com/influxdata/influxdb-client-php/issues/4): Use Makefile Targets Instead of scripts dir
+1. [#7](https://github.com/influxdata/influxdb-client-php/issues/7): Set User-Agent to influxdb-client-php/VERSION for all requests

Makefile

@@ -1,29 +1,52 @@
-###
-# Docker Targets
-##
-TARGET=v2.0.0-alpha.4
+.DEFAULT_GOAL := help
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  start-server   	to start the InfluxDB server"
+	@echo "  stop-server    	to stop the InfluxDB server"
+	@echo "  test           	to perform unit tests"
+	@echo "  coverage       	to perform unit tests with code coverage"
+	@echo "  coverage-show  	to show the code coverage report"
+	@echo "  generate-sources	to generate API sources from swagger.yml"
+	@echo "  generate-sources	to generate API sources from swagger.yml"
+	@echo "  deps           	to installs the project dependencies"
+	@echo "  dshell           	to start Docker Shell for Local Development"
+	@echo "  release           	to release client with version specified by VERSION property . make release VERSION=1.5.0"
 
 # Docker Shell for Local Development
 dshell:
-	@docker-compose run --entrypoint=ash --rm php
-
-# This needs hard-coded to a version when the beta drops
-generate-api-client:
-	@rm -rf src/InfluxDB2Generated
-	@docker container run --rm -it -v ${PWD}:/code -w /code openapitools/openapi-generator-cli:latest \
-		generate \
-			-i https://raw.githubusercontent.com/influxdata/influxdb/$(TARGET)/http/swagger.yml \
-			-g php \
-			-o /code/src/InfluxDB2Generated \
-			--api-package ApiClient \
-			--invoker-package InfluxDB2Generated
-
-###
-# Normal Targets
-###
+	@docker-compose run --entrypoint=bash --rm php
+
 deps:
 	@composer install
 
-test:
-	@./bin/phpspec run
-	@./bin/phpunit
+generate-sources:
+	@scripts/generate-sources.sh
+
+test: start-server
+	@docker-compose run php composer run test
+
+coverage: start-server
+	@docker-compose run php composer run test-coverage
+
+coverage-show:
+	open build/coverage-report/index.html
+
+start-server:
+	@docker-compose up -d influxdb_v2
+	@scripts/influxdb-onboarding.sh ||:
+
+stop-server:
+	@docker-compose stop influxdb_v2
+
+release:
+	$(if $(VERSION),,$(error VERSION is not defined. Pass via "make release VERSION=1.5.0"))
+	@echo Tagging $(VERSION)
+	git checkout master
+	git pull
+	sed -i '' -e "s/VERSION = '.*'/VERSION = '$(VERSION)'/" src/InfluxDB2/Client.php
+	git commit -am "release influxdb-client-php-$(VERSION)"
+	git tag v$(VERSION)
+	sed -i '' -e "s/VERSION = '.*'/VERSION = 'dev'/" src/InfluxDB2/Client.php
+	git commit -am "prepare for next development iteration"
+	git push origin --tags

README.md

@@ -191,11 +191,8 @@ $writeApi->write('h2o,location=west value=33i 15');
 ## Local tests
 
 ```shell script
-# start/restart InfluxDB2 on local machine using docker
-./scripts/influxdb-restart.sh
-
 # run unit & integration tests
-composer test
+make test
 ```
 
 ## Contributing

composer.json

@@ -4,7 +4,6 @@
   "keywords": [
     "InfluxDB"
   ],
-  "version": "0.0.1-alpha",
   "homepage": "https://www.github.com/influxdata/influxdb-client-php",
   "license": "MIT",
   "require": {
@@ -32,7 +31,7 @@
   },
   "scripts": {
     "test": "vendor/bin/phpunit tests",
-    "test-ci": "vendor/bin/phpunit tests --log-junit build/junit.xml -v --coverage-html=build/coverage-report"
+    "test-coverage": "vendor/bin/phpunit tests --log-junit build/junit.xml -v --coverage-html=build/coverage-report"
   }
 
 }

docker-compose.yml

@@ -4,7 +4,14 @@ services:
   php:
     build:
       context: .
-      target: dev
+      dockerfile: Dockerfile
     volumes:
       - .:/code
     working_dir: /code
+    network_mode: host
+
+  influxdb_v2:
+    image: quay.io/influxdb/influxdb:2.0.0-beta
+    ports:
+      - "9999:9999"
+    command: influxd --reporting-disabled

scripts/generate-sources.sh

@@ -6,13 +6,18 @@ rm -rf "${SCRIPT_PATH}"/../generated
 
 # Generate client
 cd "${SCRIPT_PATH}"/ || exit
-mvn org.openapitools:openapi-generator-maven-plugin:generate
+docker run --rm -it \
+  -v "${PWD}":/code \
+  -v "${PWD}/../generated":/generated \
+  -v "${PWD}/.m2":/root/.m2 \
+  -w /code \
+  maven:3.6-slim mvn org.openapitools:openapi-generator-maven-plugin:generate
 
 #### sync generated php files to src
 
 # delete old sources
-rm "${SCRIPT_PATH}"/../src/InfluxDB2/API/*
-rm "${SCRIPT_PATH}"/../src/InfluxDB2/Model/*
+rm -f "${SCRIPT_PATH}"/../src/InfluxDB2/API/*
+rm -f "${SCRIPT_PATH}"/../src/InfluxDB2/Model/*
 
 #cp -r "${SCRIPT_PATH}"/../generated/lib/ApiException.php "${SCRIPT_PATH}"/../src/InfluxDB2
 cp -r "${SCRIPT_PATH}"/../generated/lib/ObjectSerializer.php "${SCRIPT_PATH}"/../src/InfluxDB2

scripts/pom.xml

@@ -28,7 +28,7 @@
                     <generateModelTests>false</generateModelTests>
 
                     <verbose>false</verbose>
-                    <output>${project.basedir}/../generated</output>
+                    <output>/generated</output>
                     <addCompileSourceRoot>false</addCompileSourceRoot>
                 </configuration>
             </plugin>

src/InfluxDB2/Client.php

@@ -4,6 +4,11 @@
 
 class Client
 {
+    /**
+     * Client version updated by: 'make release VERSION=1.5.0'
+     */
+    const VERSION = 'dev';
+
     public $options;
     public $closed = false;
     private $autoCloseable = array();

src/InfluxDB2/DefaultApi.php

@@ -40,6 +40,7 @@ public function post($payload, $uriPath, $queryParams, $limit = self::DEFAULT_TI
             $options = [
                 'headers' => [
                     'Authorization' => "Token {$this->options['token']}",
+                    'User-Agent' => 'influxdb-client-php/' . \InfluxDB2\Client::VERSION
                 ],
                 'query' => $queryParams,
                 'body' => $payload,

tests/DefaultApiTest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace InfluxDB2Test;
+
+use GuzzleHttp\Psr7\Response;
+
+require_once('BasicTest.php');
+
+class DefaultApiTest extends BasicTest
+{
+    public function testUserAgent()
+    {
+        $this->mockHandler->append(new Response(204));
+        $this->writeApi->write('h2o,location=west value=33i 15');
+
+        $request = $this->mockHandler->getLastRequest();
+
+        $this->assertStringStartsWith('influxdb-client-php/',
+            strval($request->getHeader("User-Agent")[0]));
+    }
+}

tests/WriteApiTest.php

@@ -2,8 +2,6 @@
 
 namespace InfluxDB2Test;
 
-use GuzzleHttp\Exception\RequestException;
-use GuzzleHttp\Psr7\Request;
 use GuzzleHttp\Psr7\Response;
 use InfluxDB2\ApiException;
 use InfluxDB2\Point;