scrivito_sdk 0.18.1 → 0.30.0.rc1

data/lib/scrivito/user_definition.rb

@@ -54,22 +54,50 @@ module Scrivito
       @explicit_rules[[:can_never, verb, subject]] = message
     end
 
+    #
+    # Make the user to be always able to create workspaces, to read, to write, to publish, to delete
+    # and to invite to any workspace.
+    #
+    # @api public
+    #
+    def is_admin!
+      User::VERBS.each { |verb| @explicit_rules[[:can_always, verb, :workspace]] ||= nil }
+    end
+
+    #
     # Defines the user description to be displayed, when the user is shown in the in-place GUI.
     # @api public
+    #
+    # @param [String] description_string the description. Defaults to the the user id.
     # @param [Proc] description_proc proc to calculate the description. Defaults to the the user id.
+    #
     # @note The description is calculated "lazy".
     # @note The calculated description will be cached.
+    #
     # @see Scrivito::User.define
-    # @example
+    #
+    # @example Display the user +alice+ as +"alice"+ in the in-place GUI
+    #
     #   alice = Scrivito::User.define('alice')
-    #   # User `alice` will be displayed as "alice" in the in-place GUI.
+    #
+    # @example Display the user +bob+ as +"Bob Doe"+ in the in-place GUI
+    #
+    #   bob = Scrivito::User.define('bob') do |user|
+    #     user.description('Bob Doe')
+    #   end
     #
     #   bob = Scrivito::User.define('bob') do |user|
-    #     user.description { 'Bob Doe' }
+    #     user.description do
+    #       'Bob Doe'
+    #     end
     #   end
-    #   # User `bob` will be displayed as "Bob Doe" in the in-place GUI.
-    def description(&description_proc)
-      @description_proc = description_proc
+    #
+    def description(description_string = nil, &description_proc)
+      if description_string
+        description { description_string }
+      else
+        @description_proc = description_proc
+      end
     end
 
     # Defines the proc for fetching users for the user autocompletion of the in-place GUI.

data/lib/scrivito/widget_tag.rb

@@ -0,0 +1,67 @@
+module Scrivito
+
+class WidgetTag < Struct.new(:view, :widget, :placement_modification)
+  include TagRenderer
+
+  def tag_name
+    :div
+  end
+
+  def content
+    view.render(template: template, locals: {widget: widget})
+  end
+
+  def options
+    options = {}
+
+    if inplace_editing_allowed?
+      options['private-widget-id'] = widget.id
+      options['widget-obj-class'] = widget.obj_class_name
+      options['private-widget-description-for-editor'] = widget.description_for_editor
+
+      if has_widget_details_view?(widget)
+        options['private-widget-has-details-view'] = true
+      end
+
+      comparison = editing_context.comparison
+      options['private-widget-modification'] =
+        if comparison.revision == widget.revision
+          if placement_modification
+            unless widget.in_revision(Workspace.current.revision)
+              Modification::DELETED
+            end
+          end
+        else
+          comparison.modification(widget)
+        end
+
+      options['private-widget-placement-modification'] =
+        placement_modification
+    end
+
+    options
+  end
+
+  private
+
+  def template
+    widget.to_show_view_path
+  end
+
+  def has_widget_details_view?(widget)
+    view.lookup_context.find(widget.to_details_view_path).present?
+  rescue ActionView::MissingTemplate
+    false
+  end
+
+  def inplace_editing_allowed?
+    editing_context.authenticated_editor?
+  end
+
+  def editing_context
+    EditingContextMiddleware.from_request(view.request)
+  end
+
+end
+
+end

data/lib/scrivito/workspace.rb

@@ -1,3 +1,5 @@
+require 'active_model/naming'
+
 module Scrivito
 
 # This class represents a CMS workspace
@@ -123,6 +125,10 @@ class Workspace
     response
   end
 
+  def task_unaware_api_request(verb, path, payload = nil)
+    CmsRestApi.task_unaware_request(verb, "#{backend_url}#{path}", payload)
+  end
+
   # Updates this workspace's attributes
   # @api public
   # @param [Hash] attributes
@@ -142,17 +148,9 @@ class Workspace
   # Publish the changes of this workspace
   # @api public
   def publish
-    internal_publish
-  end
+    CmsRestApi.put("#{backend_url}/publish", {})
 
-  def conditional_publish
-    internal_publish(if_content_state_id_equals: content_state.content_state_id)
-  rescue Scrivito::ClientError => e
-    if e.message.starts_with?('The specified condition for content_state_id')
-      raise PublishPreventedDueToContentChange.new(e.message)
-    else
-      raise e
-    end
+    reset_workspace_if_current
   end
 
   # Rebases the current workspace on the published content
@@ -200,6 +198,10 @@ class Workspace
     self.id == 'rtc'
   end
 
+  def outdated?
+    !published? && Workspace.published.revision.id != base_revision_id
+  end
+
   def revision
     @revision ||= Revision.new(id: revision_id, content_state: content_state, workspace: self)
   end
@@ -250,22 +252,8 @@ class Workspace
     "<#{self.class} id=\"#{id}\" title=\"#{title}\">"
   end
 
-  def as_json(options = {})
-    {
-      id: id,
-      title: title,
-      memberships: memberships,
-    }
-  end
-
   private
 
-  def internal_publish(data={})
-    CmsRestApi.put("#{backend_url}/publish", data)
-
-    reset_workspace_if_current
-  end
-
   def backend_url
     "/workspaces/#{id}"
   end

data/lib/scrivito_sdk.rb

@@ -2,6 +2,22 @@ require "scrivito/errors"
 
 # @api public
 module Scrivito
+  #
+  # Configures the Scrivito SDK.
+  # The configuration keys +tenant+ and +api_key+ _must_ be provided.
+  #
+  # @example
+  #   Scrivito.configure do |config|
+  #     config.tenant  = 'my-tenant-name'
+  #     config.api_key = 'secret'
+  #   end
+  #
+  # @api public
+  #
+  def self.configure
+    yield Configuration
+  end
+
   def self.autoload_all_sources
     source_files = Dir.glob(File.expand_path("../scrivito/*.rb", __FILE__)).map do |file|
       File.basename(file)
@@ -16,4 +32,4 @@ module Scrivito
   autoload_all_sources
 end
 
-require "scrivito/engine" if defined?(Rails)
+require 'scrivito/sdk_engine' if defined?(Rails)

data/lib/tasks/cache.rake

@@ -1,10 +1,9 @@
 namespace :scrivito do
   namespace :cache do
-    description = "Cap number of cache file inodes at "
-    description += "#{Scrivito::CacheGarbageCollector::DEFAULT_MAX_FILE_INODES} "
-    description += "(Use MAX_FILE_INODES=500 to specify the maximum)"
-
-    desc description
+    desc 'Cap number of cache file inodes at ' \
+      "#{Scrivito::CacheGarbageCollector::DEFAULT_MAX_FILE_INODES} " \
+      '(Use MAX_FILE_INODES=500 to specify the maximum). ' \
+      'See Scrivito::CacheGarbageCollector for details.'
     task gc: :environment do
       Scrivito::CacheGarbageCollector.new(ENV['MAX_FILE_INODES']).run_gc
     end

data/lib/tasks/migration.rake

@@ -1,4 +1,4 @@
-namespace :cms do
+namespace :scrivito do
   desc 'Migrate the CMS'
   task :migrate => :environment do
     Scrivito::Migrations::Migrator.new.migrate

data/lib/widget.rb

@@ -1,3 +1,21 @@
-# Empty implementation for Widget.
-# Only unsed in case the app does not define Widget itself.
-::Widget = Class.new(::Scrivito::BasicWidget)
+#
+# The class +Widget+ should be overridden by the application (see example).
+# The SDK provides methods for +Widget+ through it's abstract base class, {Scrivito::BasicWidget}.
+# The SDK provides this empty implementation for +Widget+ which will only be used in case the app
+# does not define the class +Widget+ itself.
+#
+# @api public
+#
+# @example
+#   # in app/models/widget.rb
+#   class Widget < Scrivito::BasicWidget
+#     # Put custom extensions that apply to all +Widget+s here...
+#   end
+#
+#   # in app/models/text_widget.rb
+#   class TextWidget < ::Widget
+#     # Put custom extensions that only apply to +TextWidget+s here...
+#   end
+#
+class Widget < Scrivito::BasicWidget
+end

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_sdk
 version: !ruby/object:Gem::Version
-  version: 0.18.1
+  version: 0.30.0.rc1
 platform: ruby
 authors:
 - Infopark AG
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-22 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: addressable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 2.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: 2.3.2
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 1.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.2.2
+        version: 1.2.5
 - !ruby/object:Gem::Dependency
-  name: json
+  name: hyp_diff
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.7
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -67,75 +81,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.1.1
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 1.7.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.6.7
+        version: 1.7.7
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.6
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
-  name: addressable
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 1.5.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.3.2
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
-  name: diff-lcs
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: 4.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.5
+        version: 4.1.1
 - !ruby/object:Gem::Dependency
-  name: hyp_diff
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.9.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.0.3
+        version: 0.9.2.2
 description: ' Scrivito: A professional Cloud CMS built for Ruby on Rails. '
 email: info@scrivito.com
 executables: []
@@ -143,8 +157,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .yardopts
-- README
-- app/controllers/cms_controller.rb
 - app/controllers/scrivito/blobs_controller.rb
 - app/controllers/scrivito/default_cms_controller.rb
 - app/controllers/scrivito/objs_controller.rb
@@ -152,23 +164,34 @@ files:
 - app/controllers/scrivito/users_controller.rb
 - app/controllers/scrivito/webservice_controller.rb
 - app/controllers/scrivito/workspaces_controller.rb
-- app/helpers/cms_helper.rb
-- app/helpers/cms_routing_helper.rb
-- app/helpers/scrivito/cms_asset_helper.rb
-- app/helpers/scrivito/cms_tag_helper.rb
-- app/helpers/scrivito/default_cms_helper.rb
-- app/helpers/scrivito/default_cms_routing_helper.rb
-- app/helpers/scrivito/display_helper.rb
-- app/helpers/scrivito/editing_helper.rb
-- app/helpers/scrivito/layout_helper.rb
-- app/models/named_link.rb
-- app/views/cms/_index.html.erb
-- app/views/cms/index.html.erb
-- app/views/scrivito/_editing_javascript.html.erb
-- app/views/scrivito/default_cms/show_widget.html.erb
+- app/helpers/scrivito_helper.rb
+- app/views/google_maps_widget/show.html.erb
+- app/views/scrivito/_editing_auth_warning.html.erb
+- app/views/scrivito/blobs/upload_permission.json.jbuilder
+- app/views/scrivito/objs/copy.json.jbuilder
 - app/views/scrivito/objs/copy_widget.html.erb
+- app/views/scrivito/objs/create.json.jbuilder
 - app/views/scrivito/objs/create_widget.html.erb
+- app/views/scrivito/objs/details.json.jbuilder
+- app/views/scrivito/objs/format_missing_error.json.jbuilder
+- app/views/scrivito/objs/modification.json.jbuilder
+- app/views/scrivito/objs/page_class_selection.json.jbuilder
+- app/views/scrivito/objs/search.json.jbuilder
+- app/views/scrivito/objs/search_only_size.json.jbuilder
+- app/views/scrivito/objs/update.json.jbuilder
+- app/views/scrivito/objs/widget_class_selection.json.jbuilder
+- app/views/scrivito/objs/widget_modification.json.jbuilder
+- app/views/scrivito/tasks/show.json.jbuilder
+- app/views/scrivito/users/suggest.json.jbuilder
+- app/views/scrivito/webservice/empty.json
+- app/views/scrivito/webservice/error.json.jbuilder
 - app/views/scrivito/widget_thumbnail.html.erb
+- app/views/scrivito/workspaces/_workspace.json.jbuilder
+- app/views/scrivito/workspaces/check.json.jbuilder
+- app/views/scrivito/workspaces/create.json.jbuilder
+- app/views/scrivito/workspaces/index.json.jbuilder
+- app/views/scrivito/workspaces/show.json.jbuilder
+- app/views/scrivito/workspaces/task.json.jbuilder
 - config/ca-bundle.crt
 - config/cms_routes.rb
 - config/locales/de.scrivito.errors.yml
@@ -180,18 +203,38 @@ files:
 - config/routes.rb
 - lib/assets/images/180x120.gif
 - lib/assets/images/scrivito/image_placeholder.png
-- lib/assets/javascripts/scrivito_editing.js
-- lib/assets/stylesheets/scrivito.css
-- lib/assets/stylesheets/scrivito_editing.css
-- lib/generators/cms/migration/USAGE
-- lib/generators/cms/migration/migration_generator.rb
-- lib/generators/cms/migration/templates/migration.erb
-- lib/generators/cms/widget/templates/details.html.erb
-- lib/generators/cms/widget/templates/migration.erb
-- lib/generators/cms/widget/templates/model.erb
-- lib/generators/cms/widget/templates/show.html.erb
-- lib/generators/cms/widget/templates/thumbnail.html.erb
-- lib/generators/cms/widget/widget_generator.rb
+- lib/assets/javascripts/scrivito_sdk.js
+- lib/assets/stylesheets/scrivito_sdk.css
+- lib/generators/scrivito/install/install_generator.rb
+- lib/generators/scrivito/install/templates/app/controllers/cms_controller.rb
+- lib/generators/scrivito/install/templates/app/controllers/page_controller.rb
+- lib/generators/scrivito/install/templates/app/models/headline_widget.rb
+- lib/generators/scrivito/install/templates/app/models/image.rb
+- lib/generators/scrivito/install/templates/app/models/image_widget.rb
+- lib/generators/scrivito/install/templates/app/models/obj.rb
+- lib/generators/scrivito/install/templates/app/models/page.rb
+- lib/generators/scrivito/install/templates/app/models/text_widget.rb
+- lib/generators/scrivito/install/templates/app/models/widget.rb
+- lib/generators/scrivito/install/templates/app/views/headline_widget/show.html.erb
+- lib/generators/scrivito/install/templates/app/views/headline_widget/thumbnail.html.erb
+- lib/generators/scrivito/install/templates/app/views/image_widget/show.html.erb
+- lib/generators/scrivito/install/templates/app/views/image_widget/thumbnail.html.erb
+- lib/generators/scrivito/install/templates/app/views/page/details.html.erb
+- lib/generators/scrivito/install/templates/app/views/page/index.html.erb
+- lib/generators/scrivito/install/templates/app/views/page/thumbnail.html.erb
+- lib/generators/scrivito/install/templates/app/views/text_widget/show.html.erb
+- lib/generators/scrivito/install/templates/app/views/text_widget/thumbnail.html.erb
+- lib/generators/scrivito/install/templates/config/initializers/scrivito.rb
+- lib/generators/scrivito/install/templates/scrivito/migrate/install_scrivito.rb
+- lib/generators/scrivito/migration/USAGE
+- lib/generators/scrivito/migration/migration_generator.rb
+- lib/generators/scrivito/migration/templates/migration.erb
+- lib/generators/scrivito/widget/templates/details.html.erb
+- lib/generators/scrivito/widget/templates/migration.erb
+- lib/generators/scrivito/widget/templates/model.erb
+- lib/generators/scrivito/widget/templates/show.html.erb
+- lib/generators/scrivito/widget/templates/thumbnail.html.erb
+- lib/generators/scrivito/widget/widget_generator.rb
 - lib/obj.rb
 - lib/scrivito/access_denied.rb
 - lib/scrivito/attribute.rb
@@ -200,13 +243,13 @@ files:
 - lib/scrivito/backend_error.rb
 - lib/scrivito/basic_obj.rb
 - lib/scrivito/basic_widget.rb
-- lib/scrivito/blob.rb
+- lib/scrivito/binary.rb
 - lib/scrivito/cache.rb
 - lib/scrivito/cache_garbage_collector.rb
 - lib/scrivito/cache_middleware.rb
+- lib/scrivito/child_list_tag.rb
 - lib/scrivito/client_config.rb
 - lib/scrivito/client_error.rb
-- lib/scrivito/cms_accessible.rb
 - lib/scrivito/cms_backend.rb
 - lib/scrivito/cms_cache_storage.rb
 - lib/scrivito/cms_dispatch_controller.rb
@@ -214,9 +257,8 @@ files:
 - lib/scrivito/cms_field_tag.rb
 - lib/scrivito/cms_rest_api.rb
 - lib/scrivito/cms_rest_api/attribute_serializer.rb
-- lib/scrivito/cms_rest_api/blob_uploader.rb
 - lib/scrivito/cms_rest_api/widget_extractor.rb
-- lib/scrivito/cms_test_request.rb
+- lib/scrivito/cms_routing.rb
 - lib/scrivito/communication_error.rb
 - lib/scrivito/comparison.rb
 - lib/scrivito/configuration.rb
@@ -226,16 +268,19 @@ files:
 - lib/scrivito/content_state.rb
 - lib/scrivito/content_state_caching.rb
 - lib/scrivito/content_state_visitor.rb
+- lib/scrivito/controller_actions.rb
 - lib/scrivito/controller_runtime.rb
 - lib/scrivito/date_attribute.rb
 - lib/scrivito/deprecation.rb
 - lib/scrivito/diff.rb
 - lib/scrivito/editing_context.rb
+- lib/scrivito/editing_context_helper.rb
 - lib/scrivito/editing_context_middleware.rb
-- lib/scrivito/engine.rb
 - lib/scrivito/errors.rb
 - lib/scrivito/gem_info.rb
 - lib/scrivito/html_string.rb
+- lib/scrivito/image_tag_helper.rb
+- lib/scrivito/layout_tags.rb
 - lib/scrivito/link.rb
 - lib/scrivito/link_parser.rb
 - lib/scrivito/log_subscriber.rb
@@ -246,7 +291,6 @@ files:
 - lib/scrivito/migrations/cms_backend.rb
 - lib/scrivito/migrations/installer.rb
 - lib/scrivito/migrations/migration.rb
-- lib/scrivito/migrations/migration_dsl.rb
 - lib/scrivito/migrations/migration_store.rb
 - lib/scrivito/migrations/migrator.rb
 - lib/scrivito/migrations/workspace_lock.rb
@@ -267,7 +311,11 @@ files:
 - lib/scrivito/rate_limit_exceeded.rb
 - lib/scrivito/restriction_set.rb
 - lib/scrivito/revision.rb
+- lib/scrivito/routing_helper.rb
+- lib/scrivito/sdk_engine.rb
 - lib/scrivito/string_tagging.rb
+- lib/scrivito/tag_renderer.rb
+- lib/scrivito/test_request.rb
 - lib/scrivito/text_link.rb
 - lib/scrivito/text_link_conversion.rb
 - lib/scrivito/type_computer.rb
@@ -275,6 +323,7 @@ files:
 - lib/scrivito/user_definition.rb
 - lib/scrivito/widget_field_params.rb
 - lib/scrivito/widget_garbage_collection.rb
+- lib/scrivito/widget_tag.rb
 - lib/scrivito/workspace.rb
 - lib/scrivito/workspace/publish_checker.rb
 - lib/scrivito/workspace_data_from_service.rb
@@ -298,9 +347,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2