radiant-page_attachments-extension 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. data/.gitignore +5 -0
  2. data/LICENSE +20 -0
  3. data/README.md +129 -0
  4. data/Rakefile +57 -0
  5. data/VERSION +1 -0
  6. data/app/models/observe_page_attachments.rb +5 -0
  7. data/app/models/page_attachment.rb +28 -0
  8. data/app/models/page_attachment_associations.rb +20 -0
  9. data/app/models/page_attachment_tags.rb +261 -0
  10. data/app/models/page_attachments_interface.rb +19 -0
  11. data/app/views/admin/pages/_attachment.html.haml +12 -0
  12. data/app/views/admin/pages/_attachments_box.html.haml +12 -0
  13. data/db/migrate/001_create_page_attachments_extension_schema.rb +22 -0
  14. data/db/migrate/002_add_page_attachments_fields.rb +23 -0
  15. data/features/attachments.feature +42 -0
  16. data/features/step_definitions/attachment_steps.rb +61 -0
  17. data/features/support/env.rb +57 -0
  18. data/features/support/paths.rb +14 -0
  19. data/lib/difference_test_helper.rb +20 -0
  20. data/lib/radiant-page_attachments-extension.rb +0 -0
  21. data/lib/tasks/page_attachments_extension_tasks.rake +28 -0
  22. data/page_attachments_extension.rb +27 -0
  23. data/public/images/admin/drag_order.png +0 -0
  24. data/public/javascripts/admin/page_attachments.js +30 -0
  25. data/public/stylesheets/admin/page_attachments.css +133 -0
  26. data/radiant-page_attachments-extension.gemspec +139 -0
  27. data/spec/controllers/pages_controller_spec.rb +10 -0
  28. data/spec/datasets/page_attachments_dataset.rb +31 -0
  29. data/spec/fixtures/foo.txt +1 -0
  30. data/spec/fixtures/rails.png +0 -0
  31. data/spec/models/observe_page_attachments_spec.rb +14 -0
  32. data/spec/models/page_attachment_spec.rb +18 -0
  33. data/spec/models/page_attachment_tags_spec.rb +172 -0
  34. data/spec/models/page_spec.rb +32 -0
  35. data/spec/spec.opts +6 -0
  36. data/spec/spec_helper.rb +39 -0
  37. data/vendor/plugins/acts_as_list/README +23 -0
  38. data/vendor/plugins/acts_as_list/init.rb +3 -0
  39. data/vendor/plugins/acts_as_list/lib/active_record/acts/list.rb +256 -0
  40. data/vendor/plugins/acts_as_list/test/list_test.rb +332 -0
  41. data/vendor/plugins/attachment_fu/CHANGELOG +35 -0
  42. data/vendor/plugins/attachment_fu/LICENSE +20 -0
  43. data/vendor/plugins/attachment_fu/README +193 -0
  44. data/vendor/plugins/attachment_fu/Rakefile +22 -0
  45. data/vendor/plugins/attachment_fu/amazon_s3.yml.tpl +17 -0
  46. data/vendor/plugins/attachment_fu/init.rb +16 -0
  47. data/vendor/plugins/attachment_fu/install.rb +7 -0
  48. data/vendor/plugins/attachment_fu/lib/geometry.rb +93 -0
  49. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/cloud_file_backend.rb +211 -0
  50. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/db_file_backend.rb +39 -0
  51. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/file_system_backend.rb +126 -0
  52. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/s3_backend.rb +394 -0
  53. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/core_image_processor.rb +59 -0
  54. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/gd2_processor.rb +54 -0
  55. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/image_science_processor.rb +61 -0
  56. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/mini_magick_processor.rb +132 -0
  57. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/processors/rmagick_processor.rb +57 -0
  58. data/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu.rb +514 -0
  59. data/vendor/plugins/attachment_fu/rackspace_cloudfiles.yml.tpl +14 -0
  60. data/vendor/plugins/attachment_fu/test/backends/db_file_test.rb +16 -0
  61. data/vendor/plugins/attachment_fu/test/backends/file_system_test.rb +143 -0
  62. data/vendor/plugins/attachment_fu/test/backends/remote/cloudfiles_test.rb +102 -0
  63. data/vendor/plugins/attachment_fu/test/backends/remote/s3_test.rb +119 -0
  64. data/vendor/plugins/attachment_fu/test/base_attachment_tests.rb +77 -0
  65. data/vendor/plugins/attachment_fu/test/basic_test.rb +70 -0
  66. data/vendor/plugins/attachment_fu/test/database.yml +18 -0
  67. data/vendor/plugins/attachment_fu/test/extra_attachment_test.rb +67 -0
  68. data/vendor/plugins/attachment_fu/test/fixtures/attachment.rb +226 -0
  69. data/vendor/plugins/attachment_fu/test/fixtures/files/fake/rails.png +0 -0
  70. data/vendor/plugins/attachment_fu/test/fixtures/files/foo.txt +1 -0
  71. data/vendor/plugins/attachment_fu/test/fixtures/files/rails.png +0 -0
  72. data/vendor/plugins/attachment_fu/test/geometry_test.rb +108 -0
  73. data/vendor/plugins/attachment_fu/test/processors/core_image_test.rb +37 -0
  74. data/vendor/plugins/attachment_fu/test/processors/gd2_test.rb +31 -0
  75. data/vendor/plugins/attachment_fu/test/processors/image_science_test.rb +31 -0
  76. data/vendor/plugins/attachment_fu/test/processors/mini_magick_test.rb +103 -0
  77. data/vendor/plugins/attachment_fu/test/processors/rmagick_test.rb +255 -0
  78. data/vendor/plugins/attachment_fu/test/schema.rb +134 -0
  79. data/vendor/plugins/attachment_fu/test/test_helper.rb +150 -0
  80. data/vendor/plugins/attachment_fu/test/validation_test.rb +55 -0
  81. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/color.rb +27 -0
  82. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/effects.rb +31 -0
  83. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/perspective.rb +25 -0
  84. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/quality.rb +25 -0
  85. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/scale.rb +47 -0
  86. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/filters/watermark.rb +32 -0
  87. data/vendor/plugins/attachment_fu/vendor/red_artisan/core_image/processor.rb +123 -0
  88. metadata +178 -0
@@ -0,0 +1,35 @@
1
+ * Apr 17 2008 *
2
+ * amazon_s3.yml is now passed through ERB before being passed to AWS::S3 [François Beausoleil]
3
+
4
+ * Mar 22 2008 *
5
+ * Some tweaks to support Rails 2.0 and Rails 2.1 due to ActiveSupport::Callback changes.
6
+ Thanks to http://blog.methodmissing.com/2008/1/19/edge-callback-refactorings-attachment_fu/
7
+
8
+ * Feb. 26, 2008 *
9
+ * remove breakpoint from test_helper, makes test suite crazy (at least Rails 2+) [Rob Sanheim]
10
+ * make S3 test really optional [Rob Sanheim]
11
+
12
+ * Nov 27, 2007 *
13
+ * Handle properly ImageScience thumbnails resized from a gif file [Matt Aimonetti]
14
+ * Save thumbnails file size properly when using ImageScience [Matt Aimonetti]
15
+ * fixed s3 config file loading with latest versions of Rails [Matt Aimonetti]
16
+
17
+ * April 2, 2007 *
18
+
19
+ * don't copy the #full_filename to the default #temp_paths array if it doesn't exist
20
+ * add default ID partitioning for attachments
21
+ * add #binmode call to Tempfile (note: ruby should be doing this!) [Eric Beland]
22
+ * Check for current type of :thumbnails option.
23
+ * allow customization of the S3 configuration file path with the :s3_config_path option.
24
+ * Don't try to remove thumbnails if there aren't any. Closes #3 [ben stiglitz]
25
+
26
+ * BC * (before changelog)
27
+
28
+ * add default #temp_paths entry [mattly]
29
+ * add MiniMagick support to attachment_fu [Isacc]
30
+ * update #destroy_file to clear out any empty directories too [carlivar]
31
+ * fix references to S3Backend module [Hunter Hillegas]
32
+ * make #current_data public with db_file and s3 backends [ebryn]
33
+ * oops, actually svn add the files for s3 backend. [Jeffrey Hardy]
34
+ * experimental s3 support, egad, no tests.... [Jeffrey Hardy]
35
+ * doh, fix a few bad references to ActsAsAttachment [sixty4bit]
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 rick olson
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,193 @@
1
+ attachment-fu
2
+ =============
3
+
4
+ attachment_fu is a plugin by Rick Olson (aka technoweenie <http://techno-weenie.net>) and is the successor to acts_as_attachment. To get a basic run-through of its capabilities, check out Mike Clark's tutorial <http://clarkware.com/cgi/blosxom/2007/02/24#FileUploadFu>.
5
+
6
+
7
+ attachment_fu functionality
8
+ ===========================
9
+
10
+ attachment_fu facilitates file uploads in Ruby on Rails. There are a few storage options for the actual file data, but the plugin always at a minimum stores metadata for each file in the database.
11
+
12
+ There are four storage options for files uploaded through attachment_fu:
13
+ File system
14
+ Database file
15
+ Amazon S3
16
+ Rackspace (Mosso) Cloud Files
17
+
18
+ Each method of storage many options associated with it that will be covered in the following section. Something to note, however, is that the Amazon S3 storage requires you to modify config/amazon_s3.yml, the Rackspace Cloud Files storage requires you to modify config/rackspace_cloudfiles.yml, and the Database file storage requires an extra table.
19
+
20
+
21
+ attachment_fu models
22
+ ====================
23
+
24
+ For all three of these storage options a table of metadata is required. This table will contain information about the file (hence the 'meta') and its location. This table has no restrictions on naming, unlike the extra table required for database storage, which must have a table name of db_files (and by convention a model of DbFile).
25
+
26
+ In the model there are two methods made available by this plugins: has_attachment and validates_as_attachment.
27
+
28
+ has_attachment(options = {})
29
+ This method accepts the options in a hash:
30
+ :content_type # Allowed content types.
31
+ # Allows all by default. Use :image to allow all standard image types.
32
+ :min_size # Minimum size allowed.
33
+ # 1 byte is the default.
34
+ :max_size # Maximum size allowed.
35
+ # 1.megabyte is the default.
36
+ :size # Range of sizes allowed.
37
+ # (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
38
+ :resize_to # Used by RMagick to resize images.
39
+ # Pass either an array of width/height, or a geometry string.
40
+ :thumbnails # Specifies a set of thumbnails to generate.
41
+ # This accepts a hash of filename suffixes and RMagick resizing options.
42
+ # This option need only be included if you want thumbnailing.
43
+ :thumbnail_class # Set which model class to use for thumbnails.
44
+ # This current attachment class is used by default.
45
+ :path_prefix # Path to store the uploaded files in.
46
+ # Uses public/#{table_name} by default for the filesystem, and just #{table_name} for the S3 and Cloud Files backend.
47
+ # Setting this sets the :storage to :file_system.
48
+ :partition # Whether to partiton files in directories like /0000/0001/image.jpg. Default is true. Only applicable to the :file_system backend.
49
+ :storage # Specifies the storage system to use..
50
+ # Defaults to :db_file. Options are :file_system, :db_file, :s3, and :cloud_files.
51
+ :cloudfront # If using S3 for storage, this option allows for serving the files via Amazon CloudFront.
52
+ # Defaults to false.
53
+ :processor # Sets the image processor to use for resizing of the attached image.
54
+ # Options include ImageScience, Rmagick, and MiniMagick. Default is whatever is installed.
55
+ :uuid_primary_key # If your model's primary key is a 128-bit UUID in hexadecimal format, then set this to true.
56
+ :association_options # attachment_fu automatically defines associations with thumbnails with has_many and belongs_to. If there are any additional options that you want to pass to these methods, then specify them here.
57
+
58
+
59
+ Examples:
60
+ has_attachment :max_size => 1.kilobyte
61
+ has_attachment :size => 1.megabyte..2.megabytes
62
+ has_attachment :content_type => 'application/pdf'
63
+ has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
64
+ has_attachment :content_type => :image, :resize_to => [50,50]
65
+ has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
66
+ has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
67
+ has_attachment :storage => :file_system, :path_prefix => 'public/files'
68
+ has_attachment :storage => :file_system, :path_prefix => 'public/files',
69
+ :content_type => :image, :resize_to => [50,50], :partition => false
70
+ has_attachment :storage => :file_system, :path_prefix => 'public/files',
71
+ :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
72
+ has_attachment :storage => :s3
73
+ has_attachment :store => :s3, :cloudfront => true
74
+ has_attachment :storage => :cloud_files
75
+
76
+ validates_as_attachment
77
+ This method prevents files outside of the valid range (:min_size to :max_size, or the :size range) from being saved. It does not however, halt the upload of such files. They will be uploaded into memory regardless of size before validation.
78
+
79
+ Example:
80
+ validates_as_attachment
81
+
82
+
83
+ attachment_fu migrations
84
+ ========================
85
+
86
+ Fields for attachment_fu metadata tables...
87
+ in general:
88
+ size, :integer # file size in bytes
89
+ content_type, :string # mime type, ex: application/mp3
90
+ filename, :string # sanitized filename
91
+ that reference images:
92
+ height, :integer # in pixels
93
+ width, :integer # in pixels
94
+ that reference images that will be thumbnailed:
95
+ parent_id, :integer # id of parent image (on the same table, a self-referencing foreign-key).
96
+ # Only populated if the current object is a thumbnail.
97
+ thumbnail, :string # the 'type' of thumbnail this attachment record describes.
98
+ # Only populated if the current object is a thumbnail.
99
+ # Usage:
100
+ # [ In Model 'Avatar' ]
101
+ # has_attachment :content_type => :image,
102
+ # :storage => :file_system,
103
+ # :max_size => 500.kilobytes,
104
+ # :resize_to => '320x200>',
105
+ # :thumbnails => { :small => '10x10>',
106
+ # :thumb => '100x100>' }
107
+ # [ Elsewhere ]
108
+ # @user.avatar.thumbnails.first.thumbnail #=> 'small'
109
+ that reference files stored in the database (:db_file):
110
+ db_file_id, :integer # id of the file in the database (foreign key)
111
+
112
+ Field for attachment_fu db_files table:
113
+ data, :binary # binary file data, for use in database file storage
114
+
115
+
116
+ attachment_fu views
117
+ ===================
118
+
119
+ There are two main views tasks that will be directly affected by attachment_fu: upload forms and displaying uploaded images.
120
+
121
+ There are two parts of the upload form that differ from typical usage.
122
+ 1. Include ':multipart => true' in the html options of the form_for tag.
123
+ Example:
124
+ <% form_for(:attachment_metadata, :url => { :action => "create" }, :html => { :multipart => true }) do |form| %>
125
+
126
+ 2. Use the file_field helper with :uploaded_data as the field name.
127
+ Example:
128
+ <%= form.file_field :uploaded_data %>
129
+
130
+ Displaying uploaded images is made easy by the public_filename method of the ActiveRecord attachment objects using file system, s3, and Cloud Files storage.
131
+
132
+ public_filename(thumbnail = nil)
133
+ Returns the public path to the file. If a thumbnail prefix is specified it will return the public file path to the corresponding thumbnail.
134
+ Examples:
135
+ attachment_obj.public_filename #=> /attachments/2/file.jpg
136
+ attachment_obj.public_filename(:thumb) #=> /attachments/2/file_thumb.jpg
137
+ attachment_obj.public_filename(:small) #=> /attachments/2/file_small.jpg
138
+
139
+ When serving files from database storage, doing more than simply downloading the file is beyond the scope of this document.
140
+
141
+
142
+ attachment_fu controllers
143
+ =========================
144
+
145
+ There are two considerations to take into account when using attachment_fu in controllers.
146
+
147
+ The first is when the files have no publicly accessible path and need to be downloaded through an action.
148
+
149
+ Example:
150
+ def readme
151
+ send_file '/path/to/readme.txt', :type => 'plain/text', :disposition => 'inline'
152
+ end
153
+
154
+ See the possible values for send_file for reference.
155
+
156
+
157
+ The second is when saving the file when submitted from a form.
158
+ Example in view:
159
+ <%= form.file_field :attachable, :uploaded_data %>
160
+
161
+ Example in controller:
162
+ def create
163
+ @attachable_file = AttachmentMetadataModel.new(params[:attachable])
164
+ if @attachable_file.save
165
+ flash[:notice] = 'Attachment was successfully created.'
166
+ redirect_to attachable_url(@attachable_file)
167
+ else
168
+ render :action => :new
169
+ end
170
+ end
171
+
172
+ attachement_fu scripting
173
+ ====================================
174
+
175
+ You may wish to import a large number of images or attachments.
176
+ The following example shows how to upload a file from a script.
177
+
178
+ #!/usr/bin/env ./script/runner
179
+
180
+ # required to use ActionController::TestUploadedFile
181
+ require 'action_controller'
182
+ require 'action_controller/test_process.rb'
183
+
184
+ path = "./public/images/x.jpg"
185
+
186
+ # mimetype is a string like "image/jpeg". One way to get the mimetype for a given file on a UNIX system
187
+ # mimetype = `file -ib #{path}`.gsub(/\n/,"")
188
+
189
+ mimetype = "image/jpeg"
190
+
191
+ # This will "upload" the file at path and create the new model.
192
+ @attachable = AttachmentMetadataModel.new(:uploaded_data => ActionController::TestUploadedFile.new(path, mimetype))
193
+ @attachable.save
@@ -0,0 +1,22 @@
1
+ require 'rake'
2
+ require 'rake/testtask'
3
+ require 'rake/rdoctask'
4
+
5
+ desc 'Default: run unit tests.'
6
+ task :default => :test
7
+
8
+ desc 'Test the attachment_fu plugin.'
9
+ Rake::TestTask.new(:test) do |t|
10
+ t.libs << 'lib'
11
+ t.pattern = 'test/**/*_test.rb'
12
+ t.verbose = true
13
+ end
14
+
15
+ desc 'Generate documentation for the attachment_fu plugin.'
16
+ Rake::RDocTask.new(:rdoc) do |rdoc|
17
+ rdoc.rdoc_dir = 'rdoc'
18
+ rdoc.title = 'ActsAsAttachment'
19
+ rdoc.options << '--line-numbers --inline-source'
20
+ rdoc.rdoc_files.include('README')
21
+ rdoc.rdoc_files.include('lib/**/*.rb')
22
+ end
@@ -0,0 +1,17 @@
1
+ development:
2
+ bucket_name: appname_development
3
+ access_key_id:
4
+ secret_access_key:
5
+ distribution_domain: XXXX.cloudfront.net
6
+
7
+ test:
8
+ bucket_name: appname_test
9
+ access_key_id:
10
+ secret_access_key:
11
+ distribution_domain: XXXX.cloudfront.net
12
+
13
+ production:
14
+ bucket_name: appname
15
+ access_key_id:
16
+ secret_access_key:
17
+ distribution_domain: XXXX.cloudfront.net
@@ -0,0 +1,16 @@
1
+ require 'tempfile'
2
+
3
+ Tempfile.class_eval do
4
+ # overwrite so tempfiles use the extension of the basename. important for rmagick and image science
5
+ def make_tmpname(basename, n)
6
+ ext = nil
7
+ sprintf("%s%d-%d%s", basename.to_s.gsub(/\.\w+$/) { |s| ext = s; '' }, $$, n, ext)
8
+ end
9
+ end
10
+
11
+ require 'geometry'
12
+ ActiveRecord::Base.send(:extend, Technoweenie::AttachmentFu::ActMethods)
13
+ Technoweenie::AttachmentFu.tempfile_path = ATTACHMENT_FU_TEMPFILE_PATH if Object.const_defined?(:ATTACHMENT_FU_TEMPFILE_PATH)
14
+ FileUtils.mkdir_p Technoweenie::AttachmentFu.tempfile_path
15
+
16
+ $:.unshift(File.dirname(__FILE__) + '/vendor')
@@ -0,0 +1,7 @@
1
+ require 'fileutils'
2
+
3
+ s3_config = File.dirname(__FILE__) + '/../../../config/amazon_s3.yml'
4
+ FileUtils.cp File.dirname(__FILE__) + '/amazon_s3.yml.tpl', s3_config unless File.exist?(s3_config)
5
+ cloudfiles_config = File.dirname(__FILE__) + '/../../../config/rackspace_cloudfiles.yml'
6
+ FileUtils.cp File.dirname(__FILE__) + '/rackspace_cloudfiles.yml.tpl', cloudfiles_config unless File.exist?(cloudfiles_config)
7
+ puts IO.read(File.join(File.dirname(__FILE__), 'README'))
@@ -0,0 +1,93 @@
1
+ # This Geometry class was yanked from RMagick. However, it lets ImageMagick handle the actual change_geometry.
2
+ # Use #new_dimensions_for to get new dimensons
3
+ # Used so I can use spiffy RMagick geometry strings with ImageScience
4
+ class Geometry
5
+ # ! and @ are removed until support for them is added
6
+ FLAGS = ['', '%', '<', '>']#, '!', '@']
7
+ RFLAGS = { '%' => :percent,
8
+ '!' => :aspect,
9
+ '<' => :>,
10
+ '>' => :<,
11
+ '@' => :area }
12
+
13
+ attr_accessor :width, :height, :x, :y, :flag
14
+
15
+ def initialize(width=nil, height=nil, x=nil, y=nil, flag=nil)
16
+ # Support floating-point width and height arguments so Geometry
17
+ # objects can be used to specify Image#density= arguments.
18
+ raise ArgumentError, "width must be >= 0: #{width}" if width < 0
19
+ raise ArgumentError, "height must be >= 0: #{height}" if height < 0
20
+ @width = width.to_f
21
+ @height = height.to_f
22
+ @x = x.to_i
23
+ @y = y.to_i
24
+ @flag = flag
25
+ end
26
+
27
+ # Construct an object from a geometry string
28
+ RE = /\A(\d*)(?:x(\d+)?)?([-+]\d+)?([-+]\d+)?([%!<>@]?)\Z/
29
+
30
+ def self.from_s(str)
31
+ raise(ArgumentError, "no geometry string specified") unless str
32
+
33
+ if m = RE.match(str)
34
+ new(m[1].to_i, m[2].to_i, m[3].to_i, m[4].to_i, RFLAGS[m[5]])
35
+ else
36
+ raise ArgumentError, "invalid geometry format"
37
+ end
38
+ end
39
+
40
+ # Convert object to a geometry string
41
+ def to_s
42
+ str = ''
43
+ str << "%g" % @width if @width > 0
44
+ str << 'x' if (@width > 0 || @height > 0)
45
+ str << "%g" % @height if @height > 0
46
+ str << "%+d%+d" % [@x, @y] if (@x != 0 || @y != 0)
47
+ str << FLAGS[@flag.to_i]
48
+ end
49
+
50
+ # attempts to get new dimensions for the current geometry string given these old dimensions.
51
+ # This doesn't implement the aspect flag (!) or the area flag (@). PDI
52
+ def new_dimensions_for(orig_width, orig_height)
53
+ new_width = orig_width
54
+ new_height = orig_height
55
+
56
+ case @flag
57
+ when :percent
58
+ scale_x = @width.zero? ? 100 : @width
59
+ scale_y = @height.zero? ? @width : @height
60
+ new_width = scale_x.to_f * (orig_width.to_f / 100.0)
61
+ new_height = scale_y.to_f * (orig_height.to_f / 100.0)
62
+ when :<, :>, nil
63
+ scale_factor =
64
+ if new_width.zero? || new_height.zero?
65
+ 1.0
66
+ else
67
+ if @width.nonzero? && @height.nonzero?
68
+ [@width.to_f / new_width.to_f, @height.to_f / new_height.to_f].min
69
+ else
70
+ @width.nonzero? ? (@width.to_f / new_width.to_f) : (@height.to_f / new_height.to_f)
71
+ end
72
+ end
73
+ new_width = scale_factor * new_width.to_f
74
+ new_height = scale_factor * new_height.to_f
75
+ new_width = orig_width if @flag && orig_width.send(@flag, new_width)
76
+ new_height = orig_height if @flag && orig_height.send(@flag, new_height)
77
+ end
78
+
79
+ [new_width, new_height].collect! { |v| [v.round, 1].max }
80
+ end
81
+ end
82
+
83
+ class Array
84
+ # allows you to get new dimensions for the current array of dimensions with a given geometry string
85
+ #
86
+ # [50, 64] / '40>' # => [40, 51]
87
+ def /(geometry)
88
+ raise ArgumentError, "Only works with a [width, height] pair" if size != 2
89
+ raise ArgumentError, "Must pass a valid geometry string or object" unless geometry.is_a?(String) || geometry.is_a?(Geometry)
90
+ geometry = Geometry.from_s(geometry) if geometry.is_a?(String)
91
+ geometry.new_dimensions_for first, last
92
+ end
93
+ end
@@ -0,0 +1,211 @@
1
+ module Technoweenie # :nodoc:
2
+ module AttachmentFu # :nodoc:
3
+ module Backends
4
+ # = CloudFiles Storage Backend
5
+ #
6
+ # Enables use of {Rackspace Cloud Files}[http://www.mosso.com/cloudfiles.jsp] as a storage mechanism
7
+ #
8
+ # Based heavily on the Amazon S3 backend.
9
+ #
10
+ # == Requirements
11
+ #
12
+ # Requires the {Cloud Files Gem}[http://www.mosso.com/cloudfiles.jsp] by Rackspace
13
+ #
14
+ # == Configuration
15
+ #
16
+ # Configuration is done via <tt>RAILS_ROOT/config/rackspace_cloudfiles.yml</tt> and is loaded according to the <tt>RAILS_ENV</tt>.
17
+ # The minimum connection options that you must specify are a container name, your Mosso login name and your Mosso API key.
18
+ # You can sign up for Cloud Files and get access keys by visiting https://www.mosso.com/buy.htm
19
+ #
20
+ # Example configuration (RAILS_ROOT/config/rackspace_cloudfiles.yml)
21
+ #
22
+ # development:
23
+ # container_name: appname_development
24
+ # username: <your key>
25
+ # api_key: <your key>
26
+ #
27
+ # test:
28
+ # container_name: appname_test
29
+ # username: <your key>
30
+ # api_key: <your key>
31
+ #
32
+ # production:
33
+ # container_name: appname
34
+ # username: <your key>
35
+ # apik_key: <your key>
36
+ #
37
+ # You can change the location of the config path by passing a full path to the :cloudfiles_config_path option.
38
+ #
39
+ # has_attachment :storage => :cloud_files, :cloudfiles_config_path => (RAILS_ROOT + '/config/mosso.yml')
40
+ #
41
+ # === Required configuration parameters
42
+ #
43
+ # * <tt>:username</tt> - The username for your Rackspace Cloud (Mosso) account. Provided by Rackspace.
44
+ # * <tt>:secret_access_key</tt> - The api key for your Rackspace Cloud account. Provided by Rackspace.
45
+ # * <tt>:container_name</tt> - The name of a container in your Cloud Files account.
46
+ #
47
+ # If any of these required arguments is missing, a AuthenticationException will be raised from CloudFiles::Connection.
48
+ #
49
+ # == Usage
50
+ #
51
+ # To specify Cloud Files as the storage mechanism for a model, set the acts_as_attachment <tt>:storage</tt> option to <tt>:cloud_files/tt>.
52
+ #
53
+ # class Photo < ActiveRecord::Base
54
+ # has_attachment :storage => :cloud_files
55
+ # end
56
+ #
57
+ # === Customizing the path
58
+ #
59
+ # By default, files are prefixed using a pseudo hierarchy in the form of <tt>:table_name/:id</tt>, which results
60
+ # in Cloud Files object names (and urls) that look like: http://:server/:container_name/:table_name/:id/:filename with :table_name
61
+ # representing the customizable portion of the path. You can customize this prefix using the <tt>:path_prefix</tt>
62
+ # option:
63
+ #
64
+ # class Photo < ActiveRecord::Base
65
+ # has_attachment :storage => :cloud_files, :path_prefix => 'my/custom/path'
66
+ # end
67
+ #
68
+ # Which would result in public URLs like <tt>http(s)://:server/:container_name/my/custom/path/:id/:filename.</tt>
69
+ #
70
+ # === Permissions
71
+ #
72
+ # File permisisons are determined by the permissions of the container. At present, the options are public (and distributed
73
+ # by the Limelight CDN), and private (only available to your login)
74
+ #
75
+ # === Other options
76
+ #
77
+ # Of course, all the usual configuration options apply, such as content_type and thumbnails:
78
+ #
79
+ # class Photo < ActiveRecord::Base
80
+ # has_attachment :storage => :cloud_files, :content_type => ['application/pdf', :image], :resize_to => 'x50'
81
+ # has_attachment :storage => :cloud_files, :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
82
+ # end
83
+ #
84
+ # === Accessing Cloud Files URLs
85
+ #
86
+ # You can get an object's public URL using the cloudfiles_url accessor. For example, assuming that for your postcard app
87
+ # you had a container name like 'postcard_world_development', and an attachment model called Photo:
88
+ #
89
+ # @postcard.cloudfiles_url # => http://cdn.cloudfiles.mosso.com/c45182/uploaded_files/20/london.jpg
90
+ #
91
+ # The resulting url is in the form: http://:server/:container_name/:table_name/:id/:file.
92
+ # The optional thumbnail argument will output the thumbnail's filename (if any).
93
+ #
94
+ # Additionally, you can get an object's base path relative to the container root using
95
+ # <tt>base_path</tt>:
96
+ #
97
+ # @photo.file_base_path # => uploaded_files/20
98
+ #
99
+ # And the full path (including the filename) using <tt>full_filename</tt>:
100
+ #
101
+ # @photo.full_filename # => uploaded_files/20/london.jpg
102
+ #
103
+ # Niether <tt>base_path</tt> or <tt>full_filename</tt> include the container name as part of the path.
104
+ # You can retrieve the container name using the <tt>container_name</tt> method.
105
+ module CloudFileBackend
106
+ class RequiredLibraryNotFoundError < StandardError; end
107
+ class ConfigFileNotFoundError < StandardError; end
108
+
109
+ def self.included(base) #:nodoc:
110
+ mattr_reader :container_name, :cloudfiles_config
111
+
112
+ begin
113
+ require 'cloudfiles'
114
+ rescue LoadError
115
+ raise RequiredLibraryNotFoundError.new('CloudFiles could not be loaded')
116
+ end
117
+
118
+ begin
119
+ @@cloudfiles_config_path = base.attachment_options[:cloudfiles_config_path] || (RAILS_ROOT + '/config/rackspace_cloudfiles.yml')
120
+ @@cloudfiles_config = @@cloudfiles_config = YAML.load(ERB.new(File.read(@@cloudfiles_config_path)).result)[RAILS_ENV].symbolize_keys
121
+ rescue
122
+ #raise ConfigFileNotFoundError.new('File %s not found' % @@cloudfiles_config_path)
123
+ end
124
+
125
+ @@container_name = @@cloudfiles_config[:container_name]
126
+ @@cf = CloudFiles::Connection.new(@@cloudfiles_config[:username], @@cloudfiles_config[:api_key])
127
+ @@container = @@cf.container(@@container_name)
128
+
129
+ base.before_update :rename_file
130
+ end
131
+
132
+ # Overwrites the base filename writer in order to store the old filename
133
+ def filename=(value)
134
+ @old_filename = filename unless filename.nil? || @old_filename
135
+ write_attribute :filename, sanitize_filename(value)
136
+ end
137
+
138
+ # The attachment ID used in the full path of a file
139
+ def attachment_path_id
140
+ ((respond_to?(:parent_id) && parent_id) || id).to_s
141
+ end
142
+
143
+ # The pseudo hierarchy containing the file relative to the container name
144
+ # Example: <tt>:table_name/:id</tt>
145
+ def base_path
146
+ File.join(attachment_options[:path_prefix], attachment_path_id)
147
+ end
148
+
149
+ # The full path to the file relative to the container name
150
+ # Example: <tt>:table_name/:id/:filename</tt>
151
+ def full_filename(thumbnail = nil)
152
+ File.join(base_path, thumbnail_name_for(thumbnail))
153
+ end
154
+
155
+ # All public objects are accessible via a GET request to the Cloud Files servers. You can generate a
156
+ # url for an object using the cloudfiles_url method.
157
+ #
158
+ # @photo.cloudfiles_url
159
+ #
160
+ # The resulting url is in the CDN URL for the object
161
+ #
162
+ # The optional thumbnail argument will output the thumbnail's filename (if any).
163
+ #
164
+ # If you are trying to get the URL for a nonpublic container, nil will be returned.
165
+ def cloudfiles_url(thumbnail = nil)
166
+ if @@container.public?
167
+ File.join(@@container.cdn_url, full_filename(thumbnail))
168
+ else
169
+ nil
170
+ end
171
+ end
172
+ alias :public_filename :cloudfiles_url
173
+
174
+ def create_temp_file
175
+ write_to_temp_file current_data
176
+ end
177
+
178
+ def current_data
179
+ @@container.get_object(full_filename).data
180
+ end
181
+
182
+ protected
183
+ # Called in the after_destroy callback
184
+ def destroy_file
185
+ @@container.delete_object(full_filename)
186
+ end
187
+
188
+ def rename_file
189
+ # Cloud Files doesn't rename right now, so we'll just nuke.
190
+ return unless @old_filename && @old_filename != filename
191
+
192
+ old_full_filename = File.join(base_path, @old_filename)
193
+ @@container.delete_object(old_full_filename)
194
+
195
+ @old_filename = nil
196
+ true
197
+ end
198
+
199
+ def save_to_storage
200
+ if save_attachment?
201
+ @object = @@container.create_object(full_filename)
202
+ @object.write((temp_path ? File.open(temp_path) : temp_data))
203
+ end
204
+
205
+ @old_filename = nil
206
+ true
207
+ end
208
+ end
209
+ end
210
+ end
211
+ end