Add code of conduct

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at [kiko@barcelli.net](mailto:kiko@barcelli.net).
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

README.md

@@ -36,6 +36,12 @@ to the Banqup API of Unifiedpost.
     - Fetch the invoice in Banqup to verify its existence in the portal and retrieve its id in Banqup.
     - Post a request to the Banqup API to mark the invoice as 'Paid'.
     - Display the response from the Banqup API, confirming the success or failure of the request.
+* Run `python3 delete_invoice.py <documentNo>`, where `<documentNo>` is the human readable invoice number in Openbravo, to delete an invoice in Banqup portal via the API.
+  - The application will do the following:
+    - Authenticate with Banqup using OAuth2, for which it will launch a webbrowser to complete the authentication. The browser will receive the response from the Banqup server including the authentication token. The user will need to 'Copy' and 'Paste' this response at the corresponding prompt in the terminal.
+    - Fetch the invoice in Banqup to verify its existence in the portal and retrieve its id in Banqup.
+    - Post a request to the Banqup API to delete the invoice.
+    - Display the response from the Banqup API, confirming the success or failure of the request.
 
 **Credits**
 

SECURITY.md

@@ -0,0 +1,19 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.5.x   | :heavy_check_mark: |
+| 0.4.x   | :heavy_check_mark: |
+| 0.3.x   | :heavy_check_mark: |
+| 0.2.x   | :x:                |
+| 0.1.x   | :x:                |
+
+## Reporting
+
+We take Security seriously, so if you have discovered a security risk report it by email to [kiko@barcelli.net](mailto:kiko@barcelli.net) preferably using end-to-end encrypted messages with the following PGP key: [0x70c7d0901133471df2e6e9a8006c13a68e25d3b7](https://keyserver.ubuntu.com/pks/lookup?op=get&search=0x70c7d0901133471df2e6e9a8006c13a68e25d3b7).
+
+Our team will assess and handle it accordingly. Please don't disclose security risks publicly until they have been handled by our team.
+
+Your email will be acknowledged within 24 hours, and you will receive a more detailed email response about the actions to be taken to handle your report within 1 week.

api.py

@@ -61,13 +61,16 @@ class OpenbravoToBanqupAPI:
 		self.authHandler.checkHeaderTokens()
 		response = self.doRequest(method, url, data, headers, files)
 
-		if 'json' in response.headers['Content-Type']:
-			respContent = response.json()
-		elif 'pdf' in response.headers['Content-Type']:
-			respContent = response.content
-        
+		if response.status_code != 204:
+			if 'json' in response.headers['Content-Type']:
+				respContent = response.json()
+			elif 'pdf' in response.headers['Content-Type']:
+				respContent = response.content
+		else:
+			respContent = ''
+
 		return response.status_code, response.headers, respContent
-    
+
 	def get(self, url, data=None, headers=None):
 		status, headers, response = self.request('GET', url, data, headers)
 		return status, headers, response

config-sample.py

@@ -12,7 +12,10 @@ userpass_b64 = base64.b64encode((ob_user+':'+ob_pass).encode('ascii')).decode('a
 # 2) you may enter the user:password base64 encoded
 #userpass_b64 = "your-ob-user:your-ob-password-base64-encoded"
 
-# You may use this one product as a 'comment' in order to print the invoice line description instead of the product description
+# You may use a special product as a 'comment flag' in order to print the invoice line description instead of the product description.
+# To take advantage of this feature, first create a product for this purpose in the Master Data of Openbravo, and then update
+# the line below to match the 'Search Key' of that specific product:
+# comment_product = 'search-key-of-your-comment-product'
 comment_product = 'Comment/Note'
 
 # Banqup API parameters

delete_invoice.py

@@ -0,0 +1,35 @@
+import requests
+from requests_oauthlib import OAuth2Session
+import json
+import sys
+import webbrowser
+from config import *
+from cachehandler import CacheHandler
+from authhandler import AuthHandler
+from api import OpenbravoToBanqupAPI
+from datetime import timedelta, date
+
+def delete_invoice(document):
+
+	api = OpenbravoToBanqupAPI(bq_client_id,bq_client_secret)
+	authUrl = api.authHandler.getAuthURL(bq_redirect_uri)
+	webbrowser.open(authUrl)
+	response = input('Paste response: ')
+	token = api.authHandler.retrieveToken(response, redirectUri=bq_redirect_uri)
+	#print(token)
+	invoice_list = api.get('sales-invoices?client_id='+banqup_client_id+'&sales_invoice_number='+document,None,None)
+	if not invoice_list[2]['results']:
+		print('***********************')
+		print('The invoice number provided does not exist in the Banqup portal.')
+		print('Please verify and try again.')
+		print('***********************')
+		return
+	invoice_id = str(invoice_list[2]['results'][0]['id'])
+	#print(invoice_id)
+	payload = json.dumps({})
+	invoice_action = api.delete('sales-invoices/'+invoice_id,json.loads(payload),None)
+	print(invoice_action)
+
+
+if __name__ == '__main__':
+	delete_invoice(str(sys.argv[1]))