paperclip-fedora 0.1.0 → 0.2.0

data/README.md

@@ -5,10 +5,36 @@ Paperclip-Fedora uses Rubydora to extend the storage options of Paperclip to use
 
 ## Installation
 
-TODO: Tell how to install this thing!
+To use, require the gem in your Gemfile:
 
-## Copyright
+`gem 'paperclip-fedora'`
 
-Copyright (c) 2011 Jared Sartin. See LICENSE for
-further details.
+To specify Fedora Commons as your storage location, add the storage option to your
+has_attachment:
 
+`has_attached_file :content, :storage => :Fedora`
+
+For server connection options, you should have a file titled paperclip_fedora.yml in your
+/config folder. There is a nifty rake task to put the yaml file there for you:
+
+`rake paperclip:fedora:setup`
+
+After that, go edit the yaml file with your server settings per rails environment (They default to a server on the localhost).
+
+## Overview
+
+The Fedora Commons storage has very complex ways of connecting data. Currently in
+paperclip-fedora there is no support for complex relationships. The upload creates
+a data object with a datastream per style (such as thumbnails, image sizes, or
+other that you specify), as well as the original upload.
+
+## Todo
+
+The object and datastream labels are currently static and not too pretty. Plans to 
+make the object label the original filename and the datastreams follow a similar pattern.
+
+## Copyright & Acknowledgements
+
+Using Paperclip: https://github.com/thoughtbot/paperclip
+
+Using Rubydora: https://github.com/cbeer/rubydora

data/Rakefile

@@ -1 +1,3 @@
-require "bundler/gem_tasks"
+require 'bundler'
+
+Bundler::GemHelper.install_tasks

data/lib/paperclip-fedora/railtie.rb

@@ -0,0 +1,11 @@
+module Paperclip
+  module Storage
+    module Fedora
+      class Railtie < Rails::Railtie
+        rake_tasks do
+          require "paperclip-fedora/rake"
+        end
+      end
+    end
+  end
+end

data/lib/paperclip-fedora/rake.rb

@@ -0,0 +1,8 @@
+namespace :paperclip do
+  namespace :fedora do
+    desc "Copy the default configuration to the config folder"
+    task :setup => [:environment] do
+      Paperclip::Storage::Fedora.setup!
+    end
+  end
+end

data/lib/paperclip-fedora/version.rb

@@ -1,5 +1,5 @@
 module Paperclip
   module Fedora
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/paperclip-fedora.rb

@@ -1,13 +1,16 @@
 require "paperclip-fedora/version"
+require "paperclip-fedora/railtie" if Rails.version >= "3.0"
+require "FileUtils" unless defined?(FileUtils)
 
 module Paperclip
   module Storage
     module Fedora
+      extend self
       def self.extended(base)
         require 'rubydora'
         base.instance_eval do
           if(!@options[:fedora_config])
-            @options[:fedora_config] = Rails.root.to_s + "/config/paperclip_fedora.yml"
+            @options[:fedora_config] = config_file
           end
 
           @fedora_config = parse_config(@options[:fedora_config])
@@ -38,7 +41,7 @@ module Paperclip
           ds.file = file
           ds.dsLabel = "TempFile"
           ds.save
-          log("Added #{style} to #{@object_id}")
+          log("Added #{style} datastream to #{@object_id}")
         end
         @queued_for_write = {}
       end
@@ -75,6 +78,18 @@ module Paperclip
         (config[Rails.env] || config).symbolize_keys
       end
 
+      def setup!
+        FileUtils.cp(File.dirname(__FILE__) + "/../config/paperclip_fedora.yml", config_file) unless config?
+      end
+
+      def config_file
+        Rails.root.join("config", "paperclip_fedora.yml").to_s
+      end
+      
+      def config?
+        File.file? config_file
+      end
+
       private
 
       def find_credentials config

data/paperclip-fedora.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_runtime_dependency "paperclip"
-  s.add_runtime_dependency "rubydora"
+  s.add_dependency "paperclip"
+  s.add_dependency "rubydora"
+  s.add_development_dependency "rake", "0.9.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paperclip-fedora
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-14 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paperclip
-  requirement: &2152403360 !ruby/object:Gem::Requirement
+  requirement: &2152442460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152403360
+  version_requirements: *2152442460
 - !ruby/object:Gem::Dependency
   name: rubydora
-  requirement: &2152402940 !ruby/object:Gem::Requirement
+  requirement: &2152441900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2152402940
+  version_requirements: *2152441900
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152441060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *2152441060
 description: Adds Fedora Commons storage support for the Paperclip gem.
 email:
 - jaredsartin@gmail.com
@@ -46,6 +57,8 @@ files:
 - Rakefile
 - config/paperclip_fedora.yml
 - lib/paperclip-fedora.rb
+- lib/paperclip-fedora/railtie.rb
+- lib/paperclip-fedora/rake.rb
 - lib/paperclip-fedora/version.rb
 - paperclip-fedora.gemspec
 homepage: https://github.com/JaredSartin/paperclip-fedora