jquery-rest 0.1

Sign up to get free protection for your applications and to get access to all the features.
data/LICENSE ADDED
@@ -0,0 +1,166 @@
1
+ GNU LESSER GENERAL PUBLIC LICENSE
2
+ Version 3, 29 June 2007
3
+
4
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5
+ Everyone is permitted to copy and distribute verbatim copies
6
+ of this license document, but changing it is not allowed.
7
+
8
+
9
+ This version of the GNU Lesser General Public License incorporates
10
+ the terms and conditions of version 3 of the GNU General Public
11
+ License, supplemented by the additional permissions listed below.
12
+
13
+ 0. Additional Definitions.
14
+
15
+ As used herein, "this License" refers to version 3 of the GNU Lesser
16
+ General Public License, and the "GNU GPL" refers to version 3 of the GNU
17
+ General Public License.
18
+
19
+ "The Library" refers to a covered work governed by this License,
20
+ other than an Application or a Combined Work as defined below.
21
+
22
+ An "Application" is any work that makes use of an interface provided
23
+ by the Library, but which is not otherwise based on the Library.
24
+ Defining a subclass of a class defined by the Library is deemed a mode
25
+ of using an interface provided by the Library.
26
+
27
+ A "Combined Work" is a work produced by combining or linking an
28
+ Application with the Library. The particular version of the Library
29
+ with which the Combined Work was made is also called the "Linked
30
+ Version".
31
+
32
+ The "Minimal Corresponding Source" for a Combined Work means the
33
+ Corresponding Source for the Combined Work, excluding any source code
34
+ for portions of the Combined Work that, considered in isolation, are
35
+ based on the Application, and not on the Linked Version.
36
+
37
+ The "Corresponding Application Code" for a Combined Work means the
38
+ object code and/or source code for the Application, including any data
39
+ and utility programs needed for reproducing the Combined Work from the
40
+ Application, but excluding the System Libraries of the Combined Work.
41
+
42
+ 1. Exception to Section 3 of the GNU GPL.
43
+
44
+ You may convey a covered work under sections 3 and 4 of this License
45
+ without being bound by section 3 of the GNU GPL.
46
+
47
+ 2. Conveying Modified Versions.
48
+
49
+ If you modify a copy of the Library, and, in your modifications, a
50
+ facility refers to a function or data to be supplied by an Application
51
+ that uses the facility (other than as an argument passed when the
52
+ facility is invoked), then you may convey a copy of the modified
53
+ version:
54
+
55
+ a) under this License, provided that you make a good faith effort to
56
+ ensure that, in the event an Application does not supply the
57
+ function or data, the facility still operates, and performs
58
+ whatever part of its purpose remains meaningful, or
59
+
60
+ b) under the GNU GPL, with none of the additional permissions of
61
+ this License applicable to that copy.
62
+
63
+ 3. Object Code Incorporating Material from Library Header Files.
64
+
65
+ The object code form of an Application may incorporate material from
66
+ a header file that is part of the Library. You may convey such object
67
+ code under terms of your choice, provided that, if the incorporated
68
+ material is not limited to numerical parameters, data structure
69
+ layouts and accessors, or small macros, inline functions and templates
70
+ (ten or fewer lines in length), you do both of the following:
71
+
72
+ a) Give prominent notice with each copy of the object code that the
73
+ Library is used in it and that the Library and its use are
74
+ covered by this License.
75
+
76
+ b) Accompany the object code with a copy of the GNU GPL and this license
77
+ document.
78
+
79
+ 4. Combined Works.
80
+
81
+ You may convey a Combined Work under terms of your choice that,
82
+ taken together, effectively do not restrict modification of the
83
+ portions of the Library contained in the Combined Work and reverse
84
+ engineering for debugging such modifications, if you also do each of
85
+ the following:
86
+
87
+ a) Give prominent notice with each copy of the Combined Work that
88
+ the Library is used in it and that the Library and its use are
89
+ covered by this License.
90
+
91
+ b) Accompany the Combined Work with a copy of the GNU GPL and this license
92
+ document.
93
+
94
+ c) For a Combined Work that displays copyright notices during
95
+ execution, include the copyright notice for the Library among
96
+ these notices, as well as a reference directing the user to the
97
+ copies of the GNU GPL and this license document.
98
+
99
+ d) Do one of the following:
100
+
101
+ 0) Convey the Minimal Corresponding Source under the terms of this
102
+ License, and the Corresponding Application Code in a form
103
+ suitable for, and under terms that permit, the user to
104
+ recombine or relink the Application with a modified version of
105
+ the Linked Version to produce a modified Combined Work, in the
106
+ manner specified by section 6 of the GNU GPL for conveying
107
+ Corresponding Source.
108
+
109
+ 1) Use a suitable shared library mechanism for linking with the
110
+ Library. A suitable mechanism is one that (a) uses at run time
111
+ a copy of the Library already present on the user's computer
112
+ system, and (b) will operate properly with a modified version
113
+ of the Library that is interface-compatible with the Linked
114
+ Version.
115
+
116
+ e) Provide Installation Information, but only if you would otherwise
117
+ be required to provide such information under section 6 of the
118
+ GNU GPL, and only to the extent that such information is
119
+ necessary to install and execute a modified version of the
120
+ Combined Work produced by recombining or relinking the
121
+ Application with a modified version of the Linked Version. (If
122
+ you use option 4d0, the Installation Information must accompany
123
+ the Minimal Corresponding Source and Corresponding Application
124
+ Code. If you use option 4d1, you must provide the Installation
125
+ Information in the manner specified by section 6 of the GNU GPL
126
+ for conveying Corresponding Source.)
127
+
128
+ 5. Combined Libraries.
129
+
130
+ You may place library facilities that are a work based on the
131
+ Library side by side in a single library together with other library
132
+ facilities that are not Applications and are not covered by this
133
+ License, and convey such a combined library under terms of your
134
+ choice, if you do both of the following:
135
+
136
+ a) Accompany the combined library with a copy of the same work based
137
+ on the Library, uncombined with any other library facilities,
138
+ conveyed under the terms of this License.
139
+
140
+ b) Give prominent notice with the combined library that part of it
141
+ is a work based on the Library, and explaining where to find the
142
+ accompanying uncombined form of the same work.
143
+
144
+ 6. Revised Versions of the GNU Lesser General Public License.
145
+
146
+ The Free Software Foundation may publish revised and/or new versions
147
+ of the GNU Lesser General Public License from time to time. Such new
148
+ versions will be similar in spirit to the present version, but may
149
+ differ in detail to address new problems or concerns.
150
+
151
+ Each version is given a distinguishing version number. If the
152
+ Library as you received it specifies that a certain numbered version
153
+ of the GNU Lesser General Public License "or any later version"
154
+ applies to it, you have the option of following the terms and
155
+ conditions either of that published version or of any later version
156
+ published by the Free Software Foundation. If the Library as you
157
+ received it does not specify a version number of the GNU Lesser
158
+ General Public License, you may choose any version of the GNU Lesser
159
+ General Public License ever published by the Free Software Foundation.
160
+
161
+ If the Library as you received it specifies that a proxy can decide
162
+ whether future versions of the GNU Lesser General Public License shall
163
+ apply, that proxy's public statement of acceptance of any version is
164
+ permanent authorization for you to choose that version for the
165
+ Library.
166
+
@@ -0,0 +1,93 @@
1
+ # jQuery REST
2
+
3
+ Add shortcuts to make `PUT` and `DELETE` AJAX requests:
4
+
5
+ ```js
6
+ $.put('/posts/1', { title: 'New' }, function(message) {
7
+ alert('Saved. ' + message)
8
+ })
9
+
10
+ $.del('/posts/1', function(message) {
11
+ alert('Deleted. ' + message)
12
+ })
13
+ ```
14
+
15
+ Because some browsers and firewalls have problems with `PUT` and `DELETE`
16
+ requests, shortcuts create `POST` request with `X-HTTP-Method-Override` header
17
+ with correct method name.
18
+
19
+ All Rack frameworks (Ruby on Rails, Sinatra) support this override.
20
+ For plain Rack app you need to use `Rack::MethodOverride` middleware.
21
+
22
+ Shorcuts have same arguments as `$.post` (url, data, callback, dataType),
23
+ so you can set response type on last argument.
24
+
25
+ They just shortcuts under `$.ajax`, so they return `$.Deferred` object:
26
+
27
+ ```js
28
+ $.delete('/posts/1').
29
+ success(function() { alert('Deleted') }).
30
+ error(function() { alert('Error') })
31
+ ```
32
+
33
+ ## Install
34
+
35
+ ### Rails 3.1
36
+
37
+ In Rails 3.1 (or another project with Sprockets 2) just add `jquery-rest` to
38
+ `Gemfile`:
39
+
40
+ ```ruby
41
+ gem 'jquery-rest'
42
+ ```
43
+
44
+ and add require to `app/assets/javascripts/application.js.coffee`:
45
+
46
+ ```coffee
47
+ #= require "jquery.rest"
48
+ ```
49
+
50
+ ### Jammit
51
+
52
+ If you use Jammit or another package manager just copy `lib/jquery.rest.js` to
53
+ `public/javascripts/lib` in your project and add library to `config/assets.yml`:
54
+
55
+ ```yaml
56
+ javascripts:
57
+ application:
58
+ - public/javascripts/lib/jquery.rest.js
59
+ ```
60
+
61
+ ### Other
62
+
63
+ If you didn’t use Rails 3.1 or assets packaging manager you can use already
64
+ minimized version of library at `lib/jquery.rest.min.js`.
65
+
66
+ ## Contributing
67
+
68
+ To run project tests and minimize source you must have Ruby and Bundler.
69
+ For example, on Ubuntu:
70
+
71
+ ```
72
+ sudo apt-get install ruby rubygems
73
+ sudo gem install bundler
74
+ ```
75
+
76
+ Next you need install Jasmine, UglifyJS and other dependencies by Bundler.
77
+ Run in project root:
78
+
79
+ ```
80
+ bundle install --path=.bundle
81
+ ```
82
+
83
+ That’s all. To run tests start server and open <http://localhost:8888/>:
84
+
85
+ ```
86
+ bundle exec rake server
87
+ ```
88
+
89
+ Before commit minimize project source:
90
+
91
+ ```
92
+ bundle exec rake min
93
+ ```
@@ -0,0 +1,44 @@
1
+ /*
2
+ * Copyright 2011 Andrey “A.I.” Sitnik <andrey@sitnik.ru>,
3
+ * sponsored by Evil Martians.
4
+ *
5
+ * This program is free software: you can redistribute it and/or modify
6
+ * it under the terms of the GNU Lesser General Public License as published by
7
+ * the Free Software Foundation, either version 3 of the License, or
8
+ * (at your option) any later version.
9
+ *
10
+ * This program is distributed in the hope that it will be useful,
11
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
+ * GNU Lesser General Public License for more details.
14
+ *
15
+ * You should have received a copy of the GNU Lesser General Public License
16
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
17
+ */
18
+
19
+ /*
20
+ * Add shortcuts to make PUT and DELETE AJAX requests.
21
+ *
22
+ * Shorcuts create POST request and override HTTP method by
23
+ * X-HTTP-Method-Override header.
24
+ */
25
+ ;(function($) {
26
+ var methods = {}
27
+ $.each({ put: 'PUT', del: 'DELETE' }, function(prop, method) {
28
+ methods[prop] = function(url, data, callback, type) {
29
+ if ($.isFunction(data)) {
30
+ type = type || callback
31
+ callback = data
32
+ data = { }
33
+ }
34
+
35
+ return $.ajax({ headers: { 'X-HTTP-Method-Override': method },
36
+ type: 'POST',
37
+ url: url,
38
+ data: data,
39
+ success: callback,
40
+ dataType: type })
41
+ }
42
+ })
43
+ $.extend(methods)
44
+ })(jQuery);
metadata ADDED
@@ -0,0 +1,87 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: jquery-rest
3
+ version: !ruby/object:Gem::Version
4
+ hash: 9
5
+ prerelease: false
6
+ segments:
7
+ - 0
8
+ - 1
9
+ version: "0.1"
10
+ platform: ruby
11
+ authors:
12
+ - "Andrey \xE2\x80\x9CA.I.\xE2\x80\x9D Sitnik"
13
+ autorequire:
14
+ bindir: bin
15
+ cert_chain: []
16
+
17
+ date: 2011-06-02 00:00:00 +04:00
18
+ default_executable:
19
+ dependencies:
20
+ - !ruby/object:Gem::Dependency
21
+ name: sprockets
22
+ prerelease: false
23
+ requirement: &id001 !ruby/object:Gem::Requirement
24
+ none: false
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ hash: 62196457
29
+ segments:
30
+ - 2
31
+ - 0
32
+ - 0
33
+ - beta
34
+ - 5
35
+ version: 2.0.0.beta.5
36
+ type: :runtime
37
+ version_requirements: *id001
38
+ description: Add shortcuts to make PUT and DELETE AJAX requests. Shorcuts create POST request and override HTTP method by X-HTTP-Method-Override header.
39
+ email:
40
+ - andrey@sitnik.ru
41
+ executables: []
42
+
43
+ extensions: []
44
+
45
+ extra_rdoc_files:
46
+ - LICENSE
47
+ - README.md
48
+ files:
49
+ - vendor/assets/javascripts/jquery.rest.js
50
+ - LICENSE
51
+ - README.md
52
+ has_rdoc: true
53
+ homepage: https://github.com/evilmartians/jquery-rest
54
+ licenses: []
55
+
56
+ post_install_message:
57
+ rdoc_options: []
58
+
59
+ require_paths:
60
+ - lib
61
+ required_ruby_version: !ruby/object:Gem::Requirement
62
+ none: false
63
+ requirements:
64
+ - - ">="
65
+ - !ruby/object:Gem::Version
66
+ hash: 3
67
+ segments:
68
+ - 0
69
+ version: "0"
70
+ required_rubygems_version: !ruby/object:Gem::Requirement
71
+ none: false
72
+ requirements:
73
+ - - ">="
74
+ - !ruby/object:Gem::Version
75
+ hash: 3
76
+ segments:
77
+ - 0
78
+ version: "0"
79
+ requirements: []
80
+
81
+ rubyforge_project:
82
+ rubygems_version: 1.3.7
83
+ signing_key:
84
+ specification_version: 3
85
+ summary: Add $.put and $.del shortcuts.
86
+ test_files: []
87
+