infopark_cloud_connector 6.8.1 → 6.8.1.26.236500544

data/lib/generators/cms/migration/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates a new CMS migration.
+
+Example:
+    rails generate cms:migration CreateExample
+    rails generate cms:migration create_example
+
+    This will create:
+        cms/migrate/[timestamp]_create_example.rb

data/lib/generators/cms/migration/migration_generator.rb

@@ -0,0 +1,15 @@
+module Cms
+  class MigrationGenerator < ::Rails::Generators::NamedBase
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def self.next_migration_number(dirname)
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    end
+
+    def create_migration_file
+      migration_template('migration.rb', "cms/migrate/#{file_name}")
+    end
+  end
+end

data/lib/generators/cms/migration/templates/migration.rb

@@ -0,0 +1,17 @@
+class <%= class_name %> < ::RailsConnector::Migration
+  def up
+    # get_attribute('test')
+    # create_attribute(:name => 'test', :type => :string)
+    # update_attribute('test', :title => 'Test Title')
+    # delete_attribute('test')
+
+    # get_obj_class('Test')
+    # create_obj_class(:name => 'Test', :type => :publication)
+    # update_obj_class('Test', :title => 'Test Title')
+
+    # get_obj('a1b2c3')
+    # create_obj(:_path => '/test', :_obj_class => 'Test')
+    # update_obj('a1b2c3', :title => 'Test Title')
+    # delete_obj('a1b2c3')
+  end
+end

data/lib/rails_connector/migration.rb

@@ -0,0 +1,2 @@
+# ::RailsConnector::Migration is just a shortcut
+::RailsConnector::Migration = ::RailsConnector::Migrations::Migration

data/lib/rails_connector/migrations.rb

@@ -0,0 +1,12 @@
+module RailsConnector
+  module Migrations
+    extend ActiveSupport::Autoload
+
+    autoload :Migration
+    autoload :Migrator
+    autoload :MigrationStore
+    autoload :MigrationDsl
+    autoload :CmsBackend
+    autoload :WorkspaceLock
+  end
+end

data/lib/rails_connector/migrations/cms_backend.rb

@@ -0,0 +1,98 @@
+module RailsConnector
+  module Migrations
+    class CmsBackend
+      def read
+        obj = find_migration_store_obj
+
+        if obj
+          obj[attribute_name]
+        else
+          initial_value
+        end
+      end
+
+      def save(value)
+        CmsRestApi.put(
+          endpoint("objs/#{migration_store_obj.id}"),
+          :obj => {
+            attribute_name => value
+          }
+        )
+      end
+
+      private
+
+      def create
+        # Create attribute
+        CmsRestApi.post(
+          endpoint('attributes'),
+          :attribute => {
+            :name => attribute_name,
+            :type => :text,
+          }
+        )
+
+        # Create obj class
+        CmsRestApi.post(
+          endpoint('obj_classes'),
+          :obj_class => {
+            :name => obj_class_name,
+            :attributes => [attribute_name],
+            :type => :publication,
+            :title => obj_class_name,
+          }
+        )
+
+        # Create obj
+        CmsRestApi.post(
+          endpoint('objs'),
+          :obj => {
+            :_path => path,
+            :_obj_class => obj_class_name,
+            attribute_name => initial_value,
+          }
+        )
+
+        # Deactivate obj class
+        CmsRestApi.put(
+          endpoint("obj_classes/#{obj_class_name}"),
+          :obj_class => {
+            :is_active => false,
+          }
+        )
+      end
+
+      def migration_store_obj
+        unless find_migration_store_obj
+          create
+        end
+
+        find_migration_store_obj
+      end
+
+      def find_migration_store_obj
+        Obj.find_by_path(path)
+      end
+
+      def attribute_name
+        'versions'
+      end
+
+      def obj_class_name
+        'MigrationStore'
+      end
+
+      def path
+        '/_internal/migration-store'
+      end
+
+      def initial_value
+        ''
+      end
+
+      def endpoint(path)
+        "revisions/#{Workspace.current.revision_id}/#{path}"
+      end
+    end
+  end
+end

data/lib/rails_connector/migrations/migration.rb

@@ -0,0 +1,43 @@
+module RailsConnector
+  module Migrations
+    # CMS Migrations can alter the structure and content of the CMS and allow
+    # other developers to simultaneously apply changes. Migrations provide a set
+    # of methods to create, update or delete CMS objects, attributes and object
+    # classes.
+    #
+    # @example Simple Migration
+    #
+    #   class CreateTestAttribute < RailsConnector::Migrations::Migration
+    #     def up
+    #       create_attribute(:name => 'test', :type => 'string')
+    #     end
+    #   end
+    class Migration
+      include MigrationDsl
+
+      attr_accessor :name
+      attr_accessor :version
+
+      def initialize(name, version)
+        @name = name
+        @version = version.to_i
+      end
+
+      def migrate
+        announce 'migrating'
+
+        time = Benchmark.measure { up }
+
+        announce 'migrated (%.4fs)' % time.real; puts
+      end
+
+      private
+
+      def announce(message)
+        text = "#{version} #{name}: #{message}"
+        length = [0, 75 - text.length].max
+        puts('== %s %s' % [text, '=' * length])
+      end
+    end
+  end
+end

data/lib/rails_connector/migrations/migration_dsl.rb

@@ -0,0 +1,176 @@
+module RailsConnector
+  module Migrations
+    module MigrationDsl
+      # Creates a CMS attribute.
+      #
+      # @example Create "test" Attribute
+      #
+      #   create_attribute(:name => 'test', :type => 'string')
+      #
+      # @param attributes [Hash] The attributes and their values of the new
+      #   CMS attribute.
+      #
+      # @return nothing
+      def create_attribute(attributes = {})
+        endpoint = "revisions/#{Workspace.current.revision_id}/attributes"
+
+        CmsRestApi.post(endpoint, :attribute => attributes)
+      end
+
+      # Creates a CMS object.
+      #
+      # @example Create "/test" Object
+      #
+      #   create_obj(:_path => '/test', :_obj_class => 'Test')
+      #
+      # @param attributes [Hash] The attributes and their values of the new
+      #   CMS object.
+      #
+      # @return nothing
+      def create_obj(attributes = {})
+        endpoint = "revisions/#{Workspace.current.revision_id}/objs"
+
+        CmsRestApi.post(endpoint, :obj => attributes)
+      end
+
+      # Creates a CMS object class.
+      #
+      # @example Create "Test" Object Class
+      #
+      #   create_obj_class(:name => 'Test', :type => 'publication')
+      #
+      # @param attributes [Hash] The attributes and their values of the new
+      #   CMS object class.
+      #
+      # @return nothing
+      def create_obj_class(attributes = {})
+        endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes"
+
+        CmsRestApi.post(endpoint, :obj_class => attributes)
+      end
+
+      # Deletes a CMS attribute.
+      #
+      # @example Delete "test" Attribute
+      #
+      #   delete_attribute('test')
+      #
+      # @param id [String] The ID of the CMS attribute.
+      #
+      # @return nothing
+      def delete_attribute(id)
+        endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
+
+        CmsRestApi.delete(endpoint)
+      end
+
+      # Deletes a CMS object with the given id.
+      #
+      # @example Deletes "a1b2c3" Object
+      #
+      #   delete_obj('a1b2c3')
+      #
+      # @param id [String] The ID of the CMS object.
+      #
+      # @return nothing
+      def delete_obj(id)
+        endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
+
+        CmsRestApi.delete(endpoint)
+      end
+
+      # Fetches all attribute attributes and their values.
+      #
+      # @example Get all attributes for the attribute "test"
+      #
+      #   get_attribute('test')
+      #
+      # @param id [String] The ID of the attribute.
+      #
+      # @return [Hash] a hash with attributes and their values.
+      def get_attribute(id)
+        endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
+
+        CmsRestApi.get(endpoint)
+      end
+
+      # Fetches all object attributes and their values.
+      #
+      # @example Get all attributes for the obj with id "abc123"
+      #
+      #   get_obj('abc123')
+      #
+      # @param id [String] The ID of the CMS object.
+      #
+      # @return [Hash] a hash with attributes and their values.
+      def get_obj(id)
+        endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
+
+        CmsRestApi.get(endpoint)
+      end
+
+      # Fetches all object class attributes and their values.
+      #
+      # @example Get all attributes for the object class "Test"
+      #
+      #   get_obj_class('Test')
+      #
+      # @param id [String] The ID of the object class.
+      #
+      # @return [Hash] a hash with attributes and their values.
+      def get_obj_class(id)
+        endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes/#{id}"
+
+        CmsRestApi.get(endpoint)
+      end
+
+      # Updates a CMS attribute.
+      #
+      # @example Update the title of the "test" Attribute
+      #
+      #   update_attribute(:title => 'Test Title')
+      #
+      # @param id [String] The ID of the attribute.
+      # @param attributes [Hash] The updated attributes and their values.
+      #
+      # @return nothing
+      def update_attribute(id, attributes = {})
+        endpoint = "revisions/#{Workspace.current.revision_id}/attributes/#{id}"
+
+        CmsRestApi.put(endpoint, :attribute => attributes)
+      end
+
+      # Updates a CMS object.
+      #
+      # @example Update the title of the "a1b2c3" Object
+      #
+      #   update_attribute('a1b2c3', :title => 'Test Title')
+      #
+      # @param id [String] The ID of the CMS object.
+      # @param attributes [Hash] The updated attributes and their values.
+      #
+      # @return nothing
+      def update_obj(id, attributes = {})
+        endpoint = "revisions/#{Workspace.current.revision_id}/objs/#{id}"
+
+        CmsRestApi.put(endpoint, :obj => attributes)
+      end
+
+      # Updates a CMS object class.
+      #
+      # @example Update the title of the "Test" Object Class
+      #
+      #   update_obj_class('Test', :title => 'Test Title')
+      #
+      # @param id [String] The ID of the CMS object class.
+      # @param attributes [Hash] The updated attributes and their values.
+      #
+      # @return nothing
+      def update_obj_class(id, attributes = {})
+        endpoint = "revisions/#{Workspace.current.revision_id}/obj_classes/#{id}"
+
+        CmsRestApi.put(endpoint, :obj_class => attributes)
+      end
+    end
+  end
+end

data/lib/rails_connector/migrations/migration_store.rb

@@ -0,0 +1,23 @@
+require 'singleton'
+
+module RailsConnector
+  module Migrations
+    class MigrationStore
+      include Singleton
+
+      def backend
+        @backend ||= CmsBackend.new
+      end
+
+      def versions
+        @versions ||= MultiJson.load(backend.read.presence || '[]')
+      end
+
+      def add_version(version)
+        versions << version
+
+        backend.save(MultiJson.dump(versions))
+      end
+    end
+  end
+end

data/lib/rails_connector/migrations/migrator.rb

@@ -0,0 +1,123 @@
+module RailsConnector
+  module Migrations
+    class Migrator
+      attr_reader :migrations
+      attr_reader :workspace_lock
+
+      def initialize
+        @migrations = determine_migrations
+        @migration_store = MigrationStore.instance
+        @workspace_lock = WorkspaceLock.instance
+
+        validate
+      end
+
+      def migrate
+        workspace.as_current do
+          runnable.each do |migration|
+            migration.migrate
+            @migration_store.add_version(migration.version)
+          end
+        end
+      end
+
+      def publish
+        remove_workspace_with do
+          CmsRestApi.put("workspaces/#{workspace.id}/publish", {})
+        end
+      end
+
+      def abort
+        remove_workspace_with do
+          CmsRestApi.delete("workspaces/#{workspace.id}")
+        end
+      end
+
+      private
+
+      def workspace
+        workspace = migration_workspace
+
+        if workspace
+          if workspace_lock.exists?
+            workspace_lock.validate(workspace)
+          end
+        else
+          CmsRestApi.post('workspaces', :workspace => { :title => 'rtc', :id => 'rtc' })
+
+          workspace = migration_workspace
+          workspace_lock.write(workspace)
+        end
+
+        workspace
+      end
+
+      def migration_workspace
+        Workspace.find('rtc')
+      rescue ResourceNotFound
+      end
+
+      def remove_workspace_with(&block)
+        workspace = migration_workspace
+
+        if workspace
+          workspace_lock.validate(workspace)
+
+          yield
+
+          workspace_lock.remove
+        else
+          raise RailsConnectorError.new('Migration workspace does not exist')
+        end
+      end
+
+      def determine_migrations
+        files = Dir[*migrations_paths.map { |path| "#{path}/**/[0-9]*_*.rb" }]
+
+        migrations = files.map do |file|
+          version, name = file.scan(/([0-9]+)_([_a-z0-9]*)\.rb\z/).first
+
+          unless version
+            raise RailsConnectorError.new("Illegal name for migration file: #{file}\n\t(only lower case letters, numbers, and '_' allowed)")
+          end
+
+          version = version
+          name = name.camelize
+
+          require(File.expand_path(file))
+          name.constantize.new(name, version)
+        end
+
+        migrations.sort_by(&:version)
+      end
+
+      def migrations_paths
+        ["#{Rails.root}/cms/migrate"]
+      end
+
+      def runnable
+        migrations.reject do |migration|
+          migrated_versions.include?(migration.version)
+        end
+      end
+
+      def migrated_versions
+        @migration_store.versions
+      end
+
+      def validate
+        name, _ = migrations.group_by(&:name).find { |_, value| value.length > 1 }
+
+        if name
+          raise RailsConnectorError.new("Multiple migrations have the name #{name}")
+        end
+
+        version, _ = migrations.group_by(&:version).find { |_, value| value.length > 1 }
+
+        if version
+          raise RailsConnectorError.new("Multiple migrations have the version number #{version}")
+        end
+      end
+    end
+  end
+end

data/lib/rails_connector/migrations/workspace_lock.rb

@@ -0,0 +1,38 @@
+require 'singleton'
+
+module RailsConnector
+  module Migrations
+    class WorkspaceLock
+      include Singleton
+
+      def validate(workspace)
+        unless exists? && workspace.revision_id == File.read(filename)
+          raise RailsConnectorError.new("Migration Workspace already exists. Please make sure to \
+            publish or discard any changes in the '#{workspace.id}' workspace.")
+        end
+      end
+
+      def write(workspace)
+        File.open(filename, 'w') do |file|
+          file.write(workspace.revision_id)
+        end
+      end
+
+      def remove
+        if exists?
+          File.delete(filename)
+        end
+      end
+
+      def exists?
+        File.exists?(filename)
+      end
+
+      private
+
+      def filename
+        File.join(Rails.root, 'tmp/migration_store.lock')
+      end
+    end
+  end
+end

data/lib/rails_connector/workspace.rb

@@ -58,6 +58,18 @@ class Workspace
     self.id == 'published'
   end
 
+  def as_current(&block)
+    old_workspace = Workspace.current
+
+    begin
+      Workspace.current = self
+
+      yield
+    ensure
+      Workspace.current = old_workspace
+    end
+  end
+
 end
 
 end

data/lib/tasks/migration.rake

@@ -0,0 +1,30 @@
+namespace :cms do
+  desc 'Migrate the CMS'
+  task :migrate => :environment do
+    RailsConnector::Migrations::Migrator.new.migrate
+  end
+
+  namespace :migrate do
+    desc 'Publish the CMS migration workspace'
+    task :publish => :environment do
+      begin
+        RailsConnector::Migrations::Migrator.new.publish
+
+        puts 'Migration workspace published.'
+      rescue RailsConnector::RailsConnectorError => exception
+        puts exception.message
+      end
+    end
+
+    desc 'Delete the CMS migration workspace'
+    task :abort => :environment do
+      begin
+        RailsConnector::Migrations::Migrator.new.abort
+
+        puts 'Migration workspace deleted.'
+      rescue RailsConnector::RailsConnectorError => exception
+        puts exception.message
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: infopark_cloud_connector
 version: !ruby/object:Gem::Version
-  version: 6.8.1
+  version: 6.8.1.26.236500544
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.8.1
+        version: 6.8.1.26.236500544
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 6.8.1
+        version: 6.8.1.26.236500544
 description: The Cloud Connector for Infopark CMS Fiona enables you to develop modern,
   dynamic Web 2.0 applications using Ruby on Rails and at the same time display CMS
   managed content.
@@ -73,6 +73,9 @@ files:
 - app/helpers/rails_connector/cms_tag_helper.rb
 - app/helpers/rails_connector/marker_helper.rb
 - config/routes.rb
+- lib/generators/cms/migration/USAGE
+- lib/generators/cms/migration/migration_generator.rb
+- lib/generators/cms/migration/templates/migration.rb
 - lib/infopark_cloud_connector.rb
 - lib/rails_connector/access_denied.rb
 - lib/rails_connector/backend_not_available.rb
@@ -97,6 +100,14 @@ files:
 - lib/rails_connector/errors.rb
 - lib/rails_connector/link.rb
 - lib/rails_connector/log_subscriber.rb
+- lib/rails_connector/migration.rb
+- lib/rails_connector/migrations.rb
+- lib/rails_connector/migrations/cms_backend.rb
+- lib/rails_connector/migrations/migration.rb
+- lib/rails_connector/migrations/migration_dsl.rb
+- lib/rails_connector/migrations/migration_store.rb
+- lib/rails_connector/migrations/migrator.rb
+- lib/rails_connector/migrations/workspace_lock.rb
 - lib/rails_connector/named_link.rb
 - lib/rails_connector/obj.rb
 - lib/rails_connector/obj_data.rb
@@ -116,6 +127,7 @@ files:
 - lib/rails_connector/workspace_data_from_database.rb
 - lib/rails_connector/workspace_data_from_service.rb
 - lib/rails_connector/workspace_selection_middleware.rb
+- lib/tasks/migration.rake
 homepage: http://www.infopark.de
 licenses: []
 post_install_message: 
@@ -130,7 +142,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -881163793
+      hash: 620009807
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: