infopark_cloud_connector 6.8.0.210.ed204b0 → 6.8.0.322.c003f11

data/.yardopts

@@ -0,0 +1,5 @@
+--hide-void-return
+--protected
+--private
+--non-transitive-tag api
+--api public

data/README

@@ -0,0 +1,5 @@
+= Infopark Cloud Connector
+
+Infopark Cloud Connector integrates the {https://rubygems.org/gems/infopark_rails_connector Infopark Rails Connector} with the Infopark Cloud Express CMS.
+
+For more information about Infopark Rails and Cloud Connector, please visit {http://kb.infopark.de/ Infopark’s Knowledge Base}.

data/app/helpers/rails_connector/marker_helper.rb

@@ -1,6 +1,6 @@
 module RailsConnector
 
-  module MarkerHelper # :nodoc:
+  module MarkerHelper
 
     def edit_marker(obj, attr, options = {}, &block)
       if Configuration.editor_interface_enabled?

data/lib/infopark_cloud_connector.rb

@@ -1,6 +1,7 @@
 require 'rails_connector/rack_middlewares'
 require "rails_connector/errors"
 
+# @api public
 module RailsConnector
   def self.autoload_all_sources
     source_files = Dir.glob(File.expand_path("../rails_connector/*.rb", __FILE__)).map do |file|

data/lib/rails_connector/blob.rb

@@ -4,41 +4,50 @@ module RailsConnector
 
 class Blob
 
-  def self.find(id)
-    new(blob_class.find(id))
+  class << self
+    def find(id)
+      new(blob_class.find(id))
+    end
+
+    def config
+      @config or raise "Blob storage has not been configured yet"
+    end
+
+    def configure(spec)
+      @config = spec.symbolize_keys
+      @blob_class = nil
+    end
+
+    def blob_class
+      @blob_class ||= blob_class_from_config
+    end
+
+    # for testing purposes
+    def reset_blob_class_cache
+      @blob_class = nil
+    end
+
+    def unconfigure
+      @config = nil
+    end
+
+    private
+
+    def blob_class_from_config
+      blob_class =
+          case config[:type].to_sym
+          when :s3
+            S3Blob
+          when :service
+            ServiceBlob
+          else
+            raise "Unsupported blob storage type #{config[:type]}"
+          end
+      blob_class.configure(config)
+      blob_class
+    end
   end
 
-  def self.config
-    @config or raise "Blob storage has not been configured yet"
-  end
-
-  def self.configure(spec)
-    @config = spec.symbolize_keys
-  end
-
-  def self.blob_class
-    @blob_class ||= blob_class_from_config
-  end
-
-  # for testing purposes
-  def self.reset_blob_class_cache # :nodoc:
-    @blob_class = nil
-  end
-
-  def self.blob_class_from_config
-    blob_class =
-        case config[:type]
-        when "s3"
-          S3Blob
-        else
-          raise "Unsupported blob storage type #{config[:type]}"
-        end
-    blob_class.configure(config)
-    blob_class
-  end
-
-  attr_reader :instance
-
   def initialize(blob_instance)
     @instance = blob_instance
   end
@@ -51,6 +60,10 @@ class Blob
     instance.url
   end
 
+  def meta_url
+    instance.meta_url
+  end
+
   def content_type
     instance.content_type
   end
@@ -59,6 +72,10 @@ class Blob
     instance.length
   end
 
+  private
+
+  attr_reader :instance
+
 end
 
 end # module RailsConnector

data/lib/rails_connector/cache.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
 class Cache

data/lib/rails_connector/cache_middleware.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
 class CacheMiddleware

data/lib/rails_connector/chain.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
 class Chain

data/lib/rails_connector/cloud_engine.rb

@@ -1,5 +1,5 @@
 module ::RailsConnector
-  class CloudEngine < Rails::Engine #:nodoc:
+  class CloudEngine < Rails::Engine
   end
 end
 

data/lib/rails_connector/cms_api_search_request.rb

@@ -3,6 +3,7 @@ module RailsConnector
   # This class provides a basic implementation for accessing the search using the cms api.
   # It can be activated by making it the superclass of SearchRequest.
   # It should be customized by subclassing.
+  # @api public
   class CmsApiSearchRequest
 
     # Takes +query_string+ and +options+ for accessing Cms Api Search.
@@ -11,12 +12,14 @@ module RailsConnector
     #
     # <tt>:limit</tt>:: The maximum number of hits
     # <tt>:offset</tt>:: The search offset
+    # @api public
     def initialize(query_string, options = {})
       @query_string = query_string
       @options = Configuration.cms_api_options.merge(options)
     end
 
     # Accesses Cms Api Search using #query and fetches search hits.
+    # @api public
     def fetch_hits
       hits = CmsRestApi.get(resource_path, {
         :query => query,

data/lib/rails_connector/cms_base_model.rb

@@ -3,10 +3,9 @@ require "kvom"
 module RailsConnector
 
   # This is the abstract class from which all CMS models derive.
-  #
-  class CmsBaseModel < Kvom::Model::Base #:nodoc:
+  class CmsBaseModel < Kvom::Model::Base
     class << self
-      def instance_name=(ignore) # :nodoc:
+      def instance_name=(ignore)
         # this method is here only for compatibility with the fiona connector.
       end
 

data/lib/rails_connector/cms_rest_api.rb

@@ -18,8 +18,6 @@ module RailsConnector
   #
   # @example Delete an Obj:
   #   RailsConnector::CmsRestApi.delete('revisions/001384beff9e5845/objs/f4123622ff07b70b')
-  #
-  # @api private
   class CmsRestApi
 
     def self.get(resource_path, payload = nil)

data/lib/rails_connector/content_cache.rb

@@ -1,4 +1,3 @@
-#:enddoc:
 module RailsConnector
 
 class ContentCache < CmsBaseModel

data/lib/rails_connector/content_service.rb

@@ -6,6 +6,7 @@ class ContentService
       :headers => {
         :content_type => :json,
         :accept => :json,
+        :user_agent => user_agent,
       },
       :payload => MultiJson.dump(payload)
     ))
@@ -19,4 +20,12 @@ class ContentService
       "#{config['login']}:#{config['api_key']}@#{config['url']}"
     end
   end
+
+  def self.user_agent
+    @user_agent ||= (
+      gem_info = Gem.loaded_specs["infopark_cloud_connector"]
+      "#{gem_info.name}-#{gem_info.version}"
+    )
+  end
+
 end

data/lib/rails_connector/date_attribute.rb

@@ -1,7 +1,7 @@
 module RailsConnector
 
   # Adds support for string columns which contain ISO dates
-  module DateAttribute #:nodoc: all
+  module DateAttribute
     module ClassMethods
       def date_attribute(*names)
         names.each do |name|

data/lib/rails_connector/default_search_request.rb

@@ -1,6 +1,7 @@
 module RailsConnector
   # This class provides a default implementation for accessing the search server.
-  # It is used by DefaultSearchController.
+  # It is used by {DefaultSearchController}.
+  # @api public
   class DefaultSearchRequest < CmsApiSearchRequest
   end
 end

data/lib/rails_connector/dict_storage.rb

@@ -1,6 +1,6 @@
 module RailsConnector
 
-  class DictStorage #:nodoc: all
+  class DictStorage
 
     class << self
 

data/lib/rails_connector/errors.rb

@@ -1,8 +1,10 @@
 module RailsConnector
 
+# @api public
 class RailsConnectorError < StandardError
 end
 
+# @api public
 class ResourceNotFound < RailsConnectorError
 end
 

data/lib/rails_connector/link.rb

@@ -1,11 +1,12 @@
 module RailsConnector
   # This class provides an interfaces for handling CMS Links.
   # To format a link for rendering in an html page, use the +cms_path+ or +cms_url+ methods.
+  # @api public
   class Link
 
     extend ActiveModel::Naming
 
-    def initialize(link_data, destination_object = nil) #:nodoc:
+    def initialize(link_data, destination_object = nil)
       @link_data = link_data.symbolize_keys
       @destination_object = destination_object
     end
@@ -13,17 +14,20 @@ module RailsConnector
     # The link's external url. Only available for external links.
     # Warning: Do not output the url directly unless you know what you are doing.
     # Normally you want to use the +cms_path+ or +cms_url+ methods to format a link.
+    # @api public
     def url
       @link_data[:url]
     end
 
     # The link's title.
+    # @api public
     def title
       @link_data[:title]
     end
 
     # Returns the link's query string as in "index.html?query_string".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
     def query
       @link_data[:query]
     end
@@ -31,40 +35,44 @@ module RailsConnector
     # Depricated: use Link#query instead.
     # Returns the link's query string as in "index.html?query_string".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
     def search
       query
     end
 
     # Returns the link's anchor as in "index.html#anchor".
     # See RFC3986 for details (http://www.ietf.org/rfc/rfc3986.txt).
+    # @api public
     def fragment
       @link_data[:fragment]
     end
 
     # Returns the browser window or browser frame to be used as a target for this link.
     # Example: Links that should be opened in a new window will return "_blank" as their target.
+    # @api public
     def target
       @link_data[:target]
     end
 
-    def id #:nodoc:
+    def id
       @link_data[:link_id]
     end
 
-    def tag_name # :nodoc:
+    def tag_name
       @link_data[:tag_name]
     end
 
-    def markdown_type # :nodoc:
+    def markdown_type
       @link_data[:markdown_type]
     end
 
-    def markdown? # :nodoc:
+    def markdown?
       'markdown' == @link_data[:source_format]
     end
 
     # Returns the file extension (e.g. zip, pdf) of this link's (internal or external) target.
     # Returns an empty string if the file extension is can not be determined.
+    # @api public
     def file_extension
       if internal?
         destination_object ? destination_object.file_extension : ""
@@ -75,6 +83,7 @@ module RailsConnector
     end
 
     # Returns the id of the Links' destination_object.
+    # @api public
     def destination_object_id
       destination
     end
@@ -82,6 +91,7 @@ module RailsConnector
     # Returns the title of this Link if it is set.
     # Otherwise it returns the display_title of the destination object for internal Links
     # or the URL for external Links.
+    # @api public
     def display_title
       dt = title
       dt = destination_object.display_title if dt.blank? && !external?
@@ -90,38 +100,42 @@ module RailsConnector
     end
 
     # Returns true this Link links to a CMS Object.
+    # @api public
     def internal?
       url.nil?
     end
 
     # Returns true if this Link links to an external URL.
+    # @api public
     def external?
       !internal?
     end
 
     # An internal Link is active if it's destination object is active.
     # An external Link is always active.
+    # @api public
     def active?
       external? || (destination_object && destination_object.active?)
     end
 
-    def external_prefix? #:nodoc:
+    def external_prefix?
       nil != (url =~ /\s?external:/)
     end
 
-    def resolved? #:nodoc:
+    def resolved?
       external? || resolved_internal?
     end
 
     # Returns the destination object (+Obj+) of this Link. May be nil if the
     # link is external or internal without an existing destination object.
+    # @api public
     def destination_object
       @destination_object ||= Obj.find(destination) if resolved_internal?
     rescue RailsConnector::ResourceNotFound
       nil
     end
 
-    def to_liquid # :nodoc:
+    def to_liquid
       LiquidSupport::LinkDrop.new(self)
     end
 

data/lib/rails_connector/named_link.rb

@@ -2,9 +2,10 @@ module RailsConnector
 
   # This class provides methods used to retrieve objects from CMS based an entry
   # in CMS of the obj_class <tt>NamedLink</tt>.
+  # @api public
+  class NamedLink
 
-  class NamedLink < Obj
-
+    # @api public
     class NotFound < StandardError
     end
 
@@ -12,7 +13,7 @@ module RailsConnector
 
     # Generates a cache of named links based on the CMS objects related link list.
     # Raises exceptions if zero or more than one objects have this obj_class
-    def self.generate_named_links_cache #:nodoc:
+    def self.generate_named_links_cache
       return if @@named_links_cache
 
       found_object = find_named_link_obj
@@ -33,37 +34,39 @@ module RailsConnector
     # This method will be called to retrieve the NamedLink 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
     def self.find_named_link_obj
       Obj.find_by_path("/_named_links")
     end
 
-    def self.cache_expiry_time=(value) #:nodoc:
+    def self.cache_expiry_time=(value)
       raise "NamedLink.cache_expiry_time is deprecated. NamedLink no longer has a separate cache."
     end
 
-    def self.cache_expired? #:nodoc:
+    def self.cache_expired?
       true
     end
 
     # Returns the CMS object mapped to the given title or nil.
     # The title can be a string of symbol.
+    # @api public
     def self.get_object(title, options = {})
       object = named_links[title.to_s]
       raise NotFound, "The NamedLink '#{title.to_s}' does not exist" if object.nil?
       object
     end
 
-    def self.reset_cache #:nodoc:
+    def self.reset_cache
       @@named_links_cache = nil
     end
 
-    def self.named_links #:nodoc:
+    def self.named_links
       reset_cache if cache_expired?
       generate_named_links_cache unless named_links_cache
       named_links_cache
     end
 
-    def self.named_links_cache #:nodoc:
+    def self.named_links_cache
       @@named_links_cache
     end