Move the API into a subdirectory for ease of imports.

Previously, if users of our code put the API folder in their pyshared
they would have to import it as "humbug.humbug". By moving Humbug's API
into a directory named "humbug" and moving the API into __init__, you
can just "import humbug".

(imported from commit 1d2654ae57f8ecbbfe76559de267ec4889708ee8)
This commit is contained in:
Luke Faraone 2013-01-16 11:38:19 -05:00
parent d4d7da3acc
commit f2f4a2f8bd
23 changed files with 0 additions and 0 deletions

View file

@ -1,14 +0,0 @@
#!/bin/sh
# Two quick API tests using curl
curl https://humbughq.com/api/v1/send_message \
-d "api-key=YOUR_API_KEY" \
-d "email=YOUR_EMAIL" \
-d "type=private" -d "content=test" \
-d "to=RECIPIENT_EMAIL"
curl https://humbughq.com/api/v1/get_messages \
-d "api-key=YOUR_API_KEY" \
-d "email=YOUR_EMAIL"
# Or replace https://humbughq.com with your local test instance

View file

@ -1,44 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """get-public-streams --user=<email address> [options]
Prints out all the public streams in the realm.
Example: get-public-streams --user=tabbott@humbughq.com --site=https://zephyr.humbughq.com
"""
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
parser = optparse.OptionParser(usage=usage)
parser.add_option_group(humbug.generate_option_group(parser))
(options, args) = parser.parse_args()
client = humbug.init_from_options(options)
print client.get_public_streams()

View file

@ -1,4 +0,0 @@
; put this file in ~/.humbugrc
[api]
key=<api key from the web interface>
email=<your email address>

View file

@ -1,43 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """list-subscriptions --user=<email address> [options]
Prints out a list of the user's subscriptions.
Example: list-subscriptions --user=tabbott@humbughq.com --site=https://zephyr.humbughq.com
"""
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
parser = optparse.OptionParser(usage=usage)
parser.add_option_group(humbug.generate_option_group(parser))
(options, args) = parser.parse_args()
client = humbug.init_from_options(options)
print client.list_subscriptions()

View file

@ -1,50 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """print-messages --user=<email address> [--stream=<stream>] [options]
Prints out each message received by the indicated user, or on the indicated public stream.
Example: print-messages --user=tabbott@humbughq.com --site=https://zephyr.humbughq.com
"""
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
parser = optparse.OptionParser(usage=usage)
parser.add_option_group(humbug.generate_option_group(parser))
parser.add_option('--stream', default=None)
(options, args) = parser.parse_args()
client = humbug.init_from_options(options)
def print_message(message):
print message
get_messages_options = {}
if options.stream is not None:
get_messages_options['stream_name'] = options.stream
client.call_on_each_message(print_message, get_messages_options)

View file

@ -1,47 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """print-next-message --user=<email address> [--stream=<stream>] [options]
Prints out the next message received by the indicated user, or on the indicated public stream.
Example: print-next-messages --user=tabbott@humbughq.com --site=https://zephyr.humbughq.com
"""
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
parser = optparse.OptionParser(usage=usage)
parser.add_option_group(humbug.generate_option_group(parser))
parser.add_option('--stream', default=None)
(options, args) = parser.parse_args()
client = humbug.init_from_options(options)
get_messages_options = {}
if options.stream is not None:
get_messages_options['stream_name'] = options.stream
print client.get_messages(get_messages_options)

View file

@ -1,61 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """send-message [options] <recipients>
Sends a test message to the specified recipients.
Example: send-message --sender=you@example.com --type=stream commits --subject="my subject" --message="test message"
Example: send-message --sender=you@example.com --site=https://zephyr.humbughq.com user1@example.com user2@example.com
"""
parser = optparse.OptionParser(usage=usage)
parser.add_option('--api-key')
parser.add_option('--sender')
parser.add_option('--subject', default="test")
parser.add_option('--message', default="test message")
parser.add_option('--site', default='https://humbughq.com')
parser.add_option('--type', default='private')
(options, args) = parser.parse_args()
if len(args) == 0:
parser.error("You must specify recipients")
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
client = humbug.Client(
email=options.sender,
api_key=options.api_key,
verbose=True,
site=options.site)
message_data = {
"type": options.type,
"content": options.message,
"subject": options.subject,
"to": args,
}
print client.send_message(message_data)

View file

@ -1,48 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """subscribe --user=<email address> [options] --streams=<streams>
Ensures the user is subscribed to the listed streams.
Example: subscribe --user=tabbott@humbughq.com --site=https://zephyr.humbughq.com
"""
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
parser = optparse.OptionParser(usage=usage)
parser.add_option_group(humbug.generate_option_group(parser))
parser.add_option('--streams', default='')
(options, args) = parser.parse_args()
client = humbug.init_from_options(options)
if options.streams == "":
print >>sys.stderr, "Usage:", parser.usage
sys.exit(1)
print client.add_subscriptions(options.streams.split())

View file

@ -1,48 +0,0 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright © 2012 Humbug, Inc.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
import sys
from os import path
import optparse
usage = """unsubscribe --user=<email address> [options] --streams=<streams>
Ensures the user is not subscribed to the listed streams.
Example: unsubscribe --user=tabbott@humbughq.com --site=https://zephyr.humbughq.com
"""
sys.path.append(path.join(path.dirname(__file__), '..'))
import humbug
parser = optparse.OptionParser(usage=usage)
parser.add_option_group(humbug.generate_option_group(parser))
parser.add_option('--streams', default='')
(options, args) = parser.parse_args()
client = humbug.init_from_options(options)
if options.streams == "":
print >>sys.stderr, "Usage:", parser.usage
sys.exit(1)
print client.remove_subscriptions(options.streams.split())