updated code, test and readme

Author: chfw

README.rst

@@ -27,6 +27,61 @@ or clone it and install it::
     $ python setup.py install
 
 
+Usage
+=========
+
+This small section outlines the steps to adapt **pyexcel-webio** for your favourite web framework. For illustration purpose, I took **Flask** micro-framework as an example.
+
+1. Inherit **ExcelInput** class and implement **load_single_sheet** and **load_book** methods depending on the parameters you will have. For example, **Flask.Request** put the incoming file in **Flask.Request.files** and the key is the field name in the html form::
+
+    from flask import Flask, Request
+    import pyexcel as pe
+    from pyexcel.ext import webio
+
+    class ExcelRequest(webio.ExcelInput, Request):
+        def _get_file_tuple(self, field_name):
+            filehandle = self.files[field_name]
+            filename = filehandle.filename
+            extension = filename.split(".")[1]
+            return extension, filehandle
+    
+        def load_single_sheet(self, field_name=None, sheet_name=None, **keywords):
+            file_type, file_handle = self._get_file_tuple(field_name)
+            return pe.load_from_memory(file_type, file_handle.read(), sheet_name, **keywords)
+    
+        def load_book(self, field_name=None, **keywords):
+            file_type, file_handle = self._get_file_tuple(field_name)
+            return pe.load_book_from_memory(file_type, file_handle.read(), **keywords)
+
+2. Plugin in a response method that has the following signature::
+
+    def your_func(content, content_type=None, status=200):
+        ....
+
+or a response class has the same signature::
+
+    class YourClass:
+	    def __init__(self, content, content_type=None, status=200):
+		....
+
+For example, with **Flask**, it is just a few lines::
+
+    from flask import Response
+
+
+    webio.ExcelResponse = Response
+
+
+3. Then make the proxy for **make_response** series by simply copying the following lines to your extension::
+
+    from pyexcel.ext.webio import (
+        make_response,
+        make_response_from_array,
+        make_response_from_dict,
+        make_response_from_records,
+        make_response_from_book_dict
+    )
+
 Dependencies
 ============
 

pyexcel_webio/__init__.py

@@ -109,7 +109,8 @@ def get_records(self, sheet_name=None, name_columns_by_row=0, **keywords):
 
     def save_to_database(self, session=None, table=None, sheet_name=None, name_columns_by_row=0, **keywords):
         sheet = self.load_single_sheet(sheet_name=sheet_name, name_columns_by_row=name_columns_by_row, **keywords)
-        sheet.save_to_database(session, table)
+        if sheet:
+            sheet.save_to_database(session, table)
 
     def get_book(self, **keywords):
         """Get a instance of :class:`Book` from the file
@@ -135,7 +136,8 @@ def get_book_dict(self, **keywords):
 
     def save_book_to_database(self, session, tables, **keywords):
         book = self.load_book(**keywords)
-        book.save_to_database(session, tables)
+        if book:
+            book.save_to_database(session, tables)
 
 
 def dumpy_func(content, content_type=None, status=200):

tests/test_webio.py

@@ -4,31 +4,80 @@
 from pyexcel.ext import xls
 from db import Session, Base, Signature, Signature2, engine
 import sys
-
 if sys.version_info[0] == 2 and sys.version_info[1] < 7:
     from ordereddict import OrderedDict
 else:
     from collections import OrderedDict
+from nose.tools import raises
+    
 
 OUTPUT = "response_test.xls"
 
 
 class TestInput(webio.ExcelInput):
+    """This is sample implementation that read excel source from file"""
     def load_single_sheet(self, filename=None, sheet_name=None, **keywords):
+        """Load a single sheet"""
         return pe.get_sheet(file_name=filename, **keywords)
 
     def load_book(self, filename=None, **keywords):
+        """Load a book"""
         return pe.get_book(file_name=filename, **keywords)
 
+
 def dumpy_response(content, content_type=None, status=200):
+    """A dummy response"""
     f = open(OUTPUT, 'wb')
     f.write(content)
     f.close()
 
 
 webio.ExcelResponse = dumpy_response
-    
-    
+
+
+class TestExceptions:
+    @raises(NotImplementedError)
+    def test_load_single_sheet(self):
+        testinput = webio.ExcelInput()
+        testinput.get_sheet(filename="test") # booom
+
+    @raises(NotImplementedError)
+    def test_load_book(self):
+        testinput = webio.ExcelInput()
+        testinput.get_book(filename="test") # booom
+
+    def test_get_sheet(self):
+        myinput = TestInput()
+        sheet = myinput.get_sheet(unrelated="foo bar")
+        assert sheet == None
+
+    def test_get_array(self):
+        myinput = TestInput()
+        array = myinput.get_array(unrelated="foo bar")
+        assert array == None
+
+    def test_get_dict(self):
+        myinput = TestInput()
+        result = myinput.get_dict(unrelated="foo bar")
+        assert result == None
+
+    def test_get_records(self):
+        myinput = TestInput()
+        result = myinput.get_records(unrelated="foo bar")
+        assert result == None
+
+    def test_get_book(self):
+        myinput = TestInput()
+        result = myinput.get_book(unrelated="foo bar")
+        assert result == None
+
+    def test_get_book_dict(self):
+        myinput = TestInput()
+        result = myinput.get_book_dict(unrelated="foo bar")
+        assert result == None
+
+# excel inputs
+
 class TestExcelInput:
     def setUp(self):
         self.data = [
@@ -103,10 +152,21 @@ def test_get_book_dict(self):
         assert result["sheet1"] == self.data
         assert result["sheet2"] == self.data1
 
+    def test_save_to_database(self):
+        Base.metadata.drop_all(engine)
+        Base.metadata.create_all(engine)
+        self.session = Session()
+        myinput = TestInput()
+        myinput.save_book_to_database(filename=self.testfile, session=self.session, tables=[Signature, Signature2])
+        array = pe.get_array(session=self.session, table=Signature)
+        assert array == self.data
+        array = pe.get_array(session=self.session, table=Signature2)
+        assert array == self.data1
 
     def tearDown(self):
         os.unlink(self.testfile)
 
+## responses
 
 class TestResponse:
     def setUp(self):