RCB-530 Proxy (#72)

cp2boston · Li Xu · commit 42f6fc142887 · 2017-09-20T13:38:28.000-04:00
* RCB-530 Proxy Fix

- Modified the requests code to include proxies if they are set in environment
- Created a simple docker-compose file that can be used to test against a proxy

* Minor comment

* PEP8 fix on comment

* Updated multi-part with proxy change

* Tox related changes

- Running py2 and py3 exposed a bug in sentiment.py, which is fixed
- api.py updated
- tox.ini added to tests directory

* Cleaned up proxy code

* Additional proxy cleanup

* Final linefeed on docker-compose

* Updated examples Dockerfile

* Missed a module in Dockerfile

* Mod to Jenkinsfile

- force pull of latest docker image

* Removed kitchen requirement

* Fixed pep8 miscue

* Fixed unclosed connection warning

- In python3.  _make_requests was using a local session, not the class level one
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -9,6 +9,7 @@ node {
         }
         stage("Test with Docker") {
             withEnv(["API_KEY=${env.ROSETTE_API_KEY}", "ALT_URL=${env.BINDING_TEST_URL}"]) {
+                sh "docker pull rosetteapi/docker-python"
                 sh "docker run --rm -e API_KEY=${API_KEY} -e ALT_URL=${ALT_URL} -v ${SOURCEDIR}:/source rosetteapi/docker-python"
             }
         }
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,15 @@
+application:
+  image: rosetteapi/docker-python
+  environment:
+    - API_KEY=$API_KEY
+    - HTTP_PROXY=http://squid:3128
+    - HTTPS_PROXY=https://squid:3128
+  volumes:
+    - .:/source
+  links:
+    - proxy:squid
+
+proxy:
+  image: datadog/squid
+  ports:
+  - 3128:3128
diff --git a/examples/docker/Dockerfile b/examples/docker/Dockerfile
@@ -1,9 +1,28 @@
-FROM python:2.7.11
-MAINTAINER Fiona Hasanaj
-ENV MAINTENANCE_DATE 03.28.2016
+FROM python
+MAINTAINER Chris Park
+LABEL SOURCE="https://github.com/rosette-api/python/blob/develop/examples/docker/Dockerfile"
+LABEL VERSION="1.7.1"
+ENV LANGUAGE=python
 
-# install necessary software
-RUN apt-get -y update && apt-get install -y vim  && apt-get install -y git && pip install rosette_api
+ENV LANG en_US.UTF-8
+
+RUN apt-get update && \
+        apt-get -y install \
+        wget \
+        curl \
+        libssl-dev \
+        libffi-dev \
+        git \
+        vim && \
+        apt-get clean && \
+        rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# required for pip to run as non-root
+RUN mkdir -p /.cache && chmod 777 /.cache
+RUN mkdir -p /.local && chmod 777 /.local
+
+RUN pip install --upgrade tox
+RUN pip install --upgrade autopep8 requests rosette_api
 
 COPY run_python.sh /python/examples/run_python.sh
 RUN chmod 755 /python/examples/run_python.sh
diff --git a/examples/sentiment.py b/examples/sentiment.py
@@ -1,3 +1,4 @@
+#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """
 Example code to call Rosette API to get the sentiment of a local file.
@@ -18,7 +19,7 @@ def run(key, alt_url='https://api.rosette.com/rest/v1/'):
     temp_file = tempfile.NamedTemporaryFile(suffix=".html")
     sentiment_file_data = "<html><head><title>New Ghostbusters Film</title></head><body><p>Original Ghostbuster Dan Aykroyd, who also co-wrote the 1984 Ghostbusters film, couldn’t be more pleased with the new all-female Ghostbusters cast, telling The Hollywood Reporter, “The Aykroyd family is delighted by this inheritance of the Ghostbusters torch by these most magnificent women in comedy.”</p></body></html>"
     message = sentiment_file_data
-    temp_file.write(message)
+    temp_file.write(message if isinstance(message, bytes) else message.encode())
     temp_file.seek(0)
 
     # Create an API instance
diff --git a/rosette/api.py b/rosette/api.py
@@ -524,12 +524,12 @@ def call(self, parameters):
                     'application/json')}
             request = requests.Request(
                 'POST', url, files=files, headers=headers, params=payload)
-            session = requests.Session()
-            prepared_request = session.prepare_request(request)
-            resp = session.send(prepared_request)
-            rdata = resp.content
-            response_headers = {"responseHeaders": dict(resp.headers)}
-            status = resp.status_code
+            prepared_request = self.api.session.prepare_request(request)
+            settings = self.api.session.merge_environment_settings(prepared_request.url, {}, {}, {}, {})
+            response = self.api.session.send(prepared_request, **settings)
+            rdata = response.content
+            response_headers = {"responseHeaders": dict(response.headers)}
+            status = response.status_code
             response = _ReturnObject(
                 _my_loads(rdata, response_headers), status)
         else:
@@ -644,11 +644,12 @@ def _make_request(self, operation, url, data, headers):
 
         request = requests.Request(
             operation, url, data=data, headers=headers, params=payload)
-        session = requests.Session()
-        prepared_request = session.prepare_request(request)
+        prepared_request = self.session.prepare_request(request)
+        # Take into account environment settings, e.g. HTTP_PROXY and HTTPS_PROXY
+        settings = self.session.merge_environment_settings(prepared_request.url, {}, {}, {}, {})
 
         try:
-            response = session.send(prepared_request)
+            response = self.session.send(prepared_request, **settings)
             status = response.status_code
             rdata = response.content
             dict_headers = dict(response.headers)
diff --git a/tests/tox.ini b/tests/tox.ini
@@ -0,0 +1,13 @@
+[tox]
+skipsdist = True
+envlist = py2, py3
+
+[testenv]
+commands =
+    pytest -s --pep8
+deps =
+    pytest
+    pytest-pep8
+    httpretty
+    epydoc
+    requests

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ node {`
`9`	`9`	`}`
`10`	`10`	`stage("Test with Docker") {`
`11`	`11`	`withEnv(["API_KEY=${env.ROSETTE_API_KEY}", "ALT_URL=${env.BINDING_TEST_URL}"]) {`
	`12`	`+ sh "docker pull rosetteapi/docker-python"`
`12`	`13`	`sh "docker run --rm -e API_KEY=${API_KEY} -e ALT_URL=${ALT_URL} -v ${SOURCEDIR}:/source rosetteapi/docker-python"`
`13`	`14`	`}`
`14`	`15`	`}`