infopark_cloud_connector 6.8.0.328.4a753fc → 6.8.0.348.160665197

data/lib/rails_connector/obj.rb

@@ -50,17 +50,19 @@ module RailsConnector
       end
     end
 
-    # (notice: not yet implemented)
-    # Returns a list of all Objs.
+    # Returns a {ObjSearchEnumerator} of all Objs.
     # If invoked on a subclass of Obj, the result will be restricted to Obj of that subclass.
     def self.all
-      raise "not yet implemented!"
+      if self.name == 'RailsConnector::Obj'
+        ObjSearchEnumerator.new(nil)
+      else
+        find_all_by_obj_class(self.name)
+      end
     end
 
-    # (notice: not yet implemented)
-    # returns an Array of all Objs with the given obj_class.
+    # Returns an {ObjSearchEnumerator} of all Objs with the given obj_class.
     def self.find_all_by_obj_class(obj_class)
-      raise "not yet implemented!"
+      ObjSearchEnumerator.new([{:field => '_obj_class', :operator => 'equal', :value => obj_class}])
     end
 
     # Find the Obj with the given path.
@@ -74,18 +76,18 @@ module RailsConnector
       find_objs_by(:path, pathes).map(&:first)
     end
 
-    # (notice: not yet implemented)
     # Find an Obj with the given name.
     # If several Objs exist with the given name, one of them is chosen and returned.
     # If no Obj with the name exits, nil is returned.
     def self.find_by_name(name)
-      raise "not yet implemented!"
+      enum = ObjSearchEnumerator.new(
+          [{:field => '_name', :operator => 'equal', :value => name}], {:batch_size => 1})
+      enum.first
     end
 
-    # (notice: not yet implemented)
-    # Find all Objs with the given name.
+    # Returns an {ObjSearchEnumerator} of all Objs with the given name.
     def self.find_all_by_name(name)
-      raise "not yet implemented!"
+      ObjSearchEnumerator.new([{:field => '_name', :operator => 'equal', :value => name}])
     end
 
     # Return the Obj with the given permalink or nil if no matching Obj exists.

data/lib/rails_connector/obj_search_enumerator.rb

@@ -0,0 +1,83 @@
+module RailsConnector
+  # Provides an enumerator, to iterate over obj search results and return "real" objs.
+  # This is done using the {http://ruby-doc.org/core-1.8.7/Enumerable.html <code>Enumerable</code> mixin}, which provided methods like <code>map</code>, <code>select</code> or <code>take</code>.
+  #
+  # This enumerator is lazy. Let's say, that when looking for Objs with the ObjClass Publication there are 123 objs in total. Now <code>enum.take(10)</code> will only fetch the first 10 objs, leaving the other 113 objs untouched.
+  # This also means, that iterating multiple times over this enumerator, each time the search results and objs are fetched again. If you want to get all objs at once, use <code>enum.to_a</code>.
+  #
+  # For all possible <code>query</code>'s and <code>options</code> have a look at the cms api documentation about objs/search.
+  # There is one exception: To adjust how many search results should be fetch with one chunk, use the option <code>:batch_size</code>. The default is <code>10</code>. The <code>:size</code> option will be silently ignored.
+  #
+  # @example All objs, which are Publications
+  #   enum = ObjSearchEnumerator([{:field => '_obj_class', :operator => 'equal', :value => 'Publication'}])
+  #   enum.each { |obj| puts obj.path }
+  class ObjSearchEnumerator
+    include Enumerable
+
+    attr_reader :query
+    attr_reader :options
+
+    # @param [Array] query
+    # @param [Hash] options
+    def initialize(query, options = {})
+      @query = query
+      @query.freeze
+
+      options.delete(:size)
+      options.delete('size')
+      if batch_size = options.delete(:batch_size)
+        options[:size] = batch_size
+      end
+      @options = options
+      @options.freeze
+    end
+
+    def each
+      offset = 0
+      current_batch, total = fetch_next_batch(offset)
+      loop do
+        if current_batch.size == 0
+          if offset < total
+            current_batch, total = fetch_next_batch(offset)
+          else
+            raise StopIteration
+          end
+        end
+
+        offset += 1
+        hit = current_batch.shift
+        yield Obj.find(hit['id'])
+      end
+    end
+
+    # The total size of all results.
+    # @return [Integer]
+    def size
+      if @size.blank?
+        @size = CmsRestApi.get(resource_path, {:query => query, :size => 1})['total'].to_i
+      end
+      @size
+    end
+
+    alias_method :length, :size
+
+    private
+
+    def fetch_next_batch(offset)
+      request_result = CmsRestApi.get(resource_path, search_dsl(offset))
+
+      [request_result['results'], request_result['total'].to_i]
+    end
+
+    def resource_path
+      "revisions/#{Workspace.current.revision_id}/objs/search"
+    end
+
+    def search_dsl(offset)
+      options.merge({
+        :offset => offset,
+        :query => query,
+      })
+    end
+  end
+end

metadata

@@ -1,18 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: infopark_cloud_connector
 version: !ruby/object:Gem::Version 
-  hash: 383871886
-  prerelease: 11
+  hash: 321329493
+  prerelease: 
   segments: 
   - 6
   - 8
   - 0
-  - 328
-  - 4
-  - a
-  - 753
-  - fc
-  version: 6.8.0.328.4a753fc
+  - 348
+  - 160665197
+  version: 6.8.0.348.160665197
 platform: ruby
 authors: 
 - Infopark AG
@@ -20,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-11-16 00:00:00 +01:00
+date: 2012-11-23 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,17 +57,14 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        hash: 383871886
+        hash: 321329493
         segments: 
         - 6
         - 8
         - 0
-        - 328
-        - 4
-        - a
-        - 753
-        - fc
-        version: 6.8.0.328.4a753fc
+        - 348
+        - 160665197
+        version: 6.8.0.348.160665197
   version_requirements: *id003
   name: kvom
   prerelease: false
@@ -114,6 +108,7 @@ files:
 - lib/rails_connector/obj_data_from_database.rb
 - lib/rails_connector/obj_data_from_hash.rb
 - lib/rails_connector/obj_data_from_service.rb
+- lib/rails_connector/obj_search_enumerator.rb
 - lib/rails_connector/path_conversion.rb
 - lib/rails_connector/permission.rb
 - lib/rails_connector/rack_middlewares.rb