aizuchi 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~
+.#*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2011 Phil Hofmann
+
+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.

data/README.md

@@ -0,0 +1,41 @@
+Aizuchi - Instant Feedback Tool
+===============================
+
+[Aizuchi](http://en.wikipedia.org/wiki/Aizuchi) is a
+[Rack](http://rack.rubyforge.org/) based middleware which
+automatically integrates with [Rails](http://rubyonrails.org/) to
+display a form to collect feedback from your clients. Aizuchi
+therefore creates issues via [Redmine's](http://www.redmine.org/) REST
+API. 
+
+Install in Rails
+----------------
+
+Put the following in your Gemfile and run `bundle install` or let
+[Guard](https://github.com/guard/guard-bundler) kick in.
+
+    gem 'aizuchi'
+
+Using Aizuchi outside of Rails
+------------------------------
+
+    require 'aizuchi/middleware'
+    use Aizuchi::Middleware, :config => 'path/to/config/aizuchi.yml'
+
+Configure
+---------
+
+Aizuchi will create a sample config file in `config/aizuchi.yml`.
+Aizuchi is disabled by default, but you'll have to edit this config file
+anyways.
+
+Patches and the like
+--------------------
+
+If you run into bugs, have suggestions, patches or want to use Aizuchi
+with something else than Rails or Redmine feel free to drop me a line.
+
+License
+-------
+
+Aizuchi is release under MIT License, see LICENSE.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/aizuchi.gemspec

@@ -0,0 +1,20 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "aizuchi/version"
+
+Gem::Specification.new do |s|
+  s.name        = "aizuchi"
+  s.version     = Aizuchi::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Phil Hofmann"]
+  s.email       = ["phil@branch14.org"]
+  s.homepage    = "http://branch14.org/aizuchi"
+  s.summary     = %q{Collect instant feedback into Redmine}
+  s.description = %q{Collect instant feedback into Redmine}
+
+  # s.rubyforge_project = "aizuchi"
+
+  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", "rails"]
+end

data/lib/aizuchi.rb

@@ -0,0 +1,2 @@
+require "aizuchi/railtie" if defined? Rails
+

data/lib/aizuchi/middleware.rb

@@ -0,0 +1,282 @@
+# (c) 2011 Phil Hofmann <pho@panter.ch>
+#
+# after install see config/aizuchi.yml for more information
+
+require 'net/https'
+
+module Aizuchi
+  class Middleware < Struct.new :app, :options
+
+    def call(env)
+      return app.call(env) unless config['enabled']
+      if env["REQUEST_METHOD"] == "POST" and
+          env["PATH_INFO"] =~ /^\/aizuchi/
+        # proxy
+        request = Rack::Request.new env
+        res = post(config['target'], request.POST.to_json,
+                   config['user'], config['password'])
+        case res
+        when Net::HTTPSuccess
+          [ 200, {}, [] ]
+        else
+          [ 500, {}, [] ]
+        end
+      else
+        # inject
+        status, headers, response = app.call(env)
+        if headers["Content-Type"] =~ /text\/html|application\/xhtml\+xml/
+          body = ""
+          response.each { |part| body << part }
+          index = body.rindex "</body>"
+          if index
+            body.insert index, data
+            headers["Content-Length"] = body.length.to_s
+            response = [ body ]
+          end
+        end
+        [ status, headers, response ]
+      end
+    end
+
+    private
+
+    def default_config
+      <<-EOB
+---
+# Aizuchi -- Instant Feedback
+# Aizuchi depends on jQuery >= 1.4.4
+# upon changing this file you will need to restart your app
+enabled: false
+target: https://your.redmine.instance/issues.xml
+user: feedback
+password: secret
+init:
+  params:
+    project_id: project-handle
+    assigned_to_id: 123
+    tracker_id: 4
+  text:
+    imperative: please type your feedback here
+    submit: submit
+    cancel: cancel
+  css:
+    hidden:
+      top: 150px
+      left: -600px
+      height: 60px
+    visible:
+      top: 150px
+      left: 0px
+      height: 200px
+# uncomment the following two lines, if your project
+# doesn't use jquery already
+# javascripts:
+#   - http://code.jquery.com/jquery-1.5.1.min.js
+# or this line if you want to ship it yourself
+#   - /javascripts/jquery-1.5.1.min.js
+# uncomment the following line, in case your project uses prototype
+# jquery_noconflict: true
+      EOB
+    end
+
+    def config
+      return @config unless @config.nil?
+      path = options[:config]
+      raise "no config path given" unless path
+      ::File.open(path, 'w') { |f| f.puts default_config } unless ::File.exist?(path)
+      @config = ::File.open(path) { |yf| YAML::load(yf) }
+    end
+
+    def post(uri_str, body_str, user=nil , pass=nil)
+      url = URI.parse uri_str
+      http = Net::HTTP.new url.host, url.port
+      http.use_ssl = (url.scheme == 'https')
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new url.path
+      request["Content-Type"] = "application/json"
+      request.basic_auth user, pass
+      request.body = body_str
+      response = http.start { |http| http.request(request) }
+      case response
+      when Net::HTTPSuccess then response
+      else
+        response.error!
+      end
+    end
+
+    def data # DATA doesn't work with Rack
+      template = ::File.read(__FILE__).gsub(/.*__END__\n/m, '')
+      (config['javascripts'] || []).map do |j|
+        "<script type='text/javascript' src='%s'></script>" % j
+      end * "\n" + ERB.new(template).result(binding)
+    end
+
+  end
+end
+
+__END__
+<script type="text/javascript">
+  (function( $ ){
+
+    <% if config['jquery_noconflict'] %>
+    $.noConflict();
+    <% end %>
+
+    $(function() { Aizuchi.init(<%= config['init'].to_json %>); });
+  
+    Aizuchi = {
+      settings: {},
+      state: "visible",
+  
+      // returns the root url of the application
+      root_url: function() {
+        var url = window.location.protocol + "//" + window.location.hostname;
+        if(window.location.port != "") { url += ":" + window.location.port; }
+        return url;
+      },
+  
+      // build a string, which is posted as the description of the issue
+      description: function() {
+        var desc = "h1. User Feedback\n\n"
+            + $('#aizuchi textarea').val() + "\n\n";
+        // meta data
+        var referer = document.referrer;
+        if(referer == "") { referer = "(no referer)"; }
+        desc += "<pre>"
+            + "sent from:   " + document.title + "\n"
+            + "URL:         " + document.URL + "\n"
+            + "referer:     " + referer + "\n"
+            + "user agent:  " + navigator.userAgent + "\n"
+            + "screen size: " + screen.width + "x" + screen.height
+            + ", color depth: " + screen.colorDepth + "\n";
+        desc += "</pre>\n";
+        desc += "Installed plugins:\n\n";
+        // plugins & mimetypes
+        for(var pid=0;pid<navigator.plugins.length;pid++) {
+            var plugin = navigator.plugins[pid];
+            desc += "* " + plugin.name + "(" + plugin.description + ")\n";
+            for(var mid=0;mid<plugin.length;mid++) {
+                var mime = plugin[mid];
+                desc += "** " + mime.type + " (" + mime.description + ")\n";
+            }
+        }
+        return desc;
+      },
+      
+      subject: function() {
+          return $('#aizuchi textarea').val().substring(0, 50) + '...';
+      },
+  
+      markup: function() {
+          return "<div id='aizuchi' onmouseover='Aizuchi.show()'>"
+              + "<form>"
+              + "<textarea>" + this.settings.text.imperative + "</textarea>"
+              + "<div class='buttons'>"
+              + "<input type='button' value='" + this.settings.text.submit
+              + "' onclick='Aizuchi.send()' />"
+              + "<input type='button' value='" + this.settings.text.cancel
+              + "' onclick='Aizuchi.hide()' />"
+              + "</div>"
+              + "<form>"
+              + "</div>";
+      },
+  
+      resizeHack: function() {
+          $('#aizuchi textarea').height($('#aizuchi').height() - 35);
+      },
+  
+      show: function() {
+          if(this.state == 'visible') { return; }
+          $('#aizuchi').animate(this.settings.css.visible, 150, 'swing', function() {
+              Aizuchi.resizeHack();
+              // $('#aizuchi textarea').focus(function() { this.select(); });
+              // $('#aizuchi textarea').first().focus();
+              Aizuchi.state = 'visible';
+          });
+      },
+  
+      hide: function() {
+          $('#aizuchi').animate(this.settings.css.hidden, 150, 'linear', function() {
+              Aizuchi.resizeHack();
+              Aizuchi.state = 'hidden';
+          });
+          // setTimeout(function() { Aizuchi.state = 'hidden'; }, 500);
+      },
+  
+      init: function(hash) {
+          var dyn = {
+            params: {
+              target_url:  this.root_url() + "/aizuchi",
+              subject:     this.subject,
+              description: this.description
+            }
+          };
+          $.extend(true, this.settings, dyn, hash);
+          $('body').append(this.markup());
+          this.hide();
+          // setTimeout(function() { $('#aizuchi').css('display', 'block'); }, 1000);
+          setTimeout(function() {
+              $('#aizuchi').animate({opacity: 1});
+              Aizuchi.state = 'hidden';
+          }, 1000);
+      },
+  
+      responseHandler: function(data, status, request) {},
+  
+      send: function() {
+          this.sendToRedmine();
+          this.hide();
+          $('#aizuchi textarea').val(this.settings.text.imperative);
+      },
+  
+      sendToRedmine: function(hash) {
+          if(typeof hash == undefined) { hash = {}; }
+          var data = $.extend({}, this.settings.params, hash);
+          var url = data.target_url;
+          $.post(url, {"issue": data}, this.responseHandler);
+      },
+  
+      log: function(msg) {
+          if(typeof console == undefined) { return; }
+          console.log(msg);
+      }
+    };
+  })( jQuery );
+</script>
+<style>
+#aizuchi {
+    width: 600px;
+    height: 200px;
+    padding: 10px;
+    -moz-border-radius: 0 15px 15px 0;
+    border-radius: 0 15px 15px 0;
+    position: absolute;
+    background-color: #00bcff;
+    z-index: 999;
+    /*display: none;*/
+    opacity: 0;
+}
+
+#aizuchi textarea {
+    background-color: #c0c0c0;
+    width: 580px;
+    height: 100%;
+    border: 0px;
+    padding: 8px;
+    font-size: 18px;
+    -moz-border-radius: 10px;
+    border-radius: 10px;
+}
+
+#aizuchi .buttons {
+    float: right;
+}
+
+#aizuchi input {
+    margin: 0 5px 0 0;
+}
+
+#aizuchi img {
+    border: none;
+}
+</style>

data/lib/aizuchi/railtie.rb

@@ -0,0 +1,11 @@
+require 'aizuchi/middleware'
+
+module Aizuchi
+  class Railtie < Rails::Railtie
+    initializer "aizuchi.insert_middleware" do |app|
+      app.config.middleware.use "Aizuchi::Middleware",
+        :config => File.expand_path('config/aizuchi.yml', Rails.root)
+    end
+  end
+end
+

data/lib/aizuchi/version.rb

@@ -0,0 +1,3 @@
+module Aizuchi
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: aizuchi
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Phil Hofmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-28 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Collect instant feedback into Redmine
+email: 
+- phil@branch14.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- aizuchi.gemspec
+- lib/aizuchi.rb
+- lib/aizuchi/middleware.rb
+- lib/aizuchi/railtie.rb
+- lib/aizuchi/version.rb
+has_rdoc: true
+homepage: http://branch14.org/aizuchi
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- rails
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Collect instant feedback into Redmine
+test_files: []
+