polisher 0.1

data/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.

data/app/controllers/application_controller.rb

@@ -0,0 +1,12 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  #protect_from_forgery # See ActionController::RequestForgeryProtection for details
+  protect_from_forgery :only => [:create, :update, :destroy]
+  layout "index"
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/callback_controller.rb

@@ -0,0 +1,47 @@
+#
+# Copyright (C) 2010 Red Hat, Inc.
+# Written by Mohammed Morsi <mmorsi@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+# Currently handles gemcutter api callback invocations
+class CallbackController < ApplicationController
+  layout nil
+
+  # invoked when a gem is updated on a remote source
+  def gem_updated
+     name    = params[:name]
+     # XXX bit of a dirty hack needed as this is the only way to get source_uri
+     source_uri = GemApiAdapter.gem_to_source_uri(params[:gem_uri]) 
+     logger.info ">> gem #{name} hosted at #{source_uri} has been updated"
+
+     # find the managed gem which was updated, invoke gem_updated event handlers
+     gem_source = GemSource.find(:first, :conditions => ["uri = ?", source_uri])
+     gem = gem_source.gems.all.find { |gem| gem.name == name }
+     logger.info ">> found corresponding managed gem #{gem.name}"
+
+     # update gem attributes
+     gem_data = GemApiAdapter.gem_info :api_uri => gem_source.uri, 
+                                       :gem_name => gem.name, 
+                                       :logger => logger
+     gem.version = gem_data["version"]
+     gem.save!
+
+     gem.event_handlers.find_all { |eh| eh.event == "gem_updated" }.each { |eh|
+        eh.run
+     }
+  end
+end

data/app/controllers/manage_controller.rb

@@ -0,0 +1,112 @@
+#
+# Copyright (C) 2010 Red Hat, Inc.
+# Written by Mohammed Morsi <mmorsi@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+# Currently handles all user based actions, including CRUDing
+# the user controlled model entities / fields
+class ManageController < ApplicationController
+  def list
+     @gem_sources = GemSource.find :all
+  end
+
+  ############################ gem sources
+
+  def new_gem_source
+  end
+
+  def create_gem_source
+     name = params[:name]
+     uri  = params[:uri]
+     @gem_source = GemSource.new :name => name, :uri => uri
+     @error = nil
+     @gem_source.save!
+     rescue Exception => e
+       @error = e
+  end
+
+  def delete_gem_source
+     id = params[:id]
+     @name = GemSource.find(id).name
+     GemSource.delete id
+     @error = nil
+  end
+
+  ############################ managed gems
+
+  def new_gem
+     @gem_source_id = params[:gem_source_id]
+     @gem_sources   = GemSource.find :all
+  end
+
+  def create_gem
+     gem_source_id = params[:gem_source_id]
+     name          = params[:name]
+     version       = params[:version]
+     @gem = ManagedGem.new :name => name, :version => version, :gem_source_id => gem_source_id
+     @error = nil
+
+     # save gem / subscribe to updates
+     # FIXME these two steps should be in a transaction
+     @gem.save!
+     @gem.subscribe :callback_url => url_for(:controller => :callback, :action => :gem_updated)
+     rescue Exception => e
+       @error = e
+  end
+
+  def delete_gem
+     id = params[:id]
+     @name = ManagedGem.find(id).name
+     ManagedGem.delete id
+     @error = nil
+  end
+
+  ############################ gem search criterias
+
+  def new_gem_search_criteria
+     @gem_source_id = params[:gem_source_id]
+     @gem_sources   = GemSource.find :all
+  end
+
+  ############################ event handlers
+
+  def new_event_handler
+     @gem_id = params[:gem_id]
+     @gems   = ManagedGem.find :all
+     @events   = EventHandler::EVENTS
+     @handlers = EventHandler::HANDLERS
+  end
+
+  def create_event_handler
+     gem_id  = params[:gem_id]
+     event   = params[:event]
+     handler = params[:handler]
+     @event_handler = EventHandler.new :managed_gem_id => gem_id, :event => event, :handler => handler
+     @error = nil
+     @event_handler.save!
+     rescue Exception => e
+       @error = e
+  end
+
+  def delete_event_handler
+     id = params[:id]
+     @name = EventHandler.find(id).name
+     EventHandler.delete id
+     @error = nil
+  end
+
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/artifact.rb

@@ -0,0 +1,21 @@
+# Copyright (C) 2010 Red Hat, Inc.
+# Written by Mohammed Morsi <mmorsi@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+# An Artifact is an entity created by polisher
+class Artifact < ActiveRecord::Base
+end

data/app/models/event_handler.rb

@@ -0,0 +1,61 @@
+# Copyright (C) 2010 Red Hat, Inc.
+# Written by Mohammed Morsi <mmorsi@redhat.com>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 2 of the License.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+# MA  02110-1301, USA.  A copy of the GNU General Public License is
+# also available at http://www.gnu.org/copyleft/gpl.html.
+
+# EventHandler refers to a Gem, and specified event enumeration value,
+# and event handler enumeration value.
+# Currently both events / handlers are pretty static / hard coded into
+# this system, but this may change in the future.
+class EventHandler < ActiveRecord::Base
+   belongs_to :managed_gem
+   alias :gem :managed_gem
+
+   validates_presence_of :managed_gem_id, :event, :handler
+   validates_uniqueness_of :handler, :scope => [:managed_gem_id, :event]
+
+   def name
+     gem.name.to_s + ":" + @event.to_s + ":" + @handler.to_s
+   end
+
+   # FIXME right now hard coding and dispatching 
+   # specific events / handlers here, at some point
+   # replace w/ something more dynamic / plugable
+   EVENTS   = [:gem_created,:gem_updated]
+   HANDLERS = [:send_email, :build_rpm, :submit_rpm]
+
+   # dispatch to correct handler upon event
+   def run
+      logger.info ">> running #{event} handler #{handler} for gem #{gem.name}"
+      case(handler)
+        when "send_email"
+           EmailAdapter.send_email(:server  => POLISHER_CONFIG["smtp_server"],
+                                   :from    => POLISHER_CONFIG["email_from"],
+                                   :to      => POLISHER_CONFIG["email_to"],
+                                   :subject => "gem #{gem.name} event #{event}",
+                                   :logger  => logger)
+        when "build_rpm"
+           # FIXME create artifact
+           RpmAdapter.build(:gem => gem, :logger => logger)
+        when "submit_rpm"
+           #if @event == :gem_created
+           # rpm = RPMEventHandler.build(@managed_gem)
+           # RPMEventHandler.submit(rpm)
+           #end
+      end
+   end
+
+end