Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

license added

directory layout changed
 * example app moved
 * lib renamed to marketplace
 * tests moved inside marketplace

classes modified
 * Marketplace is split into Client and Connection classes

setup tools added to setup.py to provide requirements
  • Loading branch information...
commit 3e6d3ce8a4034141b09cc83de0d547ef776b15e5 1 parent b6f0bbc
@zalun authored
View
27 LICENSE
@@ -1,27 +0,0 @@
-Copyright (c) 2012, Mozilla Corporation
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice,
-this list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-this list of conditions and the following disclaimer in the documentation
-and/or other materials provided with the distribution.
-
-* Neither the name of the Mozilla Corporation nor the names of its contributors
-may be used to endorse or promote products derived from this software without
-specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
View
373 LICENSE.TXT
@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+ means each individual or legal entity that creates, contributes to
+ the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+ means the combination of the Contributions of others (if any) used
+ by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+ means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+ means Source Code Form to which the initial Contributor has attached
+ the notice in Exhibit A, the Executable Form of such Source Code
+ Form, and Modifications of such Source Code Form, in each case
+ including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+ means
+
+ (a) that the initial Contributor has attached the notice described
+ in Exhibit B to the Covered Software; or
+
+ (b) that the Covered Software was made available under the terms of
+ version 1.1 or earlier of the License, but not also under the
+ terms of a Secondary License.
+
+1.6. "Executable Form"
+ means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+ means a work that combines Covered Software with other material, in
+ a separate file or files, that is not Covered Software.
+
+1.8. "License"
+ means this document.
+
+1.9. "Licensable"
+ means having the right to grant, to the maximum extent possible,
+ whether at the time of the initial grant or subsequently, any and
+ all of the rights conveyed by this License.
+
+1.10. "Modifications"
+ means any of the following:
+
+ (a) any file in Source Code Form that results from an addition to,
+ deletion from, or modification of the contents of Covered
+ Software; or
+
+ (b) any new file in Source Code Form that contains any Covered
+ Software.
+
+1.11. "Patent Claims" of a Contributor
+ means any patent claim(s), including without limitation, method,
+ process, and apparatus claims, in any patent Licensable by such
+ Contributor that would be infringed, but for the grant of the
+ License, by the making, using, selling, offering for sale, having
+ made, import, or transfer of either its Contributions or its
+ Contributor Version.
+
+1.12. "Secondary License"
+ means either the GNU General Public License, Version 2.0, the GNU
+ Lesser General Public License, Version 2.1, the GNU Affero General
+ Public License, Version 3.0, or any later versions of those
+ licenses.
+
+1.13. "Source Code Form"
+ means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+ means an individual or a legal entity exercising rights under this
+ License. For legal entities, "You" includes any entity that
+ controls, is controlled by, or is under common control with You. For
+ purposes of this definition, "control" means (a) the power, direct
+ or indirect, to cause the direction or management of such entity,
+ whether by contract or otherwise, or (b) ownership of more than
+ fifty percent (50%) of the outstanding shares or beneficial
+ ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+ Licensable by such Contributor to use, reproduce, make available,
+ modify, display, perform, distribute, and otherwise exploit its
+ Contributions, either on an unmodified basis, with Modifications, or
+ as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+ for sale, have made, import, and otherwise transfer either its
+ Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+ or
+
+(b) for infringements caused by: (i) Your and any other third party's
+ modifications of Covered Software, or (ii) the combination of its
+ Contributions with other software (except as part of its Contributor
+ Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+ its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+ Form, as described in Section 3.1, and You must inform recipients of
+ the Executable Form how they can obtain a copy of such Source Code
+ Form by reasonable means in a timely manner, at a charge no more
+ than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+ License, or sublicense it under different terms, provided that the
+ license for the Executable Form does not attempt to limit or alter
+ the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+* *
+* 6. Disclaimer of Warranty *
+* ------------------------- *
+* *
+* Covered Software is provided under this License on an "as is" *
+* basis, without warranty of any kind, either expressed, implied, or *
+* statutory, including, without limitation, warranties that the *
+* Covered Software is free of defects, merchantable, fit for a *
+* particular purpose or non-infringing. The entire risk as to the *
+* quality and performance of the Covered Software is with You. *
+* Should any Covered Software prove defective in any respect, You *
+* (not any Contributor) assume the cost of any necessary servicing, *
+* repair, or correction. This disclaimer of warranty constitutes an *
+* essential part of this License. No use of any Covered Software is *
+* authorized under this License except under this disclaimer. *
+* *
+************************************************************************
+
+************************************************************************
+* *
+* 7. Limitation of Liability *
+* -------------------------- *
+* *
+* Under no circumstances and under no legal theory, whether tort *
+* (including negligence), contract, or otherwise, shall any *
+* Contributor, or anyone who distributes Covered Software as *
+* permitted above, be liable to You for any direct, indirect, *
+* special, incidental, or consequential damages of any character *
+* including, without limitation, damages for lost profits, loss of *
+* goodwill, work stoppage, computer failure or malfunction, or any *
+* and all other commercial damages or losses, even if such party *
+* shall have been informed of the possibility of such damages. This *
+* limitation of liability shall not apply to liability for death or *
+* personal injury resulting from such party's negligence to the *
+* extent applicable law prohibits such limitation. Some *
+* jurisdictions do not allow the exclusion or limitation of *
+* incidental or consequential damages, so this exclusion and *
+* limitation may not apply to You. *
+* *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+ This Source Code Form is subject to the terms of the Mozilla Public
+ License, v. 2.0. If a copy of the MPL was not distributed with this
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+ This Source Code Form is "Incompatible With Secondary Licenses", as
+ defined by the Mozilla Public License, v. 2.0.
View
47 README.rst
@@ -1,45 +1,16 @@
-Examples of the Marketplace clients
-===================================
+Marketplace Client Library
+==========================
-Python
-######
-**Marketplace command line client**
+Mozilla is building a Marketplace to bring personalized discovery,
+worldwide distribution, and easy payments to the largest platform
+for app development: the Web.
-Install requirements::
+This library helps to create Python based sites or apps to communicate
+with Marketplace.
- cd python
- pip install -r requirements.txt
+You may find and collaborate your time and experience at
+https://github.com/mozilla/Marketplace.Python
Test::
nosetests
-
-Usage
------
-
-* Set CONSUMER_KEY and CONSUMER_SECRET environment variables::
-
- export CONSUMER_KEY=yourconsumerkey
- export CONSUMER_SECRET=yourconsumersecret
-
-* Validate manifest. Will return ``manifest_id`` which is needed for the next steps::
-
- python main.py validate_manifest http://mozilla.github.com/MarketplaceClientExample/manifest.webapp
-
-* Check if the manifest is valid::
-
- python main.py is_manifest_valid your_manifest_id
-
-* Add app to marketplace, app_id will be returned::
-
- python main.py create your_manifest_id
-
-* Display status of the app::
-
- python main.py status your_app_id
-
-* Add screenshot (currently only JPEG) to app, some data including id will be returned::
-
- python main.py add_screenshot your_app_id ~/data/some.jpg
-
-
View
36 example/README.rst
@@ -0,0 +1,36 @@
+Command Line Marketplace Client
+===============================
+
+Install requirements::
+
+ pip install -r requirements.txt

Is this still relevant?

@zalun Owner
zalun added a note

IMHO yes - it contains one line - marketplace, but it's a good practice to keep requirements in the file

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+
+Usage
+-----
+
+* Set CONSUMER_KEY and CONSUMER_SECRET environment variables::
+
+ export CONSUMER_KEY=yourconsumerkey
+ export CONSUMER_SECRET=yourconsumersecret
+
+* Validate manifest. Will return ``manifest_id`` which is needed for the next steps::
+
+ python main.py validate_manifest http://mozilla.github.com/MarketplaceClientExample/manifest.webapp
+
+* Check if the manifest is valid::
+
+ python main.py is_manifest_valid your_manifest_id
+
+* Add app to marketplace, app_id will be returned::
+
+ python main.py create your_manifest_id
+
+* Display status of the app::
+
+ python main.py status your_app_id
+
+* Add screenshot (currently only JPEG) to app, some data including id will be returned::
+
+ python main.py add_screenshot your_app_id ~/data/some.jpg
+
+
View
0  python/tests/__init__.py → example/__init__.py
File renamed without changes
View
2  python/app/commands.py → example/commands.py
@@ -7,8 +7,6 @@
import config
-from lib.marketplace import Marketplace
-
def validate_manifest(auth, manifest_url):
response = auth.validate_manifest(manifest_url)
View
0  python/app/config.py → example/config.py
File renamed without changes
View
12 python/main.py → example/main.py
@@ -1,10 +1,10 @@
import argparse
import sys
-import app.commands
-import app.config as config
+import commands
+import config as config
-from lib.marketplace import Marketplace
+import marketplace
commands = {'validate_manifest': app.commands.validate_manifest,
'is_manifest_valid': app.commands.is_manifest_valid,
@@ -23,7 +23,7 @@
help='command arguments')
args = parser.parse_args()
-auth = Marketplace(
+client = marketplace.Client(
domain=config.MARKETPLACE_DOMAIN,
protocol=config.MARKETPLACE_PROTOCOL,
port=config.MARKETPLACE_PORT,
@@ -31,9 +31,9 @@
consumer_secret=config.CONSUMER_SECRET)
if args.attrs:
- result = commands[args.method](auth, *args.attrs)
+ result = commands[args.method](client, *args.attrs)
else:
- result = commands[args.method](auth)
+ result = commands[args.method](client)
if result['success']:
sys.stdout.write('%s\n' % result['message'])
View
1  example/requirements.txt
@@ -0,0 +1 @@
+marketplace
View
19 marketplace/__init__.py
@@ -0,0 +1,19 @@
+"""Marketplace Client Library
+
+https://wiki.mozilla.org/Marketplace
+
+Mozilla is building a Marketplace to bring personalized discovery,
+worldwide distribution, and easy payments to the largest platform
+for app development: the Web.
+
+This library helps to create Python based sites or apps to communicate
+with Marketplace.
+"""
+
+__version__ = '0.1'
+__all__ = [
+ 'Client',
+]
+__author__ = 'Piotr Zalewa <zalun@mozilla.com>'
+
+from .client import Client
View
101 python/lib/marketplace.py → marketplace/client.py
@@ -1,14 +1,11 @@
"""
A class to interact with Marketplace's api, using OAuth.
-Ripped off from Andy's Flightdeck.utils.amo.py
For full spec please read Marketplace API documentation
https://github.com/mozilla/zamboni/blob/master/docs/topics/api.rst
"""
import json
import logging
-import time
-import urllib
import mimetypes
from base64 import b64encode
@@ -19,6 +16,8 @@
from urlparse import urlparse, urlunparse, parse_qsl
+from .connection import Connection
+
log = logging.getLogger('marketplace.%s' % __name__)
MARKETPLACE_PORT = 443
@@ -34,21 +33,11 @@
'categories': '/apps/category/',
}
-def _get_args(consumer):
- """Provide a dict with oauth data
- """
- return dict(
- oauth_consumer_key=consumer.key,
- oauth_nonce=oauth.generate_nonce(),
- oauth_signature_method='HMAC-SHA1',
- oauth_timestamp=int(time.time()),
- oauth_version='1.0')
-
-class Marketplace:
+
+class Client:
"""A base class to authenticate and work with Marketplace OAuth.
"""
signature_method = oauth.SignatureMethod_HMAC_SHA1()
- should_save_storage = False
def __init__(self, domain=MARKETPLACE_DOMAIN,
protocol=MARKETPLACE_PROTOCOL,
@@ -60,9 +49,13 @@ def __init__(self, domain=MARKETPLACE_DOMAIN,
self.port = port
self.prefix = prefix
self.three_legged = three_legged
- self.consumer = None
+ self.conn = None
if consumer_secret and consumer_key:
- self.set_consumer(consumer_key, consumer_secret)
+ self.conn = self.get_connection(consumer_key, consumer_secret)
+
+ @staticmethod
+ def get_connection(consumer_key, consumer_secret):
+ return Connection(consumer_key, consumer_secret)
def url(self, key):
"""Creates a full URL to the API using urls dict
@@ -71,58 +64,6 @@ def url(self, key):
'%s/api%s' % (self.prefix, urls[key]),
'', '', ''))
- def set_consumer(self, consumer_key, consumer_secret):
- """Sets the consumer attribute
- """
- self.consumer = self.get_consumer(consumer_key, consumer_secret)
-
- def get_consumer(self, consumer_key, consumer_secret):
- """Get the :class:`oauth.Consumer` instance with prvided key and secret
- """
- return oauth.Consumer(consumer_key, consumer_secret)
-
- def prepare_request(self, method, url, body='', consumer=None):
- """Adds consumer and signs the request
-
- :returns: headers of the signed request
- """
- if not consumer:
- consumer = self.consumer
- req = oauth.Request(method=method, url=url,
- parameters=_get_args(consumer))
- req.sign_request(self.signature_method, consumer, None)
-
- headers = req.to_header()
- headers['Content-type'] = 'application/json'
- return headers
-
- def get(self, url, data=None, consumer=None):
- """ Prepare data and send a GET to provided url
- """
- body = urllib.urlencode(data) if data else ''
- headers = self.prepare_request('GET', url, body, consumer)
- return requests.get(url, headers=headers, data=body)
-
- def post(self, url, data, consumer=None):
- """ Prepare data and send a POST to provided url
- """
- body = json.dumps(data)
- headers = self.prepare_request('POST', url, body, consumer)
- return requests.post(url, headers=headers, data=body)
-
- def put(self, url, data, consumer=None):
- """ Prepare data and send a PUT to provided url
- """
- body = json.dumps(data)
- headers = self.prepare_request('PUT', url, body, consumer)
- return requests.put(url, headers=headers, data=body)
-
- def remove(self, url, consumer=None):
- """ Prepare data and send a DELETE to provided url
- """
- headers = self.prepare_request('DELETE', url, '', consumer)
- return requests.delete(url, headers=headers, data='')
-
def validate_manifest(self, manifest_url):
"""Order manifest validation
@@ -130,7 +71,8 @@ def validate_manifest(self, manifest_url):
"""
# there is a bug request to make this synchronous on Marketplace side
# this will return the same as :method:`get_manifest_validation_result`
- return self.post(self.url('validate'), {'manifest': manifest_url})
+ return self.conn.fetch('POST',
+ self.url('validate'), {'manifest': manifest_url})
def get_manifest_validation_result(self, manifest_id):
"""Check if the manifest is processed and if it's valid
@@ -143,7 +85,8 @@ def get_manifest_validation_result(self, manifest_id):
* valid (Boolean) is manifest valid?
* validation - empty string if valid else error dict
"""
- return self.get(self.url('validation_result') % manifest_id)
+ return self.conn.fetch('GET',
+ self.url('validation_result') % manifest_id)
def is_manifest_valid(self, manifest_id):
"""Check validation shortcut
@@ -174,7 +117,7 @@ def create(self, manifest_id):
* resource_uri (string) url in marketplace
* slug (string) unique name in marketplace
"""
- return self.post(self.url('create'),
+ return self.conn.fetch('POST', self.url('create'),
{'manifest': '%s' % manifest_id})
def update(self, app_id, data):
@@ -211,7 +154,7 @@ def update(self, app_id, data):
and data['payment_type']
and 'privacy_policy' in data
and data['privacy_policy'])
- return self.put(self.url('app') % app_id, data)
+ return self.conn.fetch('PUT', self.url('app') % app_id, data)
def status(self, app_id):
"""View details of an app identified by its id
@@ -220,13 +163,13 @@ def status(self, app_id):
* status_code (int) 200 if successful
* content (JSON String) with all available app information
"""
- return self.get(self.url('app') % app_id)
+ return self.conn.fetch('GET', self.url('app') % app_id)
def delete(self, app_id):
"""Delete an app from Marketplace
"""
# XXX: This isn't yet implemented on API

Should we put a raise NotImplementedError here?

@zalun Owner
zalun added a note

Yes, you're right

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
- return self.remove(self.url('app') % app_id)
+ return self.conn.fetch('DELETE', self.url('app') % app_id)
def create_screenshot(self, app_id, filename, mimetype='image/jpg',
position=1):
@@ -250,7 +193,7 @@ def create_screenshot(self, app_id, filename, mimetype='image/jpg',
data = {'position': position,
'file': {'type': mtype,
'data': s_encoded}}
- return self.post(url, data)
+ return self.conn.fetch('POST', url, data)
def get_screenshot(self, screenshot_id):
"""Get information about screenshot or video
@@ -259,7 +202,7 @@ def get_screenshot(self, screenshot_id):
* status_code (int) 200 is successful
* content (JSON string)
"""
- return self.get(self.url('screenshot') % screenshot_id)
+ return self.conn.get(self.url('screenshot') % screenshot_id)
def del_screenshot(self, screenshot_id):
"""Deletes screenshot
@@ -267,9 +210,9 @@ def del_screenshot(self, screenshot_id):
:returns: HttpResponse:
* status_code (int) 204 if successful
"""
- return self.delete(self.url('screenshot') % screenshot_id)
+ return self.conn.delete(self.url('screenshot') % screenshot_id)
def get_categories(self):
"""Get all categories from Marketplae
"""
- return self.get(self.url('categories'))
+ return self.conn.fetch('GET', self.url('categories'))
View
82 marketplace/connection.py
@@ -0,0 +1,82 @@
+import json
+import logging
+import time
+import urllib
+
+import oauth2 as oauth
+import requests
+
+log = logging.getLogger('marketplace.%s' % __name__)
+
+class NotExpectedStatusCode(requests.exceptions.HTTPError):
+ pass
+
+def _get_args(consumer):
+ """Provide a dict with oauth data
+ """
+ return dict(
+ oauth_consumer_key=consumer.key,
+ oauth_nonce=oauth.generate_nonce(),
+ oauth_signature_method='HMAC-SHA1',
+ oauth_timestamp=int(time.time()),
+ oauth_version='1.0')
+
+class Connection:

two lines before classes, one before method (see line 42)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+ signature_method = oauth.SignatureMethod_HMAC_SHA1()
+
+ def __init__(self, consumer_key, consumer_secret):
+ self.set_consumer(consumer_key, consumer_secret)
+
+ def set_consumer(self, consumer_key, consumer_secret):
+ """Sets the consumer attribute
+ """
+ self.consumer = self.get_consumer(consumer_key, consumer_secret)
+
+ def get_consumer(self, consumer_key, consumer_secret):
+ """Get the :class:`oauth.Consumer` instance with provided key and
+ secret
+ """
+ return oauth.Consumer(consumer_key, consumer_secret)
+
+
+ def prepare_request(self, method, url, body='', consumer=None):
+ """Adds consumer and signs the request
+
+ :returns: headers of the signed request
+ """
+ if not consumer:
+ consumer = self.consumer
+ req = oauth.Request(method=method, url=url,
+ parameters=_get_args(consumer))
+ req.sign_request(self.signature_method, consumer, None)
+
+ headers = req.to_header()
+ headers['Content-type'] = 'application/json'
+ if body:
+ if method == 'GET':
+ body = urllib.urlencode(body)
+ else:
+ body = json.dumps(body)
+ return {"headers": headers, "data": body}
+
+ @staticmethod
+ def _get_error_reason(response):
+ body = response.json
+ if body and 'reason' in body:
+ return body['reason']
+ return response.content
+
+ def fetch(self, method, url, data=None, expected_status_code=None,
+ consumer=None):
+ kwargs = self.prepare_request(method, url, data, consumer)
+ response = getattr(requests, method.lower())(url, **kwargs)
+ if response.status_code >= 400:
+ response.raise_for_status()
+ if expected_status_code and response.status_code != expected_status_code:
+ raise NotExpectedStatusCode(self._get_error_reason(response))
+ return response
+
+ def fetch_json(self, method, url, data=None, expected_status_code=None,
+ consumer=None):
+ return self.fetch(method, url, data, consumer,
+ expected_status_code).json()
View
1  python/requirements.txt → marketplace/requirements.txt
@@ -1,4 +1,3 @@
-# marketplace
httplib2
oauth2
# tests
View
0  python/lib/__init__.py → marketplace/tests/__init__.py
File renamed without changes
View
0  python/tests/mozilla.jpg → marketplace/tests/mozilla.jpg
File renamed without changes
View
0  python/tests/mozilla.png → marketplace/tests/mozilla.png
File renamed without changes
View
38 python/tests/testMarketplace.py → marketplace/tests/testClient.py
@@ -1,6 +1,6 @@
"""
-tests.testMarketplace
----------------------
+tests.testClient
+----------------
"""
import json
import logging
@@ -15,14 +15,15 @@
from nose import SkipTest
from nose.tools import eq_
-from ..lib.marketplace import Marketplace
+import marketplace
-log = logging.getLogger('marketplace.%s' % __name__)
+log = logging.getLogger('test.%s' % __name__)
# Preparing to mock the requests
OLD_POST = requests.post
OLD_PUT = requests.put
OLD_GET = requests.get
+OLD_DELETE = requests.delete
MARKETPLACE_PORT = 443
MARKETPLACE_DOMAIN = 'marketplace-dev.allizom.org'
@@ -33,24 +34,21 @@ def __init__(self, status_code, content=None):
self.status_code = status_code
self.content = content
-class TestMarketplace(object):
+class TestClient(object):
def setUp(self):
- consumer_key = (os.environ['CONSUMER_KEY']
- if 'CONSUMER_KEY' in os.environ else 'consumer_key')
- consumer_secret = (os.environ['CONSUMER_SECRET']
- if 'CONSUMER_SECRET' in os.environ else 'consumer_secret')
- self.marketplace = Marketplace(
+ self.marketplace = marketplace.Client(
domain=MARKETPLACE_DOMAIN,
port=MARKETPLACE_PORT,
protocol=MARKETPLACE_PROTOCOL,
- consumer_key=consumer_key,
- consumer_secret=consumer_secret)
+ consumer_key='consumer_key',
+ consumer_secret='consumer_secret')
def tearDown(self):
requests.post = OLD_POST
requests.put = OLD_PUT
requests.get = OLD_GET
+ requests.delete = OLD_DELETE
def test_init(self):
eq_(self.marketplace.domain, MARKETPLACE_DOMAIN)
@@ -187,8 +185,12 @@ def test_add_screenshot(self):
path = lambda *a: os.path.join(
os.path.dirname(os.path.abspath(__file__)), *a)
resp = {'filetype': 'image/png',
- 'thumbnail_url': 'https://marketplace-dev-cdn.allizom.org/img/uploads/previews/thumbs/71/71761.png?modified=1340899716',
- 'image_url': 'https://marketplace-dev-cdn.allizom.org/img/uploads/previews/full/71/71761.png?modified=1340899716',
+ 'thumbnail_url': 'https://marketplace-dev-cdn.allizom.org/img/'
+ 'uploads/previews/thumbs/71/71761.png?'
+ 'modified=1340899716',
+ 'image_url': 'https://marketplace-dev-cdn.allizom.org/img/'
+ 'uploads/previews/full/71/71761.png?'
+ 'modified=1340899716',
'position': 1,
'id': 71761,
'resource_uri': '/en-US/api/apps/preview/71761'}
@@ -201,10 +203,10 @@ def test_add_screenshot(self):
data = json.loads(requests.post.call_args[1]['data'])
eq_(data['position'], 1)
eq_(data['file']['data'], b64_file)
- eq_(data['file']['type'], 'image/jpg')
- # create a screenshot with a png image and not default position
+ eq_(data['file']['type'], 'image/jpeg')
+ # create a screenshot with a jpeg image and not default position
self.marketplace.create_screenshot(123,
- path('mozilla.jpg'), mimetype='image/png', position=2)
+ path('mozilla.jpg'), mimetype='image/jpeg', position=2)
data = json.loads(requests.post.call_args[1]['data'])
eq_(data['position'], 2)
- eq_(data['file']['type'], 'image/png')
+ eq_(data['file']['type'], 'image/jpeg')
View
107 marketplace/tests/testConnection.py
@@ -0,0 +1,107 @@
+"""
+tests.testClient
+----------------
+"""
+import json
+import logging
+import unittest
+import urllib
+
+import requests
+import oauth2 as oauth
+
+from mock import Mock
+from nose import SkipTest
+from nose.tools import eq_
+
+from marketplace.connection import Connection
+
+log = logging.getLogger('test.%s' % __name__)
+
+# Preparing to mock the requests
+OLD_POST = requests.post
+OLD_PUT = requests.put
+OLD_GET = requests.get
+OLD_DELETE = requests.delete
+
+
+class Response(requests.Response):
+ def __init__(self, status_code, content=None):
+ super(Response, self).__init__()
+ self.status_code = status_code
+ self._content = content
+
+class TestClient(unittest.TestCase):
+
+ def setUp(self):
+ self.conn = Connection(consumer_key='key', consumer_secret='secret')
+
+ def tearDown(self):
+ requests.post = OLD_POST
+ requests.put = OLD_PUT
+ requests.get = OLD_GET
+ requests.delete = OLD_DELETE

tearDown is called at the end of every test, so this means at the end of every test the requests are reset to normal... is there a need to do this?

@zalun Owner
zalun added a note

I think it's a good practice to start every test with the same basis. Otherwise one may receive an answer from request defined in another test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+
+ def test_raising_on_httperror(self):
+ resp = {"reason": "Error with OAuth headers"}
+ requests.post = Mock(return_value=Response(401, json.dumps(resp)))

nice use of Mock

maybe add a note in the documentation that mock is needed (but won't be installed in setup.py)

@zalun Owner
zalun added a note

Sure - same as with the nose - it isn't needed for package to be used, but needed for tests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
+ self.assertRaises(requests.exceptions.HTTPError, self.conn.fetch,
+ 'POST', 'http://example.com/', {})
+
+ resp = "<html><title>404</title><body><p>Error 404</p></body></html>"
+ requests.post = Mock(return_value=Response(404, resp))
+ self.assertRaises(requests.exceptions.HTTPError, self.conn.fetch, 'POST',
+ 'http://example.com/', {})
+
+ def test_raising_on_unexpected(self):
+ resp = {"reason": "Error with OAuth headers"}
+ requests.post = Mock(return_value=Response(204, json.dumps(resp)))
+ self.assertRaises(requests.exceptions.HTTPError, self.conn.fetch, 'POST',
+ 'http://example.com/', {}, 201)
+
+ def test_error_reason_json(self):
+ resp = {"reason": "message"}
+ eq_(Connection._get_error_reason(Response(204, json.dumps(resp))),
+ resp['reason'])
+
+ def test_error_reason_text(self):
+ resp = "<html><title>404</title><body><p>Error 404</p></body></html>"
+ eq_(Connection._get_error_reason(Response(204, resp)), resp)
+
+ def test_set_consumer(self):
+ assert isinstance(self.conn.consumer, oauth.Consumer)
+
+ def test_prepare_request(self):
+ prepared = self.conn.prepare_request('GET', 'http://example.com')
+ assert 'headers' in prepared
+ assert 'data' in prepared
+ assert not prepared['data']
+
+ data = {"some": "data"}
+ prepared = self.conn.prepare_request('POST', 'http://ex.com', data)
+ eq_(prepared['data'], json.dumps(data))
+
+ prepared = self.conn.prepare_request('GET', 'http://ex.com', data)
+ eq_(prepared['data'], urllib.urlencode(data))
+
+ def test_get(self):
+ requests.get = Mock(return_value=Response(200, '{}'))
+ self.conn.fetch('GET', 'http://ex.com')
+ assert requests.get.called
+
+ def test_post(self):
+ requests.post = Mock(return_value=Response(201, '{}'))
+ self.conn.fetch('POST', 'http://ex.com')
+ assert requests.post.called
+
+ def test_put(self):
+ requests.put = Mock(return_value=Response(202, '{}'))
+ self.conn.fetch('PUT', 'http://ex.com')
+ assert requests.put.called
+
+ def test_delete(self):
+ requests.delete = Mock(return_value=Response(204, '{}'))
+ self.conn.fetch('DELETE', 'http://ex.com')
+ assert requests.delete.called
+
+

extra new lines on the end

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
View
0  python/__init__.py
No changes.
View
0  python/app/__init__.py
No changes.
View
9 setup.py
@@ -0,0 +1,9 @@
+from setuptools import setup
+
+setup(
+ name='Marketplace',
+ version='0.1a',
+ packages=['marketplace',],
+ license='Mozilla Public License (MPL 2.0)',
+ long_description=open('README.rst').read(),
+ install_requires=['httplib2', 'oauth2', 'requests'])

This doesn't require nose, but the https://github.com/zalun/Marketplace.Python/tree/creating_package mentions a nose test command. Should probably add a note about how to install nose.

@zalun Owner
zalun added a note

Indeed - an info in documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

2 comments on commit 3e6d3ce

@andymckay

Looking good zalun, it seemed to install just fine using setup.py here. Yay!

@zalun
Owner

:D

Please sign in to comment.
Something went wrong with that request. Please try again.