Review PR for Ned and Xavier

.gitignore

@@ -0,0 +1,4 @@
+xblock_google_drive.egg-info
+*.log
+*.pyc
+*~

.pep8

@@ -0,0 +1,4 @@
+[pep8]
+ignore=E501
+max_line_length=119
+exclude=settings

.pylintrc

@@ -0,0 +1,84 @@
+[MASTER]
+
+# Profiled execution.
+profile=no
+
+# Add files or directories to the blacklist. They should be base names, not
+# paths.
+ignore=migrations
+
+
+[MESSAGES CONTROL]
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then reenable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+# I0011     locally-disabled   (module-level pylint overrides)
+# disabling ```duplicate-code``` due to 5 lines that are the same near the top of
+# both xblock files - of course these are similar because it is a core pattern to
+# use - if we separated out into a separate file, we'd have the 5 lines in a separate
+# file and have 2 import statements within each file to get back the stuff - pretty
+# useless warning in this specific case
+disable=I0011,W0232,duplicate-code
+
+
+[REPORTS]
+
+# Put messages in a separate file for each module / package specified on the
+# command line instead of printing them on stdout. Reports (if any) will be
+# written in a file name "pylint_global.[txt|html]".
+files-output=no
+
+# Add a comment according to your evaluation note. This is used by the global
+# evaluation report (RP0004).
+comment=no
+
+
+[VARIABLES]
+
+# Tells whether we should check for unused import in __init__ files.
+init-import=no
+
+# A regular expression matching the beginning of the name of dummy variables
+# (i.e. not used).
+dummy-variables-rgx=_|dummy
+
+
+[TYPECHECK]
+
+# When zope mode is activated, add a predefined set of Zope acquired attributes
+# to generated-members.
+zope=no
+
+
+[BASIC]
+
+# List of builtins function names that should not be used, separated by a comma
+bad-functions=map,filter,apply,input
+
+# Regular expression which should only match correct function names
+function-rgx=[a-z_][a-z0-9_]{2,50}$
+
+
+[SIMILARITIES]
+
+# Ignore imports when computing similarities.
+ignore-imports=no
+
+
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=120
+
+
+[IMPORTS]
+
+# Deprecated modules which should not be used, separated by a comma
+deprecated-modules=regsub,string,TERMIOS,Bastion,rexec

.travis.yml

@@ -0,0 +1,19 @@
+language: python
+
+python:
+  - "2.7"
+
+before_install:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"
+
+install:
+  - "pip install -r requirements.txt"
+  - "pip uninstall -y xblock-google-drive && python setup.py sdist && pip install dist/xblock-google-drive-0.1.tar.gz"
+
+script:
+  - DJANGO_SETTINGS_MODULE="settings" nosetests --with-coverage --cover-package="google_drive" --with-django
+  - pep8 --config=.pep8 google_drive
+  - pylint --rcfile=.pylintrc google_drive --report=no
+
+after_success: coveralls

README.rst

@@ -0,0 +1,155 @@
+Google Drive & Calendar XBlock |Build Status|
+---------------------------------------------
+
+This XBlock allows embedding of Google documents and calendar, within an
+edX course.
+
+Installation
+------------
+
+Install the requirements into the python virtual environment of your
+``edx-platform`` installation by running the following command from the
+root folder:
+
+.. code:: bash
+
+    $ pip install -r requirements.txt
+
+Enabling in Studio
+------------------
+
+You can enable the Google Drive & Calendar XBlock in studio through the
+advanced settings.
+
+1. From the main page of a specific course, navigate to
+   ``Settings ->    Advanced Settings`` from the top menu.
+2. Check for the ``advanced_modules`` policy key, and add
+   ``"google-document"`` and ``"google-calendar"`` to the policy value
+   list.
+3. Click the "Save changes" button.
+
+Workbench installation and settings
+-----------------------------------
+
+Install to the workbench's virtualenv by running the following command
+form the google-drive repo root:
+
+.. code:: bash
+
+    pip install -r requirements.txt
+
+Running the workbench
+---------------------
+
+.. code:: bash
+
+    $ ./manage.py runserver 8000
+
+Access it at `http://localhost:8000/ <http://localhost:8000>`__.
+
+Running tests
+-------------
+
+From google-drive directory, run the tests with the following command:
+
+.. code:: bash
+
+    $ DJANGO_SETTINGS_MODULE="settings" nosetests --with-django tests/*
+
+If you want to run only the integration or the unit tests, append the
+directory to the command. You can also run separate modules in this
+manner.
+
+.. code:: bash
+
+    $ DJANGO_SETTINGS_MODULE="settings" nosetests --with-django tests/unit
+
+To see the coverage, run the tests using the following command:
+
+.. code:: bash
+
+    $ DJANGO_SETTINGS_MODULE="settings" nosetests --with-coverage --cover-package="google_drive" --with-django
+
+If you have not installed the xblock-sdk in the active virtualenv, you
+might also have to prepend ``PYTHONPATH=".:/path/to/xblock"`` to the
+command above. (``/path/to/xblock`` is the path to the xblock-sdk, where
+the workbench resides).
+
+Changes to be documented
+------------------------
+
+1. Calendar width is set to 100% of parent element's width; this
+   optimizes the display of google document content within the LMS user
+   interface
+2. Max width of Google images is set to 100% to prevent images from
+   overflowing outside the parent element's boundaries
+3. Since Google WordProcessing documents and Spreadsheets don't allow
+   users to explicitly define width and height, their width is set to
+   100%. Also, min height is set to 450px, so that documents and/or
+   spreadsheets with larger number of rows are displayed in their
+   natural size. Overflow scroll is automatically turned on when the
+   height of the document becomes larger than the height of the parent.
+
+Validation
+----------
+
+Each time a character is added to or removed from Google Calendar ID,
+validation takes place. Analogically, validation takes place for
+embedded code of Google Drive File.
+
+1. Google calendar IDs are being validated against a regular expression.
+   IDs must contain at least one '@' character, with at least one
+   character on each side of it, ie. 'a@a'.
+
+2. Embedded code of Google Drive file is being validated on the server
+   side, by checking the status code of the HTTP response. Since error
+   status codes start with 400, it's assumed that each status code
+   that's larger than or equal to 400 states that file is invalid. If
+   for any reason exception occurs while getting an HTTP response, error
+   code is returned, thus overriding default signalization that is
+   invoked by edx platform when the 500 status code is reported.
+
+Accessibility (a11y)
+--------------------
+
+For users with a visual impairment:
+
+1. Iframes in which Google calendars and Google Drive files (except
+   images) are shown now have title attribute with alternative text
+   content which describes what the iframe contains.
+2. Images have alt attribute which contains alternative text that has
+   the same purpose as the title attribute of an iframe has
+
+Analytics
+---------
+
+For analytics purposes, each time an image or iframe containing a
+calendar or Google Drive file is loaded, an event will be triggered.
+
+There are two types of events:
+
+1. edx.googlecomponent.calendar.displayed (if an iframe containing a
+   Google calendar is loaded)
+2. edx.googlecomponent.document.displayed (if an image or an iframe
+   containing a Google Drive File is loaded)
+
+License
+-------
+
+The Google Drive & Calendar XBlocks are available under the GNU Affero
+General Public License (AGPLv3).
+
+Installation Troubleshooting
+----------------------------
+
+On a Mac, some people have received errors when installing lxml, trying
+to find a specific header file for the compiler
+
+Try the following if you encounter a problem:
+
+::
+
+    CPATH=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.9.sdk/usr/include/libxml2 CFLAGS=-Qunused-arguments CPPFLAGS=-Qunused-arguments pip install lxml
+
+.. |Build Status| image:: https://travis-ci.org/edx-solutions/xblock-google-drive.svg?branch=master
+   :target: https://travis-ci.org/edx-solutions/xblock-google-drive

google_drive/__init__.py

@@ -1,2 +1,5 @@
+"""
+Google drive XBlocks
+"""
 from .google_docs import GoogleDocumentBlock
-from .google_calendar import GoogleCalendarBlock
+from .google_calendar import GoogleCalendarBlock