Initial public commit.
Contains simple python client, csv uploader example,
list tasks example.
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..2f836aa
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+*~
+*.pyc
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..ad0d64f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,24 @@
+# Contributing guidelines
+
+## How to become a contributor and submit your own code
+
+### Contributor License Agreements
+
+We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
+
+Please fill out either the individual or corporate Contributor License Agreement (CLA).
+
+ * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html).
+ * If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html).
+
+Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
+
+***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
+
+## Contributing code
+
+We currently use Gerrit to host and handle code changes to the GCI API Clients. The main
+site is
+[https://code-review.googlesource.com/codein/api](https://code-review.googlesource.com/codein/api).
+See Gerrit [docs](https://gerrit-review.googlesource.com/Documentation/) for
+information on how Gerrit's code review system works.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1ce19c6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+
+# The Google Code-in API Client
+
+API Documentation is at https://developers.google.com/open-source/gci/api
+
+# Usage
+
+./list_tasks.py --apikey APIKEY
+
+./csv_uploader.py --apikey APIKEY file.csv
+
+Each script also supports other flags. Use --help to see them.
+
+# API Keys
+
+Organization Adminstrators can find their API key on their
+[User Profile](https://codein.withgoogle.com/).
+
+# Bugs/Support
+
+To report bugs, please email gci-support@google.com
diff --git a/client.py b/client.py
new file mode 100644
index 0000000..f3d7f3a
--- /dev/null
+++ b/client.py
@@ -0,0 +1,151 @@
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""The GCI API Client. A thin wrapper around the GCI API.
+
+Exmple usage:
+
+client = gciclient.GCIAPIClient(
+ auth_token='xxxxxxxxxxxxxx',
+ url_prefix='https://codein.withgoogle.com',
+ debug=False)
+
+client.NewTask(myTaskDict)
+"""
+
+import json
+import logging
+import urlparse
+
+import requests
+
+
+class GCIAPIClient(object):
+ """GCIAPIClient provides a thin wrapper around the GCI Task API.
+
+ A GCIAPIClient simplifies working with tasks by forming the HTTP requests on
+ behalf of the caller.
+
+ Attributes:
+ url_prefix: A string prefix for the codin URL
+ headers: A dictionary of HTTP headers
+ """
+
+ def __init__(self, auth_token=None,
+ url_prefix='https://codein.withgoogle.com/',
+ debug=False):
+ self.url_prefix = urlparse.urljoin(url_prefix, 'api/program/current/')
+ self.headers = {
+ 'Authorization': 'Bearer %s' % auth_token,
+ 'Content-Type': 'application/json',
+ }
+
+ if debug:
+ logging.basicConfig()
+ logging.getLogger().setLevel(logging.DEBUG)
+ requests_log = logging.getLogger('requests.packages.urllib3')
+ requests_log.setLevel(logging.DEBUG)
+ requests_log.propagate = True
+
+ def _Url(self, path):
+ return urlparse.urljoin(self.url_prefix, path) + '/'
+
+ def ListTasks(self, page=1):
+ """Fetches a list of tasks.
+
+ Args:
+ page: Which page of results to return.
+
+ Returns:
+ A JSON encoded list of tasks.
+
+ Raises:
+ HTTPError: a 4XX client error or 5XX server error response was returned.
+ """
+ r = requests.get(self._Url('tasks'), headers=self.headers,
+ params={'page': page})
+ r.raise_for_status()
+ return r.json()
+
+ def GetTask(self, task_id):
+ """Fetches a single task.
+
+ Args:
+ task_id: An integer id for the task.
+
+ Returns:
+ A JSON encoded task.
+
+ Raises:
+ HTTPError: a 4XX client error or 5XX server error response was returned.
+ """
+ r = requests.get(self._Url('tasks/%d' % task_id), headers=self.headers)
+ r.raise_for_status()
+ return r.json()
+
+ def NewTask(self, task):
+ """Creates a single new task.
+
+ Args:
+ task: A task object.
+
+ Returns:
+ A JSON encoded response.
+
+ Raises:
+ HTTPError: a 4XX client error or 5XX server error response was returned.
+ """
+ r = requests.post(self._Url('tasks'), headers=self.headers,
+ data=json.dumps(task))
+ r.raise_for_status()
+ return r.json()
+
+ def UpdateTask(self, task_id, task):
+ """Modifies a single task.
+
+ Args:
+ task_id: An integer id for the task.
+ task: A task object.
+
+ Returns:
+ A JSON encoded response.
+
+ Raises:
+ HTTPError: a 4XX client error or 5XX server error response was returned.
+ """
+ r = (
+ requests.put(
+ self._Url('tasks/%d' % task_id), data=json.dumps(task),
+ headers=self.headers))
+ r.raise_for_status()
+ return r.json()
+
+ def DeleteTask(self, task_id):
+ """Deletes a single task.
+
+ Args:
+ task_id: An integer id for the task.
+
+ Returns:
+ A JSON encoded response.
+
+ Raises:
+ HTTPError: a 4XX client error or 5XX server error response was returned.
+ """
+ r = (
+ requests.delete(
+ self._Url('tasks/%d' % task_id),
+ headers=self.headers))
+ r.raise_for_status()
+ return r.json()
diff --git a/csv_uploader.py b/csv_uploader.py
new file mode 100755
index 0000000..1f69bbf
--- /dev/null
+++ b/csv_uploader.py
@@ -0,0 +1,96 @@
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""A simple CSV uploader client for the GCI API.
+
+Usage:
+ ./csv_uploader --apikey abc123 tasks.csv
+
+Note:
+ This uploader will attempt to upload all tasks in the file. If you run it
+ more than once on a file, you will end up with duplicate tasks.
+
+"""
+
+import argparse
+import csv
+
+import requests
+import client as gciclient
+
+
+argparser = argparse.ArgumentParser(description='GCI CSV Task Uploader.')
+argparser.add_argument('--apikey', type=str, nargs='?', required=True,
+ help='api key')
+argparser.add_argument('--url', type=str, nargs='?', required=True,
+ default='https://codein.withgoogle.com',
+ help='server url')
+argparser.add_argument('--publish', action='store_true',
+ help='publish uploaded tasks')
+argparser.add_argument('-v', '--verbose', action='store_true',
+ help='enable verbose logging')
+argparser.add_argument('--debug', action='store_true',
+ help='enable debug request logging')
+argparser.add_argument('files', nargs=argparse.REMAINDER,
+ help='csv file to upload')
+
+FLAGS = argparser.parse_args()
+
+
+def upload(client, filename):
+ """Creates new tasks for each line in the csv pointed to by filename.
+
+ Args:
+ client: A GCIAPIClient to form and make the requests.
+ filename: A string filename containing the csv encoded tasks.
+
+ Raises:
+ none
+ """
+ with open(filename, 'rb') as csvfile:
+ taskreader = csv.DictReader(csvfile)
+
+ for task in taskreader:
+ t = task
+ t['status'] = 2 if FLAGS.publish else 1
+ t['mentors'] = task['mentors'].split(',')
+ t['categories'] = task['categories'].split(',')
+ t['tags'] = task['tags'].split(',')
+ t['is_beginner'] = (
+ True if task['is_beginner'].lower() in ['yes', 'true', '1']
+ else False)
+ t['time_to_complete_in_days'] = int(task['time_to_complete_in_days'])
+ t['max_instances'] = int(task['max_instances'])
+
+ try:
+ t = client.NewTask(t)
+ if FLAGS.verbose:
+ print '\t'.join(['OK', str(t['id']), t['name'], ''])
+ except requests.exceptions.HTTPError as e:
+ if FLAGS.verbose:
+ print '\t'.join(['ERROR', '', t['name'], e.response.text])
+
+
+def main():
+ client = gciclient.GCIAPIClient(
+ auth_token=FLAGS.apikey,
+ url_prefix=FLAGS.url,
+ debug=FLAGS.debug)
+
+ for filename in FLAGS.files:
+ upload(client, filename)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/list_tasks.py b/list_tasks.py
new file mode 100755
index 0000000..6876aaf
--- /dev/null
+++ b/list_tasks.py
@@ -0,0 +1,55 @@
+# Copyright 2015 Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""List all tasks for your Organization via the GCI API."""
+
+import argparse
+import re
+
+import client as gciclient
+
+
+argparser = argparse.ArgumentParser(description='GCI CSV Task Uploader.')
+argparser.add_argument('--apikey', type=str, nargs='?', required=True,
+ help='api key')
+argparser.add_argument('--url', type=str, nargs='?', required=True,
+ default='https://codein.withgoogle.com',
+ help='server url')
+argparser.add_argument('--debug', action='store_true',
+ help='enable debug request logging')
+
+FLAGS = argparser.parse_args()
+
+
+def main():
+ client = gciclient.GCIAPIClient(
+ auth_token=FLAGS.apikey,
+ url_prefix=FLAGS.url,
+ debug=FLAGS.debug)
+
+ next_page = 1
+ while next_page > 0:
+ tasks = client.ListTasks(page=next_page)
+ for t in tasks['results']:
+ print '\t'.join([str(t['id']), t['name']])
+
+ next_page = 0
+ if tasks['next']:
+ result = re.search(r'page=(\d+)', tasks['next'])
+ if result:
+ next_page = result.group(1)
+
+
+if __name__ == '__main__':
+ main()
diff --git a/sample.csv b/sample.csv
new file mode 100644
index 0000000..2d28d29
--- /dev/null
+++ b/sample.csv
@@ -0,0 +1,2 @@
+name,description,max_instances,mentors,tags,is_beginner,categories,time_to_complete_in_days,private_metadata
+"Test Task","Long Description",3,"mentor1@example.org,mentor2@example.org","a,b",yes,"1,2",5,private
