Changeset 1473

Timestamp:

07/03/08 22:06:27 (3 months ago)

Author:

thijs

Message:

Fix issue #306: User-Agent missing in AMF client.

Patch by: thijs
Review by: nick

Location:

pyamf/trunk

Files:

• CHANGES.txt (modified) (1 diff)
• pyamf/remoting/client/__init__.py (modified) (6 diffs)
• pyamf/tests/remoting/test_client.py (modified) (3 diffs)

pyamf/trunk/CHANGES.txt

@@ -7 +7 @@
 0.4.0 (unreleased)
 ------------------
+ - The remoting client now sends a customizable User-Agent header (Ticket:306)
  - Added ability to set the HTTP referer in remoting client (Ticket:316)
  - Fixed issue where the AMF3 encoder assumed objects with a 'tag' attribute

pyamf/trunk/pyamf/remoting/client/__init__.py

@@ -16 +16 @@
 #: @see: L{ClientTypes<pyamf.ClientTypes>}
 DEFAULT_CLIENT_TYPE = pyamf.ClientTypes.Flash6
+
+#: Default user agent is C{PyAMF/x.x.x}.
+DEFAULT_USER_AGENT = 'PyAMF/%s' % '.'.join(map(lambda x: str(x), pyamf.__version__))
 
 HTTP_OK = 200
@@ -187 +190 @@
 
     def __init__(self, url, amf_version=pyamf.AMF0, client_type=DEFAULT_CLIENT_TYPE,
-                 referer=None):
+                 referer=None, user_agent=DEFAULT_USER_AGENT):
         self.logger = logging.instance_logger(self)
         self.original_url = url
@@ -193 +196 @@
         self.request_number = 1
 
+        self.user_agent = user_agent
         self.referer = referer
         self.amf_version = amf_version
@@ -239 +243 @@
         self.logger.info('Creating connection to %s://%s:%s' % (self.url[0], hostname, port))
         self.logger.debug('Referer: %s' % self.referer)
+        self.logger.debug('User-Agent: %s' % self.user_agent)
         
     def addHeader(self, name, value, must_understand=False):
@@ -341 +346 @@
         self.logger.debug('Executing single request: %s' % request)
         body = remoting.encode(self.getAMFRequest([request]))
-        headers = {'Content-Type': remoting.CONTENT_TYPE}
+        headers = {'Content-Type': remoting.CONTENT_TYPE,
+                   'User-Agent': self.user_agent}
 
         if self.referer is not None:
@@ -361 +367 @@
         """
         body = remoting.encode(self.getAMFRequest(self.requests))
-        headers = {'Content-Type': remoting.CONTENT_TYPE}
+        headers = {'Content-Type': remoting.CONTENT_TYPE,
+                   'User-Agent': self.user_agent}
 
         if self.referer is not None:

pyamf/trunk/pyamf/tests/remoting/test_client.py

@@ -5 +5 @@
 
 """
-Test for Remoting client.
+Tests for Remoting client.
 
 @since: 0.1.0
@@ -371 +371 @@
 
         dc.tc = self
-        dc.expected_headers = {'Content-Type': 'application/x-amf'}
+        dc.expected_headers = {'Content-Type': remoting.CONTENT_TYPE,
+                               'User-Agent': client.DEFAULT_USER_AGENT}
 
         service = gw.getService('baz', auto_execute=False)
@@ -409 +410 @@
 
         dc.tc = self
-        dc.expected_headers = {'Content-Type': 'application/x-amf'}
+        dc.expected_headers = {'Content-Type': 'application/x-amf',
+                               'User-Agent': client.DEFAULT_USER_AGENT}
 
         baz = gw.getService('baz', auto_execute=False)