[MODEL] Improved the support for returning an array of error elements from import

Changed the option name to `return`, to allow future expansion for other return values,
and for improved expressivity:

    Article.import return: 'errors'

Added documentation, tweaked tests.

Related: 107

Author: karmi

elasticsearch-model/lib/elasticsearch/model/importing.rb

@@ -90,13 +90,18 @@ module ClassMethods
         #
         #    Article.import preprocess: enrich
         #
+        # @example Return an array of error elements instead of the number of errors, eg.
+        #          to try importing these records again
+        #
+        #    Article.import return: 'errors'
+        #
         def import(options={}, &block)
-          errors         = []
+          errors       = []
           refresh      = options.delete(:refresh)   || false
           target_index = options.delete(:index)     || index_name
           target_type  = options.delete(:type)      || document_type
           transform    = options.delete(:transform) || __transform
-          return_errors  = options.delete(:return_errors) || false
+          return_value = options.delete(:return)    || 'count'
 
           unless transform.respond_to?(:call)
             raise ArgumentError,
@@ -115,15 +120,16 @@ def import(options={}, &block)
 
             yield response if block_given?
 
-            errors += response['items'].select { |i| i['index']['error'] }
+            errors +=  response['items'].select { |k, v| k.values.first['error'] }
           end
 
           self.refresh_index! if refresh
 
-          if return_errors
-            errors
-          else
-            errors.size
+          case return_value
+            when 'errors'
+              errors
+            else
+              errors.size
           end
         end
 

elasticsearch-model/test/unit/importing_test.rb

@@ -48,7 +48,7 @@ def importing_mixin
       assert_equal 0, DummyImportingModel.import
     end
 
-    should "return number of errors" do
+    should "return the number of errors" do
       Elasticsearch::Model::Adapter.expects(:from_class)
                                    .with(DummyImportingModel)
                                    .returns(DummyImportingAdapter)
@@ -66,24 +66,22 @@ def importing_mixin
       assert_equal 1, DummyImportingModel.import
     end
 
-    should "return list of errors if passing option 'return_errors'" do
+    should "return an array of error elements" do
       Elasticsearch::Model::Adapter.expects(:from_class)
                                    .with(DummyImportingModel)
                                    .returns(DummyImportingAdapter)
 
       DummyImportingModel.__send__ :include, Elasticsearch::Model::Importing
 
       client = mock('client')
-      error_text = 'FAILED'
-      client.expects(:bulk).returns({'items' => [ {'index' => {}}, {'index' => {'error' => error_text}} ]})
+      client.expects(:bulk).returns({'items' => [ {'index' => {}}, {'index' => {'error' => 'FAILED'}} ]})
 
       DummyImportingModel.stubs(:client).returns(client)
       DummyImportingModel.stubs(:index_name).returns('foo')
       DummyImportingModel.stubs(:document_type).returns('foo')
+      DummyImportingModel.stubs(:__batch_to_bulk)
 
-      expected_error_element = {'index' => {'error' => error_text}}
-
-      assert_equal [expected_error_element], DummyImportingModel.import(return_errors: true)
+      assert_equal [{'index' => {'error' => 'FAILED'}}], DummyImportingModel.import(return: 'errors')
     end
 
     should "yield the response" do