scrivito_sdk 0.12.0

data/lib/scrivito/workspace_data_from_service.rb

@@ -0,0 +1,80 @@
+module Scrivito
+
+class WorkspaceDataFromService
+  class << self
+    # Fetches a workspace data previously store in cache storage.
+    # Returns nil if not found.
+    def find_from_cache(id)
+      if data = CmsCacheStorage.read_workspace_data(id)
+        new(data)
+      end
+    end
+
+    private
+
+    def data_attr_reader(attr_name)
+      define_method(attr_name) { @data[attr_name.to_s] }
+    end
+  end
+
+  data_attr_reader :id
+  data_attr_reader :title
+  data_attr_reader :revision_id
+  data_attr_reader :content_state_id
+  data_attr_reader :base_revision_id
+  data_attr_reader :base_content_state_id
+  data_attr_reader :diff
+
+  def initialize(data)
+    @data = data
+  end
+
+  def content_state
+    @content_state ||= ContentState.find_or_create(content_state_id) if content_state_id
+  end
+
+  def base_content_state
+    if base_content_state_id
+      @base_content_state ||= ContentState.find_or_create(base_content_state_id)
+    end
+  end
+
+  def changes
+    diff && diff['changes']
+  end
+
+  def from_content_state_id
+    diff && diff['from_content_state_id']
+  end
+
+  def to_content_state_id
+    diff && diff['to_content_state_id']
+  end
+
+  # Serializes and stores a workspace data in cache storage.
+  # Also creates an appropriate content state if needed.
+  def store_in_cache
+    create_content_state if content_state_id
+    CmsCacheStorage.write_workspace_data(id, to_hash)
+  end
+
+  private
+
+  def to_hash
+    {
+      'id'                    => id,
+      'revision_id'           => revision_id,
+      'title'                 => title,
+      'content_state_id'      => content_state_id,
+      'base_revision_id'      => base_revision_id,
+      'base_content_state_id' => base_content_state_id,
+    }
+  end
+
+  def create_content_state
+    ContentState.create(content_state_id: to_content_state_id, changes: changes,
+        from_content_state_id: from_content_state_id)
+  end
+end
+
+end # module Scrivito

data/lib/scrivito/workspace_selection_middleware.rb

@@ -0,0 +1,23 @@
+module Scrivito
+
+class WorkspaceSelectionMiddleware
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
+    Workspace.current = proc do
+      env[EditingContextMiddleware::ENVKEY].visible_workspace
+    end
+    @app.call(env)
+  end
+
+  private
+
+  def session(env)
+    env[Rack::Session::Abstract::ENV_SESSION_KEY]
+  end
+end
+
+end # module Scrivito
+

data/lib/scrivito_sdk.rb

@@ -0,0 +1,19 @@
+require "scrivito/errors"
+
+# @api public
+module Scrivito
+  def self.autoload_all_sources
+    source_files = Dir.glob(File.expand_path("../scrivito/*.rb", __FILE__)).map do |file|
+      File.basename(file)
+    end
+
+    source_files.each do |file|
+      name = file.gsub(".rb", "")
+      autoload name.camelcase, "scrivito/#{name}"
+    end
+  end
+
+  autoload_all_sources
+end
+
+require "scrivito/engine" if defined?(Rails)

data/lib/tasks/cache.rake

@@ -0,0 +1,12 @@
+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
+    task gc: :environment do
+      Scrivito::CacheGarbageCollector.new(ENV['MAX_FILE_INODES']).run_gc
+    end
+  end
+end

data/lib/tasks/migration.rake

@@ -0,0 +1,35 @@
+namespace :cms do
+  desc 'Migrate the CMS'
+  task :migrate => :environment do
+    Scrivito::Migrations::Migrator.new.migrate
+  end
+
+  namespace :migrate do
+    desc 'Publish the CMS migration workspace'
+    task :publish => :environment do
+      begin
+        Scrivito::Migrations::Migrator.new.publish
+
+        puts 'Migration workspace published.'
+      rescue Scrivito::ScrivitoError => exception
+        puts exception.message
+      end
+    end
+
+    desc 'Delete the CMS migration workspace'
+    task :abort => :environment do
+      begin
+        Scrivito::Migrations::Migrator.new.abort
+
+        puts 'Migration workspace deleted.'
+      rescue Scrivito::ScrivitoError => exception
+        puts exception.message
+      end
+    end
+
+    desc 'Copy CMS migrations from Engines. Specify Engines to use with FROM=engine1,engine2'
+    task :install => :environment do
+      Scrivito::Migrations::Installer.new(ENV['FROM']).install
+    end
+  end
+end

data/lib/widget.rb

@@ -0,0 +1,3 @@
+# Empty implementation for Widget.
+# Only unsed in case the app does not define Widget itself.
+::Widget = Class.new(::Scrivito::BasicWidget)

metadata

@@ -0,0 +1,291 @@
+--- !ruby/object:Gem::Specification
+name: scrivito_sdk
+version: !ruby/object:Gem::Version
+  version: 0.12.0
+platform: ruby
+authors:
+- Infopark AG
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.5
+- !ruby/object:Gem::Dependency
+  name: hyp_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: ' Scrivito: A professional Cloud CMS built for Ruby on Rails. '
+email: info@scrivito.com
+executables: []
+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
+- app/controllers/scrivito/tasks_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/views/scrivito/objs/copy_widget.html.erb
+- app/views/scrivito/objs/create_widget.html.erb
+- app/views/scrivito/widget_thumbnail.html.erb
+- config/ca-bundle.crt
+- config/cms_routes.rb
+- config/locales/de.scrivito.errors.yml
+- config/locales/de.scrivito.lib.yml
+- config/locales/de.scrivito.models.yml
+- config/locales/en.scrivito.errors.yml
+- config/locales/en.scrivito.lib.yml
+- config/locales/en.scrivito.models.yml
+- 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/obj.rb
+- lib/scrivito/access_denied.rb
+- lib/scrivito/attribute_content.rb
+- lib/scrivito/backend_error.rb
+- lib/scrivito/basic_obj.rb
+- lib/scrivito/basic_widget.rb
+- lib/scrivito/blob.rb
+- lib/scrivito/cache.rb
+- lib/scrivito/cache_garbage_collector.rb
+- lib/scrivito/cache_middleware.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
+- lib/scrivito/cms_env.rb
+- 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/communication_error.rb
+- lib/scrivito/comparison.rb
+- lib/scrivito/configuration.rb
+- lib/scrivito/connection_manager.rb
+- lib/scrivito/content_conversion.rb
+- lib/scrivito/content_service.rb
+- lib/scrivito/content_state.rb
+- lib/scrivito/content_state_caching.rb
+- lib/scrivito/content_state_visitor.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_middleware.rb
+- lib/scrivito/engine.rb
+- lib/scrivito/errors.rb
+- lib/scrivito/html_string.rb
+- lib/scrivito/link.rb
+- lib/scrivito/link_parser.rb
+- lib/scrivito/log_subscriber.rb
+- lib/scrivito/migration.rb
+- lib/scrivito/migrations.rb
+- 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
+- lib/scrivito/model_identity.rb
+- lib/scrivito/modification.rb
+- lib/scrivito/named_link.rb
+- lib/scrivito/network_error.rb
+- lib/scrivito/obj_data.rb
+- lib/scrivito/obj_data_from_hash.rb
+- lib/scrivito/obj_data_from_service.rb
+- lib/scrivito/obj_params_parser.rb
+- lib/scrivito/obj_search_builder.rb
+- lib/scrivito/obj_search_enumerator.rb
+- lib/scrivito/rate_limit_exceeded.rb
+- lib/scrivito/revision.rb
+- lib/scrivito/string_tagging.rb
+- lib/scrivito/text_link.rb
+- lib/scrivito/text_link_conversion.rb
+- lib/scrivito/type_computer.rb
+- lib/scrivito/widget_field_params.rb
+- lib/scrivito/widget_garbage_collection.rb
+- lib/scrivito/workspace.rb
+- lib/scrivito/workspace_data_from_service.rb
+- lib/scrivito/workspace_selection_middleware.rb
+- lib/scrivito_sdk.rb
+- lib/tasks/cache.rake
+- lib/tasks/migration.rake
+- lib/widget.rb
+homepage: https://scrivito.com
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: SDK for the Scrivito CMS
+test_files: []
+has_rdoc: yard