taskr 0.1.0 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
data/CHANGELOG.txt CHANGED
@@ -0,0 +1,20 @@
1
+ === 0.2.0 :: 2008-01-03
2
+
3
+ * Added Taskr4rails action and accompanying Rails plugin for
4
+ executing code on a remote Rails server. See
5
+ http://code.google.com/p/ruby-taskr/wiki/Taskr4rails for
6
+ details.
7
+ * The Howlr action now takes an optional content_type parameter
8
+ to allow for sending out HTML-formatted messages.
9
+ * Change to REST API: the 'action(s)' parameter is now a bit looser.
10
+ You can use 'action' or 'actions' interchangeably, whether you're
11
+ scheduling multiple actions or just one.
12
+ * Fixed some routing problems in the HTML views.
13
+ * The ActiveResource and PHP examples have been updated with
14
+ some more illustrative code and better explanations.
15
+ * Misc bugs fixed while writing extensive documentation. See
16
+ wiki pages at http://code.google.com/p/ruby-taskr/w/list.
17
+
18
+ === 0.1.0 :: 2007-12-21
19
+
20
+ * First public release.
data/Manifest.txt CHANGED
@@ -20,6 +20,15 @@ lib/taskr/models.rb
20
20
  lib/taskr/version.rb
21
21
  lib/taskr/views.rb
22
22
  setup.rb
23
+ taskr4rails/LICENSE.txt
24
+ taskr4rails/README
25
+ taskr4rails/Rakefile
26
+ taskr4rails/init.rb
27
+ taskr4rails/install.rb
28
+ taskr4rails/lib/taskr4rails_controller.rb
29
+ taskr4rails/tasks/taskr4rails_tasks.rake
30
+ taskr4rails/test/taskr4rails_test.rb
31
+ taskr4rails/uninstall.rb
23
32
  test.rb
24
33
  test/taskr_test.rb
25
34
  test/test_helper.rb
data/README.txt CHANGED
@@ -1,4 +1,17 @@
1
- === LICENSE ===
1
+ = Taskr
2
+
3
+ Taskr is a stand-alone HTTP daemon, providing a cron-like networked scheduling
4
+ service. Tasks are created and managed via a REST calls over HTTP, allowing
5
+ other REST-aware services to schedule and manage jobs.
6
+
7
+
8
+ Please see Taskr's Google Code site for further information:
9
+
10
+ http://code.google.com/p/ruby-taskr/
11
+
12
+
13
+
14
+ == LICENSE
2
15
 
3
16
  This program is free software: you can redistribute it and/or modify
4
17
  it under the terms of the GNU General Public License as published by
@@ -17,20 +17,30 @@ task = Task.find(123)
17
17
  # Print the Task's name
18
18
  puts task.name
19
19
 
20
- # Create a new Task to be executed every 10 seconds
20
+ # Create a new Task with two actions to be executed every 10 seconds
21
21
  task = Task.new
22
22
  task.name = "My Example Task"
23
23
  task.schedule_method = 'every'
24
24
  task.schedule_when = '10s'
25
25
  task.actions = [
26
- {:action_class_name => 'Ruby', :code => "puts 'Hello World!'"},
27
- {:action_class_name => 'Ruby', :code => "puts 'Goodbye!'"}
26
+ {:action_class_name => 'Ruby', :code => "puts 'Sending message through Howlr...'"},
27
+ {:action_class_name => 'Howlr',
28
+ :subject => "Testing Howlr",
29
+ :body => "Just testing! Please ignore this.",
30
+ :from => "joe@example.foo",
31
+ :recipients => "sally@example.foo; bob@example.foo",
32
+ :url => "http://howlr.example.foo/messages.xml",
33
+ :username => 'howlr',
34
+ :password => 'howl!'}
28
35
  ]
29
36
 
30
- # Save the new Task -- the Task is not scheduled for execution until
31
- # it is saved.
37
+ # Save the new Task; saving the Task commits it to the Taskr server
38
+ # and schedules it for execution.
32
39
  task.save
33
40
 
34
- # Deleting a task
41
+ # Delete the Task we just created
42
+ task.destroy
43
+
44
+ # Or delete a Task with some arbitrary id
35
45
  id = 123
36
- Task.delete(id)
46
+ Task.delete(id)
@@ -15,71 +15,111 @@ require 'Zend/Rest/Client.php';
15
15
 
16
16
  $taskr_site_url = "http://localhost:7007";
17
17
 
18
+ /**
19
+ If your Taskr server is configured to require authentication, uncomment the next block
20
+ and change the username and password to whatever you have in your server's config.yml.
21
+ **/
22
+ //$username = 'taskr';
23
+ //$password = 'task!';
24
+ //Zend_Rest_Client::getHttpClient()->setAuth($username, $password);
18
25
 
26
+ /**
27
+ Initialize the REST client.
28
+ **/
29
+ $rest = new Zend_Rest_Client($taskr_site_url);
19
30
 
20
31
  /**
21
32
  Retreiving the list of all scheduled Tasks
22
33
  **/
23
34
 
24
- $rest = new Zend_Rest_Client($taskr_site_url);
25
35
  $tasks = $rest->get("/tasks.xml");
26
36
 
27
37
  // $tasks is a SimpleXml object, so calling print_r($result) will let
28
38
  // you see all of its data.
29
39
  //
30
40
  // Here's an example of how to print out all of the tasks as an HTML list:
31
-
32
- echo "<ul>";
33
- foreach ($tasks->task as $task) {
34
- echo "<li>".$task->name."</li>";
35
- echo "<ul>";
36
- echo "<li>execute ".$task->{'schedule-method'}." ".$task->{'schedule-when'}."</li>";
37
- echo "<li>created by ".$task->{'created-by'}." on ".$task->{'created-on'}."</li>";
41
+ if ($tasks->task) {
42
+ echo "<ul>\n";
43
+ foreach ($tasks->task as $task) {
44
+ echo "\t<li>".$task->name."</li>\n";
45
+ echo "\t<ul>\n";
46
+ echo "\t\t<li>execute ".$task->{'schedule-method'}." ".$task->{'schedule-when'}."</li>\n";
47
+ echo "\t\t<li>created by ".$task->{'created-by'}." on ".$task->{'created-on'}."</li>\n";
48
+ echo "\t</ul>\n";
49
+ }
50
+ echo "</ul>\n";
51
+ } else {
52
+ echo "<p>There are no scheduled tasks.</p>\n";
38
53
  }
39
- echo "</ul>";
40
-
41
54
 
42
55
 
43
56
  /**
44
- Retreiving a specific task
57
+ Creating a new task, to be executed every 10 seconds
45
58
  **/
46
59
 
47
- $id = 6;
48
- $rest = new Zend_Rest_Client($taskr_site_url);
49
- $task = $rest->get("/tasks/$id.xml");
50
-
51
- // print the Task's name
52
- echo $task->name;
53
- // print the type of the first action in this task
54
- echo $task->{'task-actions'}->{'task-action'}[0]->{'action-class-name'};
60
+ $data = array(
61
+ 'name' => "My Example Task #".mktime(),
62
+ 'schedule_method' => "every",
63
+ 'schedule_when' => "10s",
64
+ 'action' => array(
65
+ 'action_class_name' => "Ruby",
66
+ 'code' => 'puts "Hello World!"'
67
+ )
68
+ );
55
69
 
70
+ $task1 = $rest->post('/tasks.xml', $data);
56
71
 
57
72
  /**
58
- Creating a new task, to be executed every 10 seconds
73
+ Creating a new task with multiple actions, to be executed 5 minutes from now
59
74
  **/
60
75
 
61
76
  $data = array(
62
- 'name' => "My Example Task",
63
- 'schedule_method' => "every",
64
- 'schedule_when' => "10s",
77
+ 'name' => "Another Example Task #".mktime(),
78
+ 'schedule_method' => "in",
79
+ 'schedule_when' => "5m",
65
80
  'actions' => array(
66
81
  array('action_class_name' => "Ruby",
67
- 'code' => 'puts "Hello World!"'),
68
- array('action_class_name' => "Ruby",
69
- 'code' => 'puts "Goodbye!"')
82
+ 'code' => 'puts "Sending a message through Howlr..."'),
83
+ array('action_class_name' => "Howlr",
84
+ 'url' => "http://howlr.example.foo/messages.xml",
85
+ 'subject' => "Testing",
86
+ 'from' => "joe@example.foo",
87
+ 'recipients' => "sally@example.foo",
88
+ 'body' => "Just testing!",
89
+ 'username' => "howlr",
90
+ 'password' => "howl!")
70
91
  )
71
92
  );
72
93
 
73
- $rest = new Zend_Rest_Client($taskr_site_url);
74
- $rest->post('/tasks.xml', $data);
94
+ $task2 = $rest->post('/tasks.xml', $data);
75
95
 
76
96
 
77
97
  /**
78
- Deleting a task
98
+ Retreiving a specific task by its ID
99
+ **/
100
+
101
+ $id = $task1->id;
102
+ $task = $rest->get("/tasks/$id.xml");
103
+
104
+ if ($task) {
105
+ // print the Task's name
106
+ echo $task->name;
107
+ // print the type of the first action in this task
108
+ //echo $task->{'task-actions'}->{'task-action'}[0]->{'action-class-name'};
109
+ } else {
110
+ echo "";
111
+ }
112
+
113
+
114
+ /**
115
+ Deleting the tasks we just created
79
116
  **/
80
117
 
81
- $id = 6;
82
- $rest = new Zend_Rest_Client($taskr_site_url);
83
- $task = $rest->delete("/tasks/$id.xml");
84
-
118
+ $id1 = $task1->id;
119
+ $rest->delete("/tasks/$id1.xml");
120
+
121
+ $id2 = $task2->id;
122
+ $rest->delete("/tasks/$id2.xml");
123
+
124
+
85
125
  ?>
data/lib/taskr/actions.rb CHANGED
@@ -62,10 +62,13 @@ module Taskr
62
62
  task.update_attribute(:last_triggered, Time.now)
63
63
  task.update_attribute(:last_triggered_error, nil)
64
64
  rescue => e
65
+ puts
65
66
  $LOG.error(e)
66
- $LOG.debug(e.backtrace.to_s)
67
+ $LOG.debug(e.backtrace.join($/))
68
+ details = e.message
69
+ details += "\n\n#{$LAST_ERROR_BODY}" if $LAST_ERROR_BODY # dumb way of reading Restr errors... Restr needs to be fixed
67
70
  task.update_attribute(:last_triggered, Time.now)
68
- task.update_attribute(:last_triggered_error, {:type => e.class.to_s, :message => e.message})
71
+ task.update_attribute(:last_triggered_error, {:type => e.class.to_s, :message => details})
69
72
  raise e
70
73
  end
71
74
  end
@@ -210,12 +213,16 @@ module Taskr
210
213
  end
211
214
 
212
215
  class Howlr < Rest
213
- self.parameters = ['url', 'from', 'recipients', 'subject', 'body', 'username', 'password']
216
+ self.parameters = ['url', 'from', 'recipients', 'subject', 'body', 'username', 'password', 'content_type']
214
217
  self.description = "Send a message through a Howlr service."
215
218
 
216
219
  def execute
220
+ content_type = parameters['content_type']
221
+ content_type = 'text/plain' if content_type.blank?
222
+
217
223
  parameters['method'] = 'post'
218
224
  parameters['params'] = {
225
+ 'content_type' => content_type,
219
226
  'from' => parameters['from'],
220
227
  'recipients' => parameters['recipients'],
221
228
  'subject' => parameters['subject'],
@@ -226,5 +233,22 @@ module Taskr
226
233
  super
227
234
  end
228
235
  end
236
+
237
+ class Taskr4rails < Base
238
+ self.parameters = ['url', 'auth', 'ruby_code']#, 'shell_command']
239
+ self.description = "Executes code on a remote Rails server via the taskr4rails plugin."
240
+
241
+ def execute
242
+ data = {
243
+ :auth => parameters['auth'],
244
+ :ruby_code => parameters['ruby_code']#,
245
+ #:shell_command => parameters['shell_command']
246
+ }
247
+
248
+
249
+ Restr.logger = $LOG
250
+ Restr.post(parameters['url'], data)
251
+ end
252
+ end
229
253
  end
230
254
  end
@@ -65,10 +65,6 @@ module Taskr::Controllers
65
65
 
66
66
  def create
67
67
  begin
68
- puts @input.class
69
- puts @input.to_xml if @input.kind_of?(XmlSimple)
70
- puts @input.inspect
71
-
72
68
  # the "0" is for compatibility with PHP's Zend_Rest_Client
73
69
  task_data = @input[:task] || @input["0"] || @input
74
70
 
@@ -98,7 +94,7 @@ module Taskr::Controllers
98
94
  actions << a
99
95
  end
100
96
  else
101
- actions = actions_data[:action]
97
+ actions = actions_data[:action] || actions_data[:actions] || actions_data
102
98
  end
103
99
 
104
100
  actions = [actions] unless actions.kind_of? Array
@@ -156,9 +152,12 @@ module Taskr::Controllers
156
152
 
157
153
  def destroy(id)
158
154
  @task = Task.find(id)
159
- Taskr.scheduler.unschedule(@task.scheduler_job_id) if @task.scheduler_job_id
155
+ if @task.scheduler_job_id
156
+ $LOG.debug "Unscheduling task #{@task}..."
157
+ Taskr.scheduler.unschedule(@task.scheduler_job_id)
158
+ end
160
159
  @task.destroy
161
- return redirect('/tasks')
160
+ return redirect(R(Tasks, :list))
162
161
  end
163
162
  end
164
163
  end
data/lib/taskr/version.rb CHANGED
@@ -1,7 +1,7 @@
1
1
  module Taskr #:nodoc:
2
2
  module VERSION #:nodoc:
3
3
  MAJOR = 0
4
- MINOR = 1
4
+ MINOR = 2
5
5
  TINY = 0
6
6
 
7
7
  STRING = [MAJOR, MINOR, TINY].join('.')
data/lib/taskr/views.rb CHANGED
@@ -24,11 +24,11 @@ module Taskr::Views
24
24
  CONTENT_TYPE = 'text/xml'
25
25
 
26
26
  def tasks_list
27
- @tasks.to_xml(:root => 'tasks', :include => [:task_actions])
27
+ @tasks.to_xml(:root => 'tasks')#, :include => [:task_actions])
28
28
  end
29
29
 
30
30
  def view_task
31
- @task.to_xml(:root => 'task', :include => [:task_actions])
31
+ @task.to_xml(:root => 'task')#, :include => [:task_actions])
32
32
  end
33
33
 
34
34
  def create_task_result
@@ -40,6 +40,8 @@ module Taskr::Views
40
40
  end
41
41
 
42
42
  module HTML
43
+ include Taskr::Controllers
44
+
43
45
  CONTENT_TYPE = 'text/html'
44
46
 
45
47
  def tasks_list
@@ -93,7 +95,7 @@ module Taskr::Views
93
95
  script(:type => 'text/javascript') do
94
96
  %{
95
97
  function show_action_parameters(num) {
96
- new Ajax.Updater('parameters_'+num, '/actions', {
98
+ new Ajax.Updater('parameters_'+num, '#{R(Actions)}', {
97
99
  method: 'get',
98
100
  parameters: {
99
101
  id: $F('action_class_name_'+num),
@@ -134,9 +136,9 @@ module Taskr::Views
134
136
  script(:type => 'text/javascript') do
135
137
  %{
136
138
  Event.observe('add_action', 'click', function() {
137
- new Ajax.Updater('add_action', '#{self/'/actions'}', {
139
+ new Ajax.Updater('add_action', '#{R(Actions, :new)}', {
138
140
  method: 'get',
139
- parameters: { action: 'new', num: $$('select.action_class_name').size() },
141
+ parameters: { num: $$('select.action_class_name').size() },
140
142
  insertion: Insertion.Before
141
143
  });
142
144
  return false;
@@ -155,7 +157,7 @@ module Taskr::Views
155
157
  button(:type => 'submit', :value => 'delete') {"Delete"}
156
158
  end
157
159
  br
158
- a(:href => self/'tasks') {"Back to Task List"}
160
+ a(:href => R(Tasks, :list)) {"Back to Task List"}
159
161
 
160
162
  h1 "Task #{@task.id}"
161
163
  table do
@@ -167,6 +169,10 @@ module Taskr::Views
167
169
  th "Schedule:"
168
170
  td "#{@task.schedule_method} #{@task.schedule_when}"
169
171
  end
172
+ tr do
173
+ th "Job ID:"
174
+ td @task.scheduler_job_id
175
+ end
170
176
  tr do
171
177
  th "Triggered:"
172
178
  td do
@@ -183,7 +189,7 @@ module Taskr::Views
183
189
  td(:style => 'color: #e00;') do
184
190
  strong "#{@task.last_triggered_error[:type]}"
185
191
  br
186
- span @task.last_triggered_error[:message]
192
+ pre @task.last_triggered_error[:message]
187
193
  end
188
194
  end
189
195
  tr do
@@ -243,7 +249,7 @@ module Taskr::Views
243
249
  p do
244
250
  label param
245
251
  br
246
- input :type => 'textarea', :name => "action[#{@num}][#{param}]", :size => 40
252
+ input :type => 'text', :name => "action[#{@num}][#{param}]", :size => 50
247
253
  end
248
254
  end
249
255
  end
@@ -0,0 +1,504 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 2.1, February 1999
3
+
4
+ Copyright (C) 1991, 1999 Free Software Foundation, Inc.
5
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6
+ Everyone is permitted to copy and distribute verbatim copies
7
+ of this license document, but changing it is not allowed.
8
+
9
+ [This is the first released version of the Lesser GPL. It also counts
10
+ as the successor of the GNU Library Public License, version 2, hence
11
+ the version number 2.1.]
12
+
13
+ Preamble
14
+
15
+ The licenses for most software are designed to take away your
16
+ freedom to share and change it. By contrast, the GNU General Public
17
+ Licenses are intended to guarantee your freedom to share and change
18
+ free software--to make sure the software is free for all its users.
19
+
20
+ This license, the Lesser General Public License, applies to some
21
+ specially designated software packages--typically libraries--of the
22
+ Free Software Foundation and other authors who decide to use it. You
23
+ can use it too, but we suggest you first think carefully about whether
24
+ this license or the ordinary General Public License is the better
25
+ strategy to use in any particular case, based on the explanations below.
26
+
27
+ When we speak of free software, we are referring to freedom of use,
28
+ not price. Our General Public Licenses are designed to make sure that
29
+ you have the freedom to distribute copies of free software (and charge
30
+ for this service if you wish); that you receive source code or can get
31
+ it if you want it; that you can change the software and use pieces of
32
+ it in new free programs; and that you are informed that you can do
33
+ these things.
34
+
35
+ To protect your rights, we need to make restrictions that forbid
36
+ distributors to deny you these rights or to ask you to surrender these
37
+ rights. These restrictions translate to certain responsibilities for
38
+ you if you distribute copies of the library or if you modify it.
39
+
40
+ For example, if you distribute copies of the library, whether gratis
41
+ or for a fee, you must give the recipients all the rights that we gave
42
+ you. You must make sure that they, too, receive or can get the source
43
+ code. If you link other code with the library, you must provide
44
+ complete object files to the recipients, so that they can relink them
45
+ with the library after making changes to the library and recompiling
46
+ it. And you must show them these terms so they know their rights.
47
+
48
+ We protect your rights with a two-step method: (1) we copyright the
49
+ library, and (2) we offer you this license, which gives you legal
50
+ permission to copy, distribute and/or modify the library.
51
+
52
+ To protect each distributor, we want to make it very clear that
53
+ there is no warranty for the free library. Also, if the library is
54
+ modified by someone else and passed on, the recipients should know
55
+ that what they have is not the original version, so that the original
56
+ author's reputation will not be affected by problems that might be
57
+ introduced by others.
58
+
59
+ Finally, software patents pose a constant threat to the existence of
60
+ any free program. We wish to make sure that a company cannot
61
+ effectively restrict the users of a free program by obtaining a
62
+ restrictive license from a patent holder. Therefore, we insist that
63
+ any patent license obtained for a version of the library must be
64
+ consistent with the full freedom of use specified in this license.
65
+
66
+ Most GNU software, including some libraries, is covered by the
67
+ ordinary GNU General Public License. This license, the GNU Lesser
68
+ General Public License, applies to certain designated libraries, and
69
+ is quite different from the ordinary General Public License. We use
70
+ this license for certain libraries in order to permit linking those
71
+ libraries into non-free programs.
72
+
73
+ When a program is linked with a library, whether statically or using
74
+ a shared library, the combination of the two is legally speaking a
75
+ combined work, a derivative of the original library. The ordinary
76
+ General Public License therefore permits such linking only if the
77
+ entire combination fits its criteria of freedom. The Lesser General
78
+ Public License permits more lax criteria for linking other code with
79
+ the library.
80
+
81
+ We call this license the "Lesser" General Public License because it
82
+ does Less to protect the user's freedom than the ordinary General
83
+ Public License. It also provides other free software developers Less
84
+ of an advantage over competing non-free programs. These disadvantages
85
+ are the reason we use the ordinary General Public License for many
86
+ libraries. However, the Lesser license provides advantages in certain
87
+ special circumstances.
88
+
89
+ For example, on rare occasions, there may be a special need to
90
+ encourage the widest possible use of a certain library, so that it becomes
91
+ a de-facto standard. To achieve this, non-free programs must be
92
+ allowed to use the library. A more frequent case is that a free
93
+ library does the same job as widely used non-free libraries. In this
94
+ case, there is little to gain by limiting the free library to free
95
+ software only, so we use the Lesser General Public License.
96
+
97
+ In other cases, permission to use a particular library in non-free
98
+ programs enables a greater number of people to use a large body of
99
+ free software. For example, permission to use the GNU C Library in
100
+ non-free programs enables many more people to use the whole GNU
101
+ operating system, as well as its variant, the GNU/Linux operating
102
+ system.
103
+
104
+ Although the Lesser General Public License is Less protective of the
105
+ users' freedom, it does ensure that the user of a program that is
106
+ linked with the Library has the freedom and the wherewithal to run
107
+ that program using a modified version of the Library.
108
+
109
+ The precise terms and conditions for copying, distribution and
110
+ modification follow. Pay close attention to the difference between a
111
+ "work based on the library" and a "work that uses the library". The
112
+ former contains code derived from the library, whereas the latter must
113
+ be combined with the library in order to run.
114
+
115
+ GNU LESSER GENERAL PUBLIC LICENSE
116
+ TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117
+
118
+ 0. This License Agreement applies to any software library or other
119
+ program which contains a notice placed by the copyright holder or
120
+ other authorized party saying it may be distributed under the terms of
121
+ this Lesser General Public License (also called "this License").
122
+ Each licensee is addressed as "you".
123
+
124
+ A "library" means a collection of software functions and/or data
125
+ prepared so as to be conveniently linked with application programs
126
+ (which use some of those functions and data) to form executables.
127
+
128
+ The "Library", below, refers to any such software library or work
129
+ which has been distributed under these terms. A "work based on the
130
+ Library" means either the Library or any derivative work under
131
+ copyright law: that is to say, a work containing the Library or a
132
+ portion of it, either verbatim or with modifications and/or translated
133
+ straightforwardly into another language. (Hereinafter, translation is
134
+ included without limitation in the term "modification".)
135
+
136
+ "Source code" for a work means the preferred form of the work for
137
+ making modifications to it. For a library, complete source code means
138
+ all the source code for all modules it contains, plus any associated
139
+ interface definition files, plus the scripts used to control compilation
140
+ and installation of the library.
141
+
142
+ Activities other than copying, distribution and modification are not
143
+ covered by this License; they are outside its scope. The act of
144
+ running a program using the Library is not restricted, and output from
145
+ such a program is covered only if its contents constitute a work based
146
+ on the Library (independent of the use of the Library in a tool for
147
+ writing it). Whether that is true depends on what the Library does
148
+ and what the program that uses the Library does.
149
+
150
+ 1. You may copy and distribute verbatim copies of the Library's
151
+ complete source code as you receive it, in any medium, provided that
152
+ you conspicuously and appropriately publish on each copy an
153
+ appropriate copyright notice and disclaimer of warranty; keep intact
154
+ all the notices that refer to this License and to the absence of any
155
+ warranty; and distribute a copy of this License along with the
156
+ Library.
157
+
158
+ You may charge a fee for the physical act of transferring a copy,
159
+ and you may at your option offer warranty protection in exchange for a
160
+ fee.
161
+
162
+ 2. You may modify your copy or copies of the Library or any portion
163
+ of it, thus forming a work based on the Library, and copy and
164
+ distribute such modifications or work under the terms of Section 1
165
+ above, provided that you also meet all of these conditions:
166
+
167
+ a) The modified work must itself be a software library.
168
+
169
+ b) You must cause the files modified to carry prominent notices
170
+ stating that you changed the files and the date of any change.
171
+
172
+ c) You must cause the whole of the work to be licensed at no
173
+ charge to all third parties under the terms of this License.
174
+
175
+ d) If a facility in the modified Library refers to a function or a
176
+ table of data to be supplied by an application program that uses
177
+ the facility, other than as an argument passed when the facility
178
+ is invoked, then you must make a good faith effort to ensure that,
179
+ in the event an application does not supply such function or
180
+ table, the facility still operates, and performs whatever part of
181
+ its purpose remains meaningful.
182
+
183
+ (For example, a function in a library to compute square roots has
184
+ a purpose that is entirely well-defined independent of the
185
+ application. Therefore, Subsection 2d requires that any
186
+ application-supplied function or table used by this function must
187
+ be optional: if the application does not supply it, the square
188
+ root function must still compute square roots.)
189
+
190
+ These requirements apply to the modified work as a whole. If
191
+ identifiable sections of that work are not derived from the Library,
192
+ and can be reasonably considered independent and separate works in
193
+ themselves, then this License, and its terms, do not apply to those
194
+ sections when you distribute them as separate works. But when you
195
+ distribute the same sections as part of a whole which is a work based
196
+ on the Library, the distribution of the whole must be on the terms of
197
+ this License, whose permissions for other licensees extend to the
198
+ entire whole, and thus to each and every part regardless of who wrote
199
+ it.
200
+
201
+ Thus, it is not the intent of this section to claim rights or contest
202
+ your rights to work written entirely by you; rather, the intent is to
203
+ exercise the right to control the distribution of derivative or
204
+ collective works based on the Library.
205
+
206
+ In addition, mere aggregation of another work not based on the Library
207
+ with the Library (or with a work based on the Library) on a volume of
208
+ a storage or distribution medium does not bring the other work under
209
+ the scope of this License.
210
+
211
+ 3. You may opt to apply the terms of the ordinary GNU General Public
212
+ License instead of this License to a given copy of the Library. To do
213
+ this, you must alter all the notices that refer to this License, so
214
+ that they refer to the ordinary GNU General Public License, version 2,
215
+ instead of to this License. (If a newer version than version 2 of the
216
+ ordinary GNU General Public License has appeared, then you can specify
217
+ that version instead if you wish.) Do not make any other change in
218
+ these notices.
219
+
220
+ Once this change is made in a given copy, it is irreversible for
221
+ that copy, so the ordinary GNU General Public License applies to all
222
+ subsequent copies and derivative works made from that copy.
223
+
224
+ This option is useful when you wish to copy part of the code of
225
+ the Library into a program that is not a library.
226
+
227
+ 4. You may copy and distribute the Library (or a portion or
228
+ derivative of it, under Section 2) in object code or executable form
229
+ under the terms of Sections 1 and 2 above provided that you accompany
230
+ it with the complete corresponding machine-readable source code, which
231
+ must be distributed under the terms of Sections 1 and 2 above on a
232
+ medium customarily used for software interchange.
233
+
234
+ If distribution of object code is made by offering access to copy
235
+ from a designated place, then offering equivalent access to copy the
236
+ source code from the same place satisfies the requirement to
237
+ distribute the source code, even though third parties are not
238
+ compelled to copy the source along with the object code.
239
+
240
+ 5. A program that contains no derivative of any portion of the
241
+ Library, but is designed to work with the Library by being compiled or
242
+ linked with it, is called a "work that uses the Library". Such a
243
+ work, in isolation, is not a derivative work of the Library, and
244
+ therefore falls outside the scope of this License.
245
+
246
+ However, linking a "work that uses the Library" with the Library
247
+ creates an executable that is a derivative of the Library (because it
248
+ contains portions of the Library), rather than a "work that uses the
249
+ library". The executable is therefore covered by this License.
250
+ Section 6 states terms for distribution of such executables.
251
+
252
+ When a "work that uses the Library" uses material from a header file
253
+ that is part of the Library, the object code for the work may be a
254
+ derivative work of the Library even though the source code is not.
255
+ Whether this is true is especially significant if the work can be
256
+ linked without the Library, or if the work is itself a library. The
257
+ threshold for this to be true is not precisely defined by law.
258
+
259
+ If such an object file uses only numerical parameters, data
260
+ structure layouts and accessors, and small macros and small inline
261
+ functions (ten lines or less in length), then the use of the object
262
+ file is unrestricted, regardless of whether it is legally a derivative
263
+ work. (Executables containing this object code plus portions of the
264
+ Library will still fall under Section 6.)
265
+
266
+ Otherwise, if the work is a derivative of the Library, you may
267
+ distribute the object code for the work under the terms of Section 6.
268
+ Any executables containing that work also fall under Section 6,
269
+ whether or not they are linked directly with the Library itself.
270
+
271
+ 6. As an exception to the Sections above, you may also combine or
272
+ link a "work that uses the Library" with the Library to produce a
273
+ work containing portions of the Library, and distribute that work
274
+ under terms of your choice, provided that the terms permit
275
+ modification of the work for the customer's own use and reverse
276
+ engineering for debugging such modifications.
277
+
278
+ You must give prominent notice with each copy of the work that the
279
+ Library is used in it and that the Library and its use are covered by
280
+ this License. You must supply a copy of this License. If the work
281
+ during execution displays copyright notices, you must include the
282
+ copyright notice for the Library among them, as well as a reference
283
+ directing the user to the copy of this License. Also, you must do one
284
+ of these things:
285
+
286
+ a) Accompany the work with the complete corresponding
287
+ machine-readable source code for the Library including whatever
288
+ changes were used in the work (which must be distributed under
289
+ Sections 1 and 2 above); and, if the work is an executable linked
290
+ with the Library, with the complete machine-readable "work that
291
+ uses the Library", as object code and/or source code, so that the
292
+ user can modify the Library and then relink to produce a modified
293
+ executable containing the modified Library. (It is understood
294
+ that the user who changes the contents of definitions files in the
295
+ Library will not necessarily be able to recompile the application
296
+ to use the modified definitions.)
297
+
298
+ b) Use a suitable shared library mechanism for linking with the
299
+ Library. A suitable mechanism is one that (1) uses at run time a
300
+ copy of the library already present on the user's computer system,
301
+ rather than copying library functions into the executable, and (2)
302
+ will operate properly with a modified version of the library, if
303
+ the user installs one, as long as the modified version is
304
+ interface-compatible with the version that the work was made with.
305
+
306
+ c) Accompany the work with a written offer, valid for at
307
+ least three years, to give the same user the materials
308
+ specified in Subsection 6a, above, for a charge no more
309
+ than the cost of performing this distribution.
310
+
311
+ d) If distribution of the work is made by offering access to copy
312
+ from a designated place, offer equivalent access to copy the above
313
+ specified materials from the same place.
314
+
315
+ e) Verify that the user has already received a copy of these
316
+ materials or that you have already sent this user a copy.
317
+
318
+ For an executable, the required form of the "work that uses the
319
+ Library" must include any data and utility programs needed for
320
+ reproducing the executable from it. However, as a special exception,
321
+ the materials to be distributed need not include anything that is
322
+ normally distributed (in either source or binary form) with the major
323
+ components (compiler, kernel, and so on) of the operating system on
324
+ which the executable runs, unless that component itself accompanies
325
+ the executable.
326
+
327
+ It may happen that this requirement contradicts the license
328
+ restrictions of other proprietary libraries that do not normally
329
+ accompany the operating system. Such a contradiction means you cannot
330
+ use both them and the Library together in an executable that you
331
+ distribute.
332
+
333
+ 7. You may place library facilities that are a work based on the
334
+ Library side-by-side in a single library together with other library
335
+ facilities not covered by this License, and distribute such a combined
336
+ library, provided that the separate distribution of the work based on
337
+ the Library and of the other library facilities is otherwise
338
+ permitted, and provided that you do these two things:
339
+
340
+ a) Accompany the combined library with a copy of the same work
341
+ based on the Library, uncombined with any other library
342
+ facilities. This must be distributed under the terms of the
343
+ Sections above.
344
+
345
+ b) Give prominent notice with the combined library of the fact
346
+ that part of it is a work based on the Library, and explaining
347
+ where to find the accompanying uncombined form of the same work.
348
+
349
+ 8. You may not copy, modify, sublicense, link with, or distribute
350
+ the Library except as expressly provided under this License. Any
351
+ attempt otherwise to copy, modify, sublicense, link with, or
352
+ distribute the Library is void, and will automatically terminate your
353
+ rights under this License. However, parties who have received copies,
354
+ or rights, from you under this License will not have their licenses
355
+ terminated so long as such parties remain in full compliance.
356
+
357
+ 9. You are not required to accept this License, since you have not
358
+ signed it. However, nothing else grants you permission to modify or
359
+ distribute the Library or its derivative works. These actions are
360
+ prohibited by law if you do not accept this License. Therefore, by
361
+ modifying or distributing the Library (or any work based on the
362
+ Library), you indicate your acceptance of this License to do so, and
363
+ all its terms and conditions for copying, distributing or modifying
364
+ the Library or works based on it.
365
+
366
+ 10. Each time you redistribute the Library (or any work based on the
367
+ Library), the recipient automatically receives a license from the
368
+ original licensor to copy, distribute, link with or modify the Library
369
+ subject to these terms and conditions. You may not impose any further
370
+ restrictions on the recipients' exercise of the rights granted herein.
371
+ You are not responsible for enforcing compliance by third parties with
372
+ this License.
373
+
374
+ 11. If, as a consequence of a court judgment or allegation of patent
375
+ infringement or for any other reason (not limited to patent issues),
376
+ conditions are imposed on you (whether by court order, agreement or
377
+ otherwise) that contradict the conditions of this License, they do not
378
+ excuse you from the conditions of this License. If you cannot
379
+ distribute so as to satisfy simultaneously your obligations under this
380
+ License and any other pertinent obligations, then as a consequence you
381
+ may not distribute the Library at all. For example, if a patent
382
+ license would not permit royalty-free redistribution of the Library by
383
+ all those who receive copies directly or indirectly through you, then
384
+ the only way you could satisfy both it and this License would be to
385
+ refrain entirely from distribution of the Library.
386
+
387
+ If any portion of this section is held invalid or unenforceable under any
388
+ particular circumstance, the balance of the section is intended to apply,
389
+ and the section as a whole is intended to apply in other circumstances.
390
+
391
+ It is not the purpose of this section to induce you to infringe any
392
+ patents or other property right claims or to contest validity of any
393
+ such claims; this section has the sole purpose of protecting the
394
+ integrity of the free software distribution system which is
395
+ implemented by public license practices. Many people have made
396
+ generous contributions to the wide range of software distributed
397
+ through that system in reliance on consistent application of that
398
+ system; it is up to the author/donor to decide if he or she is willing
399
+ to distribute software through any other system and a licensee cannot
400
+ impose that choice.
401
+
402
+ This section is intended to make thoroughly clear what is believed to
403
+ be a consequence of the rest of this License.
404
+
405
+ 12. If the distribution and/or use of the Library is restricted in
406
+ certain countries either by patents or by copyrighted interfaces, the
407
+ original copyright holder who places the Library under this License may add
408
+ an explicit geographical distribution limitation excluding those countries,
409
+ so that distribution is permitted only in or among countries not thus
410
+ excluded. In such case, this License incorporates the limitation as if
411
+ written in the body of this License.
412
+
413
+ 13. The Free Software Foundation may publish revised and/or new
414
+ versions of the Lesser General Public License from time to time.
415
+ Such new versions will be similar in spirit to the present version,
416
+ but may differ in detail to address new problems or concerns.
417
+
418
+ Each version is given a distinguishing version number. If the Library
419
+ specifies a version number of this License which applies to it and
420
+ "any later version", you have the option of following the terms and
421
+ conditions either of that version or of any later version published by
422
+ the Free Software Foundation. If the Library does not specify a
423
+ license version number, you may choose any version ever published by
424
+ the Free Software Foundation.
425
+
426
+ 14. If you wish to incorporate parts of the Library into other free
427
+ programs whose distribution conditions are incompatible with these,
428
+ write to the author to ask for permission. For software which is
429
+ copyrighted by the Free Software Foundation, write to the Free
430
+ Software Foundation; we sometimes make exceptions for this. Our
431
+ decision will be guided by the two goals of preserving the free status
432
+ of all derivatives of our free software and of promoting the sharing
433
+ and reuse of software generally.
434
+
435
+ NO WARRANTY
436
+
437
+ 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440
+ OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446
+
447
+ 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456
+ DAMAGES.
457
+
458
+ END OF TERMS AND CONDITIONS
459
+
460
+ How to Apply These Terms to Your New Libraries
461
+
462
+ If you develop a new library, and you want it to be of the greatest
463
+ possible use to the public, we recommend making it free software that
464
+ everyone can redistribute and change. You can do so by permitting
465
+ redistribution under these terms (or, alternatively, under the terms of the
466
+ ordinary General Public License).
467
+
468
+ To apply these terms, attach the following notices to the library. It is
469
+ safest to attach them to the start of each source file to most effectively
470
+ convey the exclusion of warranty; and each file should have at least the
471
+ "copyright" line and a pointer to where the full notice is found.
472
+
473
+ <one line to give the library's name and a brief idea of what it does.>
474
+ Copyright (C) <year> <name of author>
475
+
476
+ This library is free software; you can redistribute it and/or
477
+ modify it under the terms of the GNU Lesser General Public
478
+ License as published by the Free Software Foundation; either
479
+ version 2.1 of the License, or (at your option) any later version.
480
+
481
+ This library is distributed in the hope that it will be useful,
482
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
483
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
484
+ Lesser General Public License for more details.
485
+
486
+ You should have received a copy of the GNU Lesser General Public
487
+ License along with this library; if not, write to the Free Software
488
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
489
+
490
+ Also add information on how to contact you by electronic and paper mail.
491
+
492
+ You should also get your employer (if you work as a programmer) or your
493
+ school, if any, to sign a "copyright disclaimer" for the library, if
494
+ necessary. Here is a sample; alter the names:
495
+
496
+ Yoyodyne, Inc., hereby disclaims all copyright interest in the
497
+ library `Frob' (a library for tweaking knobs) written by James Random Hacker.
498
+
499
+ <signature of Ty Coon>, 1 April 1990
500
+ Ty Coon, President of Vice
501
+
502
+ That's all there is to it!
503
+
504
+
@@ -0,0 +1,31 @@
1
+ = Taskr4rails
2
+
3
+ Taskr4rails makes it possible for the Taskr scheduler to execute arbitrary
4
+ code on a running Rails server.
5
+
6
+ Please see the Taskr4rails wiki page for more information:
7
+
8
+ http://code.google.com/p/ruby-taskr/wiki/Taskr4rails
9
+
10
+ For general info on the Taskr's RESTful scheduling service, please see:
11
+
12
+ http://code.google.com/p/ruby-taskr/
13
+
14
+
15
+
16
+ == LICENSE
17
+
18
+ Taskr4rails is free software; you can redistribute it and/or modify
19
+ it under the terms of the GNU Lesser General Public License as published
20
+ by the Free Software Foundation; either version 2 of the License, or
21
+ (at your option) any later version.
22
+
23
+ Taskr4rails is distributed in the hope that it will be useful,
24
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
25
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26
+ GNU General Public License for more details.
27
+
28
+ You should have received a copy of the GNU Lesser General Public License
29
+ along with Taskr4rails; if not, write to the Free Software
30
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
31
+
@@ -0,0 +1,22 @@
1
+ require 'rake'
2
+ require 'rake/testtask'
3
+ require 'rake/rdoctask'
4
+
5
+ desc 'Default: run unit tests.'
6
+ task :default => :test
7
+
8
+ desc 'Test the taskr4rails plugin.'
9
+ Rake::TestTask.new(:test) do |t|
10
+ t.libs << 'lib'
11
+ t.pattern = 'test/**/*_test.rb'
12
+ t.verbose = true
13
+ end
14
+
15
+ desc 'Generate documentation for the taskr4rails plugin.'
16
+ Rake::RDocTask.new(:rdoc) do |rdoc|
17
+ rdoc.rdoc_dir = 'rdoc'
18
+ rdoc.title = 'Taskr4rails'
19
+ rdoc.options << '--line-numbers' << '--inline-source'
20
+ rdoc.rdoc_files.include('README')
21
+ rdoc.rdoc_files.include('lib/**/*.rb')
22
+ end
@@ -0,0 +1 @@
1
+ require 'taskr4rails_controller'
@@ -0,0 +1,26 @@
1
+ # Add the necessary route to routes.rb
2
+
3
+ puts "Adding taskr4rails route to your routes.rb file..."
4
+
5
+ routes_file = File.expand_path("#{RAILS_ROOT}/config/routes.rb")
6
+
7
+ routes = IO.read(routes_file)
8
+ find = "ActionController::Routing::Routes.draw do |map|"
9
+ idx = routes.index(find)
10
+
11
+ unless idx
12
+ $stderr.puts "Couldn't add taskr4rails route. You will have to do this manually."
13
+ exit
14
+ end
15
+
16
+ File.open(routes_file, "w") do |io|
17
+ loc = idx + find.length
18
+
19
+ ins = %{ }+$/+$/+
20
+ %{ # route automatically added by taskr4rails plugin}+$/+
21
+ %{ map.taskr4rails "taskr4rails", :controller => 'taskr4rails', :action => 'execute'}+$/+$/
22
+
23
+ routes.insert(loc, ins)
24
+
25
+ io.write(routes)
26
+ end
@@ -0,0 +1,51 @@
1
+ class Taskr4railsController < ActionController::Base
2
+
3
+ def execute
4
+ unless Object.const_defined?("TASKR4RAILS_AUTH")
5
+ render :text => "The taskr4rails receiver cannot be used until TASKR4RAILS_AUTH is defined. See http://code.google.com/p/ruby-taskr/wiki/Taskr4rails for help.",
6
+ :status => 500
7
+ return false
8
+ end
9
+
10
+ unless request.post?
11
+ render :text => "This is the taskr4rails receiver. It responds only to POST requests.",
12
+ :status => 405
13
+ return false
14
+ end
15
+
16
+ if Object.const_defined?("TASKR4RAILS_ALLOWED_HOSTS")
17
+ ok = TASKR4RAILS_ALLOWED_HOSTS.any? do |h|
18
+ if h.kind_of? Regexp
19
+ h =~ request.remote_addr
20
+ else
21
+ h == request.remote_addr
22
+ end
23
+ end
24
+
25
+ unless ok
26
+ render :text => "Remote address is not in the list of permitted hosts.",
27
+ :status => 403
28
+ return false
29
+ end
30
+ end
31
+
32
+ unless params[:auth] == TASKR4RAILS_AUTH
33
+ render :text => "Invalid auth password.",
34
+ :status => 401
35
+ return false
36
+ end
37
+
38
+ out = ""
39
+ begin
40
+ out << (eval(params[:ruby_code]) || "") if params[:ruby_code]
41
+ out << (`cd #{RAILS_ROOT}; #{params[:shell_command]}` || "") if params[:shell_command]
42
+ err = false
43
+ rescue => e
44
+ out << e
45
+ err = true
46
+ end
47
+
48
+ render :text => out, :status => (err ? 500 : 200)
49
+ end
50
+
51
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :taskr4rails do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,8 @@
1
+ require 'test/unit'
2
+
3
+ class Taskr4railsTest < Test::Unit::TestCase
4
+ # Replace this with your real tests.
5
+ def test_this_plugin
6
+ flunk
7
+ end
8
+ end
@@ -0,0 +1 @@
1
+ # Uninstall hook code here
metadata CHANGED
@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
3
3
  specification_version: 1
4
4
  name: taskr
5
5
  version: !ruby/object:Gem::Version
6
- version: 0.1.0
7
- date: 2007-12-21 00:00:00 -05:00
6
+ version: 0.2.0
7
+ date: 2008-01-03 00:00:00 -05:00
8
8
  summary: description of gem
9
9
  require_paths:
10
10
  - lib
@@ -51,6 +51,15 @@ files:
51
51
  - lib/taskr/version.rb
52
52
  - lib/taskr/views.rb
53
53
  - setup.rb
54
+ - taskr4rails/LICENSE.txt
55
+ - taskr4rails/README
56
+ - taskr4rails/Rakefile
57
+ - taskr4rails/init.rb
58
+ - taskr4rails/install.rb
59
+ - taskr4rails/lib/taskr4rails_controller.rb
60
+ - taskr4rails/tasks/taskr4rails_tasks.rake
61
+ - taskr4rails/test/taskr4rails_test.rb
62
+ - taskr4rails/uninstall.rb
54
63
  - test.rb
55
64
  - test/taskr_test.rb
56
65
  - test/test_helper.rb
@@ -65,6 +74,7 @@ extra_rdoc_files:
65
74
  - History.txt
66
75
  - Manifest.txt
67
76
  - README.txt
77
+ - taskr4rails/LICENSE.txt
68
78
  executables:
69
79
  - taskr
70
80
  - taskr-ctl