Merge pull request #29 from wilau2/use-docker-env-file

Use docker env file

Author: wilau2

.github/CONTRIBUTING.md

@@ -17,6 +17,11 @@ Read and follow according template
 Read and follow according template
 
 
+## Run
+
+Read and follow `package.json`
+
+
 ## commitizen + cz-conventional-changelog
 
 https://github.com/commitizen/cz-cli

.github/README.md

@@ -1,6 +1,6 @@
 FROM williamlauze/harvest-balance-calculator-infra:latest
 
-COPY . /www
+COPY src /www
 
 WORKDIR www
 

Dockerfile

@@ -0,0 +1,59 @@
+[![CircleCI](https://circleci.com/gh/wilau2/harvest-balance-calculator.svg?style=svg)](https://circleci.com/gh/wilau2/harvest-balance-calculator)
+
+# harvest-balance-calculator
+
+Calculate how much overtime or time you owe based on the average hours you should work per weeks.
+
+## Run
+
+```
+docker run --env-file ./env.secret williamlauze/harvest-balance-calculator:1.0.0
+```
+
+## Setup
+create `env.secret` file containing the following information
+
+```
+HARVEST_ACCOUNT_ID=
+HARVEST_AUTHORIZATION=
+BEGIN_DATE='2016-5-2'
+END_DATE='2017-11-24'
+HOURS_PER_WORK_DAY=7.5
+WORK_DAYS_OF_THE_WEEK=0 1 2 3 4
+```
+
+## Environment variables details
+
+### HARVEST_ACCOUNT_ID
+details [here](https://github.com/wilau2/harvest-balance-calculator/blob/master/docs/harvest-credentials.md)
+
+### HARVEST_AUTHORIZATION
+details [here](https://github.com/wilau2/harvest-balance-calculator/blob/master/docs/harvest-credentials.md)
+
+### BEGIN_DATE
+The first day you want to count "**included**"
+
+### END_DATE
+The last day you want to count "**included**"
+
+### HOURS_PER_WORK_DAY
+where 7.5 is 7 hours and 30 minutes
+
+### WORK_DAYS_OF_THE_WEEK
+0 is monday
+
+## Github
+
+click [here](https://github.com/wilau2/harvest-balance-calculator/)
+
+## Dockerhub
+
+click [here](https://hub.docker.com/r/williamlauze/harvest-balance-calculator/)
+
+## Timezone
+Don't worry !
+Harvest will return every time already converted with your timezone
+you can make sure your user has the good timezone ->  `GET https://api.harvestapp.com/v2/users/me`
+
+## Beer
+If you like this project and want to help. You can buy me a beer [here](https://www.paypal.me/williamlauze)

HarvestBalanceCalculator/Config/Loader.py

@@ -0,0 +1,15 @@
+- Login to [harvest](https://id.getharvest.com/developers)
+
+
+![alt text](https://github.com/wilau2/harvest-balance-calculator/blob/master/.github/harvest_creds_creation_step1.png)
+
+![alt text](https://github.com/wilau2/harvest-balance-calculator/blob/master/.github/harvest_creds_creation_step2.png)
+
+![alt text](https://github.com/wilau2/harvest-balance-calculator/blob/master/.github/harvest_creds_creation_step3.png)
+
+- Add to following section to your `env.secret`
+
+```
+HARVEST_ACCOUNT_ID=123456
+HARVEST_AUTHORIZATION=Bearer 65776576576675765765
+```

HarvestBalanceCalculator/Config/__init__.py

@@ -3,3 +3,5 @@ FROM python:3.6.3-alpine3.6
 RUN pip3 install python-dateutil
 RUN pip3 install isoweek
 RUN pip3 install pycodestyle
+RUN pip3 install -U "python-dotenv[cli]"
+

HarvestBalanceCalculator/Config/tests/testLoader.py

@@ -1,12 +1,12 @@
 {
   "name": "harvest-balance-calculator-infra",
   "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "config" : {
+    "dockerorganization" : "williamlauze"
+  },
   "scripts": {
-    "docker:build": "docker build -t williamlauze/harvest-balance-calculator-infra .",
-    "docker:push": "docker push williamlauze/harvest-balance-calculator-infra"
+    "docker:build": "docker build -t ${npm_package_config_dockerorganization}/${npm_package_name} .",
+    "docker:push": "docker push ${npm_package_config_dockerorganization}/${npm_package_name}"
   },
-  "author": "",
-  "license": "ISC"
+  "license": "MIT"
 }

HarvestBalanceCalculator/__init__.pyc

@@ -1,28 +1,31 @@
 {
   "name": "harvest-balance-calculator",
-  "version": "1.0.0",
-  "description": "With this project you can calculate how much overtime or time you owe based on the average hours you should work per weeks.",
-  "main": "index.js",
-  "directories": {
-    "doc": "docs"
+  "version": "1.0.1",
+  "config" : {
+    "dockerorganization" : "williamlauze"
   },
   "scripts": {
-    "docker:build": "docker build -t harvest-balance-calculator .",
-    "docker:run": "docker run harvest-balance-calculator",
-    "docker:teststep": "docker run harvest-balance-calculator python3 -m unittest discover -v",
-    "docker:codestyle": "docker run harvest-balance-calculator pycodestyle HarvestBalanceCalculator",
-    "docker:start": "npm run docker:build && npm run docker:run",
+    "deploy": "npm run deploy:build && npm run deploy:push",
+    "deploy:build": "docker build -t ${npm_package_config_dockerorganization}/${npm_package_name}:${npm_package_version} .",
+    "deploy:push": "docker push ${npm_package_config_dockerorganization}/${npm_package_name}:${npm_package_version}",
+    "start": "npm run start:pull && npm run start:exec",
+    "start:pull": "docker pull ${npm_package_config_dockerorganization}/${npm_package_name}:${npm_package_version}",
+    "start:exec": "docker run --env-file ./env.secret ${npm_package_config_dockerorganization}/${npm_package_name}:${npm_package_version}",
+    "docker:teststep": "docker run ${npm_package_name} python3 -m unittest discover -v",
+    "docker:codestyle": "docker run ${npm_package_name} pycodestyle HarvestBalanceCalculator",
+    "docker:build": "docker build -t ${npm_package_name} .",
+    "docker:start": "docker run --env-file ./env.secret ${npm_package_name}",
     "docker:test": "npm run docker:build && npm run docker:codestyle && npm run docker:teststep",
-    "codestyle": "pipenv run pycodestyle HarvestBalanceCalculator",
-    "test": "pipenv run python -m unittest discover -v",
-    "start": "pipenv run python main.py"
+    "python:codestyle": "pipenv run pycodestyle src",
+    "python:test": "pipenv run python -m unittest discover -v src",
+    "python:start": "pipenv run python src/main.py"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wilau2/harvest-balance-calculator.git"
   },
-  "author": "",
-  "license": "ISC",
+  "author": "William Lauze",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/wilau2/harvest-balance-calculator/issues"
   },

README.md

@@ -1,8 +1,10 @@
+import os
+
+
 class WorkingPreference:
-    def __init__(self, config):
-        self.config = config
-        self.workdays = config["workDaysOfTheWeek"]
-        self.hours_per_day = float(config["hoursPerWorkDay"])
+    def __init__(self):
+        self.workdays = list(map(float, os.environ['WORK_DAYS_OF_THE_WEEK'].split()))
+        self.hours_per_day = float(os.environ['HOURS_PER_WORK_DAY'])
 
     def is_a_working_day(self, date):
         return True if date.weekday() in self.workdays else False

config.json

@@ -1,14 +1,16 @@
+import os
+
 from datetime import timedelta
 from dateutil.parser import parse
 
 from HarvestBalanceCalculator import WorkingPreference
 
 
 class WorkingTimeInterval:
-    def __init__(self, config):
-        self.working_preference = WorkingPreference(config)
-        self.begin_date = parse(config["beginDate"]).date()
-        self.end_date = parse(config["endDate"]).date()
+    def __init__(self):
+        self.working_preference = WorkingPreference()
+        self.begin_date = parse(os.environ['BEGIN_DATE']).date()
+        self.end_date = parse(os.environ['END_DATE']).date()
 
     def get_number_of_working_days(self):
         delta = (self.end_date - self.begin_date)

docs/harvest-credentials.md

@@ -1,4 +1,3 @@
-from HarvestBalanceCalculator.Config import Loader
 from HarvestBalanceCalculator.HarvestTimeEntries import HarvestTimeEntries
 from HarvestBalanceCalculator.WorkingPreference import WorkingPreference
 from HarvestBalanceCalculator.WorkingTimeInterval import WorkingTimeInterval

infra/Dockerfile

@@ -1,12 +1,17 @@
 import unittest
+import os
 from datetime import datetime
 from HarvestBalanceCalculator import WorkingPreference
 
-config = {
-    "workDaysOfTheWeek": [0, 1, 2],
-    "hoursPerWorkDay": 7
-}
-working_preference = WorkingPreference(config)
+# config = {
+#     "workDaysOfTheWeek": [0, 1, 2],
+#     "hoursPerWorkDay": 7
+# }
+
+os.environ['WORK_DAYS_OF_THE_WEEK'] = '0 1 2'
+os.environ['HOURS_PER_WORK_DAY'] = '7'
+
+working_preference = WorkingPreference()
 a_monday = datetime(2016, 5, 2)
 a_tuesday = datetime(2016, 5, 3)
 a_wednesday = datetime(2016, 5, 4)

infra/package.json

@@ -1,13 +1,10 @@
 import unittest
+import os
 from HarvestBalanceCalculator import WorkingTimeInterval
 
-config = {
-    "beginDate": "2016-5-2",
-    "endDate": "2016-5-8",
-    "workDaysOfTheWeek": [0, 1, 2],
-    "hoursPerWorkDay": 7
-}
-working_time_interval = WorkingTimeInterval(config)
+os.environ['BEGIN_DATE'] = '2016-5-2'
+os.environ['END_DATE'] = '2016-5-8'
+working_time_interval = WorkingTimeInterval()
 
 
 class TestWorkingTimeInterval(unittest.TestCase):

package.json

@@ -1,22 +1,19 @@
 import http.client
 import json
-
-from HarvestBalanceCalculator.Config.Loader import load_configuration_file
+import os
 
 
 class HarvestHttpClient:
     def __init__(self,
-                 config_loader=load_configuration_file,
                  https_connection=http.client.HTTPSConnection):
         self.HARVEST_API_URL = "api.harvestapp.com"
         self.HARVEST_ACCOUNT_ID_HEADER = "Harvest-Account-ID"
         self.HARVEST_AUTHORIZATION_HEADER = "Authorization"
         self.HARVEST_USER_AGENT = "User-Agent"
         self.conn = https_connection(self.HARVEST_API_URL)
-        secret_config = config_loader('config.json.secret')
         self.headers = {
-            self.HARVEST_ACCOUNT_ID_HEADER: secret_config["harvest"]["accountId"],
-            self.HARVEST_AUTHORIZATION_HEADER: secret_config["harvest"]["authorization"],
+            self.HARVEST_ACCOUNT_ID_HEADER: os.environ['HARVEST_ACCOUNT_ID'],
+            self.HARVEST_AUTHORIZATION_HEADER: os.environ['HARVEST_AUTHORIZATION'],
             self.HARVEST_USER_AGENT: "HarvestBalanceCalculator API Example"
         }
 

HarvestBalanceCalculator/HarvestTimeEntries.py src/HarvestBalanceCalculator/HarvestTimeEntries.py

@@ -1,11 +1,15 @@
 import unittest
+import os
 from datetime import datetime
 from unittest.mock import MagicMock, Mock
 
 from HarvestHttpClient import Client
 
 
 class TestTimeUtils(unittest.TestCase):
+    os.environ['HARVEST_ACCOUNT_ID'] = 'dumpAccountId'
+    os.environ['HARVEST_AUTHORIZATION'] = 'dumbAuthorization'
+
     def test_get_user_time_entries_when_error(self):
         with self.assertRaises(RuntimeError):
             self.__given_an_error()
@@ -71,9 +75,7 @@ def __given_an_error(self):
 
     @staticmethod
     def __given_http_client_with_secret_config_and_http_client():
-        harvest_http_client = Client.HarvestHttpClient(MagicMock(return_value={
-            "harvest": {"accountId": "dumpAccountId", "authorization": "dumbAuthorization"}
-        }), MagicMock())
+        harvest_http_client = Client.HarvestHttpClient(MagicMock())
         mock = Mock()
         mock.status = 200
         harvest_http_client.conn.getresponse.return_value = mock
@@ -82,7 +84,5 @@ def __given_http_client_with_secret_config_and_http_client():
         return harvest_http_client
 
 
-
-
 if __name__ == '__main__':
     unittest.main()