Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
stomper
Artifacts are distributable versions of a package. It typically includes the source code and metadata
Advanced tools
stomper - npm Package Compare versions
| include README.md |
+167
| ======= | ||
| Stomper | ||
| ======= | ||
| .. contents:: | ||
| :Author: | ||
| Oisin Mulvihill | ||
| Contributors: | ||
| Micheal Twomey, Ricky Iacovou <iacovou at gmail dot com>, | ||
| Arfrever Frehtes <arfrever dot fta at gmail dot com>, | ||
| Niki Pore <niki pore at gmail dot com>, | ||
| Simon Chopin | ||
| Introduction | ||
| ------------ | ||
| This is a python client implementation of the STOMP protocol. | ||
| The client is attempting to be transport layer neutral. This module provides | ||
| functions to create and parse STOMP messages in a programmatic fashion. The | ||
| messages can be easily generated and parsed, however its up to the user to do | ||
| the sending and receiving. The STOMP protocol specification can be found here: | ||
| - `Stomp Protocol <http://stomp.codehaus.org/Protocol/>`_ | ||
| I've looked at the stomp client by Jason R. Briggs. I've based some of the | ||
| 'function to message' generation on how his client does it. The client can | ||
| be found at the follow address however it isn't a dependency. | ||
| - `stompy <http://www.briggs.net.nz/log/projects/stomppy>`_ | ||
| In testing this library I run against ActiveMQ project. The server runs | ||
| in java, however its fairly standalone and easy to set up. The projects | ||
| page is here: | ||
| - `ActiveMQ <http://activemq.apache.org/>`_ | ||
| Source Code | ||
| ----------- | ||
| The code can be accessed via subversion via google project hosting. Further | ||
| details can be found here: | ||
| - `Stomper http://code.google.com/p/stomper/`_ | ||
| Examples | ||
| -------- | ||
| Basic Usage | ||
| ~~~~~~~~~~~ | ||
| To see some basic code usage example see "*example/stomper_usage.py*". The unit test | ||
| "*tests/teststomper.py*" illustrates how to use all aspects of the code. | ||
| Receive/Sender | ||
| ~~~~~~~~~~~~~~ | ||
| The example "*receiver.py*" and "*sender.py*" show how messages and generated and then | ||
| transmitted using the twisted framework. Other frameworks could be used instead. The | ||
| examples also demonstrate the state machine I used to determine a response to received | ||
| messages. | ||
| I've also included "*stompbuffer-rx.py*" and "*stompbuffer-tx.py*" as examples of using | ||
| the new stompbuffer module contributed by Ricky Iacovou. | ||
| Version History | ||
| --------------- | ||
| 0.2.6 | ||
| ~~~~~ | ||
| Add contributed fixes from Simon Chopin. He corrected many spelling mistakes | ||
| throughout the code base. I've also made the README.md the main | ||
| 0.2.5 | ||
| ~~~~~ | ||
| Add the contributed fix for issue #14 by Niki Pore. The issue was reported by | ||
| Roger Hoover. This removes the extra line ending which can cause problems. | ||
| 0.2.4 | ||
| ~~~~~ | ||
| OM: A minor release fixing the problem whereby uuid would be installed on python2.5+. It | ||
| is not needed after python2.4 as it comes with python. Arfrever Frehtes Taifersar Arahesis | ||
| contributed the fix for this. | ||
| 0.2.3 | ||
| ~~~~~ | ||
| OM: I've fixed issue #9 with the example code. All messages are sent and received correctly. | ||
| 0.2.2 | ||
| ~~~~~ | ||
| - Applied patch from esteve.fernandez to resolve "Issue 4: First Message not received" in the | ||
| example code (http://code.google.com/p/stomper/issues/detail?id=4&can=1). | ||
| - I've (Oisin) updated the examples to use twisted's line receiver and got it to "detect" | ||
| complete stomp messages. The old example would not work if a large amount of data was streamed. | ||
| In this case dataReceived would be called with all the chunks of a message. This means that it | ||
| would not be correct for it to attempt to unpack and react until the whole message has been | ||
| received. Using twisted's line receiver looking for the \x00 works like a charm for this. | ||
| This release integrates the bug fixes and the optional stompbuffer contributed by Ricky | ||
| Iacovou: | ||
| - Removed the trailing '\n\n' inserted by Frame.pack(). I believe that adding this is | ||
| incorrect, for the following reasons: | ||
| http://stomp.codehaus.org/Protocol gives the example: | ||
| CONNECT | ||
| login: <username> | ||
| passcode:<passcode> | ||
| ^@ | ||
| and comments, "the body is empty in this case". This gives the impression that the body | ||
| is *exactly* defined as "the bytes, if any, between the '\n\n' at the end of the header | ||
| and the null byte". | ||
| This works for both binary and ASCII payloads: if I want to send a string without a | ||
| newline, I should be able to, in which case the body should look like: | ||
| this is a string without a newline^@ | ||
| ... and the receiver should deal with this. | ||
| This impression is reinforced by the fact that ActiveMQ will complain if you supply a | ||
| content-length header with any other byte count than that described above. | ||
| I am also unsure about the newline after the null byte as nothing in the protocol says | ||
| that there should be a newline after the null byte. Much of the code in StompBuffer | ||
| actively expects it to be there, but I suspect that *relying* on a frame ending '\x00\n' | ||
| may well limit compatibility. It's not an issue with Stomper-to-Stomper communication, | ||
| of course, as the sender puts it, the receiver accepts it, and ActiveMQ happily sends | ||
| it along. | ||
| - StompBuffer has had a few fixes; most notably, a fix that prevents a content-length "header" | ||
| in the *body* from being picked up and used (!). The biggest change is a new method, | ||
| syncBuffer(), which allows a corrupted buffer to recover from the corruption. Note that | ||
| I've never actually *seen* the buffer corruption when using Twisted, but the thought | ||
| occurred to me that a single corrupt buffer could hang the entire message handling process. | ||
| - Fixed the typo "NO_REPONSE_NEEDED". I've changed it to NO_RESPONSE_NEEDED, but kept the | ||
| old variable for backwards compatibility; | ||
| - I've also modified the string format in send() to include the '\n\n' between the header | ||
| and the body, which I think is missing (it currently has only one '\n'). | ||
| - Added CONNECTED to VALID_COMMANDS so syncBuffer() does not decide these messages are bogus. | ||
| - Added new unit test file teststompbuffer which covers the new functionality. | ||
| Metadata-Version: 1.1 | ||
| Name: stomper | ||
| Version: 0.2.5 | ||
| Version: 0.2.6 | ||
| Summary: This is a transport neutral client implementation of the STOMP protocol. | ||
| Home-page: http://code.google.com/p/stomper | ||
| Home-page: https://github.com/oisinmulvihill/stomper | ||
| Author: Oisin Mulvihill | ||
@@ -13,3 +13,3 @@ Author-email: oisin dot mulvihill at gmail com | ||
| .. content: | ||
| .. contents:: | ||
@@ -21,4 +21,5 @@ :Author: | ||
| Micheal Twomey, Ricky Iacovou <iacovou at gmail dot com>, | ||
| Arfrever Frehtes Taifersar Arahesis <arfrever dot fta at gmail dot com> | ||
| Niki Pore <niki pore at gmail dot com> | ||
| Arfrever Frehtes <arfrever dot fta at gmail dot com>, | ||
| Niki Pore <niki pore at gmail dot com>, | ||
| Simon Chopin | ||
@@ -33,3 +34,3 @@ | ||
| The client is attempting to be transport layer neutral. This module provides | ||
| functions to create and parse STOMP messages in a programatic fashion. The | ||
| functions to create and parse STOMP messages in a programmatic fashion. The | ||
| messages can be easily generated and parsed, however its up to the user to do | ||
@@ -42,3 +43,3 @@ the sending and receiving. The STOMP protocol specification can be found here: | ||
| 'function to message' generation on how his client does it. The client can | ||
| be found at the follow address however it isn't a dependancy. | ||
| be found at the follow address however it isn't a dependency. | ||
@@ -88,2 +89,8 @@ - `stompy <http://www.briggs.net.nz/log/projects/stomppy>`_ | ||
| 0.2.6 | ||
| ~~~~~ | ||
| Add contributed fixes from Simon Chopin. He corrected many spelling mistakes | ||
| throughout the code base. I've also made the README.md the main | ||
| 0.2.5 | ||
@@ -99,3 +106,3 @@ ~~~~~ | ||
| OM: A minor relase fixing the problem whereby uuid would be installed on python2.5+. It | ||
| OM: A minor release fixing the problem whereby uuid would be installed on python2.5+. It | ||
| is not needed after python2.4 as it comes with python. Arfrever Frehtes Taifersar Arahesis | ||
@@ -102,0 +109,0 @@ contributed the fix for this. |
@@ -1,2 +0,3 @@ | ||
| README | ||
| MANIFEST.in | ||
| README.md | ||
| runtests.py | ||
@@ -11,4 +12,2 @@ setup.py | ||
| lib/stomper.egg-info/top_level.txt | ||
| lib/stomper/doc/__init__.py | ||
| lib/stomper/doc/stomper.stx | ||
| lib/stomper/examples/__init__.py | ||
@@ -15,0 +14,0 @@ lib/stomper/examples/receiver.py |
+10
-11
@@ -5,3 +5,3 @@ """ | ||
| It aims to be transport layer neutral. This module provides functions to | ||
| create and parse STOMP messages in a programatic fashion. | ||
| create and parse STOMP messages in a programmatic fashion. | ||
@@ -39,7 +39,6 @@ The examples package contains two examples using twisted as the transport | ||
| import doc | ||
| import utils | ||
| import stompbuffer | ||
| # This is used as a return from message reponses functions. | ||
| # This is used as a return from message responses functions. | ||
| # It is used more for readability more then anything or reason. | ||
@@ -84,3 +83,3 @@ NO_RESPONSE_NEEDED = '' | ||
| a frame instance. It uses the unpack_frame(...) function | ||
| to do the intial parsing. | ||
| to do the initial parsing. | ||
@@ -134,8 +133,8 @@ The frame has three important member variables: | ||
| ) | ||
| stomp_mesage = "%s\n%s\n%s%s\n" % (self._cmd, headers, self.body, NULL) | ||
| stomp_message = "%s\n%s\n%s%s\n" % (self._cmd, headers, self.body, NULL) | ||
| # import pprint | ||
| # print "stomp_mesage: ", pprint.pprint(stomp_mesage) | ||
| # print "stomp_message: ", pprint.pprint(stomp_message) | ||
| return stomp_mesage | ||
| return stomp_message | ||
@@ -294,3 +293,3 @@ | ||
| Do whatever is required to make the series of actions | ||
| permenant for this transactionid. | ||
| permanent for this transactionid. | ||
@@ -433,5 +432,5 @@ transactionid: | ||
| def connected(self, msg): | ||
| """No reponse is needed to a connected frame. | ||
| """No response is needed to a connected frame. | ||
| This method stores the session id as a the | ||
| This method stores the session id as the | ||
| member sessionId for later use. | ||
@@ -454,3 +453,3 @@ | ||
| This function will generate an acknowlege message | ||
| This function will generate an acknowledge message | ||
| for the given message and transaction (if present). | ||
@@ -457,0 +456,0 @@ |
@@ -60,3 +60,3 @@ """ | ||
| # | ||
| # prevent the messages we send comming back to us. | ||
| # prevent the messages we send coming back to us. | ||
| f.headers['activemq.noLocal'] = 'true' | ||
@@ -63,0 +63,0 @@ |
@@ -39,3 +39,3 @@ """ | ||
| self.log.info("Connected: session %s. Begining say hello." % msg['headers']['session']) | ||
| self.log.info("Connected: session %s. Beginning say hello." % msg['headers']['session']) | ||
@@ -42,0 +42,0 @@ def setup_looping_call(): |
@@ -47,3 +47,3 @@ """ | ||
| # After a successfull connect you might want to subscribe | ||
| # After a successful connect you might want to subscribe | ||
| # for messages from a destination and tell the server you'll | ||
@@ -50,0 +50,0 @@ # acknowledge all messages. |
@@ -131,3 +131,3 @@ ###################################################################### | ||
| self.failUnless ( msg2 is None ) | ||
| # Veryify that in fact the buffer is empty. | ||
| # Verify that in fact the buffer is empty. | ||
| self.failUnless ( self.sb.bufferIsEmpty() ) | ||
@@ -145,3 +145,3 @@ | ||
| self.failUnless ( msg2 is None ) | ||
| # Veryify that in fact the buffer is empty. | ||
| # Verify that in fact the buffer is empty. | ||
| self.failUnless ( self.sb.bufferIsEmpty() ) | ||
@@ -148,0 +148,0 @@ |
@@ -73,3 +73,3 @@ """ | ||
| error.cmd = 'ERROR' | ||
| error.headers = {'mesage:': 'malformed packet received!'} | ||
| error.headers = {'message:': 'malformed packet received!'} | ||
| error.body = """The message: | ||
@@ -76,0 +76,0 @@ ----- |
+15
-8
| Metadata-Version: 1.1 | ||
| Name: stomper | ||
| Version: 0.2.5 | ||
| Version: 0.2.6 | ||
| Summary: This is a transport neutral client implementation of the STOMP protocol. | ||
| Home-page: http://code.google.com/p/stomper | ||
| Home-page: https://github.com/oisinmulvihill/stomper | ||
| Author: Oisin Mulvihill | ||
@@ -13,3 +13,3 @@ Author-email: oisin dot mulvihill at gmail com | ||
| .. content: | ||
| .. contents:: | ||
@@ -21,4 +21,5 @@ :Author: | ||
| Micheal Twomey, Ricky Iacovou <iacovou at gmail dot com>, | ||
| Arfrever Frehtes Taifersar Arahesis <arfrever dot fta at gmail dot com> | ||
| Niki Pore <niki pore at gmail dot com> | ||
| Arfrever Frehtes <arfrever dot fta at gmail dot com>, | ||
| Niki Pore <niki pore at gmail dot com>, | ||
| Simon Chopin | ||
@@ -33,3 +34,3 @@ | ||
| The client is attempting to be transport layer neutral. This module provides | ||
| functions to create and parse STOMP messages in a programatic fashion. The | ||
| functions to create and parse STOMP messages in a programmatic fashion. The | ||
| messages can be easily generated and parsed, however its up to the user to do | ||
@@ -42,3 +43,3 @@ the sending and receiving. The STOMP protocol specification can be found here: | ||
| 'function to message' generation on how his client does it. The client can | ||
| be found at the follow address however it isn't a dependancy. | ||
| be found at the follow address however it isn't a dependency. | ||
@@ -88,2 +89,8 @@ - `stompy <http://www.briggs.net.nz/log/projects/stomppy>`_ | ||
| 0.2.6 | ||
| ~~~~~ | ||
| Add contributed fixes from Simon Chopin. He corrected many spelling mistakes | ||
| throughout the code base. I've also made the README.md the main | ||
| 0.2.5 | ||
@@ -99,3 +106,3 @@ ~~~~~ | ||
| OM: A minor relase fixing the problem whereby uuid would be installed on python2.5+. It | ||
| OM: A minor release fixing the problem whereby uuid would be installed on python2.5+. It | ||
| is not needed after python2.4 as it comes with python. Arfrever Frehtes Taifersar Arahesis | ||
@@ -102,0 +109,0 @@ contributed the fix for this. |
+3
-3
@@ -13,4 +13,4 @@ """ | ||
| Name = 'stomper' | ||
| ProjectUrl = "http://code.google.com/p/stomper" | ||
| Version = '0.2.5' | ||
| ProjectUrl = "https://github.com/oisinmulvihill/stomper" | ||
| Version = '0.2.6' | ||
| Author = 'Oisin Mulvihill' | ||
@@ -36,3 +36,3 @@ AuthorEmail = 'oisin dot mulvihill at gmail com' | ||
| # Recover the ReStructuredText docs: | ||
| fd = file("lib/stomper/doc/stomper.stx") | ||
| fd = file("README.md") | ||
| Description = fd.read() | ||
@@ -39,0 +39,0 @@ fd.close() |
| """ | ||
| This is used in the setup.py to read in the docs and assign it to | ||
| the description in the setup.py. | ||
| (c) Oisin Mulvihill, 2007-07-28. | ||
| License: http://www.apache.org/licenses/LICENSE-2.0 | ||
| """ | ||
| import os | ||
| doc_dir = os.path.dirname(__file__) | ||
| documentation = os.path.join(doc_dir, "stomper.stx") |
Sorry, the diff of this file is not supported yet
-1
| see stomper.doc/stomper.stx |
Alert delta unavailable
Currently unable to show alert delta for PyPI packages.
Improved metrics
- Total package byte prevSize
85861
0.29%Worsened metrics
- Number of package files
22
-4.35%- Lines of code
1637
-0.61%