restrack 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/README.rdoc +27 -15
- data/lib/restrack/version.rb +1 -1
- metadata +4 -4
data/README.rdoc
CHANGED
|
@@ -1,15 +1,32 @@
|
|
|
1
1
|
= RESTRack
|
|
2
2
|
|
|
3
3
|
== Description:
|
|
4
|
-
|
|
5
|
-
services.
|
|
4
|
+
RESTRack is a Rack based MVC framework that makes it extremely easy to
|
|
5
|
+
develop RESTful data services. It is inspired by Rails, and follows a few of
|
|
6
|
+
its conventions. But it has no routes file, routing relationships are done
|
|
7
|
+
through supplying custom code blocks to class methods such as
|
|
8
|
+
'has_relationship_to', 'has_mapped_relationships_to',
|
|
9
|
+
'has_direct_relationship_to', and 'has_direct_relationships_to'.
|
|
10
|
+
RESTRack aims at being lightweight and easy to use. RESTRack will
|
|
11
|
+
automatically render JSON and XML for the data structures you return in your
|
|
12
|
+
actions (any structure parsable by the 'json' and 'xml-simple' gems,
|
|
13
|
+
respectively).
|
|
14
|
+
If you supply a view for a controller action, you do that using a builder
|
|
15
|
+
file (view/<controller>/<action>.xml.builder). XML format requests will then
|
|
16
|
+
render the view template with the builder gem, rather than generating XML with
|
|
17
|
+
XmlSimple.
|
|
18
|
+
|
|
6
19
|
|
|
7
20
|
== Installation:
|
|
8
21
|
<sudo> gem install restrack
|
|
9
22
|
|
|
10
23
|
|
|
11
24
|
== Why RESTRack when there is Rails?
|
|
12
|
-
|
|
25
|
+
Rails is a powerful tool for full web applications. RESTRack is targetted at
|
|
26
|
+
making development of lightweight data services as easy as possible, while
|
|
27
|
+
still giving you a performant and extensible framework. The primary goal of
|
|
28
|
+
the framework was to add as little as possible to the framework to give the
|
|
29
|
+
web developer a good application space for developing JSON or XML services.
|
|
13
30
|
|
|
14
31
|
|
|
15
32
|
== Usage:
|
|
@@ -20,23 +37,18 @@
|
|
|
20
37
|
|
|
21
38
|
== REST action method names
|
|
22
39
|
All default RESTful controller method names align with their Rails
|
|
23
|
-
counterparts, with
|
|
24
|
-
|
|
25
|
-
=== RESTRack:
|
|
26
|
-
# HTTP Verb: | GET | PUT | POST | DELETE
|
|
27
|
-
# Collection URI (/widgets/): | index | replace | create | drop
|
|
28
|
-
# Element URI (/widgets/42): | show | update | add | destroy
|
|
40
|
+
counterparts, with two additional actions being supported(*).
|
|
29
41
|
|
|
30
|
-
=== Rails
|
|
31
42
|
# HTTP Verb: | GET | PUT | POST | DELETE
|
|
32
|
-
# Collection URI (/widgets/): | index |
|
|
33
|
-
# Element URI (/widgets/42): | show | update |
|
|
43
|
+
# Collection URI (/widgets/): | index | replace | create | *drop
|
|
44
|
+
# Element URI (/widgets/42): | show | update | *add | destroy
|
|
34
45
|
|
|
35
46
|
|
|
36
47
|
== How-Tos
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
48
|
+
|
|
49
|
+
...yet to be done...
|
|
50
|
+
|
|
51
|
+
=== Logging/Logging Level
|
|
40
52
|
|
|
41
53
|
=== XML Serialization
|
|
42
54
|
==== With Builder
|
data/lib/restrack/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: restrack
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
hash:
|
|
4
|
+
hash: 27
|
|
5
5
|
prerelease: false
|
|
6
6
|
segments:
|
|
7
7
|
- 0
|
|
8
8
|
- 0
|
|
9
|
-
-
|
|
10
|
-
version: 0.0.
|
|
9
|
+
- 2
|
|
10
|
+
version: 0.0.2
|
|
11
11
|
platform: ruby
|
|
12
12
|
authors:
|
|
13
13
|
- Chris St. John
|
|
@@ -15,7 +15,7 @@ autorequire:
|
|
|
15
15
|
bindir: bin
|
|
16
16
|
cert_chain: []
|
|
17
17
|
|
|
18
|
-
date: 2011-01-
|
|
18
|
+
date: 2011-01-26 00:00:00 -05:00
|
|
19
19
|
default_executable:
|
|
20
20
|
dependencies:
|
|
21
21
|
- !ruby/object:Gem::Dependency
|