initial commit

Author: yorek

.gitignore

@@ -4,7 +4,6 @@
 ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
 
 # User-specific files
-*.rsuser
 *.suo
 *.user
 *.userosscache
@@ -13,23 +12,17 @@
 # User-specific files (MonoDevelop/Xamarin Studio)
 *.userprefs
 
-# Mono auto generated files
-mono_crash.*
-
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/
 [Rr]elease/
 [Rr]eleases/
 x64/
 x86/
-[Aa][Rr][Mm]/
-[Aa][Rr][Mm]64/
 bld/
 [Bb]in/
 [Oo]bj/
 [Ll]og/
-[Ll]ogs/
 
 # Visual Studio 2015/2017 cache/options directory
 .vs/
@@ -43,10 +36,9 @@ Generated\ Files/
 [Tt]est[Rr]esult*/
 [Bb]uild[Ll]og.*
 
-# NUnit
+# NUNIT
 *.VisualState.xml
 TestResult.xml
-nunit-*.xml
 
 # Build Results of an ATL Project
 [Dd]ebugPS/
@@ -60,14 +52,15 @@ BenchmarkDotNet.Artifacts/
 project.lock.json
 project.fragment.lock.json
 artifacts/
+**/Properties/launchSettings.json
 
 # StyleCop
 StyleCopReport.xml
 
 # Files built by Visual Studio
 *_i.c
 *_p.c
-*_h.h
+*_i.h
 *.ilk
 *.meta
 *.obj
@@ -84,7 +77,6 @@ StyleCopReport.xml
 *.tlh
 *.tmp
 *.tmp_proj
-*_wpftmp.csproj
 *.log
 *.vspscc
 *.vssscc
@@ -127,6 +119,9 @@ _ReSharper*/
 *.[Rr]e[Ss]harper
 *.DotSettings.user
 
+# JustCode is a .NET coding add-in
+.JustCode
+
 # TeamCity is a build add-in
 _TeamCity*
 
@@ -184,8 +179,6 @@ PublishScripts/
 
 # NuGet Packages
 *.nupkg
-# NuGet Symbol Packages
-*.snupkg
 # The packages folder can be ignored because of Package Restore
 **/[Pp]ackages/*
 # except build/, which is used as an MSBuild target.
@@ -210,14 +203,12 @@ BundleArtifacts/
 Package.StoreAssociation.xml
 _pkginfo.txt
 *.appx
-*.appxbundle
-*.appxupload
 
 # Visual Studio cache files
 # files ending in .cache can be ignored
 *.[Cc]ache
 # but keep track of directories ending in .cache
-!?*.[Cc]ache/
+!*.[Cc]ache/
 
 # Others
 ClientBin/
@@ -230,7 +221,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk
+# Including strong name files can present a security risk 
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -261,9 +252,6 @@ ServiceFabricBackup/
 *.bim.layout
 *.bim_*.settings
 *.rptproj.rsuser
-*- [Bb]ackup.rdl
-*- [Bb]ackup ([0-9]).rdl
-*- [Bb]ackup ([0-9][0-9]).rdl
 
 # Microsoft Fakes
 FakesAssemblies/
@@ -299,8 +287,12 @@ paket-files/
 # FAKE - F# Make
 .fake/
 
-# CodeRush personal settings
-.cr/personal
+# JetBrains Rider
+.idea/
+*.sln.iml
+
+# CodeRush
+.cr/
 
 # Python Tools for Visual Studio (PTVS)
 __pycache__/
@@ -325,7 +317,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output
+# Azure Stream Analytics local run output 
 ASALocalRun/
 
 # MSBuild Binary and Structured Log
@@ -334,17 +326,10 @@ ASALocalRun/
 # NVidia Nsight GPU debugger configuration file
 *.nvuser
 
-# MFractors (Xamarin productivity tool) working folder
+# MFractors (Xamarin productivity tool) working folder 
 .mfractor/
 
-# Local History for Visual Studio
-.localhistory/
-
-# BeatPulse healthcheck temp database
-healthchecksdb
-
-# Backup folder for Package Reference Convert tool in Visual Studio 2017
-MigrationBackup/
-
-# Ionide (cross platform F# VS Code tools) working folder
-.ionide/
+# Additional Files
+venv/
+env/
+env.*

.vscode/launch.json

@@ -0,0 +1,25 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Flask",
+            "type": "python",
+            "request": "launch",
+            "module": "flask",
+            "env": {
+                "FLASK_APP": "app.py",
+                "FLASK_ENV": "development",
+                "FLASK_DEBUG": "0"
+            },
+            "args": [
+                "run",
+                "--no-debugger",
+                "--no-reload"
+            ],
+            "jinja": true
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "python.pythonPath": "venv\\Scripts\\python.exe",
+    "cSpell.words": [
+        "pyodbc"
+    ]
+}

app.py

@@ -0,0 +1,83 @@
+import sys
+import os
+from flask import Flask
+from flask_restful import reqparse, abort, Api, Resource
+import json
+import pyodbc
+
+# Initialize Flask
+app = Flask(__name__)
+
+# Setup Flask Restful framework
+api = Api(app)
+parser = reqparse.RequestParser()
+parser.add_argument('customer')
+
+# Create connection to Azure SQL
+conn = pyodbc.connect(os.environ['SQLAZURECONNSTR_WWIF'])
+
+class Queryable(Resource):
+    def executeQueryJson(self, verb, payload=None):
+        result = {}        
+        cursor = conn.cursor()    
+        entity = type(self).__name__.lower()
+        procedure = f"web.{verb}_{entity}"
+        try:
+            if payload:
+                cursor.execute(f"EXEC {procedure} ?", json.dumps(payload))
+            else:
+                cursor.execute(f"EXEC {procedure}")
+
+            result = cursor.fetchone()
+
+            if result:
+                result = json.loads(result[0])                           
+            else:
+                result = {}
+
+            cursor.commit()    
+        except:
+            print("Unexpected error:", sys.exc_info()[0])
+            raise
+        finally:    
+            cursor.close()
+
+        return result
+
+# Customer Class
+class Customer(Queryable):
+    def get(self, customer_id):     
+        customer = {}
+        customer["CustomerID"] = customer_id
+        result = self.executeQueryJson("get", customer)   
+        return result, 200
+    
+    def put(self):
+        args = parser.parse_args()
+        customer = json.loads(args['customer'])
+        result = self.executeQueryJson("put", customer)
+        return result, 201
+
+    def patch(self, customer_id):
+        args = parser.parse_args()
+        customer = json.loads(args['customer'])
+        customer["CustomerID"] = customer_id        
+        result = self.executeQueryJson("patch", customer)
+        return result, 202
+
+    def delete(self, customer_id):       
+        customer = {}
+        customer["CustomerID"] = customer_id
+        result = self.executeQueryJson("delete", customer)
+        return result, 202
+
+# Customers Class
+class Customers(Queryable):
+    def get(self):     
+        result = self.executeQueryJson("get")   
+        return result, 200
+    
+    
+# Create API routes
+api.add_resource(Customer, '/customer', '/customer/<customer_id>')
+api.add_resource(Customers, '/customers')

azure-deploy.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Make sure these values are correct for your environment
+resourceGroup="azure-sql-db-python-rest-api"
+appName="azure-sql-db-python-rest-api"
+location="WestUS2" 
+
+# Change this if you are using your own github repository
+gitSource="https://github.com/yorek/azure-sql-db-python-rest-api.git"
+
+az group create \
+    -n $resourceGroup \
+    -l $location
+
+az appservice plan create \
+    -g $resourceGroup \
+    -n "linux-plan" \
+    --sku B1 \
+    --is-linux
+
+az webapp create \
+    -g $resourceGroup \
+    -n $appName \
+    --plan "linux-plan" \
+    --runtime "Python|3.7" \
+    --deployment-source-url $gitSource \
+    --deployment-source-branch master
+
+az webapp config connection-string set \
+    -g $resourceGroup \
+    -n $appName \    
+    --settings WWIF=$SQLAZURECONNSTR_WWIF
+    --connection-string-type=SQLAzure

requirements.txt

@@ -0,0 +1,3 @@
+pyodbc
+flask
+flask-restful

sample-usage.md

@@ -0,0 +1,25 @@
+# Sample REST API usage with cUrl
+
+## Get a customer
+
+```bash
+curl -s -X GET http://localhost:5000/customer/123
+```
+
+## Create new customer
+
+```bash
+curl -s -X PUT http://localhost:5000/customer -d 'customer={"CustomerName": "John Doe", "PhoneNumber": "123-234-5678", "FaxNumber": "123-234-5678", "WebsiteURL": "http://www.something.com", "Delivery": { "AddressLine1": "One Microsoft Way", "PostalCode": 98052 }}'
+```
+
+## Update customer
+
+```bash
+curl -s -X PATCH http://localhost:5000/customer/123 -d 'customer={"CustomerName": "Jane Dean", "PhoneNumber": "231-778-5678" }'
+```
+
+## Delete a customer
+
+```bash
+curl -s -X DELETE http://localhost:5000/customer/123
+```

simple-app.py

@@ -0,0 +1,42 @@
+import sys
+import os
+from flask import Flask
+from flask_restful import reqparse, Api, Resource
+import json
+import pyodbc
+
+# This is a simplified example that only support GET request.
+# It is meant to help you to get you started if you're new to development
+# and to show how simple is using Azure SQL with Python
+# A more complete example is in "app.py"
+# To run this simplified sample follow the README, but instead of running "flask run"
+# just run "python ./simple-app.py"
+# Enjoy!
+
+# Initialize Flask
+app = Flask(__name__)
+
+# Setup Flask Restful framework
+api = Api(app)
+parser = reqparse.RequestParser()
+parser.add_argument('customer')
+
+# Create connection to Azure SQL
+conn = pyodbc.connect(os.environ['SQLAZURECONNSTR_WWIF'])
+
+# Customer Class
+class Customer(Resource):
+    def get(self, customer_id):     
+        customer = {"CustomerID": customer_id}
+        cursor = conn.cursor()    
+        cursor.execute("EXEC web.get_customer ?", json.dumps(customer))
+        result = json.loads(cursor.fetchone()[0])        
+        cursor.close()
+        return result, 200
+    
+# Create API route to defined Customer class
+api.add_resource(Customer, '/customer', '/customer/<customer_id>')
+
+# Start App
+if __name__ == '__main__':
+    app.run()

sql/WideWorldImportersUpdates.sql

@@ -0,0 +1,193 @@
+/*
+	Create schema
+*/
+IF SCHEMA_ID('web') IS NULL BEGIN	
+	EXECUTE('CREATE SCHEMA [web]');
+END
+GO
+
+/*
+	Create user to be used in the sample API solution
+*/
+IF USER_ID('PythonWebApp') IS NULL BEGIN	
+	CREATE USER [PythonWebApp] WITH PASSWORD = 'a987REALLY#$%TRONGpa44w0rd';	
+END
+
+/*
+	Grant execute permission to created users
+*/
+GRANT EXECUTE ON SCHEMA::[web] TO [PythonWebApp];
+GO
+
+/*
+	Return details on a specific customer
+*/
+CREATE OR ALTER PROCEDURE web.get_customer
+@Json NVARCHAR(MAX)
+AS
+SET NOCOUNT ON;
+DECLARE @CustomerId INT = JSON_VALUE(@Json, '$.CustomerID');
+SELECT 
+	[CustomerID], 
+	[CustomerName], 
+	[PhoneNumber], 
+	[FaxNumber], 
+	[WebsiteURL],
+	[DeliveryAddressLine1] AS 'Delivery.AddressLine1',
+	[DeliveryAddressLine2] AS 'Delivery.AddressLine2',
+	[DeliveryPostalCode] AS 'Delivery.PostalCode'	
+FROM 
+	[Sales].[Customers] 
+WHERE 
+	[CustomerID] = @CustomerId
+FOR JSON PATH
+GO
+
+/*
+	Delete a specific customer
+*/
+CREATE OR ALTER PROCEDURE web.delete_customer
+@Json NVARCHAR(MAX)
+AS
+SET NOCOUNT ON;
+DECLARE @CustomerId INT = JSON_VALUE(@Json, '$.CustomerID');
+DELETE FROM [Sales].[Customers] WHERE CustomerId = @CustomerId;
+SELECT * FROM (SELECT CustomerID = @CustomerId) D FOR JSON AUTO;
+GO
+
+/*
+	Update (Patch) a specific customer
+*/
+CREATE OR ALTER PROCEDURE web.patch_customer
+@Json NVARCHAR(MAX)
+AS
+SET NOCOUNT ON;
+DECLARE @CustomerId INT = JSON_VALUE(@Json, '$.CustomerID');
+WITH [source] AS 
+(
+	SELECT * FROM OPENJSON(@Json) WITH (
+		[CustomerID] INT, 
+		[CustomerName] NVARCHAR(100), 
+		[PhoneNumber] NVARCHAR(20), 
+		[FaxNumber] NVARCHAR(20), 
+		[WebsiteURL] NVARCHAR(256),
+		[DeliveryAddressLine1] NVARCHAR(60) '$.Delivery.AddressLine1',
+		[DeliveryAddressLine2] NVARCHAR(60) '$.Delivery.AddressLine2',
+		[DeliveryPostalCode] NVARCHAR(10) '$.Delivery.PostalCode'	
+	)
+)
+UPDATE
+	t
+SET
+	t.[CustomerName] = COALESCE(s.[CustomerName], t.[CustomerName]),
+	t.[PhoneNumber] = COALESCE(s.[PhoneNumber], t.[PhoneNumber]),
+	t.[FaxNumber] = COALESCE(s.[FaxNumber], t.[FaxNumber]),
+	t.[WebsiteURL] = COALESCE(s.[WebsiteURL], t.[WebsiteURL]),
+	t.[DeliveryAddressLine1] = COALESCE(s.[DeliveryAddressLine1], t.[DeliveryAddressLine1]),
+	t.[DeliveryAddressLine2] = COALESCE(s.[DeliveryAddressLine2], t.[DeliveryAddressLine2]),
+	t.[DeliveryPostalCode] = COALESCE(s.[DeliveryPostalCode], t.[DeliveryPostalCode])
+FROM
+	[Sales].[Customers] t
+INNER JOIN
+	[source] s ON t.[CustomerID] = s.[CustomerID]
+WHERE
+	t.CustomerId = @CustomerId;
+
+DECLARE @Json2 NVARCHAR(MAX) = N'{"CustomerID": ' + CAST(@CustomerId AS NVARCHAR(9)) + N'}'
+EXEC web.get_customer @Json2;
+GO
+
+/*
+	Create a new customer
+*/
+
+CREATE OR ALTER PROCEDURE web.put_customer
+@Json NVARCHAR(MAX)
+AS
+SET NOCOUNT ON;
+DECLARE @CustomerId INT = NEXT VALUE FOR Sequences.CustomerID;
+WITH [source] AS 
+(
+	SELECT * FROM OPENJSON(@Json) WITH (		
+		[CustomerName] NVARCHAR(100), 
+		[PhoneNumber] NVARCHAR(20), 
+		[FaxNumber] NVARCHAR(20), 
+		[WebsiteURL] NVARCHAR(256),
+		[DeliveryAddressLine1] NVARCHAR(60) '$.Delivery.AddressLine1',
+		[DeliveryAddressLine2] NVARCHAR(60) '$.Delivery.AddressLine2',
+		[DeliveryPostalCode] NVARCHAR(10) '$.Delivery.PostalCode'	
+	)
+)
+INSERT INTO [Sales].[Customers] 
+(
+	CustomerID, 
+	CustomerName, 	
+	BillToCustomerID, 
+	CustomerCategoryID,	
+	PrimaryContactPersonID,
+	DeliveryMethodID,
+	DeliveryCityID,
+	PostalCityID,
+	AccountOpenedDate,
+	StandardDiscountPercentage,
+	IsStatementSent,
+	IsOnCreditHold,
+	PaymentDays,
+	PhoneNumber, 
+	FaxNumber, 
+	WebsiteURL, 
+	DeliveryAddressLine1, 
+	DeliveryAddressLine2, 
+	DeliveryPostalCode,
+	PostalAddressLine1, 
+	PostalAddressLine2, 
+	PostalPostalCode,
+	LastEditedBy
+)
+SELECT
+	@CustomerId, 
+	CustomerName, 
+	@CustomerId, 
+	5, -- Computer Shop
+	1, -- No contact person
+	1, -- Post Delivery 
+	28561, -- Redmond
+	28561, -- Redmond
+	SYSUTCDATETIME(),
+	0.00,
+	0,
+	0,
+	30,
+	PhoneNumber, 
+	FaxNumber, 
+	WebsiteURL, 
+	DeliveryAddressLine1, 
+	DeliveryAddressLine2, 
+	DeliveryPostalCode,
+	DeliveryAddressLine1, 
+	DeliveryAddressLine2, 
+	DeliveryPostalCode,
+	1 
+FROM
+	[source]
+;
+
+DECLARE @Json2 NVARCHAR(MAX) = N'{"CustomerID": ' + CAST(@CustomerId AS NVARCHAR(9)) + N'}'
+EXEC web.get_customer @Json2;
+GO
+
+CREATE OR ALTER PROCEDURE web.get_customers
+AS
+SET NOCOUNT ON;
+-- Cast is needed to corretly inform pyodbc of output type is NVARCHAR(MAX)
+-- Needed if generated json is bigger then 4000 bytes and thus pyodbc trucates it
+-- https://stackoverflow.com/questions/49469301/pyodbc-truncates-the-response-of-a-sql-server-for-json-query
+SELECT CAST((
+	SELECT 
+		[CustomerID], 
+		[CustomerName]
+	FROM 
+		[Sales].[Customers] 
+	FOR JSON PATH) AS NVARCHAR(MAX)) AS JsonResult
+GO
+