ex_cite 1.0.1 → 1.1.0

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2012 YOURNAME
+Copyright 2013 NYU Division of Libraries
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/app/controllers/ex_cite/export_citations_controller.rb

@@ -13,7 +13,7 @@ module ExCite
     
     # Sends bad request if there is no destination format
     def valid_to_format?
-      head :bad_request unless to_format      
+      head :bad_request unless to_format
     end
     
     # Checks to see if destination format is valid and stores it in a class variable
@@ -37,6 +37,7 @@ module ExCite
       (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 
+          (record.nil?) ? (raise(ArgumentError, "This ID cannot be found.")) : record
         end
     end
     
@@ -44,9 +45,9 @@ module ExCite
     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
+          citation = ExCite.acts_as_citable_class.new()
+          citation.resource_key = key
+          citation
         end
     end
     
@@ -66,9 +67,7 @@ module ExCite
     # 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"  
-          citations.collect { |citation| citation.send(to_format) }.join "\n\n"
+      @output ||= citations.collect { |citation| Rails.cache.fetch(citation.resource_key+to_format) { citation.send(to_format) } }.join_and_enclose *delimiters
     rescue Exception => exc
       raise ArgumentError, "#{exc}\n Data or source format not provided and/or mismatched. [citations => #{citations}, to_format => #{@to_format}]  "
     end
@@ -93,7 +92,7 @@ module ExCite
         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))
+      if (direction == :to && (Citero.to_formats.include?(format.downcase) || Citero.citation_styles.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))
@@ -109,7 +108,6 @@ module ExCite
     
     # 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
@@ -124,7 +122,7 @@ module ExCite
         redirect_to @push_to.url+callback, :status => 303
       elsif @push_to.action.eql? :render
         # call the method this service needs
-        render_push @push_to
+        render_push
       end
     end
 
@@ -161,11 +159,17 @@ module ExCite
       name
     end
 
-    def render_push push
-      push.vars.each do |key, value|
-        instance_variable_set "@#{key}", value.outputize(@output)
+    def render_push
+      render :template => @push_to.template
+    end
+    
+    def delimiters
+      case @to_format
+      when "to_easybib", "to_csl"
+        return [",\n","[","]"]
+      else
+        return ["\n\n"]
       end
-      render :template => push.template
     end
   end
 end

data/app/helpers/ex_cite/application_helper.rb

@@ -1,14 +1,7 @@
 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
+      return "<textarea name=\"#{@push_to.element_name}\" id=\"#{@push_to.element_name}\">#{@output}</textarea>"
     end
   end
 end

data/app/models/ex_cite/push_format.rb

@@ -2,14 +2,16 @@ 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
+    attr_accessor :name, :to_format, :action, :template, :url, :method, :enctype, :element_name
     def initialize args = {}
-      self.name = args[:name]
+      self.name = (args[:name] or 'Service')
       self.to_format = args[:to_format]
-      self.action = args[:action]
-      self.vars = args[:vars]
-      self.template = args[:template]
+      self.action = (args[:action] or :render)
+      self.template = (args[:template] or "ex_cite/cite/external_form")
       self.url = args[:url]
+      self.method = (args[:method] or "POST")
+      self.enctype = (args[:enctype] or "application/x-www-form-urlencoded")
+      self.element_name = (args[:element_name] or "data")
     end
   end
 end

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

@@ -10,8 +10,8 @@
 	});
 <% end %>
 <div class="inner_form_dialog">
-	<form id="<%= @id %>" action="<%= @action %>" method="<%= @method %>" class="external_form" enctype="<%= @enctype %>">
-		<h2><%= @name %></h2>
+	<form id="<%= @id %>" action="<%= @push_to.url %>" method="<%= @push_to.method %>" class="external_form" enctype="<%= @push_to.enctype %>">
+		<h2>Push to <%= @push_to.name.capitalize %></h2>
 		<div class="formError">
 		<%= @error || flash[:error] %>
 		</div>
@@ -19,7 +19,7 @@
 			<legend><%= @legend %></legend>
 			<%= raw build_external_form %>
 			<div class="section">
-				<%= submit_tag @name%>
+				<%= submit_tag "Push to #{@push_to.name.capitalize}"%>
 			</div>
 		</fieldset>
 	</form>

data/config/initializers/mime_types.rb

@@ -1,3 +1,9 @@
 Mime::Type.register "application/x-url", :openurl
 Mime::Type.register "text/plain", :csf
-Mime::Type.register "application/json", :easybib
+Mime::Type.register "application/json", :easybib
+Mime::Type.register "text/plain", :refworks_tagged
+Mime::Type.register "application/json", :csl
+
+Mime::Type.register "text/html", :apa
+Mime::Type.register "text/html", :mla
+Mime::Type.register "text/html", :chicago_author_date

data/lib/ex_cite/core_ext.rb

@@ -10,23 +10,12 @@ String.class_eval do
   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}
+  def join_and_enclose seperator, *args
+    left_end = (args[0] or "")
+    right_end = (args[1] or left_end)
+    left_end + self.join(seperator) + right_end
   end
 end

data/lib/ex_cite/engine.rb

@@ -4,6 +4,7 @@ require "acts_as_citable"
 module ExCite
   mattr_accessor :acts_as_citable_class
   mattr_accessor :push_formats
+  mattr_accessor :endnote, :easybib, :refworks
   def self.acts_as_citable_class
     @@acts_as_citable_class.constantize
   end
@@ -12,33 +13,18 @@ module ExCite
     isolate_namespace ExCite
     engine_name "ex_cite"
     ExCite.acts_as_citable_class = "ExCite::Citation"
-  end
-  
-  def self.config &block
-    if block
-      yield self
+    config.before_initialize do
+      ExCite.easybib ||= PushFormat.new( :name => :easybibpush, :to_format => :easybib, :url => "http://www.easybib.com/cite/bulk")
+      ExCite.endnote ||= PushFormat.new :name => :endnote, :to_format => :ris, :action => :redirect, :url => 'http://www.myendnoteweb.com/?func=directExport&partnerName=Primo&dataIdentifier=1&dataRequestUrl='
+      ExCite.refworks ||= PushFormat.new( :name => :refworks, :to_format => :refworks_tagged, :element_name=> 'ImportData', :url => "http://www.refworks.com/express/ExpressImport.asp?vendor=Primo&filter=RefWorks%20Tagged%20Format&encoding=65001")
+      formats = Hash[ExCite.easybib.name => ExCite.easybib, ExCite.endnote.name => ExCite.endnote, ExCite.refworks.name => ExCite.refworks]
+      ExCite.push_formats = formats
     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]
+
+  ActiveSupport.on_load(:after_initialize) do
+    ActiveRecord::Base.class_eval do
+      include ResourceKey
+    end
   end
 end

data/lib/ex_cite/version.rb

@@ -1,3 +1,3 @@
 module ExCite
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end