ex_cite 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,3 @@
+= ExCite
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'ExCite'
+  rdoc.options << '--line-numbers'
+  rdoc.options << '--markup markdown'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/ex_cite/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/ex_cite/cite.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/ex_cite/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/ex_cite/cite.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/ex_cite/export_citations_controller.rb

@@ -0,0 +1,171 @@
+require "ex_cite/engine"
+require 'digest/sha1'
+require 'open-uri'
+module ExCite
+  # Logic behind the webservice. First it gathers all the resource keys and creates Citation objects out of them and then
+  # it gathers any and all from formats and data variables that were sent via post and creates an array out of them. If the
+  # array is still empty it uses the URL as an OpenURL. It then loops through the array and translates and caches (or fetches)
+  # each one using acts_as_citable. It then either downloads the data or redirects to another webservice.
+  class ExportCitationsController < ActionController::Base
+    # There must be a destination format, or else this whole thing doesnt make sense
+    before_filter :valid_to_format?
+    layout "ex_cite/application"
+    
+    # Sends bad request if there is no destination format
+    def valid_to_format?
+      head :bad_request unless to_format      
+    end
+    
+    # Checks to see if destination format is valid and stores it in a class variable
+    def to_format
+      @to_format ||= whitelist_formats :to, params[:to_format]
+    end
+    private :to_format
+    
+    # Constructs an array containing all the citations
+    def citations
+     unless defined? @citations
+      @citations = record_citation + resource_citation + format_citation
+      if @citations.empty?
+        @citations << open_url_citation
+      end
+     end
+     @citations.compact 
+    end
+    
+    def record_citation
+      (params[:id].nil?) ? [] :
+        params[:id].collect do |id|
+          record = ExCite.acts_as_citable_class.find_by_id id if ExCite.acts_as_citable_class.respond_to? :find_by_id 
+        end
+    end
+    
+    # Constructs new citation objects with only the citation key set, returns an array
+    def resource_citation
+      (params[:resource_key].nil?) ? [] :
+        params[:resource_key].collect do |key|
+           citation = ExCite.acts_as_citable_class.new()
+           citation.resource_key = key 
+           citation
+        end
+    end
+    
+    # Constructs new citation objects with data and source format set (the citation key is constructed automatically), returns an array
+    def format_citation
+      (params[:from_format].nil? || params[:data].nil?) ? [] :
+        params[:from_format].collect.with_index do |format, index|
+          # p ActsAsCitableClass.format_field
+          ExCite.acts_as_citable_class.new  ExCite.acts_as_citable_class.data_field.to_sym => params[:data].to_a[index],   ExCite.acts_as_citable_class.format_field.to_sym => (whitelist_formats :from, format)
+        end
+    end
+    
+    # Returns a single citation object with data and format set as the url and openurl respectively
+    def open_url_citation
+       ExCite.acts_as_citable_class.new   ExCite.acts_as_citable_class.data_field.to_sym => CGI::unescape(request.protocol+request.host_with_port+request.fullpath),   ExCite.acts_as_citable_class.format_field.to_sym => (whitelist_formats :from, 'openurl')
+    end
+    
+    # Maps the output and caches it, alternatively it fetches the already cached result. Seperates each output with two new lines.
+    # Raises an argument error if any error is caught in mapping (usually the formats are messed up)
+    def map
+      @output ||= 
+        citations.collect { |citation| Rails.cache.fetch(citation.resource_key+to_format) { citation.send(to_format) } }.join "\n\n"  
+    rescue Exception => exc
+      raise ArgumentError, "#{exc}\n Data or source format not provided and/or mismatched. [citations => #{citations}, to_format => #{@to_format}]"
+    end
+    
+    # Maps then decides wether its a push request or a download, catches all bad argument errors
+    def index
+      map
+      serve
+    rescue ArgumentError => exc
+      handle_invalid_arguments exc
+    end
+    
+    # Pushes to a web service if that is what was requested else it downloads
+    def serve
+      @push_to ? push : download
+    end
+
+    # Cleans the user input and finds the associated method for that format
+    def whitelist_formats direction, format
+      # if the params are nil then it returns nil
+      if direction.nil? || format.nil?
+        return
+      end
+      # if the to format is found, it returns the method name for that to format
+      if (direction == :to && Citero.to_formats.include?(format.downcase))
+        return "#{:to.to_s}_#{format.downcase}"
+      # if the from format is found, it returns just that because the object already knows what method to call
+      elsif (direction == :from && Citero.from_formats.include?(format.downcase))
+        return format.downcase
+      end
+      # if the format is still not found, it might be a push request, check if that is the case
+      if ExCite.push_formats.include? format.to_sym
+        @push_to = ExCite.push_formats[format.to_sym]
+        @to_format = @push_to.to_format.downcase
+        return "#{direction.to_s}_#{@to_format}"
+      end
+    end
+    
+    # For debugging purposes prints out the error. Also sends bad request header
+    def handle_invalid_arguments exc
+      p exc
+      logger.debug exc
+      head :bad_request
+    end
+
+    # Redirects or calls a predefined method depending on the webservice selected
+    def push
+      # for redirects
+      if @push_to.action.eql? :redirect
+        # Openurl is data
+        @data = "#{request.protocol}#{request.host_with_port}#{request.fullpath}"
+        # and redirect to the url supplied by the webservice and the callback url
+        redirect_to @push_to.url+callback, :status => 303
+      elsif @push_to.action.eql? :render
+        # call the method this service needs
+        render_push @push_to
+      end
+    end
+
+    # sends the data with utf-8 encoding
+    def download
+      send_data @output.force_encoding('UTF-8'), :filename => filename, :type => @to_format.formatize.to_sym
+    end
+
+    # The callback url is defined here
+    def callback
+      # Starts with current url minus the querystring..
+      callback = "#{export_citations_url}?"
+      citations.collect do |citation|
+        # then adds a resource key for each cached resource
+        callback += (!citation.respond_to? :new_record || citation.new_record?) ? "resource_key[]=#{citation.resource_key}&" : "id[]=#{citation.id}&"
+      end
+      # and finally the to format
+      callback += "to_format=#{@to_format.formatize}"
+      # url encode and return
+      ERB::Util.url_encode(callback)
+    end
+
+    # Creates the filename and extension. Few are application specific
+    def filename
+      name = "export"
+      case @to_format
+      when "to_bibtex"
+        name += ".bib"
+      when "to_easybib"
+        name += ".json"
+      else
+        name += "." + @to_format.formatize
+      end
+      name
+    end
+
+    def render_push push
+      push.vars.each do |key, value|
+        instance_variable_set "@#{key}", value.outputize(@output)
+      end
+      render :template => push.template
+    end
+  end
+end

data/app/helpers/ex_cite/application_helper.rb

@@ -0,0 +1,14 @@
+module ExCite
+  module ApplicationHelper
+    def build_external_form
+      f = ""
+      @elements.each do |element|
+        # Return input element for no js and not textarea
+        f += "<input name=\"#{element[:name]}\" type=\"#{(element[:type].nil?) ? "text" : element[:type]}\" value='#{element[:value]}' />" unless (element[:type] and element[:type].eql?("textarea"))
+        # Return textarea element for no js and type=textarea
+        f += "<textarea name=\"#{element[:name]}\" id=\"#{element[:name]}\">#{element[:value]}</textarea>" unless (element[:type].nil? or not element[:type].eql?("textarea"))
+      end
+      return f
+    end
+  end
+end

data/app/models/ex_cite/citation.rb

@@ -0,0 +1,17 @@
+module ExCite
+  # Citation class, holds data from format and/or resource key
+  class Citation
+    extend ActsAsCitable
+    include ResourceKey
+    # Required fields
+    attr_accessor :data, :from_format
+    acts_as_citable do |c|
+      c.format_field = :from_format
+    end
+    def initialize args = {}
+      self.data = args[:data]
+      self.from_format = args[:from_format]
+      self.resource_key = args[:resource_key]
+    end
+  end
+end

data/app/models/ex_cite/push_format.rb

@@ -0,0 +1,15 @@
+module ExCite
+  # Citation class, holds data from format and/or resource key
+  class PushFormat
+    # Required fields
+    attr_accessor :name, :to_format, :action, :vars, :template, :url
+    def initialize args = {}
+      self.name = args[:name]
+      self.to_format = args[:to_format]
+      self.action = args[:action]
+      self.vars = args[:vars]
+      self.template = args[:template]
+      self.url = args[:url]
+    end
+  end
+end

data/app/models/ex_cite/resource_key.rb

@@ -0,0 +1,13 @@
+module ExCite
+  module ResourceKey
+    def self.included(klass)
+      klass.class_eval do
+        attr_writer :resource_key
+      end
+    end
+    # Construct a resource key if it doesn't already exist
+    def resource_key 
+      @resource_key ||= Digest::SHA1.hexdigest(_data)
+    end
+  end
+end

data/app/views/ex_cite/cite/_external_form.html.erb

@@ -0,0 +1,26 @@
+<%= javascript_tag do %>
+	jQuery(document).ready(function($) {
+		submit_external_form();
+		function submit_external_form() {
+			// Hide the page
+			$("body").hide();
+			$form = $(".external_form");
+			$form.trigger("submit");
+		}
+	});
+<% end %>
+<div class="inner_form_dialog">
+	<form id="<%= @id %>" action="<%= @action %>" method="<%= @method %>" class="external_form" enctype="<%= @enctype %>">
+		<h2><%= @name %></h2>
+		<div class="formError">
+		<%= @error || flash[:error] %>
+		</div>
+		<fieldset>
+			<legend><%= @legend %></legend>
+			<%= raw build_external_form %>
+			<div class="section">
+				<%= submit_tag @name%>
+			</div>
+		</fieldset>
+	</form>
+</div>

data/app/views/ex_cite/cite/external_form.html.erb

@@ -0,0 +1 @@
+<div class="no_js"><%= render :partial=>"ex_cite/cite/external_form" %></div>

data/app/views/layouts/ex_cite/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ExCite</title>
+  <%= stylesheet_link_tag    "ex_cite/application", :media => "all" %>
+  <%= javascript_include_tag "ex_cite/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/citation.rb

@@ -0,0 +1,7 @@
+module ExCite
+  ActiveSupport.on_load(:after_initialize) do
+    ActiveRecord::Base.class_eval do
+      include ResourceKey
+    end
+  end
+end

data/config/initializers/mime_types.rb

@@ -0,0 +1,3 @@
+Mime::Type.register "application/x-url", :openurl
+Mime::Type.register "text/plain", :csf
+Mime::Type.register "application/json", :easybib

data/config/routes.rb

@@ -0,0 +1,3 @@
+ExCite::Engine.routes.draw do
+  match "export_citations(/:to_format)(/:id)" => 'export_citations#index', :via => [:get, :post], :as => "export_citations"
+end

data/lib/ex_cite/core_ext.rb

@@ -0,0 +1,32 @@
+String.class_eval do
+  def formatize
+    self.split('_',2).last.strip
+  end
+  
+  def collect &block
+    self.split('',1).collect &block
+  end
+  
+  def to_a
+    self.split('',1)
+  end
+  
+  def outputize output
+    if self.include? "@output" 
+      self.gsub!("@output", output)
+    end
+    self
+  end
+end
+
+Hash.class_eval do
+  def outputize output
+    self.values.each {|val| val.outputize output}
+  end
+end
+
+Array.class_eval do
+  def outputize output
+    self.each {|val| val.outputize output}
+  end
+end

data/lib/ex_cite/engine.rb

@@ -0,0 +1,44 @@
+require 'ex_cite/core_ext'
+require "acts_as_citable"
+
+module ExCite
+  mattr_accessor :acts_as_citable_class
+  mattr_accessor :push_formats
+  def self.acts_as_citable_class
+    @@acts_as_citable_class.constantize
+  end
+
+  class Engine < Rails::Engine
+    isolate_namespace ExCite
+    engine_name "ex_cite"
+    ExCite.acts_as_citable_class = "ExCite::Citation"
+  end
+  
+  def self.config &block
+    if block
+      yield self
+    end
+  end
+  
+  def self.push_formats
+    @easybib ||= PushFormat.new( :name => :easybibpush, :to_format => :easybib, :action => :render, :template => "ex_cite/cite/external_form",
+    :vars => Hash[
+       "elements" => [{:name => 'data', :value => "[ @output ]", :type => 'textarea'}],
+       "name" => "Push to EasyBib",
+       "action" => "http://www.easybib.com/cite/bulk",
+       "method" => "POST",
+       "enctype" => "application/x-www-form-urlencoded"
+       ])
+    @endnote ||= PushFormat.new :name => :endnote, :to_format => :ris, :action => :redirect, :url => 'http://www.myendnoteweb.com/?func=directExport&partnerName=Primo&dataIdentifier=1&dataRequestUrl='
+    # @refworks ||= PushFormat.new :name => :refworks, :to_format => :ris, :action => :redirect, :url => 'http://www.refworks.com/express/ExpressImport.asp?vendor=Primo&filter=RIS%20Format&encoding=65001&url='
+    @refworks ||= PushFormat.new( :name => :refworks, :to_format => :ris, :action => :render, :template => "ex_cite/cite/external_form",
+    :vars => Hash[
+       "elements" => [{:name => 'ImportData', :value => "@output", :type => 'textarea'}],
+       "name" => "ExportRWForm",
+       "action" => "http://www.refworks.com/express/ExpressImport.asp?vendor=Primo&filter=RefWorks%20Tagged%20Format&encoding=65001",
+       "method" => "POST",
+       "enctype" => "application/x-www-form-urlencoded"
+       ])
+    @@push_formats ||= Hash[@easybib.name => @easybib, @endnote.name => @endnote, @refworks.name => @refworks]
+  end
+end

data/lib/ex_cite/version.rb

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

data/lib/tasks/ex_cite_tasks.rake

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