summon-refworks 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.rvmrc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in summon-refworks.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Charles Lowell
+
+MIT License
+
+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,42 @@
+# Summon::Refworks
+
+This provides an extension to the summon gem to convert summon documents
+to [refworks tagged format][1]
+
+It does this by implementing a single `to_refworks` method, which returns
+a hash containing refworks tags as keys corresponding to field values.
+
+### Basic Usage
+
+```ruby
+require 'summon/refworks'
+document = summon.search('shakespeare').first
+document.to_refworks #=> {:RT => ['Play'], :T1 => ['Romeo and Juliet'], ...}
+```
+
+### Advanced Usage
+
+If you want to override the default mappings, you can do so by passing
+in a hash of options to the `to_refworks` method where the keys are the
+refworks tag names, and the values are either a value, a symbol or a proc
+
+
+## Mappings
+
+Content type mappings can be found in `lib/summon/refworks/RT.yaml`
+
+Other field mappings are found in `lib/summon/refworks/mappings.rb`
+
+## Installation
+
+summon-refworks requires ruby > 1.9.2
+
+Gemfile
+
+    gem 'summon-refworks'
+
+standalone
+
+    gem install summon-refworks
+
+[1]: http://www.refworks.com/rwathens/help/RefWorks_Tagged_Format.htm

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["--colour","--format documentation"]
+end
+
+task :default => :spec

data/lib/summon/RT.yaml

@@ -0,0 +1,163 @@
+# This file is a mapping of Summon content types to
+# corresponding Refworks 'reference types'. If a
+# mapping is not found, or is left blank, then
+# the 'Generic reference type will be used.
+# see http://www.refworks.com/rwathens/help/RefWorks_Tagged_Format.htm
+# for a complete listing of reference types.
+
+# "newspaper article"         => "Newspaper Article",
+# "journal article"           => "Journal Article",
+# "dissertation"              => 'Dissertation/Thesis',
+# "book"                      => "Book, Whole",
+# "patent"                    => "Patent",
+# "conference proceeding"     => "Conference Proceedings",
+# "report"                    => "Report",
+# "ebook"                     => "Book, Whole",
+# "book chapter"              => "Book, Section",
+# "journal"                   => "Journal, Electronic",
+# "ejournal"                  => "Journal, Electronic",
+# "map"                       => "Map",
+# "music score"               => "Music Score",
+# "video recording"           => 'Video/DVD',
+# "computer file"             => "Computer Program",
+# "photograph"                => "Artwork",
+# "audio recording"           => "Sound Recording",
+# "image"                     => "Artwork",
+# "poster"                    => "Artwork",
+# "paper"                     => "Report",
+# "government document"       => "Report",
+# "manuscript"                => "Book, Whole",
+# "musical score"             => "Music Score",
+# "trade publication article" => "Journal, Electronic",
+# "trade publication"         => "Journal, Electronic",
+# "magazine"                  => "Journal, Electronic"
+
+
+Album:
+Architectural Drawing:
+Archival Material:
+Art: Artwork
+Artifact:
+Atlas:
+Audio Recording: Sound Recording
+Audio Tape:
+Blueprints:
+Book: Book, Whole
+Book Chapter: Book, Section
+Book Review:
+Case:
+Catalog:
+Ceremonial Object:
+Citation:
+Clothing:
+Compact Disc:
+Computer File: Computer Program
+Course Reading:
+Conference Proceeding: Conference Proceedings
+Data Set:
+Database:
+Dissertation: Dissertation/Thesis
+Drawing:
+DVD: Video/ DVD
+eBook: Book, Whole
+eJournal: Journal, Electronic
+Electronic Resource:
+Equipment:
+Exam:
+Film:
+Film Script:
+Filmstrip:
+Finding Aid:
+Furnishing:
+Globe:
+Government Document: Report
+Graphic Arts:
+Houseware:
+Ignored:
+Image: Artwork
+Implements:
+Interactive Media:
+Journal: Journal, Electronic
+Journal Article: Journal Article
+Kit:
+Library Holding:
+Magazine: Journal, Electronic
+Magazine Article:
+Manuscript: Book, Whole
+Map: Map
+Market Research:
+Microfilm:
+Microform:
+Model:
+Music Manuscript:
+Music Score: Music Score
+Music Recording:
+Musical Instrument:
+Newsletter:
+Newspaper:
+Newspaper Article: Newspaper Article
+Painting:
+Pamphlet:
+Paper: Report
+Patent: Patent
+Personal Article:
+Personal Narrative:
+Photograph: Artwork
+Poem:
+Postcard:
+Poster: Artwork
+Play:
+Presentation:
+Publication:
+Publication Article:
+Realia:
+Reference:
+Report: Report
+Research Guide:
+Sheet Music:
+Slide:
+Special Collection:
+Spoken Word Recording:
+Standard:
+Streaming Audio:
+Streaming Video:
+Technical Report:
+Tool:
+Trade Publication: Journal, Electronic
+Trade Publication Article: Journal, Electronic
+Transcript:
+Unknown:
+Video Recording: Video/DVD
+Web Resource:
+Archival Material/Manuscripts:
+Audio-visual:
+CD/DVD:
+Digital Collection:
+Learning Object:
+Library Research Guide:
+Online Archival Material:
+Online Audio Recording:
+Online Dissertation:
+Online Image:
+Online Map:
+Online Music Score: Music Score
+Online Video Recording:
+Performance:
+Research Publication:
+Streaming Audio:
+Streaming Video:
+Student Thesis:
+Article:
+Serial:
+Video Cassette:
+Video DVD:
+Music CD:
+Music LP:
+Music:
+Audio Book on Cassette:
+Audio Book on CD:
+Sound Recording:
+Maps and Atlases:
+Software:
+Text:
+Mixed:

data/lib/summon/mappings.rb

@@ -0,0 +1,78 @@
+#These are the mappings from which
+#refworks will draw its tags. On the left is the refworks tag
+#on the right an expression which will yield that value given
+#a summon document.
+
+#This is an exhaustive list of refworks fields according to:
+#http://www.refworks.com/rwathens/help/RefWorks_Tagged_Format.htm
+#so some mappings are inevitably going to be blank.
+
+{
+  RT: ->() { content_type_to_reference_type }, #Reference Type
+  SR: blank, #Source Type (field is either Print(0) or  Electronic(1) )
+  ID: blank, #Reference Identifier
+  A1: ->() { authors.map(&:name) + corporate_authors.map(&:name) }, #Primary Authors
+  T1: ->() { subtitle ? "#{title}: #{subtitle}" : title},   #Primary Title
+  JF: ->() { publication_title }, #Periodical Full
+  JO: blank, #Periodical Abbrev
+  YR: ->() { publication_date.year.to_s }, #Publication Year
+  FD: blank, #Publication Data, Free Form
+  VO: ->() { volume }, #Volume
+  IS: ->() { issue }, #Issue
+  SP: ->() { start_page }, #Start Page
+  OP: ->() { end_page }, #Other Pages
+  K1: ->() { subject_terms.tag_per_value }, #Keyword
+  AB: ->() { abstract }, #Abstract
+  NO: ->() { isi_cited_references_count ? uri : url }, #Notes
+  A2: blank, #Secondary Authors
+  T2: blank, #Secondary Title
+  ED: blank, #Edition
+  PB: ->() { publisher }, #Publisher
+  PP: ->() { publication_place }, #Place of Publication
+  A3: blank, #Tertiary Authors
+  A4: blank, #Quaternary Authors
+  A5: blank, #Quinary Authors
+  T3: blank, #Tertiary Title
+  SN: ->() { issns.empty? ? isbns : issns }, #ISSN/ISBN
+  AV: blank, #Availability
+  AD: blank, #Author Address
+  AN: blank, #Accession Number
+  LA: ->() { languages }, #Language
+  CL: blank, #Classification
+  SF: blank, #Subfile/Database
+  OT: blank, #Original Foreign Title
+  LK: blank, #Links
+  DO: ->() { doi }, #Digital Object Identifier
+  CN: blank, #Call Number
+  DB: blank, #Database
+  DS: blank, #Data Source
+  IP: blank, #Identifying Phrase
+  RD: blank, #Retrieved Date
+  ST: blank, #Shortened Title
+  U1: blank, #User 1
+  U2: blank, #User 2
+  U3: blank, #User 3
+  U4: blank, #User 4
+  U5: ->() { [thumbnail_small, thumbnail_medium, thumbnail_large] if thumbnail_large}, #User 5
+  U6: ->() { open_url }, #User 6
+  U7: ->() { content_type }, #User 7
+  U8: blank, #User 8
+  U9: blank, #User 9
+  U10: blank, #User 10
+  U11: blank, #User 11
+  U12: blank, #User 12
+  U13: blank, #User 13
+  U14: blank, #User 14
+  U15: blank, #User 15
+  UL: ->() { link }, #URL
+  SL: blank, #Sponsoring Library
+  LL: blank, #Sponsoring Library Location
+  CR: blank, #Cited References
+  WT: blank, #Website Title
+  A6: blank, #Website editors
+  WV: blank, #Website version
+  WP: blank, #Date of Electronic Publication
+  OL: blank, #Output Language (see codes for specific languages below)
+  PMID: blank, #PMID
+  PMCID: blank, #PMCID
+}

data/lib/summon/refworks.rb

@@ -0,0 +1,72 @@
+require 'yaml'
+require 'summon'
+require "summon/refworks/version"
+module Summon
+  module Refworks
+    def to_refworks(options = {})
+      Builder.build self, options
+    end
+
+    def to_refworks_text(options = {})
+      buffer = StringIO.new
+      to_refworks(options).each do |key, values|
+        values.each do |value|
+          buffer.puts "#{key} #{value}"
+        end
+      end
+      buffer.string
+    end
+
+    module Builder
+      define_method(:blank) {''}
+
+      def self.build(document, options)
+        document.extend self
+        document.to_refworks_tagged_format options
+      end
+
+      def refworks_tags
+        filename = File.expand_path("../mappings.rb", __FILE__)
+        eval(File.read(filename), binding, filename, 1)
+      end
+
+      def refworks_normal(value)
+        if value.kind_of?(Array)
+          value.tag_per_value? ? value : [value.join(', ')]
+        else
+          [value]
+        end.compact
+      end
+
+      def content_type_to_reference_type
+        mapping = YAML.load(File.read File.expand_path("../RT.yaml", __FILE__))
+        mapping[content_type] || 'Generic'
+      end
+
+      def to_refworks_tagged_format(options)
+        {}.tap do |tags|
+          refworks_tags.merge(options).each do |tag, mapping|
+            tags[tag] = refworks_normal case mapping
+            when Symbol then send(mapping)
+            when Proc then mapping.call()
+            else mapping; end
+          end
+        end
+      end
+    end
+  end
+  class Document
+    include Refworks
+  end
+end
+
+class ::Array
+  def tag_per_value
+    self.tap do
+      @tag_per_value = true
+    end
+  end
+  def tag_per_value?
+    @tag_per_value
+  end
+end

data/lib/summon/refworks/version.rb

@@ -0,0 +1,5 @@
+module Summon
+  module Refworks
+    VERSION = "0.0.1"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'summon/refworks'
+require 'summon/transport/canned'

data/spec/summon/.rbx/c0/c09f9c2f95e2fad53664b38f979c18e2786d8f58

@@ -0,0 +1,241 @@
+!RBIX
+2074804382012766664
+18
+M
+1
+n
+n
+x
+10
+__script__
+i
+24
+5
+7
+0
+64
+47
+49
+1
+1
+15
+5
+45
+2
+3
+43
+4
+56
+5
+47
+50
+6
+1
+15
+2
+11
+I
+3
+I
+0
+I
+0
+I
+0
+I
+0
+n
+p
+7
+s
+E
+0
+
+11
+spec_helper
+x
+7
+require
+x
+6
+Summon
+n
+x
+8
+Refworks
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+11
+5
+7
+0
+64
+56
+1
+47
+50
+2
+1
+11
+I
+4
+I
+0
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+3
+s
+E
+0
+
+23
+extends summon document
+M
+1
+p
+2
+x
+9
+for_block
+t
+n
+x
+9
+__block__
+i
+32
+45
+0
+1
+43
+2
+13
+71
+3
+47
+9
+23
+47
+49
+4
+0
+13
+47
+49
+5
+0
+15
+8
+26
+49
+3
+0
+49
+6
+0
+19
+0
+11
+I
+4
+I
+1
+I
+0
+I
+0
+I
+0
+I
+-2
+p
+7
+x
+6
+Summon
+n
+x
+6
+Canned
+x
+3
+new
+x
+8
+allocate
+x
+10
+initialize
+x
+6
+search
+p
+3
+I
+0
+I
+5
+I
+20
+x
+75
+/Users/cowboyd/Projects/Sersol/summon-refworks/spec/summon/refworks_spec.rb
+p
+1
+x
+8
+document
+x
+2
+it
+p
+3
+I
+0
+I
+4
+I
+b
+x
+75
+/Users/cowboyd/Projects/Sersol/summon-refworks/spec/summon/refworks_spec.rb
+p
+0
+x
+8
+describe
+p
+5
+I
+0
+I
+1
+I
+9
+I
+3
+I
+18
+x
+75
+/Users/cowboyd/Projects/Sersol/summon-refworks/spec/summon/refworks_spec.rb
+p
+0

data/spec/summon/refworks_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Summon::Refworks do
+  before do
+    @search = Summon::Service.new(:transport => Summon::Transport::Canned.new).search
+    @doc = @search.documents.first
+  end
+  it "extends summon document" do
+    @doc.to_refworks.should include(:RT => ["Newspaper Article"])
+  end
+  it "uses the 'Generic' for RT if no mapping is present" do
+    @doc.stub(:content_type) {"Opaque"}
+    @doc.to_refworks[:RT].should eql ['Generic']
+  end
+
+  describe "controlling how multiple values are concatenated" do
+    before do
+      @doc.stub(:multi_value) {[1,2,3]}
+    end
+
+    it "joins multiple values with ', ' by default" do
+      @doc.to_refworks(:multi_value => lambda {@doc.multi_value})[:multi_value].should eql ["1, 2, 3"]
+    end
+
+    it "accepts the option to preseve multiple values per field" do
+      @doc.to_refworks(:multi_value => lambda {@doc.multi_value.tag_per_value})[:multi_value].should eql [1,2,3]
+    end
+  end
+end

data/summon-refworks.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/summon/refworks/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Serials Solutions, Inc."]
+  gem.email         = ["summon@serialssolutions.com"]
+  gem.description   = %q{convert summon documents to refworks tagged format}
+  gem.summary       = %q{Summon has a schema, so does Refworks. this handy tool lets you go from one to the other}
+  gem.homepage      = "https://github.com/summon/summon-refworks.rb"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "summon-refworks"
+  gem.require_paths = ["lib"]
+  gem.version       = Summon::Refworks::VERSION
+
+  gem.add_dependency 'summon', '~> 2.0.0'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: summon-refworks
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Serials Solutions, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: summon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: convert summon documents to refworks tagged format
+email:
+- summon@serialssolutions.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/summon/RT.yaml
+- lib/summon/mappings.rb
+- lib/summon/refworks.rb
+- lib/summon/refworks/version.rb
+- spec/spec_helper.rb
+- spec/summon/.rbx/c0/c09f9c2f95e2fad53664b38f979c18e2786d8f58
+- spec/summon/refworks_spec.rb
+- summon-refworks.gemspec
+homepage: https://github.com/summon/summon-refworks.rb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Summon has a schema, so does Refworks. this handy tool lets you go from one
+  to the other
+test_files:
+- spec/spec_helper.rb
+- spec/summon/.rbx/c0/c09f9c2f95e2fad53664b38f979c18e2786d8f58
+- spec/summon/refworks_spec.rb