public/engine_files
.DS_Store
vendor/plugins/sitealizer/lib/last_update
+public/pictures
+public/skin_pictures
+public/pictures
+help
+public/pictures/0000
- AFFERO GENERAL PUBLIC LICENSE
- Version 1, March 2002
-
- Copyright © 2002 Affero Inc.
- 510 Third Street - Suite 225, San Francisco, CA 94107, USA
-
-This license is a modified version of the GNU General Public License
-copyright (C) 1989, 1991 Free Software Foundation, Inc. made with their
-permission. Section 2(d) has been added to cover use of software over a
-computer network.
-
-Everyone is permitted to copy and distribute verbatim copies of this
-license document, but changing it is not allowed.
-
- Preamble
-
-The licenses for most software are designed to take away your freedom to
-share and change it. By contrast, the Affero General Public License is
-intended to guarantee your freedom to share and change free software--to
-make sure the software is free for all its users. This Public License
-applies to most of Affero's software and to any other program whose
-authors commit to using it. (Some other Affero software is covered by
-the GNU Library General Public License instead.) You can apply it to
-your programs, too.
-
-When we speak of free software, we are referring to freedom, not price.
-This General Public License is designed to make sure that you have the
-freedom to distribute copies of free software (and charge for this
-service if you wish), that you receive source code or can get it if you
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
-free programs; and that you know you can do these things.
-
-To protect your rights, we need to make restrictions that forbid anyone
-to deny you these rights or to ask you to surrender the rights. These
-restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
-For example, if you distribute copies of such a program, whether gratis
-or for a fee, you must give the recipients all the rights that you have.
-You must make sure that they, too, receive or can get the source code.
-And you must show them these terms so they know their rights.
-
-We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
-Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
-Finally, any free program is threatened constantly by software patents.
-We wish to avoid the danger that redistributors of a free program will
-individually obtain patent licenses, in effect making the program
-proprietary. To prevent this, we have made it clear that any patent must
-be licensed for everyone's free use or not licensed at all.
-
-The precise terms and conditions for copying, distribution and
+free programs, and that you know you can do these things.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
modification follow.
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-0. This License applies to any program or other work which contains a
- notice placed by the copyright holder saying it may be distributed
- under the terms of this Affero General Public License. The "Program",
- below, refers to any such program or work, and a "work based on the
- Program" means either the Program or any derivative work under
- copyright law: that is to say, a work containing the Program or a
- portion of it, either verbatim or with modifications and/or
- translated into another language. (Hereinafter, translation is
- included without limitation in the term "modification".) Each
- licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of running
-the Program is not restricted, and the output from the Program is
-covered only if its contents constitute a work based on the Program
-(independent of having been made by running the Program). Whether that
-is true depends on what the Program does.
-
-1. You may copy and distribute verbatim copies of the Program's source
- code as you receive it, in any medium, provided that you
- conspicuously and appropriately publish on each copy an appropriate
- copyright notice and disclaimer of warranty; keep intact all the
- notices that refer to this License and to the absence of any
- warranty; and give any other recipients of the Program a copy of this
- License along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
-2. You may modify your copy or copies of the Program or any portion of
- it, thus forming a work based on the Program, and copy and distribute
- such modifications or work under the terms of Section 1 above,
- provided that you also meet all of these conditions:
-
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
-
- c) If the modified program normally reads commands interactively when
- run, you must cause it, when started running for such interactive
- use in the most ordinary way, to print or display an announcement
- including an appropriate copyright notice and a notice that there
- is no warranty (or else, saying that you provide a warranty) and
- that users may redistribute the program under these conditions,
- and telling the user how to view a copy of this License.
- (Exception: if the Program itself is interactive but does not
- normally print such an announcement, your work based on the
- Program is not required to print an announcement.)
-
- d) If the Program as you received it is intended to interact with
- users through a computer network and if, in the version you
- received, any user interacting with the Program was given the
- opportunity to request transmission to that user of the Program's
- complete source code, you must not remove that facility from your
- modified version of the Program or work based on the Program, and
- must offer an equivalent opportunity for all users interacting
- with your Program through a computer network to request immediate
- transmission by HTTP of the complete source code of your modified
- version or other derivative work.
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program, and
-can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based on
-the Program, the distribution of the whole must be on the terms of this
-License, whose permissions for other licensees extend to the entire
-whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of a
-storage or distribution medium does not bring the other work under the
-scope of this License.
-
-3. You may copy and distribute the Program (or a work based on it, under
- Section 2) in object code or executable form under the terms of
- Sections 1 and 2 above provided that you also do one of the
- following:
-
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for softpware interchange; or,
-
- b) Accompany it with a written offer, valid for at least three years,
- to give any third party, for a charge no more than your cost of
- physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
-
- c) Accompany it with the information you received as to the offer to
- distribute corresponding source code. (This alternative is allowed
- only for noncommercial distribution and only if you received the
- program in object code or executable form with such an offer, in
- accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source code
-means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to control
-compilation and installation of the executable. However, as a special
-exception, the source code distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies the
-executable.
-
-If distribution of executable or object code is made by offering access
-to copy from a designated place, then offering equivalent access to copy
-the source code from the same place counts as distribution of the source
-code, even though third parties are not compelled to copy the source
-along with the object code.
-
-4. You may not copy, modify, sublicense, or distribute the Program
- except as expressly provided under this License. Any attempt
- otherwise to copy, modify, sublicense or distribute the Program is
- void, and will automatically terminate your rights under this
- License. However, parties who have received copies, or rights, from
- you under this License will not have their licenses terminated so
- long as such parties remain in full compliance.
-
-5. You are not required to accept this License, since you have not
- signed it. However, nothing else grants you permission to modify or
- distribute the Program or its derivative works. These actions are
- prohibited by law if you do not accept this License. Therefore, by
- modifying or distributing the Program (or any work based on the
- Program), you indicate your acceptance of this License to do so, and
- all its terms and conditions for copying, distributing or modifying
- the Program or works based on it.
-
-6. Each time you redistribute the Program (or any work based on the
- Program), the recipient automatically receives a license from the
- original licensor to copy, distribute or modify the Program subject
- to these terms and conditions. You may not impose any further
- restrictions on the recipients' exercise of the rights granted
- herein. You are not responsible for enforcing compliance by third
- parties to this License.
-
-7. If, as a consequence of a court judgment or allegation of patent
- infringement or for any other reason (not limited to patent issues),
- conditions are imposed on you (whether by court order, agreement or
- otherwise) that contradict the conditions of this License, they do
- not excuse you from the conditions of this License. If you cannot
- distribute so as to satisfy simultaneously your obligations under
- this License and any other pertinent obligations, then as a
- consequence you may not distribute the Program at all. For example,
- if a patent license would not permit royalty-free redistribution of
- the Program by all those who receive copies directly or indirectly
- through you, then the only way you could satisfy both it and this
- License would be to refrain entirely from distribution of the
- Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is implemented
-by public license practices. Many people have made generous
-contributions to the wide range of software distributed through that
-system in reliance on consistent application of that system; it is up to
-the author/donor to decide if he or she is willing to distribute
-software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be
-a consequence of the rest of this License.
-
-8. If the distribution and/or use of the Program is restricted in
- certain countries either by patents or by copyrighted interfaces, the
- original copyright holder who places the Program under this License
- may add an explicit geographical distribution limitation excluding
- those countries, so that distribution is permitted only in or among
- countries not thus excluded. In such case, this License incorporates
- the limitation as if written in the body of this License.
-
-9. Affero Inc. may publish revised and/or new versions of the Affero
- General Public License from time to time. Such new versions will be
- similar in spirit to the present version, but may differ in detail to
- address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-Affero, Inc. If the Program does not specify a version number of this
-License, you may choose any version ever published by Affero, Inc.
-
-You may also choose to redistribute modified versions of this program
-under any version of the Free Software Foundation's GNU General Public
-License version 3 or higher, so long as that version of the GNU GPL
-includes terms and conditions substantially equivalent to those of this
-license.
-
-10. If you wish to incorporate parts of the Program into other free
- programs whose distribution conditions are different, write to the
- author to ask for permission. For software which is copyrighted by
- Affero, Inc., write to us; we sometimes make exceptions for this.
- Our decision will be guided by the two goals of preserving the free
- status of all derivatives of our free software and of promoting the
- sharing and reuse of software generally.
-
- NO WARRANTY
-
-11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
- FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT
- WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
- PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND,
- EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
- PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
- PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
- THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
- WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
- AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
- FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
- CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
- PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
- RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
- FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
- SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
- SUCH DAMAGES.
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<http://www.gnu.org/licenses/>.
-Known bugs or issues:
+General Issues
+==================
+
+- check out about css for headers on documentation/Selectricity anywher\12
-- randomize each voting list
+Known bugs or issues:
- it'd be nice if the ordering were persistent, so I could drag
the candidates around, then come back later (loading the page anew),
if it were aware that it's a five-seat election and could say
explicitly who the whole board is.
-- it's probably a good thing that users can't check out what alternate
- voting systems would have done at the click of a button. =)
- (though of course they could work it out themselves.)
-
- is there rhyme or reason to the ordering within each row of the
second table in pref_tables? it could be, eg, sorted by magnitude
of victory, narrowest first.
helpful for auditing, too, as one could separately match names to the
correct list and match addresses to names.)
-- just a tiny suggestion - possibly it could be a good idea to add a
- counter/line-count to the table with keys and vote results so in one
- glance someone can see that the number of votes matches the number of
- voters.
+QuickVotes
+==============
+
+- support for emailing users when quickvotes conclude (see create.rhtml)
+- support for invisible results until over quickvotes (see create.rhtml)
+- quickvotes should have automatically created urls
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class QuickVoteStruct < ActionWebService::Struct
member :name, :string
member :description, :string
member :candidate_names, [:string]
member :id, :int
end
+
class QuickVoterInfo < ActionWebService::Struct
member :voter_id, :int
member :voter_session_id, :string
member :ssd_winners, [:int]
member :borda_winners, [:int]
end
+
+
class QuickVoteCandidateMap < ActionWebService::Struct
member :candidate_ids, [:int]
member :candidate_names, [:string]
end
-## An API for interfacing with Selectricity
-## This allows for things like XML-RPC to have a unified interface
-## The implementation is elsewhere.
+# An API for interfacing with Selectricity
+# This allows for things like XML-RPC to have a unified interface
+# The implementation is elsewhere.
+
class SelectricityAPI < ActionWebService::API::Base
- ## Casts a quickvote.
- ## Expects a quickvote name, a voter ID, and a list of candidate ID's respectively.
- ## Returns a string containing any potential errors that occurred in the process.
- api_method :cast_quickvote, :expects => [:string, :int, [[:int]]], :returns => [:string]
- ## Return the results of a QuickVote.
- ## Takes in the name of a quickvote, and returns a structure as described by
- ## QuickVoteResultStruct
- api_method :get_quickvote_results, :expects => [:string], :returns => [QuickVoteResultStruct]
- ## Returns information regarding all the candidates in a QuickVote
- ## Takes in a QuickVote name, and returns the list of names and ID's of candidates
- ## This can be useful for presenting the user with a list of readable names, while
- ## the software sends results to us in the numeric ID's we require. The two lists are in
- ## respective order.
- api_method :get_quickvote_candidate_map, :expects => [:string], :returns => [QuickVoteCandidateMap]
- ## Converts QuickVote candidate ID's to names
- ## Takes in a QuickVote name and a list of candidate ID's, and returns the names of
- ## each candidate. Useful for doing just a few lookups; it's more efficient to use
- ## get_quickvote_candidate_map for presenting info about an entire election.
- api_method :quickvote_candidate_ids_to_names, :expects => [:string,[:int]], :returns => [[:string]]
- ## Get information on all the votes cast in a QuickVote
- ## Takes in the name of a QuickVote, returns an array of QuickVoterInfo structures.
- api_method :get_quickvote_votes, :expects => [:string], :returns => [ [QuickVoterInfo] ]
- ## Gets a list of all QuickVotes in the system.
- api_method :list_quickvotes, :expects => [], :returns => [[QuickVoteStruct]]
- ## Gets information on a particular QuickVote
- ## Takes in a QuickVote name
- api_method :get_quickvote, :expects => [:string], :returns => [QuickVoteStruct]
- ## Create a QuickVote
- ## Pass in a QuickVoteStruct populated with all the fields but the candidate ID's
- api_method :create_quickvote, :expects => [QuickVoteStruct], :returns => [:string]
+
+ # Casts a quickvote. Expects a quickvote name, a voter ID, and a list
+ # of candidate ID's respectively. Returns a string containing any
+ # potential errors that occurred in the process.
+ api_method :cast_quickvote, :expects => [:string, :int, [[:int]]],
+ :returns => [:string]
+
+ # Return the results of a QuickVote. Takes in the name of a
+ # quickvote, and returns a structure as described by
+ # QuickVoteResultStruct
+
+ api_method :get_quickvote_results, :expects => [:string],
+ :returns => [QuickVoteResultStruct]
+
+ # Returns information regarding all the candidates in a QuickVote
+ # Takes in a QuickVote name, and returns the list of names and ID's of
+ # candidates This can be useful for presenting the user with a list of
+ # readable names, while the software sends results to us in the
+ # numeric ID's we require. The two lists are in respective order.
+
+ api_method :get_quickvote_candidate_map, :expects => [:string],
+ :returns => [QuickVoteCandidateMap]
+
+ # Converts QuickVote candidate ID's to names Takes in a QuickVote name
+ # and a list of candidate ID's, and returns the names of each
+ # candidate. Useful for doing just a few lookups; it's more efficient
+ # to use get_quickvote_candidate_map for presenting info about an
+ # entire election.
+
+ api_method :quickvote_candidate_ids_to_names,
+ :expects => [:string,[:int]], :returns => [[:string]]
+
+ # Get information on all the votes cast in a QuickVote Takes in the
+ # name of a QuickVote, returns an array of QuickVoterInfo structures.
+ api_method :get_quickvote_votes, :expects => [:string],
+ :returns => [ [QuickVoterInfo] ]
+
+ # Gets a list of all QuickVotes in the system.
+ api_method :list_quickvotes, :expects => [],
+ :returns => [[QuickVoteStruct]]
+
+ # Gets information on a particular QuickVote. Takes in a QuickVote
+ # name.
+ api_method :get_quickvote, :expects => [:string],
+ :returns => [QuickVoteStruct]
+
+ # Create a QuickVote Pass in a QuickVoteStruct populated with all the
+ # fields but the candidate ID's
+ api_method :create_quickvote, :expects => [QuickVoteStruct],
+ :returns => [:string]
end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class AboutController < ApplicationController
layout 'main'
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class AccountController < ApplicationController
layout 'main'
end
#======================================================================
- #The following methods are for slectricity specific uses
+ #The following methods are for selectricity specific uses
def summary
@user = User.find(params[:id])
end
-# Filters added to this controller will be run for all controllers in the application.
-# Likewise, all the methods added will be available for all controllers.
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
+# Filters added to this controller will be run for all controllers in
+# the application. Likewise, all the methods added will be available
+# for all controllers.
class ApplicationController < ActionController::Base
include AuthenticatedSystem
#both election_controller and quickvote_controller need this method
def sort_candidates
+
@vote = Vote.find(params[:id])
-
+
@vote.rankings.each do |ranking|
ranking.rank = params['rankings-list'].index(ranking.candidate.id.to_s) + 1
ranking.save
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class ElectionController < ApplicationController
require_dependency "raw_voter_list"
require_dependency "voter"
@election.user = session[:user]
@election.anonymous = 1
@election.startdate = Time.now
-
+
+ holder = create_theme_hash
+ unless holder.values.all? {|v| v.has_value?("")}
+ token_generator = UniqueTokenGenerator.new( 16 )
+ @election.embed_custom_string = token_generator.token
+ add_theme(@election.embed_custom_string)
+ end
+
if @election.save
flash[:notice] = 'Election was successfully created.'
redirect_to :action => 'edit_candidates', :id => @election.id
end
end
- # add filter to verify that the person working on or looking at
- # something is the owner
- def edit
- @election = Election.find(params[:id])
+ def create_theme_hash
+ target = Hash.new
+ params.each do |k,v|
+ target[k] = v if k=="top_bar" or k=="default_image" or k=="bg1" \
+ or k=="bg2" or k=="bottom_bar"
+ end
+ return target
end
-
- def show
- @sidebar_content = render_to_string :partial => 'progress',
- :locals => { :page => 'review' }
-
+
+ # TODO add filter to verify that the person working on or looking at
+ # something is the owner
+ def edit_general_information
@election = Election.find(params[:id])
end
-
- def update
+
+ def update_general_information
@election = Election.find(params[:id])
+
+ holder = create_theme_hash
+ unless holder.values.all? {|v| v.has_value?("")}
+ unless @election.embed_custom_string
+ token_generator = UniqueTokenGenerator.new( 16 )
+ @election.embed_custom_string = token_generator.token
+ end
+
+ add_theme(@election.embed_custom_string)
+ end
+
if @election.update_attributes(params[:election])
flash[:notice] = 'Election was successfully updated.'
redirect_to :action => 'show', :id => @election
render :action => 'edit'
end
end
+
+ #Takes care of uploading custom images
+ #unnecessarily long, how can I compress?
+ def add_theme(prefix)
+ holder = create_theme_hash
+ unless params[:top_bar][:uploaded_data].to_s.empty?
+ previous = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "top_bar.png"])
+ if previous
+ previous.destroy
+ end
+ top_bar = SkinPicture.new(params[:top_bar])
+ top_bar.filename = prefix + "top_bar." + params[:top_bar][:uploaded_data].content_type[6..-2]
+ top_bar.save
+ end
+ unless params[:default_image][:uploaded_data].to_s.empty?
+ previous = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "default_image.png"])
+ if previous
+ previous.destroy
+ end
+ default_image = SkinPicture.new(params[:default_image])
+ default_image.filename = prefix + "default_image." + params[:default_image][:uploaded_data].content_type[6..-2]
+ default_image.save
+ end
+ unless params[:bg1][:uploaded_data].to_s.empty?
+ previous = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bg1.png"])
+ if previous
+ previous.destroy
+ end
+ bg1 = SkinPicture.new(params[:bg1])
+ bg1.filename = prefix + "bg1." + params[:bg1][:uploaded_data].content_type[6..-2]
+ bg1.save
+ end
+ unless params[:bg2][:uploaded_data].to_s.empty?
+ previous = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bg2.png"])
+ if previous
+ previous.destroy
+ end
+ bg2 = SkinPicture.new(params[:bg2])
+ bg2.filename = prefix + "bg2." + params[:bg2][:uploaded_data].content_type[6..-2]
+ bg2.save
+ end
+ unless params[:bottom_bar][:uploaded_data].to_s.empty?
+ previous = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bottom_bar.png"])
+ if previous
+ previous.destroy
+ end
+ bottom_bar = SkinPicture.new(params[:bottom_bar])
+ bottom_bar.filename = prefix + "bottom_bar." + params[:bottom_bar][:uploaded_data].content_type[6..-2]
+ bottom_bar.save
+ end
+
+ end
+
+ def show
+ @sidebar_content = render_to_string :partial => 'progress',
+ :locals => { :page => 'review' }
+
+ @election = Election.find(params[:id])
+ if @election.type == QuickVote
+ redirect_to(:controller => 'quickvote', :action => 'index', :ident => @election.id)
+ end
+
+ end
def start_election
@election = Election.find(params[:id])
+
@election.voters.each do |voter|
voter.vote = Vote.new
- email_voter voter
+ email_voter voter unless voter.email.nil?
end
@election.activate!
@election.candidates << @candidate
if @candidate.save
+ # check to see if they've uploaded a picture
+ if params[:picture][:uploaded_data]
+ picture = Picture.new(params[:picture])
+ @candidate.picture = picture if picture.save
+ end
+
@candidate = Candidate.new
redirect_to :action => 'edit_candidates', :id => @election.id
else
if params.has_key?( :raw_voter_list )
process_incoming_voters( params[:raw_voter_list] )
end
+ @edit = true
@raw_voter_list = RawVoterList.new
end
voter = Voter.find( params[:id] )
voter.destroy
end
+
+ def toggle_authenticated
+ @election = Election.find(params[:id])
+ if params[:authenticated] == "1"
+ @election.authenticated = true
+ else
+ @election.authenticated = false
+ end
+ @election.save
+ end
## methods for computing and printing results
####################################################################
def results
@election = Election.find( params[:id] )
votes = []
-
+
@election.voters.each do |voter|
if voter.vote and voter.vote.confirmed?
votes << voter.vote.rankings.sort.collect {|vote| vote.candidate_id}
@candidates_by_id = {}
@election.candidates.each {|cand| @candidates_by_id[cand.id] = cand}
+
end
def detailed_results
@voter_list = []
@vote_list = []
- @election.voters. each do |voter|
+
+ @election.voters.each do |voter|
if voter.vote and voter.vote.confirmed?
@voter_list << voter.email
@vote_list << voter.vote
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class FrontController < ApplicationController
layout 'frontpage'
require_dependency "user"
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
require 'date'
class GraphController < ApplicationController
class GruffGraff
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class QuickvoteController < ApplicationController
layout 'main'
require_dependency "quick_voter"
end
def confirm
+
# we need the election to verify that we have the right voter
election = QuickVote.ident_to_quickvote(params[:ident])
@voter = QuickVoter.find(:all,
:conditions => ["session_id = ? and election_id = ?",
session.session_id, election.id])[0]
-
+
if not @voter
# we have not seen this voter before. something is wrong, try
# again
redirect_to quickvote_url( :ident => params[:ident] )
else
+
# record the ip address for posterity
@voter.ipaddress = request.env["REMOTE_ADDR"]
@voter.save
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class SelectricityServiceController < ApplicationController
web_service_dispatching_mode :delegated
web_service :vote, SelectricityService.new
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class SparklinesController < ApplicationController
# Handles requests for sparkline graphs from views.
#
-end
\ No newline at end of file
+end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class VoterController < ApplicationController
layout 'main'
require_dependency "voter"
require_dependency "election"
def index
- if params[:urlpassword]
+ if params[:election_id]
+ @election = Election.find(params[:election_id])
+ unless @election.authenticated?
+ @voter = Voter.find(:all,
+ :conditions => ["session_id = ? and election_id = ?",
+ session.session_id, @election.id])[0]
+
+ @voter = Voter.new unless @voter
+
+ @voter.election = @election
+ @voter.session_id = session.session_id
+ @password = "open." + @election.id.to_s
+ end
+ elsif params[:urlpassword]
password = params[:urlpassword]
if @voter = FullVoter.find(:all,
:conditions => [ "password = ?", password ] )[0]
+ @election = @voter.election
+ @password = @voter.password
+ end
+ end
- @voter.vote = Vote.new if @voter.vote.nil?
- @voter.vote.set_defaults! if @voter.vote.rankings.empty?
+ if @voter and @election
+ # initialize things if the vote is blank
+ if @voter.vote.nil?
+ @voter.vote = Vote.new
+ @voter.save
+ end
+
+ @voter.vote.set_defaults! if @voter.vote.rankings.empty?
- @election = @voter.election
-
- # if the election is now finished
- if @election.enddate < Time.now
- # compute and display results
-
- @results = @election.results
- @candidates = {}
- @election.candidates.each {|c| @candidates[c.id] = c}
- @names = @election.names_by_id
-
- @sidebar_content = render_to_string(:partial => 'results_sidebar')
- render :action => 'results'
+ # if the election is now finished
+ if @election.enddate < Time.now
+ redirect_to :action => :results, :id => @password
+ else
+ @sidebar_content = render_to_string(:partial => 'vote_sidebar')
+ if @election.embeddable? and params[:embed] == "true"
+ #look for custom theme, and assign to instance variabels for widget use
+ if @election.embed_custom_string
+ @top_bar = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "top_bar.png"])
+ @default_image = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "default_image.png"])
+ @bg1 = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bg1.png"])
+ @bg2 = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bg2.png"])
+ @bottom_bar = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bottom_bar.png"])
+ end
+ render :template => 'embed/full_vote', :layout => 'embed'
else
- @sidebar_content = render_to_string(:partial => 'vote_sidebar')
render :action => 'full_vote'
end
- elsif params[:urlpassword]
- redirect_to :action => 'index'
end
end
end
def confirm
if authenticate
@voter.vote.confirm!
- render :action => 'thanks'
+
+ if @voter.election.embeddable? and params[:embed] == "true" \
+ and @voter.election.early_results?
+ redirect_to :action => :results, :id => @password, :embed => 'true'
+ else
+ render :action => 'thanks'
+ end
else
redirect_to :action => 'index'
end
end
end
+ def results
+ if authenticate and
+ (@voter.election.early_results? \
+ or @voter.election.enddate < Time.now)
+
+ @election = @voter.election
+ # compute and display results
+
+ @results = @election.results
+ @candidates = {}
+ @election.candidates.each {|c| @candidates[c.id] = c}
+ @names = @election.names_by_id
+
+ @sidebar_content = render_to_string(:partial => 'results_sidebar')
+ #look for custom theme, and assign to instance variabels for widget use
+ if @election.embed_custom_string
+ @top_bar = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "top_bar.png"])
+ @default_image = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "default_image.png"])
+ @bg1 = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bg1.png"])
+ @bg2 = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bg2.png"])
+ @bottom_bar = SkinPicture.find(:first,
+ :conditions => ["filename = ?", @election.embed_custom_string + "bottom_bar.png"])
+ end
+ if @election.embeddable? and params[:embed] == "true"
+ render :template => 'embed/results', :layout => 'embed'
+ else
+ render :action => 'results'
+ end
+ else
+ redirect_to :action => 'index'
+ end
+ end
private
def authenticate
password = params[:id]
- @voter = FullVoter.find(:all, :conditions => [ "password = ?", password ] )[0]
+ if password == "open"
+ election = Election.find(params[:format])
+ unless election.authenticated?
+ @voter = Voter.find(:all,
+ :conditions => ["session_id = ? and election_id = ?",
+ session.session_id, election.id])[0]
+ @password = "open." + election.id.to_s
+ end
+ else
+ @voter = FullVoter.find(:all,
+ :conditions => [ "password = ?", password ] )[0]
+ @password = @voter.password
+ end
+ @voter
end
end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Candidate < ActiveRecord::Base
belongs_to :election
+ has_one :picture
validates_presence_of :name
- # i have to call this picture_assoc because picture= does not overload
- # the normal association method made by has_one
- has_one :picture_obj, :class_name => "Picture"
-
# validate uniqueness of a name *within a given election*
def <=>(other)
name
end
- def picture
- picture_obj
- end
-
- def picture=(field)
- if field and field.length > 0
- self.picture_obj = Picture.new.set_from_field(field)
- return picture_obj.save
- else
- return false
- end
- end
-
- def picture?
- !self.picture_obj.nil?
- end
-
end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Election < ActiveRecord::Base
has_many :candidates
has_many :voters
reasons << "You must have at least two candidates."
end
- if self.voters.length <= 1
+ if self.voters.length <= 1 and self.authenticated?
reasons << "You must have at least two voters."
end
end
def quickvote?
- self.class == 'QuickVote'
+ self.class == QuickVote
end
def active?
active == 2
end
+ def authenticated?
+ authenticated
+ end
+
def shortdesc
shortdesc = description.split(/\n/)[0]
end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class FullVoter < Voter
validates_presence_of :email, :password
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Picture < ActiveRecord::Base
belongs_to :candidate
- def set_from_field(field)
- unless field.content_type.match(/^image/)
- return false
- end
- self.filename = base_part_of(field.original_filename)
- self.filetype = field.content_type.chomp
- self.data = field.read
- self
- end
+ has_attachment :storage => :file_system,
+ :max_size => 1.megabytes,
+ :thumbnails => { :thumb => '70x53' },
+ :processor => :Rmagick
- def base_part_of(filename)
- name = File.basename(filename)
- name.gsub(/[^\w._-]/, '')
- end
+ validates_as_attachment
end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class QuickVoter < Voter
validates_presence_of :session_id
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Ranking < ActiveRecord::Base
belongs_to :candidate
belongs_to :vote
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class RawVoterList
attr_accessor :email
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
require 'action_controller/integration'
class SelectricityService < ActionWebService::Base
--- /dev/null
+class SkinPicture < ActiveRecord::Base
+
+ has_attachment :storage => :file_system,
+ :processor => :Rmagick,
+ :content_type => :image
+
+ validates_as_attachment
+
+end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Token < ActiveRecord::Base
belongs_to :vote
super
token_generator = UniqueTokenGenerator.new( 16 )
- until not token.empty? and Token.find(:all, :conditions => [ "token = ?", token ]).empty?
+ until not token.empty? and Token.find(:all, :conditions => [ "token = ?", token ]).empty? and token[0..3] != "open"
self.token = token_generator.token
end
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
require 'digest/sha1'
class User < ActiveRecord::Base
has_many :elections
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Vote < ActiveRecord::Base
# relationships to other classes
belongs_to :voter
rankings.each { |ranking| ranking.destroy }
end
- def settime
- self.time = Time.now
- self.save
- end
-
def confirm!
self.confirmed = 1
+ self.time = Time.now
self.save
unless self.voter.election.quickvote?
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class Voter < ActiveRecord::Base
belongs_to :election
has_one :vote
+# Selectricity: Voting Machinery for the Masses
+# Copyright (C) 2007, 2008 Benjamin Mako Hill <mako@atdot.cc>
+# Copyright (C) 2007 Massachusetts Institute of Technology
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public
+# License along with this program. If not, see
+# <http://www.gnu.org/licenses/>.
+
class VoterNotify < ActionMailer::Base
def votestart(voter)
<table class="voterbox" id="election">
<tr>
<% Election.content_columns.each do |column| -%>
- <% next if column.name.eql?("viewable") || column.name.eql?("quickuser")\
- || column.name.eql?("active") || column.name.eql?("anonymous") %>
+ <% dontPrint = ["viewable", "quickuser", "active", "anonymous", \
+ "early_results", "embed_custom_string", "embeddable", \
+ "notices"]%>
+ <% next if dontPrint.include?(column.name)%>
<th><%= column.human_name %></th>
<% end -%>
</tr>
<td><%=h election.description %></td>
<td><%=h election.startdate.strftime("%x") %></td>
<td><%=h election.enddate.strftime("%x") %></td>
- <td>
- <% if election.notices == 0 -%>
- No
- <% else -%>
+ <td><%=h election.election_method %></td>
+ <td>
+ <% if election.authenticated? %>
Yes
- <% end -%>
- </td>
- <td><%=h election.election_method %></td>
+ <% else -%>
+ No
+ <% end -%>
+ </td>
+
</tr>
<% end -%>
</table>
<% voters = @election.voters.size %>
<% matrix = @election.ssd_result.matrix %>
<% victories = @election.ssd_result.victories_and_ties %>
-
<p>Each number in the table below shows how many times the candidate on
the left beat the matching candidate on the top. The winner is on the
top of the left column.</p>
<% candidates.each do |victor| %>
<tr>
<th><%= white_list(@names[victor]) %></th>
- <% victories[victor].keys.each do |loser| %>
- <% margin = victories[victor][loser]%>
- <td><%= white_list(@names[loser]) %>
- <% if margin == 0%>
+<!-- This is a pretty logic heavy section - think about trying to move it to
+ backend eventually. Change the order of first and second to change the order
+ that things are sorted in. -->
+ <% sorted = victories[victor].sort { |first,second| first[1] <=> second[1] }%>
+ <% sorted.each do |loserpair| %>
+ <td><%= white_list(@names[loserpair[0]]) %>
+ <% if loserpair[1] == 0%>
Tied!
<% else -%>
- (<%= margin%>)
+ (<%= loserpair[1] %>)
<% end -%>
</td>
<% end -%>
</table>
</div>
+
--- /dev/null
+<div class="candidate_box_info">
+ <% if @current_candidate.picture %>
+ <div class="candidate_box_picture">
+ <img src="<%= url_for @current_candidate.picture.public_filename(:thumb) %>" />
+ </div>
+ <% end %>
+ <div class="candidate_box_description">
+ <% if @current_candidate.description.length > 0 %>
+ <%= h(@current_candidate.description) %>
+ <% else %>
+ <!-- no description -->
+ <% end %>
+ </div>
+ <div class="clear-div"></div>
+</div>
<p style="float: left;"><label for="candidate_picture">Picture</label> (optional and < 100x100 pixels)<br />
-<%= file_field :candidate, :picture %></p>
+<%= file_field :picture, :uploaded_data%></p>
<div class="clear-div"></div>
<br />
<div style="display: none;" id="candidate_description_<%= @current_candidate.id %>">
- <%=h (@current_candidate.description) %>
+ <%= render :partial => 'candidate_box_info' %>
</>
</span>
</li>
<div class="candidate_box" id="cand<%= @current_candidate.id %>">
- <div class="candidate_box_name"><%=h @current_candidate.name %></div>
+ <div class="candidate_box_name">
+
+ <%=h @current_candidate.name %></div>
<div class="candidate_box_menu">
<%= link_to_remote "Delete",
:complete => "Element.remove('cand#{@current_candidate.id}')",
:id => @current_candidate.id } %>
</div>
<div class="clear-div"></div>
-
- <div class="candidate_box_info">
- <div class="candidate_box_picture">
- <% if @current_candidate.picture? %>
- <img src="<%= url_for :action => 'candidate_picture',
- :id => @current_candidate.id %>" />
- <% end %>
- </div>
- <div class="candidate_box_description">
- <% if @current_candidate.description.length > 0 %>
- <%= h(@current_candidate.description) %>
- <% else %>
- <!-- no description -->
- <% end %>
- </div>
- <div class="clear-div"></div>
- </div>
+ <%= render :partial => 'candidate_box_info' %>
</p>
</div>
<!--[form:election]-->
<p><label for="election_name">Title</label><br/>
-<%= text_field 'election', 'name', :size => 60 %></p>
+<%= text_field :election, :name, :size => 60 %></p>
<p><label for="election_description">Description</label><br/>
-<%= text_area 'election', 'description', :rows => 5, :cols => 60 %></p>
+<%= text_area :election, :description, :rows => 5, :cols => 60 %></p>
<!--
<p><label for="election_anonymous">Anonymous Vote</label>
-<%= check_box 'election', 'anonymous', {}, 1, 0 %></p>
+<%= check_box :election, :anonymous, {}, 1, 0 %></p>
<p>Election/Voting Start Date<br />
<%= datetime_select :election, :startdate %></p>
<% type_hash = {}; ELECTION_TYPES.each {|k,v| type_hash[v] = k} %>
<%= select_tag 'election[election_method]', options_for_select(type_hash, @election.election_method) %></p>
+<p><label for="election_election_method">Enable Embeddable Elections?</label>
+<%= check_box :election, :embeddable %></p>
+
+<p><label for="election_election_method">Should results be visible before end of election?</label>
+<%= check_box :election, :early_results%></p>
<!--[eoform:election]-->
--- /dev/null
+<%= error_messages_for("skin_picture") %>
+
+<p>If you want a custom theme upload it if here!<br />
+
+<span><label for="top_bar_uploaded_data">Top Bar</span><br />
+ <%=file_field :top_bar, :uploaded_data %><br />
+<span><label for="default_image_uploaded_data">Corner Image</span><br />
+ <%=file_field :default_image, :uploaded_data %><br />
+<span><label for="bg1_uploaded_data">Background One</span><br />
+ <%=file_field :bg1, :uploaded_data %><br />
+<span><label for="bg2_uploaded_data">Background Two</span><br />
+ <%=file_field :bg2, :uploaded_data %><br />
+<span><label for="bottom_bar_uploaded_data">Bottom Bar</span><br />
+ <%=file_field :bottom_bar, :uploaded_data %><br />
+</p>
+
+<p>Detailed Information:
+ Every embeddable widget uses five different picture files to create
+ it's color scheme and default image. If you have images you'd like to
+ use in your widget. Please make sure they fit the
+ specified dimensions.<br />
+ Top Bar/ Bottom Bar/ Alternating Backgrounds: 330px wide 53px tall
+ <br />
+ Default Image: 70px wide 53px tall
+</p>
\ No newline at end of file
-->
<%= hidden_field :raw_voter_list, :email, :value => 2 %>
</p>
-
<p><%= submit_tag "Add Voters" %></p>
+
+++ /dev/null
-<h1><strong><%=h @election.name %>:</strong> Edit Overview</h1>
-
-<% form_tag(:action => 'update', :id => @election) do %>
- <%= render :partial => 'overview_form' %>
- <%= submit_tag 'Done!' %>
-<% end %>
--- /dev/null
+<div id="title-header">
+ <span class="header">Election Overview</span>
+ <span class="subheader"></span>
+</div>
+
+<% form_tag( {:action => 'update_general_information', :id => @election},
+ :multipart => true ) do %>
+ <%= render :partial => 'overview_form' %>
+ <%= render :partial => 'theme_upload' %>
+ <%= submit_tag 'Done' %>
+<% end %>
+
+
<span class="subheader"></span>
</div>
+<p id="unauth_notice" <%= 'style="display: none;"' if @election.authenticated %>>Anyone will be able to
+vote in this election.</p>
+
+<div id="voter_info_box" <%= 'style="display: none;"' unless @election.authenticated %>>
<%= render :partial => 'voter_list' %>
<% form_tag (:action => 'edit_voters', :id => @election.id) do %>
<%= render :partial => 'voters_form' %>
<% end %>
+</div>
+
+<%= check_box :election, :authenticated %> Only allow registered voters
+
+<%= observe_field "election_authenticated",
+ :url => { :action => 'toggle_authenticated', :id => @election.id },
+ :complete => 'Element.toggle($("voter_info_box")); Element.toggle($("unauth_notice"));',
+ :with => 'authenticated' %>
+
+<script type="text/javascript">
+</script>
<div class="normal-header">
<span class="header">Continue</span>
<span class="subheader"></span>
</div>
-<% form_tag (:action => 'create_election') do %>
+<% form_tag( {:action => 'create_election'}, :multipart => true ) do %>
<%= render :partial => 'overview_form' %>
- <%= submit_tag "Done!" %>
+ <%= render :partial => 'theme_upload' %>
+ <%= submit_tag "Proceed to Next Step" %>
<% end %>
-
<span class="header">Election Overview</span>
<span class="subheader"></span>
</div>
-
-<% if @election.active? %>
+<% if @election.enddate < Time.now %>
+<div id="status">Election is finished. <%= link_to "View results",
+ :controller => 'voter', :action => 'index',
+ :election_id => @election.id %>.</div>
+
+<% elsif (@election.active? && @election.early_results? ) %>
+ <div id="status">The creator of this election has decided that the results
+ should be viewable while the election is in progress.
+ <%if @election.voters.empty? %>
+ However, no one has voted yet.
+ <% else %>
+ <%= link_to "View results", :controller => 'voter', :action => 'results',
+ :id => "open" %>.
+ <% end %>
+ </div>
+<% elsif @election.active? %>
<div id="status">Vote is in currently in progress. Return to
this page for results on <%= @election.enddate %>.</div>
-<% elsif @election.done? %>
- <div id="status">Election is finished. <%= link_to "View results",
- :action => 'results', :id => @election.id %>.</div>
+
+<% else %>
+ <p style="text-align: right;">
+ <%= link_to "Edit General Information",
+ :action => 'edit_general_information', :id => @election.id %>
+ </p>
<% end %>
<p><strong>Summary</strong></p>
<%= h(@election.description) %>
</blockquote>
-<p><strong>End Date</strong></p>
+<p><strong>Additional Information</strong></p>
-<blockquote>
-<%= @election.enddate %>
-</blockquote>
+<ul> <li>Elections will end at <strong><%= @election.enddate
+%></strong>.</li> <li>Elections results <strong><% if
+@election.early_results %>will be<% else %>will not be<% end
+%></strong> visible while election is in progress.</li>
-<% unless @election.active %>
-<p><%= link_to "Edit overview.", :action => 'edit', :id => @election.id %></p>
+<% if @election.embeddable %>
+<li>Elections <strong>will be</strong> embeddable.</li>
<% end %>
+</ul>
+
+<% if @election.active? and not @election.authenticated? %>
+<p><strong>Link</strong></p>
+<%= (link_to ("Go Vote!",
+ :controller => 'voter', :action => 'index', :election_id => @election.id)).to_s %>
+<% end -%>
+
<div class="normal-header">
<span class="header">Candidates</span>
<span class="subheader"></span>
</div>
-<% unless @election.candidates.empty? %>
- <%= render :partial => 'candidate_list' %>
- <% unless @election.active %>
- <p><%= link_to "Add, remove, or edit candidates.", :action => 'edit_candidates', :id => @election.id %></p>
- <% end %>
-<% else %>
- <p><em>There are currently no candidates registered. <%= link_to "Add some!", :action => 'edit_candidates', :id => @election.id unless @election.active %></em></p>
+<% if not (@election.active? or @election.done?) %>
+ <p style="text-align: right;">
+ <%= link_to "Edit Candidates",
+ :action => 'edit_candidates', :id => @election.id %></p>
+<% end %>
+
+
+<% if @election.candidates.empty? %>
+ <p><em>There are currently no candidates registered.</em>
+ <%= link_to "Add some!", :action => 'edit_candidates', :id => @election.id %>
+ </p>
+<% else %>
+ <%= render :partial => 'candidate_list' %>
<% end %>
<div class="normal-header">
<span class="subheader"></span>
</div>
-<% unless @election.voters.empty? %>
- <%= render :partial => 'voter_list' %>
- <%= link_to "Add or remove voters.", :action => 'edit_voters', :id => @election.id unless @election.active %></em></p>
+<% if not (@election.active? or @election.done?) %>
+<p style="text-align: right;">
+ <%= link_to "Change Voters/Options",
+ :action => 'edit_voters', :id => @election.id %></p>
+<% end %>
+
+<% if not @election.authenticated? %>
+ <p><em>This election is open the public.</em></p>
+<% elsif @election.voters.empty? %>
+ <p><em>There are currently no voters registered. </em>
+ <%= link_to "Add some!", :action => 'edit_voters',
+ :id => @election.id %></p>
<% else %>
- <p><em>There are currently no voters registered. <%= link_to "Add some!", :action => 'edit_voters', :id => @election.id unless @election.active %></em></p>
+ <%= render :partial => 'voter_list' %>
+ <p><em><%= link_to "Add or remove voters.", :action => 'edit_voters',
+ :id => @election.id unless @election.active? or @election.done? %>
+ </em></p>
<% end %>
-<% unless @election.active? %>
+<% if not (@election.active? or @election.done?) %>
<div class="normal-header">
<span class="header">Start Election</span>
<ul>
<li>The vote will be "frozen" so that further edits to the
candidate list and voting list cannot occur.</li>
+ <% if @election.authenticated? %>
<li>All voters will be emailed notifying them that the vote has
begun and of their unique login token.</li>
+ <% end %>
</ul>
<%= button_to 'Start Election!', :action => 'start_election', :id => @election.id %>
<% end %>
+<% elsif @election.embeddable? %>
+
+<div class="normal-header">
+ <span class="header">Embedding</span>
+ <span class="subheader"></span>
+</div>
+
+
+<p>To embed your election, copy and paste the following code into your
+homepage:</p>
+
+<pre><%= h("<iframe src='") + votepassword_url(:urlpassword => "open." + @election.id.to_s, :embed => "true") + h("' width='330px' height='#{(@election.candidates.length+2)*53}px'>" ) %>
+<%= h("</iframe>") %></pre>
+
<% end %>
--- /dev/null
+<%@election.candidates.length.times do |count|-%>
+ <% if (count%2)==0-%>
+ <img src=" <% if @bg1 -%>
+ <%= url_for @bg1.public_filename %>
+ <% else %>
+ /images/widget_dark.png
+ <% end -%> " style="position:absolute;top:<%=(count+1)*53%>px"/>
+ <% else -%>
+ <img src=" <% if @bg2 -%>
+ <%=url_for @bg2.public_filename %>
+ <% else %>
+ /images/widget_light.png
+ <% end -%>"
+ style="position:absolute;top:<%=(count+1)*53%>px">
+ <% end -%>
+ <p class="position" style="top:<%=(10+(count+1)*53)%>px;left:10px">
+ <%=count+1 -%>
+ </p>
+
+<%end%>
\ No newline at end of file
--- /dev/null
+<div id="header" style="background-image:url(<%if @top_bar%>
+ <%=url_for @top_bar.public_filename%>)
+ <% else %>
+ /images/embed_basic_bg.png)
+ <% end %>">
+<%= link_to '<img id="header_icon" src="/images/embed_header_icon.png" />',
+ {:controller => 'front'}, {:target => "_parent"} %><h2>Vote Now</h2>
+</div>
+
+<div id="voting-box" height="<%=(@election.candidates.length + 2)*53 %>px">
+
+ <%= render :partial => '/embed/backdrop' %>
+ <ul id="rankings-list">
+ <% @voter.vote.rankings.each do |ranking| %>
+ <li class="ranking" id="ranking_<%= ranking.candidate.id %>">
+ <img alt="<%= white_list ranking.candidate.name %>"
+ src="<% if ranking.candidate.picture -%>
+ <%= url_for ranking.candidate.picture.public_filename(:thumb) -%>
+ <% elsif @default_image %>
+ <%= url_for @default_image.public_filename %>
+ <%- else -%>
+ /images/default_icon.png
+ <%- end %>" />
+ <p class="ranking-info">
+ <strong><%= white_list ranking.candidate.name %></strong><br />
+ <%= white_list ranking.candidate.description %></p>
+ </li>
+ <% end %>
+ </ul>
+
+ <div style="clear:both;"></div>
+
+ <div id="voting-bottom" style="
+ <% if @bottom_bar %>
+ background-image:url(<%= url_for @bottom_bar.public_filename %>)
+ <% elsif @election.candidates.length%2 == 0 %>
+ background-image:url(/images/bottom_dark.png)
+ <%else%>
+ background-image:url(/images/bottom_light.png)
+ <%end%>" >
+ <div id="container">
+ <a href="<%= url_for :action => :confirm, :id => @password, :embed => 'true' %>"><h2 id="submit_vote_button">Submit Vote</h2></a>
+ <p><b>Drag and drop</b> to rank the choices.</p>
+ </div>
+ </div>
+</div>
+
+<%= sortable_element 'rankings-list',
+ :url => { :action => "sort_candidates", :id => @voter.vote.id } %>
+
--- /dev/null
+<div id="header">
+<%= link_to '<img id="header_icon" src="/images/embed_header_icon.png" />',
+ {:controller => 'front'}, {:target => "_parent"} %>
+<h2>Current Standings</h2>
+</div>
+<div id="voting-box" height="<%=(@election.candidates.length + 2)*53 %>px">
+
+ <%= render :partial => '/embed/backdrop' %>
+
+ <ul id="rankings-list">
+ <% @election.ssd_result.ranked_candidates.flatten.each do |ranking_id| %>
+ <% ranking = @candidates[ranking_id] %>
+ <li class="ranking" id="ranking_<%= ranking.id %>">
+ <img alt="<%= white_list ranking.name %>"
+ src="<% if ranking.picture -%>
+ <%= url_for ranking.picture.public_filename(:thumb) -%>
+ <%- else -%>
+ /images/default_icon.png
+ <%- end %>" />
+ <p class="ranking-info">
+ <strong><%= white_list ranking.name %></strong><br />
+ <%= white_list ranking.description %></p>
+ </li>
+ <% end %>
+ </ul>
+
+ <div style="clear:both;"></div>
+
+ <div id="results-bottom" style="
+ <% if @election.candidates.length%2 == 0 %>
+ background-image:url(/images/bottom_dark.png)
+ <%else%>
+ background-image:url(/images/bottom_light.png)
+ <%end%>">
+ <div id="container">
+ <a href="<%= votepassword_url :urlpassword => "open." + @voter.election.id.to_s, 'embed' => 'true' %>"><h2>Results</h2></a>
+
+ <p>Your vote was recorded correctly.</p>
+
+ </div>
+ </div>
+</div>
+
+
<% if @current_elections.length < 1 %>
<p><em>You have not created any elections.</em></p>
+<% elsif @current_elections.length > 6 %>
+<p>You have more than six elections which may not fit on the control panel. Clcik on the following link to go to your user profile, which lists all your elections. <b/>
+<%= link_to "Summary", :controller => "account", :action => "summary", :id => session[:user].id %> </p>
<% else %>
<ul>
<% for election in @current_elections %>
</div>
<div id="control-room" class="main-section">
- <div id="control-room-content">
+ <div id="control-room-content" >
+
<h2>Control Room</h2>
<% if session[:user] %>
<%= render :partial => 'user_summary' %>
--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <title>Selectricity</title>
+ <%= stylesheet_link_tag "embed", :media => "all" %>
+ <%begin%>
+ <%= stylesheet_link_tag "ie6hacks", :media => "all" if
+ request.user_agent =~ /msie\s(5\.[5-9]|[6]\.[0-9]*).*(win)/i %>
+ <%rescue NoMethodError%>
+ <%end%>
+ <%= javascript_include_tag "prototype", "effects", "dragdrop", "controls" %>
+ </head>
+
+ <body>
+ <%= @content_for_layout %>
+ </body>
+
+</html>
<% end %>
</ol>
-<p>Thanks you voting! You can:</p>
+<p>Thank you for voting! You can:</p>
<ul>
<li><%= link_to "Change Your Vote", quickaction_url( :ident => @voter.election.name, :action => 'change' ) %></li>
<h2>Details</h2>
-<p><%= link_to "Auditing Information", { :action => 'details', :id => @voter.password }, :popup => [] %></p>
+<p><%= link_to "Auditing Information", { :action => 'details', :id => @password }, :popup => [] %></p>
least preferred. Please list <em>all</em> choices in every vote.
<em>(For example, 123 or 321 or 213, etc.)</em></p>
-<%= form_tag :action => 'review', :id => @voter.password %>
+<%= form_tag :action => 'review', :id => @password %>
<%= text_field :vote, :votestring -%>
<%= submit_tag "Vote!" %>
<%= render :partial => 'common/sortable_vote' %>
<div style="margin-left: 30pt;">
-<%= button_to "Submit Vote", :action => 'review', :id => @voter.password %>
+<%= button_to "Submit Vote", :action => 'review', :id => @password %>
</div>
<% @voter.election.candidates.each do |candidate| %>
<% @current_candidate = candidate %>
-
<div id="cand<%= @current_candidate.id %>">
- <h3><%=h @current_candidate.name -%></h3>
- <blockquote>
- <%=h (@current_candidate.description) %>
- </blockquote>
+ <h3><%= h @current_candidate.name %></h3>
+ <%= render :partial => 'election/candidate_box_info' %>
</div>
<% end %>
</ul>
+
<p>Please select from one of the following pages.</p>
<div style="text-align: center;">
- <p><%= button_to 'Confirm This Vote', :action => 'confirm', :id => @voter.password %></p>
+ <p><%= button_to 'Confirm This Vote', :action => 'confirm', :id => @password %></p>
<p>If you choose, you will be able to go back<br />and change it up until
the end of the voting period.</p>
-
+
<p><%= button_to 'Discard This Vote', votepassword_url(
- :action => 'index', :urlpassword => @voter.password) %></p>
+ :action => 'index', :urlpassword => @password) %></p>
<p>You will be returned to the voting page to vote<br /> again, if you choose.</p>
map.connect 'voter/:action',
:controller => 'voter',
- :requirements => { :action => /(review|confirm|authenticate|index|login|reminder)/ }
+ :requirements => { :action => /(review|confirm|authenticate|index|login|reminder|results)/ }
+
+ map.voteopen 'voter/open.:election_id',
+ :controller => 'voter',
+ :action => 'index'
map.votepassword 'voter/:urlpassword',
:controller => 'voter',
+++ /dev/null
-class CreateQuickVotes < ActiveRecord::Migration
- def self.up
- create_table :quick_votes do |t|
- # t.column :name, :string
- end
- end
-
- def self.down
- drop_table :quick_votes
- end
-end
--- /dev/null
+class MoveToAttachmentFu < ActiveRecord::Migration
+ def self.up
+ drop_table :pictures
+
+ # create attachment_fu metadata table
+ create_table :pictures do |t|
+ t.column :filename, :string
+ t.column :content_type, :string
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :created_at, :datetime
+ t.column "candidate_id", :integer
+ end
+ end
+
+ def self.down
+ drop_table :pictures
+
+ create_table "pictures", :force => true do |t|
+ t.column "filename", :string, :limit => 200
+ t.column "data", :binary
+ t.column "filetype", :string, :limit => 100
+ t.column "candidate_id", :integer
+ end
+ end
+end
--- /dev/null
+class AddEmbeddableSupport < ActiveRecord::Migration
+ def self.up
+ add_column :elections, :embeddable, :boolean,
+ :null => false, :default => false
+ add_column :elections, :authenticated, :boolean,
+ :null => false, :default => true
+ add_column :elections, :early_results, :boolean,
+ :null => false, :default => false
+ end
+
+ def self.down
+ remove_column :elections, :embeddable
+ remove_column :elections, :authenticated
+ remove_column :elections, :early_results
+ end
+end
+++ /dev/null
-class CreateFullVoters < ActiveRecord::Migration
- def self.up
- create_table :full_voters do |t|
- # t.column :name, :string
- end
- end
-
- def self.down
- drop_table :full_voters
- end
-end
--- /dev/null
+class AddCustomWidgetSupport < ActiveRecord::Migration
+
+ def self.up
+ create_table :skin_pictures, :force => true do |t|
+ t.column :filename, :string
+ t.column :content_type, :string
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :created_at, :datetime
+ t.column :user_id, :integer
+ end
+
+ add_column :elections, :embed_custom_string, :string, :default => nil
+
+ end
+
+ def self.down
+ drop_table :skin_pictures
+
+ remove_column :elections, :embed_custom_string
+ end
+
+end
+++ /dev/null
-class CreateQuickVoters < ActiveRecord::Migration
- def self.up
- create_table :quick_voters do |t|
- # t.column :name, :string
- end
- end
-
- def self.down
- drop_table :quick_voters
- end
-end
+++ /dev/null
-class CreateUsers < ActiveRecord::Migration
- def self.up
- create_table "users", :force => true do |t|
- t.column :login, :string
- t.column :email, :string
- t.column :crypted_password, :string, :limit => 40
- t.column :salt, :string, :limit => 40
- t.column :created_at, :datetime
- t.column :updated_at, :datetime
- t.column :remember_token, :string
- t.column :remember_token_expires_at, :datetime
- end
- end
-
- def self.down
- drop_table "users"
- end
-end
# migrations feature of ActiveRecord to incrementally modify your database, and
# then regenerate this schema definition.
-ActiveRecord::Schema.define() do
+ActiveRecord::Schema.define(:version => 3) do
create_table "candidates", :force => true do |t|
t.column "election_id", :integer, :null => false
end
create_table "elections", :force => true do |t|
- t.column "name", :string, :limit => 100, :default => "", :null => false
- t.column "description", :text, :default => "", :null => false
- t.column "anonymous", :integer, :limit => 4, :default => 1, :null => false
- t.column "startdate", :datetime
- t.column "enddate", :datetime, :null => false
- t.column "active", :integer, :limit => 4, :default => 0, :null => false
- t.column "viewable", :integer, :limit => 4, :default => 1, :null => false
- t.column "notices", :integer, :limit => 4, :default => 0, :null => false
- t.column "user_id", :integer
- t.column "quickuser", :string
- t.column "election_method", :string, :limit => 100, :default => "ssd"
- t.column "type", :string, :limit => 100, :default => "", :null => false
+ t.column "name", :string, :limit => 100, :default => "", :null => false
+ t.column "description", :text, :default => "", :null => false
+ t.column "anonymous", :integer, :limit => 4, :default => 1, :null => false
+ t.column "startdate", :datetime
+ t.column "enddate", :datetime, :null => false
+ t.column "active", :integer, :limit => 4, :default => 0, :null => false
+ t.column "viewable", :integer, :limit => 4, :default => 1, :null => false
+ t.column "notices", :integer, :limit => 4, :default => 0, :null => false
+ t.column "user_id", :integer
+ t.column "quickuser", :string
+ t.column "election_method", :string, :limit => 100, :default => "ssd"
+ t.column "type", :string, :limit => 100, :default => "", :null => false
+ t.column "embeddable", :boolean, :default => false, :null => false
+ t.column "authenticated", :boolean, :default => true, :null => false
+ t.column "early_results", :boolean, :default => false, :null => false
+ t.column "embed_custom_string", :string
end
add_index "elections", ["user_id"], :name => "fk_user_election"
create_table "pictures", :force => true do |t|
- t.column "filename", :string, :limit => 200
- t.column "data", :binary
- t.column "filetype", :string, :limit => 100
+ t.column "filename", :string
+ t.column "content_type", :string
+ t.column "size", :integer
+ t.column "width", :integer
+ t.column "height", :integer
+ t.column "parent_id", :integer
+ t.column "thumbnail", :string
+ t.column "created_at", :datetime
t.column "candidate_id", :integer
end
- add_index "pictures", ["candidate_id"], :name => "fk_candidate_picture"
-
create_table "rankings", :force => true do |t|
t.column "vote_id", :integer
t.column "candidate_id", :integer
t.column "created_on", :date
end
+ create_table "skin_pictures", :force => true do |t|
+ t.column "filename", :string
+ t.column "content_type", :string
+ t.column "size", :integer
+ t.column "width", :integer
+ t.column "height", :integer
+ t.column "created_at", :datetime
+ t.column "user_id", :integer
+ end
+
create_table "tokens", :force => true do |t|
t.column "token", :string, :limit => 100, :default => "", :null => false
t.column "vote_id", :integer, :null => false
--- /dev/null
+@charset "utf-8";\r
+/* CSS Document */\r
+\r
+/*****************************************************************************************\r
+ *\r
+ * "Reset Reloaded"\r
+ * Thanks to Eric Meyer\r
+ * http://meyerweb.com/eric/thoughts/2007/05/01/reset-reloaded/\r
+ *\r
+ */\r
+\r
+html, body, div, span, applet, object, iframe,\r
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,\r
+a, abbr, acronym, address, big, cite, code,\r
+del, dfn, em, font, img, ins, kbd, q, s, samp,\r
+small, strike, strong, sub, sup, tt, var,\r
+dl, dt, dd, fieldset, form, label, legend,\r
+table, caption, tbody, tfoot, thead, tr, th, td {\r
+ margin: 0;\r
+ padding: 0;\r
+ border: 0;\r
+ outline: 0;\r
+ font-weight: inherit;\r
+ font-style: inherit;\r
+ font-size: 100%; \r
+ font-family: inherit;\r
+ vertical-align: baseline;\r
+}\r
+\r
+strong, h2, h3 {\r
+ font-weight: bold;\r
+}\r
+\r
+body {\r
+ line-height: 1;\r
+ color: black;\r
+ background: white;\r
+}\r
+\r
+/* tables still need 'cellspacing="0"' in the markup */\r
+table {\r
+ border-collapse: separate;\r
+ border-spacing: 0;\r
+}\r
+\r
+caption, th, td {\r
+ text-align: left;\r
+ font-weight: normal;\r
+}\r
+\r
+blockquote:before, blockquote:after,\r
+q:before, q:after {\r
+ content: "";\r
+}\r
+\r
+blockquote, q {\r
+ quotes: "" "";\r
+}\r
+\r
+\r
+\r
+\r
+\r
+/* GENERIC *****************************************************************************/\r
+\r
+body {\r
+ font-family: helvetica,verdana;\r
+ font-size: 11px;\r
+ color: white;\r
+}\r
+\r
+a {\r
+ color: inherit;\r
+ text-decoration: none;\r
+}\r
+\r
+.submit_vote_button {\r
+ cursor: pointer;\r
+}\r
+\r
+\r
+#header {\r
+ width: 330px;\r
+ height: 53px;\r
+ background: transparent url(/images/embed_basic_bg.png) top left no-repeat;\r
+ margin: 0px;\r
+ padding: 0px;\r
+ overflow: hidden;\r
+}\r
+\r
+#header h2 {\r
+ font-size: 25px;\r
+ margin: 12px 0px 12px 7px;\r
+ color: #FFF;\r
+ font-weight: normal;\r
+}\r
+#header_icon {\r
+ display: float;\r
+ float: right;\r
+}\r
+\r
+\r
+/* VOTING ******************************************************************************/\r
+\r
+#voting-box {\r
+ width: 330px;\r
+ margin: 0px;\r
+ padding: 0px;\r
+ overflow: hidden;\r
+}\r
+\r
+p.position {\r
+ color: #000000;\r
+ font-size:32px;\r
+ font-family:'arial';\r
+ position:absolute;\r
+}\r
+\r
+ul {\r
+ margin: 0 0 0 40px;\r
+ padding: 0 0 0 0px;\r
+ list-style: none;\r
+}\r
+\r
+.ranking {\r
+ margin: 0px;\r
+ height: 53px;\r
+ position:relative;\r
+ overflow: hidden !important;\r
+}\r
+\r
+.ranking img {\r
+ margin: 0 0 0 0;\r
+ padding: 0 0 0 0;\r
+ float: left;\r
+ clear: left;\r
+}\r
+\r
+.ranking-info {\r
+ margin-left: 70px;\r
+ width: 202px;\r
+ height: 23px;\r
+ padding: 11px 6px 13px 6px;\r
+ color: #666666;\r
+ line-height: 1.2em;\r
+ border: 3px solid transparent;\r
+}\r
+\r
+.ranking-info a {\r
+ font-weight: bold;\r
+ color: #666666;\r
+}\r
+\r
+#voting-bottom {\r
+ color: #464646;\r
+ position: absolute;\r
+ width: 330px;\r
+ height:53px;\r
+}\r
+\r
+#results-bottom {\r
+ position: absolute;\r
+ width: 330px;\r
+ height:53px;\r
+}\r
+\r
+#container {\r
+ margin: 0 auto 0 auto;\r
+ width: 90%;\r
+}\r
+\r
+#voting-bottom h2, #results-bottom h2 {\r
+ padding-top: 20px;\r
+ height: 0px;\r
+ width: 119px;\r
+ overflow: hidden;\r
+ float: left;\r
+ margin-top: 16px;\r
+}\r
+\r
+#voting-bottom p, #results-bottom p {\r
+ float: left;\r
+ width: 160px;\r
+ margin-top: 12px;\r
+ margin-left: 10px;\r
+ line-height: 1.3em;\r
+}\r
+\r
+\r
+#voting-bottom h2 {\r
+ background: transparent url(/images/embed_voting_submitvote.png);\r
+}\r
+\r
+#results-bottom h2 {\r
+ background: transparent url(/images/embed_results_changevote.png);\r
+}\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
+\r
font-weight: bold;
}
+pre {
+ font-family: monospace;
+ overflow: scroll;
+ background: #d9d9d9;
+}
/* Left column. Includes logo, poll information, and graph. */
.candidate_box_info {
margin: 0.5em 0 0.5em 3em;
}
-/*.candidate_box_picture {
- width: 100px;
+.candidate_box_picture {
float: left;
- margin: 0 0.8em 0.5em 0;
-}*/
-.candidate_box_picture img {
- width: 100px;
- border: 1px solid black;
+ margin: 0 0.8em 0.4em 0;
}
.candidate_box_description {
display: inline;
--- /dev/null
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+one:
+ id: 1
+two:
+ id: 2
--- /dev/null
+require File.dirname(__FILE__) + '/../test_helper'
+
+class SkinPictureTest < Test::Unit::TestCase
+ fixtures :skin_pictures
+
+ # Replace this with your real tests.
+ def test_truth
+ assert true
+ end
+end
--- /dev/null
+* Nov 27, 2007 *
+* Handle properly ImageScience thumbnails resized from a gif file [Matt Aimonetti]
+* Save thumbnails file size properly when using ImageScience [Matt Aimonetti]
+* fixed s3 config file loading with latest versions of Rails [Matt Aimonetti]
+
+* April 2, 2007 *
+
+* don't copy the #full_filename to the default #temp_paths array if it doesn't exist
+* add default ID partitioning for attachments
+* add #binmode call to Tempfile (note: ruby should be doing this!) [Eric Beland]
+* Check for current type of :thumbnails option.
+* allow customization of the S3 configuration file path with the :s3_config_path option.
+* Don't try to remove thumbnails if there aren't any. Closes #3 [ben stiglitz]
+
+* BC * (before changelog)
+
+* add default #temp_paths entry [mattly]
+* add MiniMagick support to attachment_fu [Isacc]
+* update #destroy_file to clear out any empty directories too [carlivar]
+* fix references to S3Backend module [Hunter Hillegas]
+* make #current_data public with db_file and s3 backends [ebryn]
+* oops, actually svn add the files for s3 backend. [Jeffrey Hardy]
+* experimental s3 support, egad, no tests.... [Jeffrey Hardy]
+* doh, fix a few bad references to ActsAsAttachment [sixty4bit]
\ No newline at end of file
--- /dev/null
+attachment-fu
+=============
+
+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>.
+
+
+attachment_fu functionality
+===========================
+
+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.
+
+There are three storage options for files uploaded through attachment_fu:
+ File system
+ Database file
+ Amazon S3
+
+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 and the Database file storage requires an extra table.
+
+
+attachment_fu models
+====================
+
+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).
+
+In the model there are two methods made available by this plugins: has_attachment and validates_as_attachment.
+
+has_attachment(options = {})
+ This method accepts the options in a hash:
+ :content_type # Allowed content types.
+ # Allows all by default. Use :image to allow all standard image types.
+ :min_size # Minimum size allowed.
+ # 1 byte is the default.
+ :max_size # Maximum size allowed.
+ # 1.megabyte is the default.
+ :size # Range of sizes allowed.
+ # (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
+ :resize_to # Used by RMagick to resize images.
+ # Pass either an array of width/height, or a geometry string.
+ :thumbnails # Specifies a set of thumbnails to generate.
+ # This accepts a hash of filename suffixes and RMagick resizing options.
+ # This option need only be included if you want thumbnailing.
+ :thumbnail_class # Set which model class to use for thumbnails.
+ # This current attachment class is used by default.
+ :path_prefix # path to store the uploaded files.
+ # Uses public/#{table_name} by default for the filesystem, and just #{table_name} for the S3 backend.
+ # Setting this sets the :storage to :file_system.
+ :storage # Specifies the storage system to use..
+ # Defaults to :db_file. Options are :file_system, :db_file, and :s3.
+ :processor # Sets the image processor to use for resizing of the attached image.
+ # Options include ImageScience, Rmagick, and MiniMagick. Default is whatever is installed.
+
+
+ Examples:
+ has_attachment :max_size => 1.kilobyte
+ has_attachment :size => 1.megabyte..2.megabytes
+ has_attachment :content_type => 'application/pdf'
+ has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
+ has_attachment :content_type => :image, :resize_to => [50,50]
+ has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
+ has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+ has_attachment :storage => :file_system, :path_prefix => 'public/files'
+ has_attachment :storage => :file_system, :path_prefix => 'public/files',
+ :content_type => :image, :resize_to => [50,50]
+ has_attachment :storage => :file_system, :path_prefix => 'public/files',
+ :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+ has_attachment :storage => :s3
+
+validates_as_attachment
+ 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.
+
+ Example:
+ validates_as_attachment
+
+
+attachment_fu migrations
+========================
+
+Fields for attachment_fu metadata tables...
+ in general:
+ size, :integer # file size in bytes
+ content_type, :string # mime type, ex: application/mp3
+ filename, :string # sanitized filename
+ that reference images:
+ height, :integer # in pixels
+ width, :integer # in pixels
+ that reference images that will be thumbnailed:
+ parent_id, :integer # id of parent image (on the same table, a self-referencing foreign-key).
+ # Only populated if the current object is a thumbnail.
+ thumbnail, :string # the 'type' of thumbnail this attachment record describes.
+ # Only populated if the current object is a thumbnail.
+ # Usage:
+ # [ In Model 'Avatar' ]
+ # has_attachment :content_type => :image,
+ # :storage => :file_system,
+ # :max_size => 500.kilobytes,
+ # :resize_to => '320x200>',
+ # :thumbnails => { :small => '10x10>',
+ # :thumb => '100x100>' }
+ # [ Elsewhere ]
+ # @user.avatar.thumbnails.first.thumbnail #=> 'small'
+ that reference files stored in the database (:db_file):
+ db_file_id, :integer # id of the file in the database (foreign key)
+
+Field for attachment_fu db_files table:
+ data, :binary # binary file data, for use in database file storage
+
+
+attachment_fu views
+===================
+
+There are two main views tasks that will be directly affected by attachment_fu: upload forms and displaying uploaded images.
+
+There are two parts of the upload form that differ from typical usage.
+ 1. Include ':multipart => true' in the html options of the form_for tag.
+ Example:
+ <% form_for(:attachment_metadata, :url => { :action => "create" }, :html => { :multipart => true }) do |form| %>
+
+ 2. Use the file_field helper with :uploaded_data as the field name.
+ Example:
+ <%= form.file_field :uploaded_data %>
+
+Displaying uploaded images is made easy by the public_filename method of the ActiveRecord attachment objects using file system and s3 storage.
+
+public_filename(thumbnail = nil)
+ Returns the public path to the file. If a thumbnail prefix is specified it will return the public file path to the corresponding thumbnail.
+ Examples:
+ attachment_obj.public_filename #=> /attachments/2/file.jpg
+ attachment_obj.public_filename(:thumb) #=> /attachments/2/file_thumb.jpg
+ attachment_obj.public_filename(:small) #=> /attachments/2/file_small.jpg
+
+When serving files from database storage, doing more than simply downloading the file is beyond the scope of this document.
+
+
+attachment_fu controllers
+=========================
+
+There are two considerations to take into account when using attachment_fu in controllers.
+
+The first is when the files have no publicly accessible path and need to be downloaded through an action.
+
+Example:
+ def readme
+ send_file '/path/to/readme.txt', :type => 'plain/text', :disposition => 'inline'
+ end
+
+See the possible values for send_file for reference.
+
+
+The second is when saving the file when submitted from a form.
+Example in view:
+ <%= form.file_field :attachable, :uploaded_data %>
+
+Example in controller:
+ def create
+ @attachable_file = AttachmentMetadataModel.new(params[:attachable])
+ if @attachable_file.save
+ flash[:notice] = 'Attachment was successfully created.'
+ redirect_to attachable_url(@attachable_file)
+ else
+ render :action => :new
+ end
+ end
--- /dev/null
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the attachment_fu plugin.'
+Rake::TestTask.new(:test) do |t|
+ t.libs << 'lib'
+ t.pattern = 'test/**/*_test.rb'
+ t.verbose = true
+end
+
+desc 'Generate documentation for the attachment_fu plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+ rdoc.rdoc_dir = 'rdoc'
+ rdoc.title = 'ActsAsAttachment'
+ rdoc.options << '--line-numbers --inline-source'
+ rdoc.rdoc_files.include('README')
+ rdoc.rdoc_files.include('lib/**/*.rb')
+end
--- /dev/null
+development:
+ bucket_name: appname_development
+ access_key_id:
+ secret_access_key:
+
+test:
+ bucket_name: appname_test
+ access_key_id:
+ secret_access_key:
+
+production:
+ bucket_name: appname
+ access_key_id:
+ secret_access_key:
--- /dev/null
+require 'tempfile'
+
+Tempfile.class_eval do
+ # overwrite so tempfiles use the extension of the basename. important for rmagick and image science
+ def make_tmpname(basename, n)
+ ext = nil
+ sprintf("%s%d-%d%s", basename.to_s.gsub(/\.\w+$/) { |s| ext = s; '' }, $$, n, ext)
+ end
+end
+
+require 'geometry'
+ActiveRecord::Base.send(:extend, Technoweenie::AttachmentFu::ActMethods)
+Technoweenie::AttachmentFu.tempfile_path = ATTACHMENT_FU_TEMPFILE_PATH if Object.const_defined?(:ATTACHMENT_FU_TEMPFILE_PATH)
+FileUtils.mkdir_p Technoweenie::AttachmentFu.tempfile_path
\ No newline at end of file
--- /dev/null
+require 'fileutils'
+
+s3_config = File.dirname(__FILE__) + '/../../../config/amazon_s3.yml'
+FileUtils.cp File.dirname(__FILE__) + '/amazon_s3.yml.tpl', s3_config unless File.exist?(s3_config)
+puts IO.read(File.join(File.dirname(__FILE__), 'README'))
\ No newline at end of file
--- /dev/null
+# This Geometry class was yanked from RMagick. However, it lets ImageMagick handle the actual change_geometry.
+# Use #new_dimensions_for to get new dimensons
+# Used so I can use spiffy RMagick geometry strings with ImageScience
+class Geometry
+ # ! and @ are removed until support for them is added
+ FLAGS = ['', '%', '<', '>']#, '!', '@']
+ RFLAGS = { '%' => :percent,
+ '!' => :aspect,
+ '<' => :>,
+ '>' => :<,
+ '@' => :area }
+
+ attr_accessor :width, :height, :x, :y, :flag
+
+ def initialize(width=nil, height=nil, x=nil, y=nil, flag=nil)
+ # Support floating-point width and height arguments so Geometry
+ # objects can be used to specify Image#density= arguments.
+ raise ArgumentError, "width must be >= 0: #{width}" if width < 0
+ raise ArgumentError, "height must be >= 0: #{height}" if height < 0
+ @width = width.to_f
+ @height = height.to_f
+ @x = x.to_i
+ @y = y.to_i
+ @flag = flag
+ end
+
+ # Construct an object from a geometry string
+ RE = /\A(\d*)(?:x(\d+))?([-+]\d+)?([-+]\d+)?([%!<>@]?)\Z/
+
+ def self.from_s(str)
+ raise(ArgumentError, "no geometry string specified") unless str
+
+ if m = RE.match(str)
+ new(m[1].to_i, m[2].to_i, m[3].to_i, m[4].to_i, RFLAGS[m[5]])
+ else
+ raise ArgumentError, "invalid geometry format"
+ end
+ end
+
+ # Convert object to a geometry string
+ def to_s
+ str = ''
+ str << "%g" % @width if @width > 0
+ str << 'x' if (@width > 0 || @height > 0)
+ str << "%g" % @height if @height > 0
+ str << "%+d%+d" % [@x, @y] if (@x != 0 || @y != 0)
+ str << FLAGS[@flag.to_i]
+ end
+
+ # attempts to get new dimensions for the current geometry string given these old dimensions.
+ # This doesn't implement the aspect flag (!) or the area flag (@). PDI
+ def new_dimensions_for(orig_width, orig_height)
+ new_width = orig_width
+ new_height = orig_height
+
+ case @flag
+ when :percent
+ scale_x = @width.zero? ? 100 : @width
+ scale_y = @height.zero? ? @width : @height
+ new_width = scale_x.to_f * (orig_width.to_f / 100.0)
+ new_height = scale_y.to_f * (orig_height.to_f / 100.0)
+ when :<, :>, nil
+ scale_factor =
+ if new_width.zero? || new_height.zero?
+ 1.0
+ else
+ if @width.nonzero? && @height.nonzero?
+ [@width.to_f / new_width.to_f, @height.to_f / new_height.to_f].min
+ else
+ @width.nonzero? ? (@width.to_f / new_width.to_f) : (@height.to_f / new_height.to_f)
+ end
+ end
+ new_width = scale_factor * new_width.to_f
+ new_height = scale_factor * new_height.to_f
+ new_width = orig_width if @flag && orig_width.send(@flag, new_width)
+ new_height = orig_height if @flag && orig_height.send(@flag, new_height)
+ end
+
+ [new_width, new_height].collect! { |v| v.round }
+ end
+end
+
+class Array
+ # allows you to get new dimensions for the current array of dimensions with a given geometry string
+ #
+ # [50, 64] / '40>' # => [40, 51]
+ def /(geometry)
+ raise ArgumentError, "Only works with a [width, height] pair" if size != 2
+ raise ArgumentError, "Must pass a valid geometry string or object" unless geometry.is_a?(String) || geometry.is_a?(Geometry)
+ geometry = Geometry.from_s(geometry) if geometry.is_a?(String)
+ geometry.new_dimensions_for first, last
+ end
+end
\ No newline at end of file
--- /dev/null
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ @@default_processors = %w(ImageScience Rmagick MiniMagick)
+ @@tempfile_path = File.join(RAILS_ROOT, 'tmp', 'attachment_fu')
+ @@content_types = ['image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg']
+ mattr_reader :content_types, :tempfile_path, :default_processors
+ mattr_writer :tempfile_path
+
+ class ThumbnailError < StandardError; end
+ class AttachmentError < StandardError; end
+
+ module ActMethods
+ # Options:
+ # * <tt>:content_type</tt> - Allowed content types. Allows all by default. Use :image to allow all standard image types.
+ # * <tt>:min_size</tt> - Minimum size allowed. 1 byte is the default.
+ # * <tt>:max_size</tt> - Maximum size allowed. 1.megabyte is the default.
+ # * <tt>:size</tt> - Range of sizes allowed. (1..1.megabyte) is the default. This overrides the :min_size and :max_size options.
+ # * <tt>:resize_to</tt> - Used by RMagick to resize images. Pass either an array of width/height, or a geometry string.
+ # * <tt>:thumbnails</tt> - Specifies a set of thumbnails to generate. This accepts a hash of filename suffixes and RMagick resizing options.
+ # * <tt>:thumbnail_class</tt> - Set what class to use for thumbnails. This attachment class is used by default.
+ # * <tt>:path_prefix</tt> - path to store the uploaded files. Uses public/#{table_name} by default for the filesystem, and just #{table_name}
+ # for the S3 backend. Setting this sets the :storage to :file_system.
+ # * <tt>:storage</tt> - Use :file_system to specify the attachment data is stored with the file system. Defaults to :db_system.
+ #
+ # Examples:
+ # has_attachment :max_size => 1.kilobyte
+ # has_attachment :size => 1.megabyte..2.megabytes
+ # has_attachment :content_type => 'application/pdf'
+ # has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
+ # has_attachment :content_type => :image, :resize_to => [50,50]
+ # has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
+ # has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+ # has_attachment :storage => :file_system, :path_prefix => 'public/files'
+ # has_attachment :storage => :file_system, :path_prefix => 'public/files',
+ # :content_type => :image, :resize_to => [50,50]
+ # has_attachment :storage => :file_system, :path_prefix => 'public/files',
+ # :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+ # has_attachment :storage => :s3
+ def has_attachment(options = {})
+ # this allows you to redefine the acts' options for each subclass, however
+ options[:min_size] ||= 1
+ options[:max_size] ||= 1.megabyte
+ options[:size] ||= (options[:min_size]..options[:max_size])
+ options[:thumbnails] ||= {}
+ options[:thumbnail_class] ||= self
+ options[:s3_access] ||= :public_read
+ options[:content_type] = [options[:content_type]].flatten.collect! { |t| t == :image ? Technoweenie::AttachmentFu.content_types : t }.flatten unless options[:content_type].nil?
+
+ unless options[:thumbnails].is_a?(Hash)
+ raise ArgumentError, ":thumbnails option should be a hash: e.g. :thumbnails => { :foo => '50x50' }"
+ end
+
+ # doing these shenanigans so that #attachment_options is available to processors and backends
+ class_inheritable_accessor :attachment_options
+ self.attachment_options = options
+
+ # only need to define these once on a class
+ unless included_modules.include?(InstanceMethods)
+ attr_accessor :thumbnail_resize_options
+
+ attachment_options[:storage] ||= (attachment_options[:file_system_path] || attachment_options[:path_prefix]) ? :file_system : :db_file
+ attachment_options[:path_prefix] ||= attachment_options[:file_system_path]
+ if attachment_options[:path_prefix].nil?
+ attachment_options[:path_prefix] = attachment_options[:storage] == :s3 ? table_name : File.join("public", table_name)
+ end
+ attachment_options[:path_prefix] = attachment_options[:path_prefix][1..-1] if options[:path_prefix].first == '/'
+
+ with_options :foreign_key => 'parent_id' do |m|
+ m.has_many :thumbnails, :class_name => attachment_options[:thumbnail_class].to_s
+ m.belongs_to :parent, :class_name => base_class.to_s
+ end
+ before_destroy :destroy_thumbnails
+
+ before_validation :set_size_from_temp_path
+ after_save :after_process_attachment
+ after_destroy :destroy_file
+ extend ClassMethods
+ include InstanceMethods
+ include Technoweenie::AttachmentFu::Backends.const_get("#{options[:storage].to_s.classify}Backend")
+ case attachment_options[:processor]
+ when :none
+ when nil
+ processors = Technoweenie::AttachmentFu.default_processors.dup
+ begin
+ if processors.any?
+ attachment_options[:processor] = "#{processors.first}Processor"
+ include Technoweenie::AttachmentFu::Processors.const_get(attachment_options[:processor])
+ end
+ rescue LoadError, MissingSourceFile
+ processors.shift
+ retry
+ end
+ else
+ begin
+ include Technoweenie::AttachmentFu::Processors.const_get("#{options[:processor].to_s.classify}Processor")
+ rescue LoadError, MissingSourceFile
+ puts "Problems loading #{options[:processor]}Processor: #{$!}"
+ end
+ end
+ after_validation :process_attachment
+ end
+ end
+ end
+
+ module ClassMethods
+ delegate :content_types, :to => Technoweenie::AttachmentFu
+
+ # Performs common validations for attachment models.
+ def validates_as_attachment
+ validates_presence_of :size, :content_type, :filename
+ validate :attachment_attributes_valid?
+ end
+
+ # Returns true or false if the given content type is recognized as an image.
+ def image?(content_type)
+ content_types.include?(content_type)
+ end
+
+ # Callback after an image has been resized.
+ #
+ # class Foo < ActiveRecord::Base
+ # acts_as_attachment
+ # after_resize do |record, img|
+ # record.aspect_ratio = img.columns.to_f / img.rows.to_f
+ # end
+ # end
+ def after_resize(&block)
+ write_inheritable_array(:after_resize, [block])
+ end
+
+ # Callback after an attachment has been saved either to the file system or the DB.
+ # Only called if the file has been changed, not necessarily if the record is updated.
+ #
+ # class Foo < ActiveRecord::Base
+ # acts_as_attachment
+ # after_attachment_saved do |record|
+ # ...
+ # end
+ # end
+ def after_attachment_saved(&block)
+ write_inheritable_array(:after_attachment_saved, [block])
+ end
+
+ # Callback before a thumbnail is saved. Use this to pass any necessary extra attributes that may be required.
+ #
+ # class Foo < ActiveRecord::Base
+ # acts_as_attachment
+ # before_thumbnail_saved do |record, thumbnail|
+ # ...
+ # end
+ # end
+ def before_thumbnail_saved(&block)
+ write_inheritable_array(:before_thumbnail_saved, [block])
+ end
+
+ # Get the thumbnail class, which is the current attachment class by default.
+ # Configure this with the :thumbnail_class option.
+ def thumbnail_class
+ attachment_options[:thumbnail_class] = attachment_options[:thumbnail_class].constantize unless attachment_options[:thumbnail_class].is_a?(Class)
+ attachment_options[:thumbnail_class]
+ end
+
+ # Copies the given file path to a new tempfile, returning the closed tempfile.
+ def copy_to_temp_file(file, temp_base_name)
+ returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
+ tmp.close
+ FileUtils.cp file, tmp.path
+ end
+ end
+
+ # Writes the given data to a new tempfile, returning the closed tempfile.
+ def write_to_temp_file(data, temp_base_name)
+ returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
+ tmp.binmode
+ tmp.write data
+ tmp.close
+ end
+ end
+ end
+
+ module InstanceMethods
+ # Checks whether the attachment's content type is an image content type
+ def image?
+ self.class.image?(content_type)
+ end
+
+ # Returns true/false if an attachment is thumbnailable. A thumbnailable attachment has an image content type and the parent_id attribute.
+ def thumbnailable?
+ image? && respond_to?(:parent_id) && parent_id.nil?
+ end
+
+ # Returns the class used to create new thumbnails for this attachment.
+ def thumbnail_class
+ self.class.thumbnail_class
+ end
+
+ # Gets the thumbnail name for a filename. 'foo.jpg' becomes 'foo_thumbnail.jpg'
+ def thumbnail_name_for(thumbnail = nil)
+ return filename if thumbnail.blank?
+ ext = nil
+ basename = filename.gsub /\.\w+$/ do |s|
+ ext = s; ''
+ end
+ # ImageScience doesn't create gif thumbnails, only pngs
+ ext.sub!(/gif$/, 'png') if attachment_options[:processor] == "ImageScienceProcessor"
+ "#{basename}_#{thumbnail}#{ext}"
+ end
+
+ # Creates or updates the thumbnail for the current attachment.
+ def create_or_update_thumbnail(temp_file, file_name_suffix, *size)
+ thumbnailable? || raise(ThumbnailError.new("Can't create a thumbnail if the content type is not an image or there is no parent_id column"))
+ returning find_or_initialize_thumbnail(file_name_suffix) do |thumb|
+ thumb.attributes = {
+ :content_type => content_type,
+ :filename => thumbnail_name_for(file_name_suffix),
+ :temp_path => temp_file,
+ :thumbnail_resize_options => size
+ }
+ callback_with_args :before_thumbnail_saved, thumb
+ thumb.save!
+ end
+ end
+
+ # Sets the content type.
+ def content_type=(new_type)
+ write_attribute :content_type, new_type.to_s.strip
+ end
+
+ # Sanitizes a filename.
+ def filename=(new_name)
+ write_attribute :filename, sanitize_filename(new_name)
+ end
+
+ # Returns the width/height in a suitable format for the image_tag helper: (100x100)
+ def image_size
+ [width.to_s, height.to_s] * 'x'
+ end
+
+ # Returns true if the attachment data will be written to the storage system on the next save
+ def save_attachment?
+ File.file?(temp_path.to_s)
+ end
+
+ # nil placeholder in case this field is used in a form.
+ def uploaded_data() nil; end
+
+ # This method handles the uploaded file object. If you set the field name to uploaded_data, you don't need
+ # any special code in your controller.
+ #
+ # <% form_for :attachment, :html => { :multipart => true } do |f| -%>
+ # <p><%= f.file_field :uploaded_data %></p>
+ # <p><%= submit_tag :Save %>
+ # <% end -%>
+ #
+ # @attachment = Attachment.create! params[:attachment]
+ #
+ # TODO: Allow it to work with Merb tempfiles too.
+ def uploaded_data=(file_data)
+ return nil if file_data.nil? || file_data.size == 0
+ self.content_type = file_data.content_type
+ self.filename = file_data.original_filename if respond_to?(:filename)
+ if file_data.is_a?(StringIO)
+ file_data.rewind
+ self.temp_data = file_data.read
+ else
+ self.temp_path = file_data.path
+ end
+ end
+
+ # Gets the latest temp path from the collection of temp paths. While working with an attachment,
+ # multiple Tempfile objects may be created for various processing purposes (resizing, for example).
+ # An array of all the tempfile objects is stored so that the Tempfile instance is held on to until
+ # it's not needed anymore. The collection is cleared after saving the attachment.
+ def temp_path
+ p = temp_paths.first
+ p.respond_to?(:path) ? p.path : p.to_s
+ end
+
+ # Gets an array of the currently used temp paths. Defaults to a copy of #full_filename.
+ def temp_paths
+ @temp_paths ||= (new_record? || !File.exist?(full_filename)) ? [] : [copy_to_temp_file(full_filename)]
+ end
+
+ # Adds a new temp_path to the array. This should take a string or a Tempfile. This class makes no
+ # attempt to remove the files, so Tempfiles should be used. Tempfiles remove themselves when they go out of scope.
+ # You can also use string paths for temporary files, such as those used for uploaded files in a web server.
+ def temp_path=(value)
+ temp_paths.unshift value
+ temp_path
+ end
+
+ # Gets the data from the latest temp file. This will read the file into memory.
+ def temp_data
+ save_attachment? ? File.read(temp_path) : nil
+ end
+
+ # Writes the given data to a Tempfile and adds it to the collection of temp files.
+ def temp_data=(data)
+ self.temp_path = write_to_temp_file data unless data.nil?
+ end
+
+ # Copies the given file to a randomly named Tempfile.
+ def copy_to_temp_file(file)
+ self.class.copy_to_temp_file file, random_tempfile_filename
+ end
+
+ # Writes the given file to a randomly named Tempfile.
+ def write_to_temp_file(data)
+ self.class.write_to_temp_file data, random_tempfile_filename
+ end
+
+ # Stub for creating a temp file from the attachment data. This should be defined in the backend module.
+ def create_temp_file() end
+
+ # Allows you to work with a processed representation (RMagick, ImageScience, etc) of the attachment in a block.
+ #
+ # @attachment.with_image do |img|
+ # self.data = img.thumbnail(100, 100).to_blob
+ # end
+ #
+ def with_image(&block)
+ self.class.with_image(temp_path, &block)
+ end
+
+ protected
+ # Generates a unique filename for a Tempfile.
+ def random_tempfile_filename
+ "#{rand Time.now.to_i}#{filename || 'attachment'}"
+ end
+
+ def sanitize_filename(filename)
+ returning filename.strip do |name|
+ # NOTE: File.basename doesn't work right with Windows paths on Unix
+ # get only the filename, not the whole path
+ name.gsub! /^.*(\\|\/)/, ''
+
+ # Finally, replace all non alphanumeric, underscore or periods with underscore
+ name.gsub! /[^\w\.\-]/, '_'
+ end
+ end
+
+ # before_validation callback.
+ def set_size_from_temp_path
+ self.size = File.size(temp_path) if save_attachment?
+ end
+
+ # validates the size and content_type attributes according to the current model's options
+ def attachment_attributes_valid?
+ [:size, :content_type].each do |attr_name|
+ enum = attachment_options[attr_name]
+ errors.add attr_name, ActiveRecord::Errors.default_error_messages[:inclusion] unless enum.nil? || enum.include?(send(attr_name))
+ end
+ end
+
+ # Initializes a new thumbnail with the given suffix.
+ def find_or_initialize_thumbnail(file_name_suffix)
+ respond_to?(:parent_id) ?
+ thumbnail_class.find_or_initialize_by_thumbnail_and_parent_id(file_name_suffix.to_s, id) :
+ thumbnail_class.find_or_initialize_by_thumbnail(file_name_suffix.to_s)
+ end
+
+ # Stub for a #process_attachment method in a processor
+ def process_attachment
+ @saved_attachment = save_attachment?
+ end
+
+ # Cleans up after processing. Thumbnails are created, the attachment is stored to the backend, and the temp_paths are cleared.
+ def after_process_attachment
+ if @saved_attachment
+ if respond_to?(:process_attachment_with_processing) && thumbnailable? && !attachment_options[:thumbnails].blank? && parent_id.nil?
+ temp_file = temp_path || create_temp_file
+ attachment_options[:thumbnails].each { |suffix, size| create_or_update_thumbnail(temp_file, suffix, *size) }
+ end
+ save_to_storage
+ @temp_paths.clear
+ @saved_attachment = nil
+ callback :after_attachment_saved
+ end
+ end
+
+ # Resizes the given processed img object with either the attachment resize options or the thumbnail resize options.
+ def resize_image_or_thumbnail!(img)
+ if (!respond_to?(:parent_id) || parent_id.nil?) && attachment_options[:resize_to] # parent image
+ resize_image(img, attachment_options[:resize_to])
+ elsif thumbnail_resize_options # thumbnail
+ resize_image(img, thumbnail_resize_options)
+ end
+ end
+
+ # Yanked from ActiveRecord::Callbacks, modified so I can pass args to the callbacks besides self.
+ # Only accept blocks, however
+ def callback_with_args(method, arg = self)
+ notify(method)
+
+ result = nil
+ callbacks_for(method).each do |callback|
+ result = callback.call(self, arg)
+ return false if result == false
+ end
+
+ return result
+ end
+
+ # Removes the thumbnails for the attachment, if it has any
+ def destroy_thumbnails
+ self.thumbnails.each { |thumbnail| thumbnail.destroy } if thumbnailable?
+ end
+ end
+ end
+end
--- /dev/null
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ module Backends
+ # Methods for DB backed attachments
+ module DbFileBackend
+ def self.included(base) #:nodoc:
+ Object.const_set(:DbFile, Class.new(ActiveRecord::Base)) unless Object.const_defined?(:DbFile)
+ base.belongs_to :db_file, :class_name => '::DbFile', :foreign_key => 'db_file_id'
+ end
+
+ # Creates a temp file with the current db data.
+ def create_temp_file
+ write_to_temp_file current_data
+ end
+
+ # Gets the current data from the database
+ def current_data
+ db_file.data
+ end
+
+ protected
+ # Destroys the file. Called in the after_destroy callback
+ def destroy_file
+ db_file.destroy if db_file
+ end
+
+ # Saves the data to the DbFile model
+ def save_to_storage
+ if save_attachment?
+ (db_file || build_db_file).data = temp_data
+ db_file.save!
+ self.class.update_all ['db_file_id = ?', self.db_file_id = db_file.id], ['id = ?', id]
+ end
+ true
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require 'ftools'
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ module Backends
+ # Methods for file system backed attachments
+ module FileSystemBackend
+ def self.included(base) #:nodoc:
+ base.before_update :rename_file
+ end
+
+ # Gets the full path to the filename in this format:
+ #
+ # # This assumes a model name like MyModel
+ # # public/#{table_name} is the default filesystem path
+ # RAILS_ROOT/public/my_models/5/blah.jpg
+ #
+ # Overwrite this method in your model to customize the filename.
+ # The optional thumbnail argument will output the thumbnail's filename.
+ def full_filename(thumbnail = nil)
+ file_system_path = (thumbnail ? thumbnail_class : self).attachment_options[:path_prefix].to_s
+ File.join(RAILS_ROOT, file_system_path, *partitioned_path(thumbnail_name_for(thumbnail)))
+ end
+
+ # Used as the base path that #public_filename strips off full_filename to create the public path
+ def base_path
+ @base_path ||= File.join(RAILS_ROOT, 'public')
+ end
+
+ # The attachment ID used in the full path of a file
+ def attachment_path_id
+ ((respond_to?(:parent_id) && parent_id) || id).to_i
+ end
+
+ # overrwrite this to do your own app-specific partitioning.
+ # you can thank Jamis Buck for this: http://www.37signals.com/svn/archives2/id_partitioning.php
+ def partitioned_path(*args)
+ ("%08d" % attachment_path_id).scan(/..../) + args
+ end
+
+ # Gets the public path to the file
+ # The optional thumbnail argument will output the thumbnail's filename.
+ def public_filename(thumbnail = nil)
+ full_filename(thumbnail).gsub %r(^#{Regexp.escape(base_path)}), ''
+ end
+
+ def filename=(value)
+ @old_filename = full_filename unless filename.nil? || @old_filename
+ write_attribute :filename, sanitize_filename(value)
+ end
+
+ # Creates a temp file from the currently saved file.
+ def create_temp_file
+ copy_to_temp_file full_filename
+ end
+
+ protected
+ # Destroys the file. Called in the after_destroy callback
+ def destroy_file
+ FileUtils.rm full_filename
+ # remove directory also if it is now empty
+ Dir.rmdir(File.dirname(full_filename)) if (Dir.entries(File.dirname(full_filename))-['.','..']).empty?
+ rescue
+ logger.info "Exception destroying #{full_filename.inspect}: [#{$!.class.name}] #{$1.to_s}"
+ logger.warn $!.backtrace.collect { |b| " > #{b}" }.join("\n")
+ end
+
+ # Renames the given file before saving
+ def rename_file
+ return unless @old_filename && @old_filename != full_filename
+ if save_attachment? && File.exists?(@old_filename)
+ FileUtils.rm @old_filename
+ elsif File.exists?(@old_filename)
+ FileUtils.mv @old_filename, full_filename
+ end
+ @old_filename = nil
+ true
+ end
+
+ # Saves the file to the file system
+ def save_to_storage
+ if save_attachment?
+ # TODO: This overwrites the file if it exists, maybe have an allow_overwrite option?
+ FileUtils.mkdir_p(File.dirname(full_filename))
+ File.cp(temp_path, full_filename)
+ File.chmod(attachment_options[:chmod] || 0644, full_filename)
+ end
+ @old_filename = nil
+ true
+ end
+
+ def current_data
+ File.file?(full_filename) ? File.read(full_filename) : nil
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ module Backends
+ # = AWS::S3 Storage Backend
+ #
+ # Enables use of {Amazon's Simple Storage Service}[http://aws.amazon.com/s3] as a storage mechanism
+ #
+ # == Requirements
+ #
+ # Requires the {AWS::S3 Library}[http://amazon.rubyforge.org] for S3 by Marcel Molina Jr. installed either
+ # as a gem or a as a Rails plugin.
+ #
+ # == Configuration
+ #
+ # Configuration is done via <tt>RAILS_ROOT/config/amazon_s3.yml</tt> and is loaded according to the <tt>RAILS_ENV</tt>.
+ # The minimum connection options that you must specify are a bucket name, your access key id and your secret access key.
+ # If you don't already have your access keys, all you need to sign up for the S3 service is an account at Amazon.
+ # You can sign up for S3 and get access keys by visiting http://aws.amazon.com/s3.
+ #
+ # Example configuration (RAILS_ROOT/config/amazon_s3.yml)
+ #
+ # development:
+ # bucket_name: appname_development
+ # access_key_id: <your key>
+ # secret_access_key: <your key>
+ #
+ # test:
+ # bucket_name: appname_test
+ # access_key_id: <your key>
+ # secret_access_key: <your key>
+ #
+ # production:
+ # bucket_name: appname
+ # access_key_id: <your key>
+ # secret_access_key: <your key>
+ #
+ # You can change the location of the config path by passing a full path to the :s3_config_path option.
+ #
+ # has_attachment :storage => :s3, :s3_config_path => (RAILS_ROOT + '/config/s3.yml')
+ #
+ # === Required configuration parameters
+ #
+ # * <tt>:access_key_id</tt> - The access key id for your S3 account. Provided by Amazon.
+ # * <tt>:secret_access_key</tt> - The secret access key for your S3 account. Provided by Amazon.
+ # * <tt>:bucket_name</tt> - A unique bucket name (think of the bucket_name as being like a database name).
+ #
+ # If any of these required arguments is missing, a MissingAccessKey exception will be raised from AWS::S3.
+ #
+ # == About bucket names
+ #
+ # Bucket names have to be globaly unique across the S3 system. And you can only have up to 100 of them,
+ # so it's a good idea to think of a bucket as being like a database, hence the correspondance in this
+ # implementation to the development, test, and production environments.
+ #
+ # The number of objects you can store in a bucket is, for all intents and purposes, unlimited.
+ #
+ # === Optional configuration parameters
+ #
+ # * <tt>:server</tt> - The server to make requests to. Defaults to <tt>s3.amazonaws.com</tt>.
+ # * <tt>:port</tt> - The port to the requests should be made on. Defaults to 80 or 443 if <tt>:use_ssl</tt> is set.
+ # * <tt>:use_ssl</tt> - If set to true, <tt>:port</tt> will be implicitly set to 443, unless specified otherwise. Defaults to false.
+ #
+ # == Usage
+ #
+ # To specify S3 as the storage mechanism for a model, set the acts_as_attachment <tt>:storage</tt> option to <tt>:s3</tt>.
+ #
+ # class Photo < ActiveRecord::Base
+ # has_attachment :storage => :s3
+ # end
+ #
+ # === Customizing the path
+ #
+ # By default, files are prefixed using a pseudo hierarchy in the form of <tt>:table_name/:id</tt>, which results
+ # in S3 urls that look like: http(s)://:server/:bucket_name/:table_name/:id/:filename with :table_name
+ # representing the customizable portion of the path. You can customize this prefix using the <tt>:path_prefix</tt>
+ # option:
+ #
+ # class Photo < ActiveRecord::Base
+ # has_attachment :storage => :s3, :path_prefix => 'my/custom/path'
+ # end
+ #
+ # Which would result in URLs like <tt>http(s)://:server/:bucket_name/my/custom/path/:id/:filename.</tt>
+ #
+ # === Permissions
+ #
+ # By default, files are stored on S3 with public access permissions. You can customize this using
+ # the <tt>:s3_access</tt> option to <tt>has_attachment</tt>. Available values are
+ # <tt>:private</tt>, <tt>:public_read_write</tt>, and <tt>:authenticated_read</tt>.
+ #
+ # === Other options
+ #
+ # Of course, all the usual configuration options apply, such as content_type and thumbnails:
+ #
+ # class Photo < ActiveRecord::Base
+ # has_attachment :storage => :s3, :content_type => ['application/pdf', :image], :resize_to => 'x50'
+ # has_attachment :storage => :s3, :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+ # end
+ #
+ # === Accessing S3 URLs
+ #
+ # You can get an object's URL using the s3_url accessor. For example, assuming that for your postcard app
+ # you had a bucket name like 'postcard_world_development', and an attachment model called Photo:
+ #
+ # @postcard.s3_url # => http(s)://s3.amazonaws.com/postcard_world_development/photos/1/mexico.jpg
+ #
+ # The resulting url is in the form: http(s)://:server/:bucket_name/:table_name/:id/:file.
+ # The optional thumbnail argument will output the thumbnail's filename (if any).
+ #
+ # Additionally, you can get an object's base path relative to the bucket root using
+ # <tt>base_path</tt>:
+ #
+ # @photo.file_base_path # => photos/1
+ #
+ # And the full path (including the filename) using <tt>full_filename</tt>:
+ #
+ # @photo.full_filename # => photos/
+ #
+ # Niether <tt>base_path</tt> or <tt>full_filename</tt> include the bucket name as part of the path.
+ # You can retrieve the bucket name using the <tt>bucket_name</tt> method.
+ module S3Backend
+ class RequiredLibraryNotFoundError < StandardError; end
+ class ConfigFileNotFoundError < StandardError; end
+
+ def self.included(base) #:nodoc:
+ mattr_reader :bucket_name, :s3_config
+
+ begin
+ require 'aws/s3'
+ include AWS::S3
+ rescue LoadError
+ raise RequiredLibraryNotFoundError.new('AWS::S3 could not be loaded')
+ end
+
+ begin
+ @@s3_config_path = base.attachment_options[:s3_config_path] || (RAILS_ROOT + '/config/amazon_s3.yml')
+ @@s3_config = @@s3_config = YAML.load_file(@@s3_config_path)[RAILS_ENV].symbolize_keys
+ #rescue
+ # raise ConfigFileNotFoundError.new('File %s not found' % @@s3_config_path)
+ end
+
+ @@bucket_name = s3_config[:bucket_name]
+
+ Base.establish_connection!(
+ :access_key_id => s3_config[:access_key_id],
+ :secret_access_key => s3_config[:secret_access_key],
+ :server => s3_config[:server],
+ :port => s3_config[:port],
+ :use_ssl => s3_config[:use_ssl]
+ )
+
+ # Bucket.create(@@bucket_name)
+
+ base.before_update :rename_file
+ end
+
+ def self.protocol
+ @protocol ||= s3_config[:use_ssl] ? 'https://' : 'http://'
+ end
+
+ def self.hostname
+ @hostname ||= s3_config[:server] || AWS::S3::DEFAULT_HOST
+ end
+
+ def self.port_string
+ @port_string ||= s3_config[:port] == (s3_config[:use_ssl] ? 443 : 80) ? '' : ":#{s3_config[:port]}"
+ end
+
+ module ClassMethods
+ def s3_protocol
+ Technoweenie::AttachmentFu::Backends::S3Backend.protocol
+ end
+
+ def s3_hostname
+ Technoweenie::AttachmentFu::Backends::S3Backend.hostname
+ end
+
+ def s3_port_string
+ Technoweenie::AttachmentFu::Backends::S3Backend.port_string
+ end
+ end
+
+ # Overwrites the base filename writer in order to store the old filename
+ def filename=(value)
+ @old_filename = filename unless filename.nil? || @old_filename
+ write_attribute :filename, sanitize_filename(value)
+ end
+
+ # The attachment ID used in the full path of a file
+ def attachment_path_id
+ ((respond_to?(:parent_id) && parent_id) || id).to_s
+ end
+
+ # The pseudo hierarchy containing the file relative to the bucket name
+ # Example: <tt>:table_name/:id</tt>
+ def base_path
+ File.join(attachment_options[:path_prefix], attachment_path_id)
+ end
+
+ # The full path to the file relative to the bucket name
+ # Example: <tt>:table_name/:id/:filename</tt>
+ def full_filename(thumbnail = nil)
+ File.join(base_path, thumbnail_name_for(thumbnail))
+ end
+
+ # All public objects are accessible via a GET request to the S3 servers. You can generate a
+ # url for an object using the s3_url method.
+ #
+ # @photo.s3_url
+ #
+ # The resulting url is in the form: <tt>http(s)://:server/:bucket_name/:table_name/:id/:file</tt> where
+ # the <tt>:server</tt> variable defaults to <tt>AWS::S3 URL::DEFAULT_HOST</tt> (s3.amazonaws.com) and can be
+ # set using the configuration parameters in <tt>RAILS_ROOT/config/amazon_s3.yml</tt>.
+ #
+ # The optional thumbnail argument will output the thumbnail's filename (if any).
+ def s3_url(thumbnail = nil)
+ File.join(s3_protocol + s3_hostname + s3_port_string, bucket_name, full_filename(thumbnail))
+ end
+ alias :public_filename :s3_url
+
+ # All private objects are accessible via an authenticated GET request to the S3 servers. You can generate an
+ # authenticated url for an object like this:
+ #
+ # @photo.authenticated_s3_url
+ #
+ # By default authenticated urls expire 5 minutes after they were generated.
+ #
+ # Expiration options can be specified either with an absolute time using the <tt>:expires</tt> option,
+ # or with a number of seconds relative to now with the <tt>:expires_in</tt> option:
+ #
+ # # Absolute expiration date (October 13th, 2025)
+ # @photo.authenticated_s3_url(:expires => Time.mktime(2025,10,13).to_i)
+ #
+ # # Expiration in five hours from now
+ # @photo.authenticated_s3_url(:expires_in => 5.hours)
+ #
+ # You can specify whether the url should go over SSL with the <tt>:use_ssl</tt> option.
+ # By default, the ssl settings for the current connection will be used:
+ #
+ # @photo.authenticated_s3_url(:use_ssl => true)
+ #
+ # Finally, the optional thumbnail argument will output the thumbnail's filename (if any):
+ #
+ # @photo.authenticated_s3_url('thumbnail', :expires_in => 5.hours, :use_ssl => true)
+ def authenticated_s3_url(*args)
+ thumbnail = args.first.is_a?(String) ? args.first : nil
+ options = args.last.is_a?(Hash) ? args.last : {}
+ S3Object.url_for(full_filename(thumbnail), bucket_name, options)
+ end
+
+ def create_temp_file
+ write_to_temp_file current_data
+ end
+
+ def current_data
+ S3Object.value full_filename, bucket_name
+ end
+
+ def s3_protocol
+ Technoweenie::AttachmentFu::Backends::S3Backend.protocol
+ end
+
+ def s3_hostname
+ Technoweenie::AttachmentFu::Backends::S3Backend.hostname
+ end
+
+ def s3_port_string
+ Technoweenie::AttachmentFu::Backends::S3Backend.port_string
+ end
+
+ protected
+ # Called in the after_destroy callback
+ def destroy_file
+ S3Object.delete full_filename, bucket_name
+ end
+
+ def rename_file
+ return unless @old_filename && @old_filename != filename
+
+ old_full_filename = File.join(base_path, @old_filename)
+
+ S3Object.rename(
+ old_full_filename,
+ full_filename,
+ bucket_name,
+ :access => attachment_options[:s3_access]
+ )
+
+ @old_filename = nil
+ true
+ end
+
+ def save_to_storage
+ if save_attachment?
+ S3Object.store(
+ full_filename,
+ (temp_path ? File.open(temp_path) : temp_data),
+ bucket_name,
+ :content_type => content_type,
+ :access => attachment_options[:s3_access]
+ )
+ end
+
+ @old_filename = nil
+ true
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require 'image_science'
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ module Processors
+ module ImageScienceProcessor
+ def self.included(base)
+ base.send :extend, ClassMethods
+ base.alias_method_chain :process_attachment, :processing
+ end
+
+ module ClassMethods
+ # Yields a block containing an RMagick Image for the given binary data.
+ def with_image(file, &block)
+ ::ImageScience.with_image file, &block
+ end
+ end
+
+ protected
+ def process_attachment_with_processing
+ return unless process_attachment_without_processing && image?
+ with_image do |img|
+ self.width = img.width if respond_to?(:width)
+ self.height = img.height if respond_to?(:height)
+ resize_image_or_thumbnail! img
+ end
+ end
+
+ # Performs the actual resizing operation for a thumbnail
+ def resize_image(img, size)
+ # create a dummy temp file to write to
+ # ImageScience doesn't handle all gifs properly, so it converts them to
+ # pngs for thumbnails. It has something to do with trying to save gifs
+ # with a larger palette than 256 colors, which is all the gif format
+ # supports.
+ filename.sub! /gif$/, 'png'
+ content_type.sub!(/gif$/, 'png')
+ self.temp_path = write_to_temp_file(filename)
+ grab_dimensions = lambda do |img|
+ self.width = img.width if respond_to?(:width)
+ self.height = img.height if respond_to?(:height)
+ img.save self.temp_path
+ self.size = File.size(self.temp_path)
+ callback_with_args :after_resize, img
+ end
+
+ size = size.first if size.is_a?(Array) && size.length == 1
+ if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+ if size.is_a?(Fixnum)
+ img.thumbnail(size, &grab_dimensions)
+ else
+ img.resize(size[0], size[1], &grab_dimensions)
+ end
+ else
+ new_size = [img.width, img.height] / size.to_s
+ img.resize(new_size[0], new_size[1], &grab_dimensions)
+ end
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require 'mini_magick'
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ module Processors
+ module MiniMagickProcessor
+ def self.included(base)
+ base.send :extend, ClassMethods
+ base.alias_method_chain :process_attachment, :processing
+ end
+
+ module ClassMethods
+ # Yields a block containing an MiniMagick Image for the given binary data.
+ def with_image(file, &block)
+ begin
+ binary_data = file.is_a?(MiniMagick::Image) ? file : MiniMagick::Image.from_file(file) unless !Object.const_defined?(:MiniMagick)
+ rescue
+ # Log the failure to load the image.
+ logger.debug("Exception working with image: #{$!}")
+ binary_data = nil
+ end
+ block.call binary_data if block && binary_data
+ ensure
+ !binary_data.nil?
+ end
+ end
+
+ protected
+ def process_attachment_with_processing
+ return unless process_attachment_without_processing
+ with_image do |img|
+ resize_image_or_thumbnail! img
+ self.width = img[:width] if respond_to?(:width)
+ self.height = img[:height] if respond_to?(:height)
+ callback_with_args :after_resize, img
+ end if image?
+ end
+
+ # Performs the actual resizing operation for a thumbnail
+ def resize_image(img, size)
+ size = size.first if size.is_a?(Array) && size.length == 1
+ if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+ if size.is_a?(Fixnum)
+ size = [size, size]
+ img.resize(size.join('x'))
+ else
+ img.resize(size.join('x') + '!')
+ end
+ else
+ img.resize(size.to_s)
+ end
+ self.temp_path = img
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require 'RMagick'
+module Technoweenie # :nodoc:
+ module AttachmentFu # :nodoc:
+ module Processors
+ module RmagickProcessor
+ def self.included(base)
+ base.send :extend, ClassMethods
+ base.alias_method_chain :process_attachment, :processing
+ end
+
+ module ClassMethods
+ # Yields a block containing an RMagick Image for the given binary data.
+ def with_image(file, &block)
+ begin
+ binary_data = file.is_a?(Magick::Image) ? file : Magick::Image.read(file).first unless !Object.const_defined?(:Magick)
+ rescue
+ # Log the failure to load the image. This should match ::Magick::ImageMagickError
+ # but that would cause acts_as_attachment to require rmagick.
+ logger.debug("Exception working with image: #{$!}")
+ binary_data = nil
+ end
+ block.call binary_data if block && binary_data
+ ensure
+ !binary_data.nil?
+ end
+ end
+
+ protected
+ def process_attachment_with_processing
+ return unless process_attachment_without_processing
+ with_image do |img|
+ resize_image_or_thumbnail! img
+ self.width = img.columns if respond_to?(:width)
+ self.height = img.rows if respond_to?(:height)
+ callback_with_args :after_resize, img
+ end if image?
+ end
+
+ # Performs the actual resizing operation for a thumbnail
+ def resize_image(img, size)
+ size = size.first if size.is_a?(Array) && size.length == 1 && !size.first.is_a?(Fixnum)
+ if size.is_a?(Fixnum) || (size.is_a?(Array) && size.first.is_a?(Fixnum))
+ size = [size, size] if size.is_a?(Fixnum)
+ img.thumbnail!(*size)
+ else
+ img.change_geometry(size.to_s) { |cols, rows, image| image.resize!(cols, rows) }
+ end
+ self.temp_path = write_to_temp_file(img.to_blob)
+ end
+ end
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+test:
+ bucket_name: afu
+ access_key_id: YOURACCESSKEY
+ secret_access_key: YOURSECRETACCESSKEY
+ server: 127.0.0.1
+ port: 3002
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class DbFileTest < Test::Unit::TestCase
+ include BaseAttachmentTests
+ attachment_model Attachment
+
+ def test_should_call_after_attachment_saved(klass = Attachment)
+ attachment_model.saves = 0
+ assert_created do
+ upload_file :filename => '/files/rails.png'
+ end
+ assert_equal 1, attachment_model.saves
+ end
+
+ test_against_subclass :test_should_call_after_attachment_saved, Attachment
+end
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class FileSystemTest < Test::Unit::TestCase
+ include BaseAttachmentTests
+ attachment_model FileAttachment
+
+ def test_filesystem_size_for_file_attachment(klass = FileAttachment)
+ attachment_model klass
+ assert_created 1 do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_equal attachment.size, File.open(attachment.full_filename).stat.size
+ end
+ end
+
+ test_against_subclass :test_filesystem_size_for_file_attachment, FileAttachment
+
+ def test_should_not_overwrite_file_attachment(klass = FileAttachment)
+ attachment_model klass
+ assert_created 2 do
+ real = upload_file :filename => '/files/rails.png'
+ assert_valid real
+ assert !real.new_record?, real.errors.full_messages.join("\n")
+ assert !real.size.zero?
+
+ fake = upload_file :filename => '/files/fake/rails.png'
+ assert_valid fake
+ assert !fake.size.zero?
+
+ assert_not_equal File.open(real.full_filename).stat.size, File.open(fake.full_filename).stat.size
+ end
+ end
+
+ test_against_subclass :test_should_not_overwrite_file_attachment, FileAttachment
+
+ def test_should_store_file_attachment_in_filesystem(klass = FileAttachment)
+ attachment_model klass
+ attachment = nil
+ assert_created do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert File.exists?(attachment.full_filename), "#{attachment.full_filename} does not exist"
+ end
+ attachment
+ end
+
+ test_against_subclass :test_should_store_file_attachment_in_filesystem, FileAttachment
+
+ def test_should_delete_old_file_when_updating(klass = FileAttachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ old_filename = attachment.full_filename
+ assert_not_created do
+ use_temp_file 'files/rails.png' do |file|
+ attachment.filename = 'rails2.png'
+ attachment.temp_path = File.join(fixture_path, file)
+ attachment.save!
+ assert File.exists?(attachment.full_filename), "#{attachment.full_filename} does not exist"
+ assert !File.exists?(old_filename), "#{old_filename} still exists"
+ end
+ end
+ end
+
+ test_against_subclass :test_should_delete_old_file_when_updating, FileAttachment
+
+ def test_should_delete_old_file_when_renaming(klass = FileAttachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ old_filename = attachment.full_filename
+ assert_not_created do
+ attachment.filename = 'rails2.png'
+ attachment.save
+ assert File.exists?(attachment.full_filename), "#{attachment.full_filename} does not exist"
+ assert !File.exists?(old_filename), "#{old_filename} still exists"
+ assert !attachment.reload.size.zero?
+ assert_equal 'rails2.png', attachment.filename
+ end
+ end
+
+ test_against_subclass :test_should_delete_old_file_when_renaming, FileAttachment
+end
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'test_helper'))
+require 'net/http'
+
+class S3Test < Test::Unit::TestCase
+ if File.exist?(File.join(File.dirname(__FILE__), '../../amazon_s3.yml'))
+ include BaseAttachmentTests
+ attachment_model S3Attachment
+
+ def test_should_create_correct_bucket_name(klass = S3Attachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_equal attachment.s3_config[:bucket_name], attachment.bucket_name
+ end
+
+ test_against_subclass :test_should_create_correct_bucket_name, S3Attachment
+
+ def test_should_create_default_path_prefix(klass = S3Attachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_equal File.join(attachment_model.table_name, attachment.attachment_path_id), attachment.base_path
+ end
+
+ test_against_subclass :test_should_create_default_path_prefix, S3Attachment
+
+ def test_should_create_custom_path_prefix(klass = S3WithPathPrefixAttachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_equal File.join('some/custom/path/prefix', attachment.attachment_path_id), attachment.base_path
+ end
+
+ test_against_subclass :test_should_create_custom_path_prefix, S3WithPathPrefixAttachment
+
+ def test_should_create_valid_url(klass = S3Attachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_equal "#{s3_protocol}#{s3_hostname}#{s3_port_string}/#{attachment.bucket_name}/#{attachment.full_filename}", attachment.s3_url
+ end
+
+ test_against_subclass :test_should_create_valid_url, S3Attachment
+
+ def test_should_create_authenticated_url(klass = S3Attachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_match /^http.+AWSAccessKeyId.+Expires.+Signature.+/, attachment.authenticated_s3_url(:use_ssl => true)
+ end
+
+ test_against_subclass :test_should_create_authenticated_url, S3Attachment
+
+ def test_should_save_attachment(klass = S3Attachment)
+ attachment_model klass
+ assert_created do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert attachment.image?
+ assert !attachment.size.zero?
+ assert_kind_of Net::HTTPOK, http_response_for(attachment.s3_url)
+ end
+ end
+
+ test_against_subclass :test_should_save_attachment, S3Attachment
+
+ def test_should_delete_attachment_from_s3_when_attachment_record_destroyed(klass = S3Attachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+
+ urls = [attachment.s3_url] + attachment.thumbnails.collect(&:s3_url)
+
+ urls.each {|url| assert_kind_of Net::HTTPOK, http_response_for(url) }
+ attachment.destroy
+ urls.each do |url|
+ begin
+ http_response_for(url)
+ rescue Net::HTTPForbidden, Net::HTTPNotFound
+ nil
+ end
+ end
+ end
+
+ test_against_subclass :test_should_delete_attachment_from_s3_when_attachment_record_destroyed, S3Attachment
+
+ protected
+ def http_response_for(url)
+ url = URI.parse(url)
+ Net::HTTP.start(url.host, url.port) {|http| http.request_head(url.path) }
+ end
+
+ def s3_protocol
+ Technoweenie::AttachmentFu::Backends::S3Backend.protocol
+ end
+
+ def s3_hostname
+ Technoweenie::AttachmentFu::Backends::S3Backend.hostname
+ end
+
+ def s3_port_string
+ Technoweenie::AttachmentFu::Backends::S3Backend.port_string
+ end
+ else
+ def test_flunk_s3
+ puts "s3 config file not loaded, tests not running"
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+module BaseAttachmentTests
+ def test_should_create_file_from_uploaded_file
+ assert_created do
+ attachment = upload_file :filename => '/files/foo.txt'
+ assert_valid attachment
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert attachment.image?
+ assert !attachment.size.zero?
+ #assert_equal 3, attachment.size
+ assert_nil attachment.width
+ assert_nil attachment.height
+ end
+ end
+
+ def test_reassign_attribute_data
+ assert_created 1 do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert attachment.size > 0, "no data was set"
+
+ attachment.temp_data = 'wtf'
+ assert attachment.save_attachment?
+ attachment.save!
+
+ assert_equal 'wtf', attachment_model.find(attachment.id).send(:current_data)
+ end
+ end
+
+ def test_no_reassign_attribute_data_on_nil
+ assert_created 1 do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert attachment.size > 0, "no data was set"
+
+ attachment.temp_data = nil
+ assert !attachment.save_attachment?
+ end
+ end
+
+ def test_should_overwrite_old_contents_when_updating
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_not_created do # no new db_file records
+ use_temp_file 'files/rails.png' do |file|
+ attachment.filename = 'rails2.png'
+ attachment.temp_path = File.join(fixture_path, file)
+ attachment.save!
+ end
+ end
+ end
+
+ def test_should_save_without_updating_file
+ attachment = upload_file :filename => '/files/foo.txt'
+ assert_valid attachment
+ assert !attachment.save_attachment?
+ assert_nothing_raised { attachment.save! }
+ end
+end
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class BasicTest < Test::Unit::TestCase
+ def test_should_set_default_min_size
+ assert_equal 1, Attachment.attachment_options[:min_size]
+ end
+
+ def test_should_set_default_max_size
+ assert_equal 1.megabyte, Attachment.attachment_options[:max_size]
+ end
+
+ def test_should_set_default_size
+ assert_equal (1..1.megabyte), Attachment.attachment_options[:size]
+ end
+
+ def test_should_set_default_thumbnails_option
+ assert_equal Hash.new, Attachment.attachment_options[:thumbnails]
+ end
+
+ def test_should_set_default_thumbnail_class
+ assert_equal Attachment, Attachment.attachment_options[:thumbnail_class]
+ end
+
+ def test_should_normalize_content_types_to_array
+ assert_equal %w(pdf), PdfAttachment.attachment_options[:content_type]
+ assert_equal %w(pdf doc txt), DocAttachment.attachment_options[:content_type]
+ assert_equal ['image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg'], ImageAttachment.attachment_options[:content_type]
+ assert_equal ['pdf', 'image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg'], ImageOrPdfAttachment.attachment_options[:content_type]
+ end
+
+ def test_should_sanitize_content_type
+ @attachment = Attachment.new :content_type => ' foo '
+ assert_equal 'foo', @attachment.content_type
+ end
+
+ def test_should_sanitize_filenames
+ @attachment = Attachment.new :filename => 'blah/foo.bar'
+ assert_equal 'foo.bar', @attachment.filename
+
+ @attachment.filename = 'blah\\foo.bar'
+ assert_equal 'foo.bar', @attachment.filename
+
+ @attachment.filename = 'f o!O-.bar'
+ assert_equal 'f_o_O-.bar', @attachment.filename
+ end
+
+ def test_should_convert_thumbnail_name
+ @attachment = FileAttachment.new :filename => 'foo.bar'
+ assert_equal 'foo.bar', @attachment.thumbnail_name_for(nil)
+ assert_equal 'foo.bar', @attachment.thumbnail_name_for('')
+ assert_equal 'foo_blah.bar', @attachment.thumbnail_name_for(:blah)
+ assert_equal 'foo_blah.blah.bar', @attachment.thumbnail_name_for('blah.blah')
+
+ @attachment.filename = 'foo.bar.baz'
+ assert_equal 'foo.bar_blah.baz', @attachment.thumbnail_name_for(:blah)
+ end
+
+ def test_should_require_valid_thumbnails_option
+ klass = Class.new(ActiveRecord::Base)
+ assert_raise ArgumentError do
+ klass.has_attachment :thumbnails => []
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class OrphanAttachmentTest < Test::Unit::TestCase
+ include BaseAttachmentTests
+ attachment_model OrphanAttachment
+
+ def test_should_create_image_from_uploaded_file
+ assert_created do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert attachment.image?
+ assert !attachment.size.zero?
+ end
+ end
+
+ def test_should_create_file_from_uploaded_file
+ assert_created do
+ attachment = upload_file :filename => '/files/foo.txt'
+ assert_valid attachment
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert attachment.image?
+ assert !attachment.size.zero?
+ end
+ end
+
+ def test_should_create_image_from_uploaded_file_with_custom_content_type
+ assert_created do
+ attachment = upload_file :content_type => 'foo/bar', :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.image?
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert !attachment.size.zero?
+ #assert_equal 1784, attachment.size
+ end
+ end
+
+ def test_should_create_thumbnail
+ attachment = upload_file :filename => '/files/rails.png'
+
+ assert_raise Technoweenie::AttachmentFu::ThumbnailError do
+ attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 50, 50)
+ end
+ end
+
+ def test_should_create_thumbnail_with_geometry_string
+ attachment = upload_file :filename => '/files/rails.png'
+
+ assert_raise Technoweenie::AttachmentFu::ThumbnailError do
+ attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 'x50')
+ end
+ end
+end
+
+class MinimalAttachmentTest < OrphanAttachmentTest
+ attachment_model MinimalAttachment
+end
\ No newline at end of file
--- /dev/null
+class Attachment < ActiveRecord::Base
+ @@saves = 0
+ cattr_accessor :saves
+ has_attachment :processor => :rmagick
+ validates_as_attachment
+ after_attachment_saved do |record|
+ self.saves += 1
+ end
+end
+
+class SmallAttachment < Attachment
+ has_attachment :max_size => 1.kilobyte
+end
+
+class BigAttachment < Attachment
+ has_attachment :size => 1.megabyte..2.megabytes
+end
+
+class PdfAttachment < Attachment
+ has_attachment :content_type => 'pdf'
+end
+
+class DocAttachment < Attachment
+ has_attachment :content_type => %w(pdf doc txt)
+end
+
+class ImageAttachment < Attachment
+ has_attachment :content_type => :image, :resize_to => [50,50]
+end
+
+class ImageOrPdfAttachment < Attachment
+ has_attachment :content_type => ['pdf', :image], :resize_to => 'x50'
+end
+
+class ImageWithThumbsAttachment < Attachment
+ has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }, :resize_to => [55,55]
+ after_resize do |record, img|
+ record.aspect_ratio = img.columns.to_f / img.rows.to_f
+ end
+end
+
+class FileAttachment < ActiveRecord::Base
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files', :processor => :rmagick
+ validates_as_attachment
+end
+
+class ImageFileAttachment < FileAttachment
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
+ :content_type => :image, :resize_to => [50,50]
+end
+
+class ImageWithThumbsFileAttachment < FileAttachment
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
+ :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }, :resize_to => [55,55]
+ after_resize do |record, img|
+ record.aspect_ratio = img.columns.to_f / img.rows.to_f
+ end
+end
+
+class ImageWithThumbsClassFileAttachment < FileAttachment
+ # use file_system_path to test backwards compatibility
+ has_attachment :file_system_path => 'vendor/plugins/attachment_fu/test/files',
+ :thumbnails => { :thumb => [50, 50] }, :resize_to => [55,55],
+ :thumbnail_class => 'ImageThumbnail'
+end
+
+class ImageThumbnail < FileAttachment
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files/thumbnails'
+end
+
+# no parent
+class OrphanAttachment < ActiveRecord::Base
+ has_attachment :processor => :rmagick
+ validates_as_attachment
+end
+
+# no filename, no size, no content_type
+class MinimalAttachment < ActiveRecord::Base
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files', :processor => :rmagick
+ validates_as_attachment
+
+ def filename
+ "#{id}.file"
+ end
+end
+
+begin
+ class ImageScienceAttachment < ActiveRecord::Base
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
+ :processor => :image_science, :thumbnails => { :thumb => [50, 51], :geometry => '31>' }, :resize_to => 55
+ end
+rescue MissingSourceFile
+ puts $!.message
+ puts "no ImageScience"
+end
+
+begin
+ class MiniMagickAttachment < ActiveRecord::Base
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
+ :processor => :mini_magick, :thumbnails => { :thumb => [50, 51], :geometry => '31>' }, :resize_to => 55
+ end
+rescue MissingSourceFile
+ puts $!.message
+ puts "no Mini Magick"
+end
+
+begin
+ class MiniMagickAttachment < ActiveRecord::Base
+ has_attachment :path_prefix => 'vendor/plugins/attachment_fu/test/files',
+ :processor => :mini_magick, :thumbnails => { :thumb => [50, 51], :geometry => '31>' }, :resize_to => 55
+ end
+rescue MissingSourceFile
+end
+
+begin
+ class S3Attachment < ActiveRecord::Base
+ has_attachment :storage => :s3, :processor => :rmagick, :s3_config_path => File.join(File.dirname(__FILE__), '../amazon_s3.yml')
+ validates_as_attachment
+ end
+
+ class S3WithPathPrefixAttachment < S3Attachment
+ has_attachment :storage => :s3, :path_prefix => 'some/custom/path/prefix', :processor => :rmagick
+ validates_as_attachment
+ end
+rescue Technoweenie::AttachmentFu::Backends::S3Backend::ConfigFileNotFoundError
+ puts "S3 error: #{$!}"
+end
--- /dev/null
+foo
\ No newline at end of file
--- /dev/null
+require 'test/unit'
+require File.expand_path(File.join(File.dirname(__FILE__), '../lib/geometry')) unless Object.const_defined?(:Geometry)
+
+class GeometryTest < Test::Unit::TestCase
+ def test_should_resize
+ assert_geometry 50, 64,
+ "50x50" => [39, 50],
+ "60x60" => [47, 60],
+ "100x100" => [78, 100]
+ end
+
+ def test_should_resize_no_width
+ assert_geometry 50, 64,
+ "x50" => [39, 50],
+ "x60" => [47, 60],
+ "x100" => [78, 100]
+ end
+
+ def test_should_resize_no_height
+ assert_geometry 50, 64,
+ "50" => [50, 64],
+ "60" => [60, 77],
+ "100" => [100, 128]
+ end
+
+ def test_should_resize_with_percent
+ assert_geometry 50, 64,
+ "50x50%" => [25, 32],
+ "60x60%" => [30, 38],
+ "120x112%" => [60, 72]
+ end
+
+ def test_should_resize_with_percent_and_no_width
+ assert_geometry 50, 64,
+ "x50%" => [50, 32],
+ "x60%" => [50, 38],
+ "x112%" => [50, 72]
+ end
+
+ def test_should_resize_with_percent_and_no_height
+ assert_geometry 50, 64,
+ "50%" => [25, 32],
+ "60%" => [30, 38],
+ "120%" => [60, 77]
+ end
+
+ def test_should_resize_with_less
+ assert_geometry 50, 64,
+ "50x50<" => [50, 64],
+ "60x60<" => [50, 64],
+ "100x100<" => [78, 100],
+ "100x112<" => [88, 112],
+ "40x70<" => [50, 64]
+ end
+
+ def test_should_resize_with_less_and_no_width
+ assert_geometry 50, 64,
+ "x50<" => [50, 64],
+ "x60<" => [50, 64],
+ "x100<" => [78, 100]
+ end
+
+ def test_should_resize_with_less_and_no_height
+ assert_geometry 50, 64,
+ "50<" => [50, 64],
+ "60<" => [60, 77],
+ "100<" => [100, 128]
+ end
+
+ def test_should_resize_with_greater
+ assert_geometry 50, 64,
+ "50x50>" => [39, 50],
+ "60x60>" => [47, 60],
+ "100x100>" => [50, 64],
+ "100x112>" => [50, 64],
+ "40x70>" => [40, 51]
+ end
+
+ def test_should_resize_with_greater_and_no_width
+ assert_geometry 50, 64,
+ "x40>" => [31, 40],
+ "x60>" => [47, 60],
+ "x100>" => [50, 64]
+ end
+
+ def test_should_resize_with_greater_and_no_height
+ assert_geometry 50, 64,
+ "40>" => [40, 51],
+ "60>" => [50, 64],
+ "100>" => [50, 64]
+ end
+
+ protected
+ def assert_geometry(width, height, values)
+ values.each do |geo, result|
+ # run twice to verify the Geometry string isn't modified after a run
+ geo = Geometry.from_s(geo)
+ 2.times { assert_equal result, [width, height] / geo }
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class ImageScienceTest < Test::Unit::TestCase
+ attachment_model ImageScienceAttachment
+
+ if Object.const_defined?(:ImageScience)
+ def test_should_resize_image
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert attachment.image?
+ # test image science thumbnail
+ assert_equal 42, attachment.width
+ assert_equal 55, attachment.height
+
+ thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
+ geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
+
+ # test exact resize dimensions
+ assert_equal 50, thumb.width
+ assert_equal 51, thumb.height
+
+ # test geometry string
+ assert_equal 31, geo.width
+ assert_equal 41, geo.height
+ end
+ else
+ def test_flunk
+ puts "ImageScience not loaded, tests not running"
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class MiniMagickTest < Test::Unit::TestCase
+ attachment_model MiniMagickAttachment
+
+ if Object.const_defined?(:MiniMagick)
+ def test_should_resize_image
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert attachment.image?
+ # test MiniMagick thumbnail
+ assert_equal 43, attachment.width
+ assert_equal 55, attachment.height
+
+ thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
+ geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
+
+ # test exact resize dimensions
+ assert_equal 50, thumb.width
+ assert_equal 51, thumb.height
+
+ # test geometry string
+ assert_equal 31, geo.width
+ assert_equal 40, geo.height
+ end
+ else
+ def test_flunk
+ puts "MiniMagick not loaded, tests not running"
+ end
+ end
+end
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'test_helper'))
+
+class RmagickTest < Test::Unit::TestCase
+ attachment_model Attachment
+
+ if Object.const_defined?(:Magick)
+ def test_should_create_image_from_uploaded_file
+ assert_created do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert attachment.image?
+ assert !attachment.size.zero?
+ #assert_equal 1784, attachment.size
+ assert_equal 50, attachment.width
+ assert_equal 64, attachment.height
+ assert_equal '50x64', attachment.image_size
+ end
+ end
+
+ def test_should_create_image_from_uploaded_file_with_custom_content_type
+ assert_created do
+ attachment = upload_file :content_type => 'foo/bar', :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.image?
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert !attachment.size.zero?
+ #assert_equal 1784, attachment.size
+ assert_nil attachment.width
+ assert_nil attachment.height
+ assert_equal [], attachment.thumbnails
+ end
+ end
+
+ def test_should_create_thumbnail
+ attachment = upload_file :filename => '/files/rails.png'
+
+ assert_created do
+ basename, ext = attachment.filename.split '.'
+ thumbnail = attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 50, 50)
+ assert_valid thumbnail
+ assert !thumbnail.size.zero?
+ #assert_in_delta 4673, thumbnail.size, 2
+ assert_equal 50, thumbnail.width
+ assert_equal 50, thumbnail.height
+ assert_equal [thumbnail.id], attachment.thumbnails.collect(&:id)
+ assert_equal attachment.id, thumbnail.parent_id if thumbnail.respond_to?(:parent_id)
+ assert_equal "#{basename}_thumb.#{ext}", thumbnail.filename
+ end
+ end
+
+ def test_should_create_thumbnail_with_geometry_string
+ attachment = upload_file :filename => '/files/rails.png'
+
+ assert_created do
+ basename, ext = attachment.filename.split '.'
+ thumbnail = attachment.create_or_update_thumbnail(attachment.create_temp_file, 'thumb', 'x50')
+ assert_valid thumbnail
+ assert !thumbnail.size.zero?
+ #assert_equal 3915, thumbnail.size
+ assert_equal 39, thumbnail.width
+ assert_equal 50, thumbnail.height
+ assert_equal [thumbnail], attachment.thumbnails
+ assert_equal attachment.id, thumbnail.parent_id if thumbnail.respond_to?(:parent_id)
+ assert_equal "#{basename}_thumb.#{ext}", thumbnail.filename
+ end
+ end
+
+ def test_should_resize_image(klass = ImageAttachment)
+ attachment_model klass
+ assert_equal [50, 50], attachment_model.attachment_options[:resize_to]
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert attachment.image?
+ assert !attachment.size.zero?
+ #assert_in_delta 4673, attachment.size, 2
+ assert_equal 50, attachment.width
+ assert_equal 50, attachment.height
+ end
+
+ test_against_subclass :test_should_resize_image, ImageAttachment
+
+ def test_should_resize_image_with_geometry(klass = ImageOrPdfAttachment)
+ attachment_model klass
+ assert_equal 'x50', attachment_model.attachment_options[:resize_to]
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.db_file.new_record? if attachment.respond_to?(:db_file)
+ assert attachment.image?
+ assert !attachment.size.zero?
+ #assert_equal 3915, attachment.size
+ assert_equal 39, attachment.width
+ assert_equal 50, attachment.height
+ end
+
+ test_against_subclass :test_should_resize_image_with_geometry, ImageOrPdfAttachment
+
+ def test_should_give_correct_thumbnail_filenames(klass = ImageWithThumbsFileAttachment)
+ attachment_model klass
+ assert_created 3 do
+ attachment = upload_file :filename => '/files/rails.png'
+ thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
+ geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
+
+ [attachment, thumb, geo].each { |record| assert_valid record }
+
+ assert_match /rails\.png$/, attachment.full_filename
+ assert_match /rails_geometry\.png$/, attachment.full_filename(:geometry)
+ assert_match /rails_thumb\.png$/, attachment.full_filename(:thumb)
+ end
+ end
+
+ test_against_subclass :test_should_give_correct_thumbnail_filenames, ImageWithThumbsFileAttachment
+
+ def test_should_automatically_create_thumbnails(klass = ImageWithThumbsAttachment)
+ attachment_model klass
+ assert_created 3 do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ assert !attachment.size.zero?
+ #assert_equal 1784, attachment.size
+ assert_equal 55, attachment.width
+ assert_equal 55, attachment.height
+ assert_equal 2, attachment.thumbnails.length
+ assert_equal 1.0, attachment.aspect_ratio
+
+ thumb = attachment.thumbnails.detect { |t| t.filename =~ /_thumb/ }
+ assert !thumb.new_record?, thumb.errors.full_messages.join("\n")
+ assert !thumb.size.zero?
+ #assert_in_delta 4673, thumb.size, 2
+ assert_equal 50, thumb.width
+ assert_equal 50, thumb.height
+ assert_equal 1.0, thumb.aspect_ratio
+
+ geo = attachment.thumbnails.detect { |t| t.filename =~ /_geometry/ }
+ assert !geo.new_record?, geo.errors.full_messages.join("\n")
+ assert !geo.size.zero?
+ #assert_equal 3915, geo.size
+ assert_equal 50, geo.width
+ assert_equal 50, geo.height
+ assert_equal 1.0, geo.aspect_ratio
+ end
+ end
+
+ test_against_subclass :test_should_automatically_create_thumbnails, ImageWithThumbsAttachment
+
+ # same as above method, but test it on a file model
+ test_against_class :test_should_automatically_create_thumbnails, ImageWithThumbsFileAttachment
+ test_against_subclass :test_should_automatically_create_thumbnails_on_class, ImageWithThumbsFileAttachment
+
+ def test_should_use_thumbnail_subclass(klass = ImageWithThumbsClassFileAttachment)
+ attachment_model klass
+ attachment = nil
+ assert_difference ImageThumbnail, :count do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert_valid attachment
+ end
+ assert_kind_of ImageThumbnail, attachment.thumbnails.first
+ assert_equal attachment.id, attachment.thumbnails.first.parent.id
+ assert_kind_of FileAttachment, attachment.thumbnails.first.parent
+ assert_equal 'rails_thumb.png', attachment.thumbnails.first.filename
+ assert_equal attachment.thumbnails.first.full_filename, attachment.full_filename(attachment.thumbnails.first.thumbnail),
+ "#full_filename does not use thumbnail class' path."
+ assert_equal attachment.destroy attachment
+ end
+
+ test_against_subclass :test_should_use_thumbnail_subclass, ImageWithThumbsClassFileAttachment
+
+ def test_should_remove_old_thumbnail_files_when_updating(klass = ImageWithThumbsFileAttachment)
+ attachment_model klass
+ attachment = nil
+ assert_created 3 do
+ attachment = upload_file :filename => '/files/rails.png'
+ end
+
+ old_filenames = [attachment.full_filename] + attachment.thumbnails.collect(&:full_filename)
+
+ assert_not_created do
+ use_temp_file "files/rails.png" do |file|
+ attachment.filename = 'rails2.png'
+ attachment.temp_path = File.join(fixture_path, file)
+ attachment.save
+ new_filenames = [attachment.reload.full_filename] + attachment.thumbnails.collect { |t| t.reload.full_filename }
+ new_filenames.each { |f| assert File.exists?(f), "#{f} does not exist" }
+ old_filenames.each { |f| assert !File.exists?(f), "#{f} still exists" }
+ end
+ end
+ end
+
+ test_against_subclass :test_should_remove_old_thumbnail_files_when_updating, ImageWithThumbsFileAttachment
+
+ def test_should_delete_file_when_in_file_system_when_attachment_record_destroyed(klass = ImageWithThumbsFileAttachment)
+ attachment_model klass
+ attachment = upload_file :filename => '/files/rails.png'
+ filenames = [attachment.full_filename] + attachment.thumbnails.collect(&:full_filename)
+ filenames.each { |f| assert File.exists?(f), "#{f} never existed to delete on destroy" }
+ attachment.destroy
+ filenames.each { |f| assert !File.exists?(f), "#{f} still exists" }
+ end
+
+ test_against_subclass :test_should_delete_file_when_in_file_system_when_attachment_record_destroyed, ImageWithThumbsFileAttachment
+
+ def test_should_overwrite_old_thumbnail_records_when_updating(klass = ImageWithThumbsAttachment)
+ attachment_model klass
+ attachment = nil
+ assert_created 3 do
+ attachment = upload_file :filename => '/files/rails.png'
+ end
+ assert_not_created do # no new db_file records
+ use_temp_file "files/rails.png" do |file|
+ attachment.filename = 'rails2.png'
+ attachment.temp_path = File.join(fixture_path, file)
+ attachment.save!
+ end
+ end
+ end
+
+ test_against_subclass :test_should_overwrite_old_thumbnail_records_when_updating, ImageWithThumbsAttachment
+
+ def test_should_overwrite_old_thumbnail_records_when_renaming(klass = ImageWithThumbsAttachment)
+ attachment_model klass
+ attachment = nil
+ assert_created 3 do
+ attachment = upload_file :class => klass, :filename => '/files/rails.png'
+ end
+ assert_not_created do # no new db_file records
+ attachment.filename = 'rails2.png'
+ attachment.save
+ assert !attachment.reload.size.zero?
+ assert_equal 'rails2.png', attachment.filename
+ end
+ end
+
+ test_against_subclass :test_should_overwrite_old_thumbnail_records_when_renaming, ImageWithThumbsAttachment
+ else
+ def test_flunk
+ puts "RMagick not installed, no tests running"
+ end
+ end
+end
\ No newline at end of file
--- /dev/null
+ActiveRecord::Schema.define(:version => 0) do
+ create_table :attachments, :force => true do |t|
+ t.column :db_file_id, :integer
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :aspect_ratio, :float
+ end
+
+ create_table :file_attachments, :force => true do |t|
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :type, :string
+ t.column :aspect_ratio, :float
+ end
+
+ create_table :image_science_attachments, :force => true do |t|
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :type, :string
+ end
+
+ create_table :mini_magick_attachments, :force => true do |t|
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :type, :string
+ end
+
+ create_table :mini_magick_attachments, :force => true do |t|
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :type, :string
+ end
+
+ create_table :orphan_attachments, :force => true do |t|
+ t.column :db_file_id, :integer
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ end
+
+ create_table :minimal_attachments, :force => true do |t|
+ t.column :size, :integer
+ t.column :content_type, :string, :limit => 255
+ end
+
+ create_table :db_files, :force => true do |t|
+ t.column :data, :binary
+ end
+
+ create_table :s3_attachments, :force => true do |t|
+ t.column :parent_id, :integer
+ t.column :thumbnail, :string
+ t.column :filename, :string, :limit => 255
+ t.column :content_type, :string, :limit => 255
+ t.column :size, :integer
+ t.column :width, :integer
+ t.column :height, :integer
+ t.column :type, :string
+ t.column :aspect_ratio, :float
+ end
+end
\ No newline at end of file
--- /dev/null
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+ENV['RAILS_ENV'] = 'test'
+
+require 'test/unit'
+require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
+require 'breakpoint'
+require 'active_record/fixtures'
+require 'action_controller/test_process'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+db_adapter = ENV['DB']
+
+# no db passed, try one of these fine config-free DBs before bombing.
+db_adapter ||=
+ begin
+ require 'rubygems'
+ require 'sqlite'
+ 'sqlite'
+ rescue MissingSourceFile
+ begin
+ require 'sqlite3'
+ 'sqlite3'
+ rescue MissingSourceFile
+ end
+ end
+
+if db_adapter.nil?
+ raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+end
+
+ActiveRecord::Base.establish_connection(config[db_adapter])
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+Test::Unit::TestCase.fixture_path = File.dirname(__FILE__) + "/fixtures"
+$LOAD_PATH.unshift(Test::Unit::TestCase.fixture_path)
+
+class Test::Unit::TestCase #:nodoc:
+ include ActionController::TestProcess
+ def create_fixtures(*table_names)
+ if block_given?
+ Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names) { yield }
+ else
+ Fixtures.create_fixtures(Test::Unit::TestCase.fixture_path, table_names)
+ end
+ end
+
+ def setup
+ Attachment.saves = 0
+ DbFile.transaction { [Attachment, FileAttachment, OrphanAttachment, MinimalAttachment, DbFile].each { |klass| klass.delete_all } }
+ attachment_model self.class.attachment_model
+ end
+
+ def teardown
+ FileUtils.rm_rf File.join(File.dirname(__FILE__), 'files')
+ end
+
+ self.use_transactional_fixtures = true
+ self.use_instantiated_fixtures = false
+
+ def self.attachment_model(klass = nil)
+ @attachment_model = klass if klass
+ @attachment_model
+ end
+
+ def self.test_against_class(test_method, klass, subclass = false)
+ define_method("#{test_method}_on_#{:sub if subclass}class") do
+ klass = Class.new(klass) if subclass
+ attachment_model klass
+ send test_method, klass
+ end
+ end
+
+ def self.test_against_subclass(test_method, klass)
+ test_against_class test_method, klass, true
+ end
+
+ protected
+ def upload_file(options = {})
+ use_temp_file options[:filename] do |file|
+ att = attachment_model.create :uploaded_data => fixture_file_upload(file, options[:content_type] || 'image/png')
+ att.reload unless att.new_record?
+ return att
+ end
+ end
+
+ def use_temp_file(fixture_filename)
+ temp_path = File.join('/tmp', File.basename(fixture_filename))
+ FileUtils.mkdir_p File.join(fixture_path, 'tmp')
+ FileUtils.cp File.join(fixture_path, fixture_filename), File.join(fixture_path, temp_path)
+ yield temp_path
+ ensure
+ FileUtils.rm_rf File.join(fixture_path, 'tmp')
+ end
+
+ def assert_created(num = 1)
+ assert_difference attachment_model.base_class, :count, num do
+ if attachment_model.included_modules.include? DbFile
+ assert_difference DbFile, :count, num do
+ yield
+ end
+ else
+ yield
+ end
+ end
+ end
+
+ def assert_not_created
+ assert_created(0) { yield }
+ end
+
+ def should_reject_by_size_with(klass)
+ attachment_model klass
+ assert_not_created do
+ attachment = upload_file :filename => '/files/rails.png'
+ assert attachment.new_record?
+ assert attachment.errors.on(:size)
+ assert_nil attachment.db_file if attachment.respond_to?(:db_file)
+ end
+ end
+
+ def assert_difference(object, method = nil, difference = 1)
+ initial_value = object.send(method)
+ yield
+ assert_equal initial_value + difference, object.send(method)
+ end
+
+ def assert_no_difference(object, method, &block)
+ assert_difference object, method, 0, &block
+ end
+
+ def attachment_model(klass = nil)
+ @attachment_model = klass if klass
+ @attachment_model
+ end
+end
+
+require File.join(File.dirname(__FILE__), 'fixtures/attachment')
+require File.join(File.dirname(__FILE__), 'base_attachment_tests')
\ No newline at end of file
--- /dev/null
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class ValidationTest < Test::Unit::TestCase
+ def test_should_invalidate_big_files
+ @attachment = SmallAttachment.new
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:size)
+
+ @attachment.size = 2000
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:size), @attachment.errors.full_messages.to_sentence
+
+ @attachment.size = 1000
+ assert !@attachment.valid?
+ assert_nil @attachment.errors.on(:size)
+ end
+
+ def test_should_invalidate_small_files
+ @attachment = BigAttachment.new
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:size)
+
+ @attachment.size = 2000
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:size), @attachment.errors.full_messages.to_sentence
+
+ @attachment.size = 1.megabyte
+ assert !@attachment.valid?
+ assert_nil @attachment.errors.on(:size)
+ end
+
+ def test_should_validate_content_type
+ @attachment = PdfAttachment.new
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:content_type)
+
+ @attachment.content_type = 'foo'
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:content_type)
+
+ @attachment.content_type = 'pdf'
+ assert !@attachment.valid?
+ assert_nil @attachment.errors.on(:content_type)
+ end
+
+ def test_should_require_filename
+ @attachment = Attachment.new
+ assert !@attachment.valid?
+ assert @attachment.errors.on(:filename)
+
+ @attachment.filename = 'foo'
+ assert !@attachment.valid?
+ assert_nil @attachment.errors.on(:filename)
+ end
+end
\ No newline at end of file
projects / selectricity-live / commitdiff
