Initial commit

rate/__init__.py

+from .rate import RateXBlock

rate/rate.py

+"""TO-DO: Write a description of what this XBlock is."""
+
+import pkg_resources
+
+from xblock.core import XBlock
+from xblock.fields import Scope, Integer, String, List
+from xblock.fragment import Fragment
+
+
+class RateXBlock(XBlock):
+    """
+    TO-DO: document what your XBlock does.
+    """
+
+    # Fields are defined on the class.  You can access them in your code as
+    # self.<fieldname>.
+
+    levels = List(
+        default=0, scope=Scope.settings,
+        help="Names of ratings",
+    )
+
+    prompt = String(
+        default=0, scope=Scope.settings,
+        help="User prompt",
+    )
+
+    vote = Integer(
+        default=-1, scope=Scope.user_state,
+        help="How user voted. -1 if didn't vote",
+    )
+
+    vote_aggregate = List(
+        default=0, scope=Scope.user_state_summary,
+        help="A simple counter, to show something happening",
+    )
+
+    def resource_string(self, path):
+        """Handy helper for getting resources from our kit."""
+        data = pkg_resources.resource_string(__name__, path)
+        return data.decode("utf8")
+
+    # TO-DO: change this view to display your data your own way.
+    def student_view(self, context=None):
+        """
+        The primary view of the RateXBlock, shown to students
+        when viewing courses.
+        """
+        html = self.resource_string("static/html/rate.html")
+        frag = Fragment(html.format(self=self))
+        frag.add_css(self.resource_string("static/css/rate.css"))
+        frag.add_javascript(self.resource_string("static/js/src/rate.js"))
+        frag.initialize_js('RateXBlock')
+        return frag
+
+    # TO-DO: change this handler to perform your own actions.  You may need more
+    # than one handler, or you may not need any handlers at all.
+    @XBlock.json_handler
+    def increment_count(self, data, suffix=''):
+        """
+        An example handler, which increments the data.
+        """
+        # Just to show data coming in...
+        assert data['hello'] == 'world'
+
+        self.count += 1
+        return {"count": self.count}
+
+    # TO-DO: change this to create the scenarios you'd like to see in the
+    # workbench while developing your XBlock.
+    @staticmethod
+    def workbench_scenarios():
+        """A canned scenario for display in the workbench."""
+        return [
+            ("RateXBlock",
+             """<vertical_demo>
+                <rate/>
+                <rate/>
+                <rate/>
+                </vertical_demo>
+             """),
+        ]

rate/static/README.txt

+This static directory is for files that should be included in your kit as plain
+static files.
+
+You can ask the runtime for a URL that will retrieve these files with:
+
+    url = self.runtime.local_resource_url(self, "static/js/lib.js")
+
+The default implementation is very strict though, and will not serve files from
+the static directory.  It will serve files from a directory named "public".
+Create a directory alongside this one named "public", and put files there.
+Then you can get a url with code like this:
+
+    url = self.runtime.local_resource_url(self, "public/js/lib.js")
+
+The sample code includes a function you can use to read the content of files
+in the static directory, like this:
+
+    frag.add_javascript(self.resource_string("static/js/my_block.js"))
+

rate/static/css/rate.css

+/* CSS for RateXBlock */
+
+.rate_block .count {
+    font-weight: bold;
+}
+
+.rate_block p {
+    cursor: pointer;
+}

rate/static/html/rate.html

+<div class="rate_block">
+<p>RateXBlock: count is now
+    <span class='count'>{self.count}</span> (click me to increment).
+</p>
+</div>

rate/static/js/src/rate.js

+/* Javascript for RateXBlock. */
+function RateXBlock(runtime, element) {
+
+    function updateCount(result) {
+        $('.count', element).text(result.count);
+    }
+
+    var handlerUrl = runtime.handlerUrl(element, 'increment_count');
+
+    $('p', element).click(function(eventObject) {
+        $.ajax({
+            type: "POST",
+            url: handlerUrl,
+            data: JSON.stringify({"hello": "world"}),
+            success: updateCount
+        });
+    });
+
+    $(function ($) {
+        /* Here's where you'd do things on page load. */
+    });
+}

setup.py

+"""Setup for rate XBlock."""
+
+import os
+from setuptools import setup
+
+
+def package_data(pkg, roots):
+    """Generic function to find package_data.
+
+    All of the files under each of the `roots` will be declared as package
+    data for package `pkg`.
+
+    """
+    data = []
+    for root in roots:
+        for dirname, _, files in os.walk(os.path.join(pkg, root)):
+            for fname in files:
+                data.append(os.path.relpath(os.path.join(dirname, fname), pkg))
+
+    return {pkg: data}
+
+
+setup(
+    name='rate-xblock',
+    version='0.1',
+    description='rate XBlock',   # TODO: write a better description.
+    packages=[
+        'rate',
+    ],
+    install_requires=[
+        'XBlock',
+    ],
+    entry_points={
+        'xblock.v1': [
+            'rate = rate:RateXBlock',
+        ]
+    },
+    package_data=package_data("rate", ["static", "public"]),
+)