infopark_cloud_connector 6.9.5 → 7.0.0

data/lib/rails_connector/named_link.rb

@@ -31,7 +31,7 @@ module RailsConnector
       return nil
     end
 
-    # This method will be called to retrieve the NamedLink Obj.
+    # This method will be called to retrieve the NamedLink {BasicObj Obj}.
     # By default it will look for the Obj at the path "_named_links".
     # Overwrite this method only if you know what you are doing.
     # @api public

data/lib/rails_connector/obj_search_enumerator.rb

@@ -4,30 +4,30 @@ module RailsConnector
   # This is done using the {http://ruby-doc.org/core-1.8.7/Enumerable.html <code>Enumerable</code> mixin},
   # which provides methods such as <code>map</code>, <code>select</code> or <code>take</code>.
   #
-  # This enumerator is lazy. If for example you are looking for Objs with the ObjClass "Publication",
+  # This enumerator is lazy. If for example you are looking for {BasicObj Obj}s with the ObjClass "Publication",
   # and there are 93 objs in total, than <code>enum.take(10)</code> will fetch the first 10 objs only,
   # ignoring the other 83 objs.
   # This also means, that iterating multiple times over this enumerator causes the search results and objs to be fetched again.
   # If you want to get all objs at once, use <code>enum.to_a</code>.
   #
-  # To start searching use one of the {Obj} methods that returns an {ObjSearchEnumerator}. The preferred way is to start with {Obj.where}.
+  # To start searching use one of the {BasicObj Obj} methods that returns an {ObjSearchEnumerator}. The preferred way is to start with {BasicObj.where Obj.where}.
   #
   # == Currently available fields and their values
   #
   # [+:*+]              Searches all fields.
   #                     This is only possible with the operators +contais+ or +starts_with+.
-  # [+:id+]             Id of an {Obj}. This is a +string+ field.
-  # [+:_path+]          Path of an {Obj}. This is a +string+ field.
-  # [+:_name+]          Name of an {Obj}. This is a +string+ field.
-  # [+:title+]          Title of an {Obj}. This is a +string+ field.
-  # [+:body+]           Body of an {Obj}. This is an +html+ field. Thus, only the +contains+ and
+  # [+:id+]             Id of an {BasicObj Obj}. This is a +string+ field.
+  # [+:_path+]          Path of an {BasicObj Obj}. This is a +string+ field.
+  # [+:_name+]          Name of an {BasicObj Obj}. This is a +string+ field.
+  # [+:title+]          Title of an {BasicObj Obj}. This is a +string+ field.
+  # [+:body+]           Body of an {BasicObj Obj}. This is an +html+ field. Thus, only the +contains+ and
   #                     +contains_prefix+ operators can be applied to this field.
-  # [+:_obj_class+]     ObjClass of an {Obj}. This is a +string+ field.
-  # [+:_permalink+]     Permalink of an {Obj}. This is a +string+ field.
-  # [+:_valid_from+]    The valid-from date of an {Obj}.
-  # [+:_valid_until+]   The valid-until date of an {Obj}.
-  # [+:_last_changed+]  Date of last change of an {Obj}.
-  # [every <em><code>:custom_attribute</code></em>] Custom attribute of an {Obj}. Note that
+  # [+:_obj_class+]     ObjClass of an {BasicObj Obj}. This is a +string+ field.
+  # [+:_permalink+]     Permalink of an {BasicObj Obj}. This is a +string+ field.
+  # [+:_valid_from+]    The valid-from date of an {BasicObj Obj}.
+  # [+:_valid_until+]   The valid-until date of an {BasicObj Obj}.
+  # [+:_last_changed+]  Date of last change of an {BasicObj Obj}.
+  # [every <em><code>:custom_attribute</code></em>] Custom attribute of an {BasicObj Obj}. Note that
   #                                                 depending on the attribute type (e.g. an
   #                                                 +html+ field), some operators can not be applied.
   #
@@ -111,23 +111,9 @@ module RailsConnector
     include Enumerable
 
     attr_reader :query
-    attr_reader :options
-    attr_reader :initial_offset
-
-    # 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 }
-    #
-    # @param [Array<Hash>] query
-    # @param [Hash] options
-    # @param [Integer] initial_offset
-    def initialize(query, options = {}, initial_offset = 0)
+    def initialize(query)
       @query = query
-      @options = options.symbolize_keys
-      @initial_offset = initial_offset
+      @options = {}
     end
 
     # @group Chainable methods
@@ -196,57 +182,53 @@ module RailsConnector
     # @return [ObjSearchEnumerator]
     # @api public
     def order(field_name)
-      @options[:sort_by] = field_name.to_sym
+      options[:sort_by] = field_name
 
       self
     end
 
-    # Reverses the order of the results.
+    # Reverses the order of the results. Requires {#order} to be specified before.
     # @return [ObjSearchEnumerator]
     # @api public
     def reverse_order
-      @options[:sort_order] = case options[:sort_order]
-      when :asc
-        :desc
-      when :desc
-        :asc
-      else
-        options[:sort_by].present? ? :desc : :asc
-      end
+      options[:sort_by].present? or raise "A search order has to be specified"\
+          " before reverse_order can be applied."
+      @reverse_order = !@reverse_order
 
       self
     end
 
-    # Sets the internal batch_size to +size+.
-    # The default is +10+, the maximum is +100+.
+    # Number of search results to be returned by each of the internal search requests.
+    # The default is +10+. The server may limit a large batch size to a reasonable value.
     # @param [Integer] size A value in the range from +1+ to +100+.
     # @return [ObjSearchEnumerator]
     # @api public
     def batch_size(size)
-      @options[:size] = size
+      options[:size] = size
 
       self
     end
 
 
-    # Omits the first +amount+ number of {Obj}s from the results. The default is +0+.
+    # Omits the first +amount+ number of {BasicObj Obj}s from the results. The default is +0+.
     # @param [Integer] amount
     # @return [ObjSearchEnumerator]
     # @api public
     def offset(amount)
-      @initial_offset += amount
+      options[:offset] ||= 0
+      options[:offset] += amount
 
       self
     end
 
     # @!endgroup
 
-    # Iterates over the search result.
+    # Iterates over the search result, yielding {BasicObj Obj}.
     # @yield [Obj]
     # @return [void]
     # @api public
     def each
-      offset = @initial_offset
+      offset = options[:offset] || 0
       current_batch, total = fetch_next_batch(offset)
       loop do
         if current_batch.size == 0
@@ -278,6 +260,8 @@ module RailsConnector
 
     private
 
+    attr_reader :options
+
     def convert_value(value)
       if value.kind_of?(Array)
         value.map{ |v| convert_single_value(v) }
@@ -320,14 +304,18 @@ module RailsConnector
     end
 
     def resource_path
-      "revisions/#{Workspace.current.revision_id}/objs/search"
+      "workspaces/#{Workspace.current.id}/objs/search"
     end
 
     def search_dsl(offset)
-      options.merge({
+      patches = {
         :offset => offset,
         :query => query,
-      })
+      }
+      if @reverse_order
+        patches[:sort_order] = options[:sort_by].present? ? :desc : :asc
+      end
+      options.merge(patches)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark_cloud_connector
 version: !ruby/object:Gem::Version
-  version: 6.9.5
+  version: 7.0.0
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2013-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -146,10 +146,9 @@ files:
 - app/views/cms/_index.html.erb
 - app/views/cms/index.html.erb
 - app/views/errors/403_forbidden.html.erb
-- app/views/errors/410_gone.html.erb
 - app/views/rails_connector/_editing_javascript.html.erb
 - app/views/rails_connector/objs/create_widget.html.erb
-- app/views/rails_connector/objs/show.html.erb
+- app/views/rails_connector/objs/show_widget.html.erb
 - config/ca-bundle.crt
 - config/cms_routes.rb
 - config/locales/de.rails_connector.errors.yml
@@ -173,7 +172,7 @@ files:
 - lib/assets/stylesheets/infopark_editing.css
 - lib/generators/cms/migration/USAGE
 - lib/generators/cms/migration/migration_generator.rb
-- lib/generators/cms/migration/templates/migration.rb
+- lib/generators/cms/migration/templates/migration.erb
 - lib/infopark_cloud_connector.rb
 - lib/obj.rb
 - lib/rails_connector/access_denied.rb
@@ -195,6 +194,7 @@ files:
 - lib/rails_connector/cms_rest_api.rb
 - lib/rails_connector/cms_test_request.rb
 - lib/rails_connector/configuration.rb
+- lib/rails_connector/connection_manager.rb
 - lib/rails_connector/content_conversion.rb
 - lib/rails_connector/content_service.rb
 - lib/rails_connector/content_state.rb
@@ -204,6 +204,7 @@ files:
 - lib/rails_connector/core_extensions.rb
 - lib/rails_connector/core_extensions/time.rb
 - lib/rails_connector/date_attribute.rb
+- lib/rails_connector/deprecation.rb
 - lib/rails_connector/engine.rb
 - lib/rails_connector/errors.rb
 - lib/rails_connector/html_string.rb

data/app/views/errors/410_gone.html.erb

@@ -1,7 +0,0 @@
-<h1><%= t(:'rails_connector.lib.cms_accessible.not_released') %></h1>
-
-<% if @valid_until && @valid_until < Time.now %>
-  <%= raw t(:"rails_connector.views.errors.gone.not_released_anymore", :valid_until => "<strong>#{l @valid_until}</strong>") %>
-<% elsif @valid_from && Time.now < @valid_from %>
-  <%= raw t(:"rails_connector.views.errors.gone.not_yet_released", :valid_from => "<strong>#{l @valid_from}</strong>") %>
-<% end %>

data/app/views/rails_connector/objs/show.html.erb

@@ -1 +0,0 @@
-<%= render_widget @obj, current_page, params[:field_name], @obj.widget_container %>