first commit

Author: Rustik

MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README

@@ -0,0 +1,10 @@
+RemoteTicketSupport
+===================
+
+Simple plugin that shows how to create tickets from remote domains using jsonp. Dependent on engines plugin. See 'sample/report.html' for client html code. 
+
+Simple drop this plugin into your redmine vendor/plugins dir, and copy content of sample/report.html to your client site. Please note to modify host domain, in my case its 192.168.1.34. The html is required prototype and calendar.js to run, its not really that hard to clear this dependencies.
+
+Rails 2.0 and 2.3: There are bug with ActiveSupport, have to patch it https://rails.lighthouseapp.com/projects/8994/tickets/1956-json-validations-errors-for-activeresource
+
+Copyright (c) 2009 RustamG, released under the MIT license

Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the remote_ticket_support plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the remote_ticket_support plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RemoteTicketSupport'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

app/controllers/remote_issues_controller.rb

@@ -0,0 +1,57 @@
+class RemoteIssuesController < ActionController::Base
+
+	include ApplicationHelper
+	helper ApplicationHelper
+
+	def create_remotely
+			
+	@project = Project.find(params[:project_id])
+  	
+    if @project.nil?      
+    	render :json => 'Project not found.'.to_json, :callback => params[:callback]      
+    	return
+    end
+			
+	@issue = Issue.new
+    @issue.copy_from(params[:copy_from]) if params[:copy_from]
+    @issue.project = @project
+    # Tracker must be set before custom field values
+    @issue.tracker ||= @project.trackers.find((params[:issue] && params[:issue][:tracker_id]) || params[:tracker_id] || :first)
+    if @issue.tracker.nil?      
+    	render :json => 'No tracker is associated to this project. Please check the Project settings.'.to_json, :callback => params[:callback]      
+     	return
+    end
+    if params[:issue].is_a?(Hash)
+    	@issue.attributes = params[:issue]
+    	@issue.watcher_user_ids = params[:issue]['watcher_user_ids'] if User.current.allowed_to?(:add_issue_watchers, @project)
+    end
+    @issue.author = User.current
+    
+    default_status = IssueStatus.default
+    unless default_status      
+    	render :json => 'No default issue status is defined. Please check your configuration (Go to "Administration -> Issue statuses").'.to_json, :callback => params[:callback]      
+    	return
+    end    
+    @issue.status = default_status
+    @allowed_statuses = ([default_status]).uniq
+    
+    #if request.get? || request.xhr?
+    if params[:callback].nil?
+    	@issue.start_date ||= Date.today
+    else
+		requested_status = IssueStatus.find_by_id(params[:issue][:status_id])
+      	# Check that the user is allowed to apply the requested status
+      	@issue.status = (@allowed_statuses.include? requested_status) ? requested_status : default_status
+      	if @issue.save
+	        Mailer.deliver_issue_add(@issue) if Setting.notified_events.include?('issue_added')
+    	    render :json => l(:notice_successful_create).to_json, :callback => params[:callback]    
+        	return
+      	else
+    		render :json => @issue.errors.to_json,  :callback => params[:callback]      
+      		return      	
+      	end		
+    end	
+    @priorities = Enumeration::get_values('IPRI')
+    end
+	
+end 

app/views/remote_issues/_form.rhtml

@@ -0,0 +1,81 @@
+
+<h2><%=l(:label_issue_new)%></h2>
+
+<% labelled_tabular_form_for :issue, @issue, 
+                             :html => {:multipart => true, :id => 'issue-form', :onsubmit=>"sendJSONP('http://#{ request.env['HTTP_X_FORWARDED_SERVER'].blank? ? request.env['HTTP_HOST'] : request.env['HTTP_X_FORWARDED_SERVER'] }/projects/identifier/create_issue_remotely?id_of_html_block=#{ params[:id_of_html_block] }&'+Form.serialize('issue-form'), 'loadit'); return false"} do |f| %>
+    <%= error_messages_for 'issue' %>
+    <div class="box">
+	
+<% if issue.new_record? %>
+<p><%= f.select :tracker_id, project.trackers.collect {|t| [t.name, t.id]}, :required => true %></p>
+<%= observe_field :issue_tracker_id, :url => { :action => :new },
+                                     :update => :content,
+                                     :with => "Form.serialize('issue-form')" %>
+<hr />
+<% end %>
+
+<div id="issue_descr_fields" <%= 'style="display:none"' unless issue.new_record? || issue.errors.any? %>>
+<p><%= f.text_field :subject, :size => 80, :required => true %></p>
+<p><%= f.text_area :description,
+                   :cols => 60,
+                   :rows => (issue.description.blank? ? 10 : [[10, issue.description.length / 50].max, 100].min),
+                   :accesskey => accesskey(:edit),
+                   :class => 'wiki-edit' %></p>
+</div>
+
+<div class="splitcontentleft">
+<% if issue.new_record? || allowed_statuses.any? %>
+<% unless allowed_statuses.nil? %>	
+<p><%= f.select :status_id, (allowed_statuses.collect {|p| [p.name, p.id]}), :required => true %></p>
+<% end %>
+<% else %>
+<p><label><%= l(:field_status) %></label> <%= issue.status.name %></p>
+<% end %>
+
+<p><%= f.select :priority_id, (priorities.collect {|p| [p.name, p.id]}), :required => true %></p>
+<p><%= f.select :assigned_to_id, (issue.assignable_users.collect {|m| [m.name, m.id]}), :include_blank => true %></p>
+<% unless project.issue_categories.empty? %>
+<p><%= f.select :category_id, (project.issue_categories.collect {|c| [c.name, c.id]}), :include_blank => true %>
+<%= prompt_to_remote(l(:label_issue_category_new),
+                     l(:label_issue_category_new), 'category[name]', 
+                     {:controller => 'projects', :action => 'add_issue_category', :id => project},
+                     :class => 'small', :tabindex => 199) if authorize_for('projects', 'add_issue_category') %></p>
+<% end %>
+<%= content_tag('p', f.select(:fixed_version_id, 
+                              (project.versions.sort.collect {|v| [v.name, v.id]}),
+                              { :include_blank => true })) unless project.versions.empty? %>
+</div>
+
+<div class="splitcontentright">
+<p><%= f.text_field :start_date, :size => 10 %><%= calendar_for('issue_start_date') %></p>
+<p><%= f.text_field :due_date, :size => 10 %><%= calendar_for('issue_due_date') %></p>
+<p><%= f.text_field :estimated_hours, :size => 3 %> <%= l(:field_hours) %></p>
+<p><%= f.select :done_ratio, ((0..10).to_a.collect {|r| ["#{r*10} %", r*10] }) %></p>
+</div>
+
+<div style="clear:both;"> </div>
+<%= render :partial => 'form_custom_fields', :locals => {:issue => issue} %>
+
+
+
+<% if issue.new_record? -%>
+<p><label><%= l(:label_issue_watchers) %></label>
+<% issue.project.users.sort.each do |user| -%>
+<label class="floating"><%= check_box_tag 'issue[watcher_user_ids][]', user.id, issue.watcher_user_ids.include?(user.id) %> <%=h user %></label>
+<% end -%>
+</p>
+<% end %>
+
+<%= call_hook(:view_issues_form_details_bottom, { :issue => issue, :form => f }) %>
+
+
+
+
+
+    </div>
+    
+    <input name="commit" value="Create" type="submit" id="button_submitton">
+
+											 
+		<%= javascript_tag "Form.Element.focus('issue_subject');" %>
+<% end %>

app/views/remote_issues/_form_custom_fields.rhtml

@@ -0,0 +1,12 @@
+<div class="splitcontentleft">
+<% i = 0 %>
+<% split_on = issue.custom_field_values.size / 2 %>
+<% issue.custom_field_values.each do |value| %>
+	<p><%= custom_field_tag_with_label :issue, value %></p>
+<% if i == split_on -%>
+</div><div class="splitcontentright">
+<% end -%>
+<% i += 1 -%>
+<% end -%>
+</div>
+<div style="clear:both;"> </div>

app/views/remote_issues/create_remotely.rhtml

@@ -0,0 +1,55 @@
+
+
+// callback
+function loadit(data) {
+  // работаем с данными
+  if (!data) {
+    return;
+  }
+
+  var oTotal = document.getElementById("<%= params[:id_of_html_block] %>");
+  oTotal.innerHTML = data;//.ResultSet.totalResultsAvailable;
+  
+}
+
+// здесь будет ссылка на новый элемент script
+var oElem = null;
+
+function sendJSONP(url, callback) {
+
+  if (!url || !callback)
+    return;
+
+  url += '&callback='+callback;
+
+  // выполняем запрос JSONP
+  if (oElem) {
+    oElem.parentNode.removeChild(oElem);
+  }
+
+  oElem = document.createElement('script');
+  oElem.setAttribute('type','text/javascript');
+  document.getElementsByTagName('head')[0].appendChild(oElem);
+  oElem.setAttribute('src', url);
+}
+
+function loadForm(){
+	
+  <% update_page do |page| %>
+    <%= page.replace_html params[:id_of_html_block], :partial => 'form', :object => @issue, :locals => {:issue => @issue, :project => @project, :allowed_statuses => @allowed_statuses, :priorities => @priorities} %>
+  <% end %>	
+  return false;
+	
+}
+
+window.onload = function(){
+  
+  document.getElementById("reportBtn").onclick = function(){
+  	if (document.getElementById("<%= params[:id_of_html_block] %>").style.display == 'none')
+  		document.getElementById("<%= params[:id_of_html_block] %>").style.display = 'block';   
+  	loadForm();
+  }	
+  
+  loadForm();
+  
+}

init.rb

@@ -0,0 +1,2 @@
+# Include hook code here
+require 'remote_ticket_support'

install.rb

@@ -0,0 +1 @@
+# Install hook code here

lib/remote_ticket_support.rb

@@ -0,0 +1,11 @@
+# RemoteTicketSupport
+=begin
+%w{ controllers }.each do |dir| 
+	path = File.join(File.dirname(__FILE__), 'app', dir)  
+	$LOAD_PATH << path 
+	ActiveSupport::Dependencies.load_paths << path 
+	ActiveSupport::Dependencies.load_once_paths.delete(path) 	
+end 
+=end
+# doesnt needed since redmine using engines plugin's route inclusion method
+#require "remote_ticket_support/routing" 

lib/routing.rb

@@ -0,0 +1,14 @@
+# this file isnt needed anymore
+module RemoteTicketSupport #:nodoc:  
+	module Routing #:nodoc:  
+		module MapperExtensions 
+			def create_remotely
+				@set.add_route("/projects/:project_id/create_issue_remotely", {:controller => "issues_controller", :action => "create_remotely"})  				
+			end  
+			
+		end  
+		
+	end 
+	
+end 
+ActionController::Routing::RouteSet::Mapper.send :include, RemoteTicketSupport::Routing::MapperExtensions

routes.rb

@@ -0,0 +1 @@
+connect '/projects/:project_id/create_issue_remotely', :controller => 'remote_issues', :action => "create_remotely"

sample/report.html

@@ -0,0 +1,17 @@
+<html>
+<head>
+	<script src="http://www.prototypejs.org/javascripts/prototype.js" type="text/javascript"></script>
+	<script src="http://192.168.1.34/javascripts/calendar/calendar.js?1248714700" type="text/javascript"></script><script src="http://192.168.1.34/javascripts/calendar/lang/calendar-en.js?1248714704" type="text/javascript"></script><script src="http://192.168.1.34/javascripts/calendar/calendar-setup.js?1248714700" type="text/javascript"></script><link href="http://192.168.1.34/stylesheets/calendar.css?1248714720" media="screen" rel="stylesheet" type="text/css" />
+
+</head>
+<body>
+<p>This is example of remote issue creating. Put hits file onto other domain and press the button.</p>
+
+<script type="text/javascript" src="http://192.168.1.34/projects/identifier/create_issue_remotely?id_of_html_block=some_div_id"></script>
+<div id="some_div_id" style="display:none;"></div>
+<Br/><br/>
+<form>
+	<input type=button value="Report" id="reportBtn">
+</form>	
+</body>
+</html>

tasks/remote_ticket_support_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :remote_ticket_support do
+#   # Task goes here
+# end

uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here