rest-core 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +6 -0
- data/.gitmodules +3 -0
- data/.travis.yml +9 -0
- data/CONTRIBUTORS +11 -0
- data/Gemfile +8 -0
- data/LICENSE +201 -0
- data/NOTE.md +48 -0
- data/README +83 -0
- data/README.md +83 -0
- data/Rakefile +26 -0
- data/TODO.md +17 -0
- data/example/facebook.rb +145 -0
- data/example/github.rb +21 -0
- data/lib/rest-core.rb +48 -0
- data/lib/rest-core/app/ask.rb +11 -0
- data/lib/rest-core/app/rest-client.rb +24 -0
- data/lib/rest-core/builder.rb +24 -0
- data/lib/rest-core/client.rb +278 -0
- data/lib/rest-core/client/github.rb +19 -0
- data/lib/rest-core/client/linkedin.rb +57 -0
- data/lib/rest-core/client/rest-graph.rb +262 -0
- data/lib/rest-core/client/twitter.rb +59 -0
- data/lib/rest-core/client_oauth1.rb +25 -0
- data/lib/rest-core/event.rb +17 -0
- data/lib/rest-core/middleware.rb +53 -0
- data/lib/rest-core/middleware/cache.rb +80 -0
- data/lib/rest-core/middleware/common_logger.rb +27 -0
- data/lib/rest-core/middleware/default_headers.rb +11 -0
- data/lib/rest-core/middleware/default_query.rb +11 -0
- data/lib/rest-core/middleware/default_site.rb +15 -0
- data/lib/rest-core/middleware/defaults.rb +44 -0
- data/lib/rest-core/middleware/error_detector.rb +16 -0
- data/lib/rest-core/middleware/error_detector_http.rb +11 -0
- data/lib/rest-core/middleware/error_handler.rb +19 -0
- data/lib/rest-core/middleware/json_decode.rb +83 -0
- data/lib/rest-core/middleware/oauth1_header.rb +81 -0
- data/lib/rest-core/middleware/oauth2_query.rb +19 -0
- data/lib/rest-core/middleware/timeout.rb +13 -0
- data/lib/rest-core/util/hmac.rb +22 -0
- data/lib/rest-core/version.rb +4 -0
- data/lib/rest-core/wrapper.rb +55 -0
- data/lib/rest-graph/config_util.rb +43 -0
- data/rest-core.gemspec +162 -0
- data/task/.gitignore +1 -0
- data/task/gemgem.rb +184 -0
- data/test/common.rb +29 -0
- data/test/config/rest-graph.yaml +7 -0
- data/test/pending/test_load_config.rb +42 -0
- data/test/pending/test_multi.rb +123 -0
- data/test/pending/test_test_util.rb +86 -0
- data/test/test_api.rb +98 -0
- data/test/test_cache.rb +62 -0
- data/test/test_default.rb +27 -0
- data/test/test_error.rb +66 -0
- data/test/test_handler.rb +87 -0
- data/test/test_misc.rb +75 -0
- data/test/test_oauth.rb +42 -0
- data/test/test_oauth1_header.rb +46 -0
- data/test/test_old.rb +116 -0
- data/test/test_page.rb +110 -0
- data/test/test_parse.rb +131 -0
- data/test/test_rest-graph.rb +10 -0
- data/test/test_serialize.rb +44 -0
- data/test/test_timeout.rb +25 -0
- metadata +267 -0
data/.gitignore
ADDED
data/.gitmodules
ADDED
data/.travis.yml
ADDED
data/CONTRIBUTORS
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
Lin Jen-Shin (godfat)
|
2
|
+
Barnabas Debreczeni (keo)
|
3
|
+
John Fan (johnfan)
|
4
|
+
Jaime Cham (jcham)
|
5
|
+
Andrew Liu (eggegg)
|
6
|
+
Mariusz Pruszynski (snicky)
|
7
|
+
Florent Vaucelle (florent)
|
8
|
+
Ethan Czahor (ethanz5)
|
9
|
+
Nicolas Fouché (nfo)
|
10
|
+
andy (coopsite)
|
11
|
+
Bruce Chu (bruchu)
|
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/NOTE.md
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
|
2
|
+
## NOTE
|
3
|
+
|
4
|
+
In an era of web service and mashup, we saw a blooming of REST API. One might
|
5
|
+
wonder, how do we easily and elegantly use those API? We might first try to
|
6
|
+
find dedicated clients for each web service. It might work pretty well for
|
7
|
+
the web services using dedicated clients which are designed for, but lately
|
8
|
+
found that those dedicated clients might not work well together, because
|
9
|
+
they might have different dependencies with the same purpose, and they might
|
10
|
+
conflict with each other, or they might be suffering from dependencies hell
|
11
|
+
or code bloat.
|
12
|
+
|
13
|
+
This might not be a serious issue because that we might only use one or two
|
14
|
+
web services. But we are all growing, so do our applications. At some point,
|
15
|
+
the complexity of our applications might grow into something that are very
|
16
|
+
hard to control. Then we might want to separate accessing each web service
|
17
|
+
with each different process, say, different dedicated workers. So that we
|
18
|
+
won't be suffering from the issues described above.
|
19
|
+
|
20
|
+
Yes this would work, definitely. But this might require more efforts than
|
21
|
+
it should be. If the dedicated clients can work together seamlessly, then
|
22
|
+
why not? On the other hand, what if there's no dedicated client at the
|
23
|
+
moment for the web service we want to access?
|
24
|
+
|
25
|
+
Thanks that now we are all favoring REST over SOAP, building a dedicated
|
26
|
+
client might not be that hard. So why not just build the dedicated clients
|
27
|
+
ourselves? Yet there's still another issue. We're not only embracing REST,
|
28
|
+
but also JSON. We would want some kind of JSON support for our hand crafted
|
29
|
+
clients, but we don't want to copy codes from client A to client B. That's
|
30
|
+
not so called DRY. We want reusable components, composing them together,
|
31
|
+
adding some specific features for some particular web service, and then we
|
32
|
+
get the dedicated clients, not only a generic one which might work for any
|
33
|
+
web service, but dedicated clients make us feel smooth to use for the
|
34
|
+
particular web service.
|
35
|
+
|
36
|
+
[rest-core][] is invented for that, inspired by [Rack][] and [Faraday][]. One
|
37
|
+
can simply use pre-built dedicated clients provided by rest-core, assuming
|
38
|
+
this would be the most cases. Or if someone is not satisfied with the
|
39
|
+
pre-built ones, one can use pre-built "middlewares" and "apps" provided by
|
40
|
+
rest-core, to compose and build the dedicated clients (s)he prefers. Or, even
|
41
|
+
go further that create custom "middlewares", which should be fairly easy,
|
42
|
+
and use that along with pre-built ones to compose a very customized client.
|
43
|
+
|
44
|
+
We present you rest-core.
|
45
|
+
|
46
|
+
[rest-core]: https://github.com/cardinalblue/rest-core
|
47
|
+
[Rack]: https://github.com/rack/rack
|
48
|
+
[Faraday]: https://github.com/technoweenie/faraday
|
data/README
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
# rest-core [![Build Status](http://travis-ci.org/godfat/rest-core.png)](http://travis-ci.org/godfat/rest-core)
|
2
|
+
by Cardinal Blue <http://cardinalblue.com>
|
3
|
+
|
4
|
+
## LINKS:
|
5
|
+
|
6
|
+
* [github](https://github.com/cardinalblue/rest-core)
|
7
|
+
* [rubygems](http://rubygems.org/gems/rest-core)
|
8
|
+
* [rdoc](http://rdoc.info/projects/cardinalblue/rest-core)
|
9
|
+
* [mailing list](http://groups.google.com/group/rest-core/topics)
|
10
|
+
|
11
|
+
## DESCRIPTION:
|
12
|
+
|
13
|
+
A modular Ruby REST client collection/infrastructure.
|
14
|
+
|
15
|
+
In this era of web services and mashups, we have seen a blooming of REST
|
16
|
+
APIs. One might wonder, how do we use these APIs easily and elegantly?
|
17
|
+
Since REST is very simple compared to SOAP, it is not hard to build a
|
18
|
+
dedicated client ourselves.
|
19
|
+
|
20
|
+
We have developed [rest-core][] with composable middlewares to build a
|
21
|
+
REST client, based on the effort from [rest-graph][]. In the cases of
|
22
|
+
common APIs such as Facebook, Github, and Twitter, developers can simply
|
23
|
+
use the built-in dedicated clients provided by rest-core, or do it yourself
|
24
|
+
for any other REST APIs.
|
25
|
+
|
26
|
+
[rest-core]: http://github.com/cardinalblue/rest-core
|
27
|
+
[rest-graph]: http://github.com/cardinalblue/rest-graph
|
28
|
+
|
29
|
+
## REQUIREMENTS:
|
30
|
+
|
31
|
+
* Tested with MRI (official ruby) 1.9.2, 1.8.7, and trunk
|
32
|
+
* Tested with Rubinius (rbx) 1.2.3
|
33
|
+
* Tested with JRuby 1.6.2
|
34
|
+
|
35
|
+
## INSTALLATION:
|
36
|
+
|
37
|
+
gem install rest-core
|
38
|
+
|
39
|
+
Or if you want development version, put this in Gemfile:
|
40
|
+
|
41
|
+
gem 'rest-core', :git => 'git://github.com/cardinalblue/rest-core.git'
|
42
|
+
|
43
|
+
## EXAMPLE:
|
44
|
+
|
45
|
+
RestCore::Builder.client('YourClient') do
|
46
|
+
use DefaultSite , 'https://api.github.com/users/'
|
47
|
+
use JsonDecode , true
|
48
|
+
use CommonLogger, method(:puts)
|
49
|
+
use Cache , {}, nil
|
50
|
+
run RestClient
|
51
|
+
end
|
52
|
+
|
53
|
+
client = YourClient.new
|
54
|
+
client.get('godfat')
|
55
|
+
client.get('godfat')
|
56
|
+
|
57
|
+
client.site = 'http://github.com/api/v2/json/user/show/'
|
58
|
+
client.get('godfat')
|
59
|
+
client.get('godfat')
|
60
|
+
|
61
|
+
See [example][] for more complex examples, and [build-in clients][] for even
|
62
|
+
more complex examples.
|
63
|
+
|
64
|
+
[example]: https://github.com/cardinalblue/rest-core/tree/master/example
|
65
|
+
[build-in clients]: https://github.com/cardinalblue/rest-core/tree/master/lib/rest-core/client
|
66
|
+
|
67
|
+
## LICENSE:
|
68
|
+
|
69
|
+
Apache License 2.0
|
70
|
+
|
71
|
+
Copyright (c) 2011, Cardinal Blue
|
72
|
+
|
73
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
74
|
+
you may not use this file except in compliance with the License.
|
75
|
+
You may obtain a copy of the License at
|
76
|
+
|
77
|
+
<http://www.apache.org/licenses/LICENSE-2.0>
|
78
|
+
|
79
|
+
Unless required by applicable law or agreed to in writing, software
|
80
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
81
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
82
|
+
See the License for the specific language governing permissions and
|
83
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
# rest-core [![Build Status](http://travis-ci.org/godfat/rest-core.png)](http://travis-ci.org/godfat/rest-core)
|
2
|
+
by Cardinal Blue <http://cardinalblue.com>
|
3
|
+
|
4
|
+
## LINKS:
|
5
|
+
|
6
|
+
* [github](https://github.com/cardinalblue/rest-core)
|
7
|
+
* [rubygems](http://rubygems.org/gems/rest-core)
|
8
|
+
* [rdoc](http://rdoc.info/projects/cardinalblue/rest-core)
|
9
|
+
* [mailing list](http://groups.google.com/group/rest-core/topics)
|
10
|
+
|
11
|
+
## DESCRIPTION:
|
12
|
+
|
13
|
+
A modular Ruby REST client collection/infrastructure.
|
14
|
+
|
15
|
+
In this era of web services and mashups, we have seen a blooming of REST
|
16
|
+
APIs. One might wonder, how do we use these APIs easily and elegantly?
|
17
|
+
Since REST is very simple compared to SOAP, it is not hard to build a
|
18
|
+
dedicated client ourselves.
|
19
|
+
|
20
|
+
We have developed [rest-core][] with composable middlewares to build a
|
21
|
+
REST client, based on the effort from [rest-graph][]. In the cases of
|
22
|
+
common APIs such as Facebook, Github, and Twitter, developers can simply
|
23
|
+
use the built-in dedicated clients provided by rest-core, or do it yourself
|
24
|
+
for any other REST APIs.
|
25
|
+
|
26
|
+
[rest-core]: http://github.com/cardinalblue/rest-core
|
27
|
+
[rest-graph]: http://github.com/cardinalblue/rest-graph
|
28
|
+
|
29
|
+
## REQUIREMENTS:
|
30
|
+
|
31
|
+
* Tested with MRI (official ruby) 1.9.2, 1.8.7, and trunk
|
32
|
+
* Tested with Rubinius (rbx) 1.2.3
|
33
|
+
* Tested with JRuby 1.6.2
|
34
|
+
|
35
|
+
## INSTALLATION:
|
36
|
+
|
37
|
+
gem install rest-core
|
38
|
+
|
39
|
+
Or if you want development version, put this in Gemfile:
|
40
|
+
|
41
|
+
gem 'rest-core', :git => 'git://github.com/cardinalblue/rest-core.git'
|
42
|
+
|
43
|
+
## EXAMPLE:
|
44
|
+
|
45
|
+
RestCore::Builder.client('YourClient') do
|
46
|
+
use DefaultSite , 'https://api.github.com/users/'
|
47
|
+
use JsonDecode , true
|
48
|
+
use CommonLogger, method(:puts)
|
49
|
+
use Cache , {}, nil
|
50
|
+
run RestClient
|
51
|
+
end
|
52
|
+
|
53
|
+
client = YourClient.new
|
54
|
+
client.get('godfat')
|
55
|
+
client.get('godfat')
|
56
|
+
|
57
|
+
client.site = 'http://github.com/api/v2/json/user/show/'
|
58
|
+
client.get('godfat')
|
59
|
+
client.get('godfat')
|
60
|
+
|
61
|
+
See [example][] for more complex examples, and [build-in clients][] for even
|
62
|
+
more complex examples.
|
63
|
+
|
64
|
+
[example]: https://github.com/cardinalblue/rest-core/tree/master/example
|
65
|
+
[build-in clients]: https://github.com/cardinalblue/rest-core/tree/master/lib/rest-core/client
|
66
|
+
|
67
|
+
## LICENSE:
|
68
|
+
|
69
|
+
Apache License 2.0
|
70
|
+
|
71
|
+
Copyright (c) 2011, Cardinal Blue
|
72
|
+
|
73
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
74
|
+
you may not use this file except in compliance with the License.
|
75
|
+
You may obtain a copy of the License at
|
76
|
+
|
77
|
+
<http://www.apache.org/licenses/LICENSE-2.0>
|
78
|
+
|
79
|
+
Unless required by applicable law or agreed to in writing, software
|
80
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
81
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
82
|
+
See the License for the specific language governing permissions and
|
83
|
+
limitations under the License.
|