infopark_reactor 1.5.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+.rvmrc
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in infopark_reactor.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,142 @@
+REACTOR
+=======
+
+RailsConnector EnhAnCements for TCL lOveRs. You all love RailsConnector. I know you do. It delivers nice features and great performance. And yet... An yet you always knew that something is missing. You had this feeling when writing TCL code. You had this feeling when fiddling in Fiona GUI. Yes. You know it. You are a Rails coder: `BeatufiulPage.create(:name => 'Better page', :parent => '/best/pages', :title => 'Yes, it is better')`. Write layer is missing in RailsConnector. And it shows.
+
+So, here you have it: REACTOR, writing layer for `RailsConnector`, tightly integrated with `ActiveRecord`. Maybe some of you don't like long and creative descriptions. Maybe some of you are convinced with running code:
+
+    BeatufiulPage.create(:name => 'Better page', :parent => '/best/pages', :title => 'Yes, it is better') do |page|
+      page.body = '<a href="/can/handle/links/too">link</a>'
+      page.save!
+      page.release!
+    end
+
+    other_page = OtherPage.last
+    other_page.take!
+
+    not_a_page = SomeObject.first
+    not_a_page.some_attribute = 'a value' # types: string, html, enum
+    not_a_page.multienum_attr = ['somevalue'] # multienum
+    not_a_page.some_date_attribute = Time.now # date
+    not_a_page.some_date_attribute = '20111011083526' # date
+    not_a_page.some_date_attribute = '2011-11-11'
+
+    not_a_page.release! if not_a_page.valid?(:release)
+
+All of the above are examples of what can be done with `Persistence`, `Validations`, `Attributes`. There is more:
+* all standard ActiveModel callbacks + *_release callbacks
+* Validations in three contexts: create, update, release
+* If something works with ActiveRecord, there is a high chance it works with REACTOR too!
+* Rails 3 API
+
+What about links? Every object on my page is linked with 1000 other objects! I need links! Don't worry, they are there. Not perfectly supported yet, but you can set them:
+
+    some_obj.link_list_attr = 'http://google.com'
+    some_obj.link_list_attr = Obj.last
+    some_obj.link_list_attr = '/path/to/obj'
+
+And I haven't forgotten that they are lists of links:
+
+    some_obj.link_list_attr = ['http://google.com', Obj.last, '/path/to/obj']
+
+Yes, that is nice, you say, but what if I also wan't to set a link title? No problem, here is how:
+
+    some_obj.link_list_attr = {:url => 'http://google.com', :title => 'title of my link'}
+    some_obj.link_list_attr = {:destination_object => Obj.last, :title => 'title of my link'}
+    some_obj.link_list_attr = {:destination_object => '/path/to/obj', :title => 'title of my link'}
+
+This also works for multiple links:
+
+    some_obj.link_list_attr = [ {:url => 'http://google.com', :title => 'title of my link'}, {:destination_object => Obj.last, :title => 'other title'}]
+
+You can also manipulate linklist with array methods (for example `#delete_at`) and
+
+    some_obj.link_list_attr << '/path/to/obj'
+    some_obj.link_list_attr << {:url => 'http://yahoo.com', :title => 'yahoo link'}
+
+One more thing: you can upload files too!
+
+    binary_obj.upload(File.open('/my/file'), 'txt')
+    binary_obj.save!
+
+Or:
+
+    binary_obj.upload(File.read('/my/file'), 'txt')
+    binary_obj.save!
+
+**WARNING** If your are planning to upload anything larger than 10kB it is strongly advised to use `Reactor::StreamingUpload` module. This module
+allows to stream files of any size (provided you supply them through `File.open` and not read them yourself into memory). It is also much,
+much more efficient than the traditional method.
+
+Permissions are checked also! And your user is automatically set according to `JSESSIONID` cookie.
+
+KNOWN BUGS/ISSUES
+=================
+
+Awesome! What is missing/WHAT I NEED TO BE AWARE OF:
+
+- When setting a `linklist` all links are overwritten. Don't do it like 10 million times if you don't want to risk reaching billion ids.
+- Therefore link operations are slow. 
+- Link position cannot be directly manipulated (it is implicit through array order)
+- Validations are implemented completely in Rails, there is no call to CM, so all you TCL validation callbacks aren't executed
+- There are no validations for `enum`/`multienum` field (but mandatory fields are supported)
+- You can change the `obj_class` of an obj, but after save you should get yourself a new instance. (it's a bug of `rails_connector_meta`)
+- You have to save an object before you can upload data (i.e. upload works only on existing objects)
+
+HOW TO INSTALL
+==============
+
+1. Include in your Gemfile
+2. bundle
+3. Add initializer for Reactor if you haven't done so already
+4. Include modules into your Obj
+
+Sample code for points 3. and 4.
+
+**config/initializers/reactor.rb:**
+
+    Reactor::Configuration.xml_access = {
+      :host => 'localhost', # Fiona host
+      :port => 6001, # CM http port (TCL port + 1)
+      :id => '1234', # leave it as is
+
+      :username => 'root', # default user for all requests
+      :secret => 'password' # instance secret
+    }
+
+**lib/obj_extensions.rb:**
+
+    require 'meta'
+    module ObjExtensions
+      def self.enable
+        Obj.class_eval do
+          include RailsConnector::Meta
+
+          include Reactor::Legacy::Base       # core module
+          include Reactor::Attributes::Base   # core module
+          include Reactor::Persistence::Base  # core module
+
+          include Reactor::Validations::Base  # optional module, 
+                                              #  enables Rails validations
+
+          include Reactor::Permission::Base   # optional module,
+                                              #  enables permission checking
+
+          include Reactor::Workflow::Base     # optional module,
+                                              #  enables workflow API
+
+          include Reactor::StreamingUpload::Base
+                                              # optional module,
+                                              #  enables streaming interface for
+                                              #  uploads (strongly recommended!)
+        end
+      end
+    end
+
+DOCUMENTATION
+=============
+Core and optional modules are pretty well documented. If you are looking for example usages, you will find plenty of them in test app under spec folder.
+
+BUGS, FEATURE REQUESTS?
+=======================
+Open issue on github or make a pull request! Don't be shy :)

data/Rakefile

@@ -0,0 +1,25 @@
+require 'bundler'
+#require 'yard'
+Bundler::GemHelper.install_tasks
+
+#YARD::Rake::YardocTask.new do |t|
+#  t.files   = ['lib/**/*.rb']   # optional
+##  t.options = ['--any', '--extra', '--opts'] # optional
+#end
+
+
+# remove this task, when this gem is distributed as a `real` gem (and not included in Gemfile through `:path =>` )
+task :update_gemspec_for_distribution do
+
+  fn = Dir[File.expand_path('../*.gemspec', __FILE__)].first
+  source_gemspec = File.read(fn)
+
+  source_gemspec.gsub!(/^([\t ]*)((s.files\s*=)[^\n]+\n)/m) {|s| "#{$1}##{$2}#{$1}#{$3} #{`git ls-files`.split("\n").inspect}\n"}
+  source_gemspec.gsub!(/^([\t ]*)((s.test_files\s*=)[^\n]+\n)/m) {|s| "#{$1}##{$2}#{$1}#{$3} #{`git ls-files -- {test,spec,features}/*`.split("\n").inspect}\n"}
+  source_gemspec.gsub!(/^([\t ]*)((s.executables\s*=)[^\n]+\n)/m) {|s| "#{$1}##{$2}#{$1}#{$3} #{`git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }.inspect}\n"}
+
+  File.open("#{fn}.resolved", 'w') do |f|
+    f.write source_gemspec
+  end
+
+end

data/app/controllers/reactor_controller.rb

@@ -0,0 +1,53 @@
+class ReactorController < ApplicationController
+  def create_object
+    obj_data  = params[:obj] || {}
+    obj_class = obj_data.delete("obj_class")
+    parent_id = obj_data.delete("parent_id").to_i
+    name      = obj_data.delete("name")
+
+    o = Obj.new(:obj_class => obj_class, :name => name, :parent => parent_id) do |obj|
+      obj.send(:reload_attributes, obj_class)
+      obj.update_attributes!(obj_data)
+    end
+    respond_to do |format|
+      format.html { redirect_to(cms_path(o)) }
+      format.json { render :json => o }
+    end
+  end
+
+  def release_object
+    obj = Obj.find(params[:id])
+    obj.release!
+    success = true
+  rescue => e
+    flash[:error] = "#{e.class}\n\n#{e.message}"
+    success = false
+  ensure
+    respond_to do |format|
+      format.html { redirect_to(:back) }
+      if success
+        format.json { render :json => :ok }
+      else
+        format.json { render :json => flash[:error], :status => :unprocessable_entity } # something smarter would be nice
+      end
+    end
+  end
+
+  def update_object
+    obj = Obj.find(params[:id])
+    obj.update_attributes!(params[:obj])
+    respond_to do |format|
+      format.html { redirect_to(:back) }
+      format.json { render :json => :ok }
+    end
+  end
+
+  def delete_object
+    obj = Obj.find(params[:id])
+    obj.destroy
+    respond_to do |format|
+      format.html { redirect_to(:back) }
+      format.json { render :json => :ok }
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,6 @@
+Rails.application.routes.draw do
+  post    'reactor/object'      => 'reactor#create_object',   :as => :create_object
+  post    'reactor/release/:id' => 'reactor#release_object',  :as => :release_object
+  delete  'reactor/object/:id'  => 'reactor#delete_object',   :as => :delete_object
+  put     'reactor/object/:id'  => 'reactor#update_object',   :as => :update_object
+end

data/infopark_reactor.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "reactor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "infopark_reactor"
+  s.version     = "#{Reactor::VERSION}"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tomasz Przedmojski"]
+  s.email       = ["tomasz.przedmojski@infopark.de"]
+  s.homepage    = ""
+  s.summary     = %q{Write into CM in familiar, Rails-like way}
+  s.description = %q{Use the ActiveRecord mimicking API to write into CM and enjoy all the benefits of callbacks, validations and permission checking}
+  s.license     = 'LGPL-3'
+
+  #s.rubyforge_project = "infopark_reactor"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib", "lib/tools"]
+
+  s.add_dependency 'rails', '<= 3.2.9', '>= 3.0.10'
+  s.add_dependency 'infopark_reactor_migrations', '>= 1.2.0'
+  s.add_dependency 'infopark_rails_connector'
+  s.add_dependency 'infopark_rails_connector_meta', '>= 0.0.3'
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'yard'
+end

data/lib/engine.rb

@@ -0,0 +1,35 @@
+module Reactor
+
+  class Engine < Rails::Engine
+
+    initializer "reactor.rsession" do
+      # FIXME: extract !
+      AbstractController::Base.__send__(:define_method, :rsession) do
+        self.session[:rsession] ||= Reactor::Session.instance
+      end
+      ActionController::Base.__send__(:helper_method, :rsession)
+
+      ActionController::Base.__send__(:define_method, :rsession_auth) do
+        if RailsConnector::Configuration.mode == :editor && (jsessionid = cookies['JSESSIONID']).present?
+          # Why the gsub? It's a dirty hack! Reason: JSESSIONIDs are unescaped
+          # when read through Rails and hence all + are converted into spaces.
+          # CM Kernel though stores escaped IDs.
+          # From the possible generated characters only the + seems to be
+          # problematic.
+          # CGI.escape would be the solution, but it's deprecated
+          # URI.escape does too much
+          jsessionid.gsub!(' ','+')
+
+          Rails.logger.info "Trying to log in at #{Reactor::Configuration.xml_access[:host]}:#{Reactor::Configuration.xml_access[:port]} with JSESSIONID=#{jsessionid}."
+          rsession.login(jsessionid)
+          Rails.logger.info %|Logged in as "#{rsession.user_name}".| if rsession.user?
+        else
+          rsession.destroy
+        end
+      end
+      ActionController::Base.__send__(:before_filter, :rsession_auth)
+    end
+
+  end
+
+end