acfs 0.30.0.1.b262 → 0.31.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -13
- data/CHANGELOG.md +5 -4
- data/doc/file.README.html +307 -0
- data/lib/acfs/model/attributes/uuid.rb +29 -0
- data/lib/acfs/version.rb +1 -1
- data/spec/support/service.rb +0 -7
- metadata +20 -17
checksums.yaml
CHANGED
@@ -1,15 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
|
5
|
-
data.tar.gz: !binary |-
|
6
|
-
NTA4MDJjYWJmMTYwNjVjNmZiMDU1NmY3MjRhMjY5YjY5MjIxYTdkNA==
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 24794bc4702d1a05ea2999d1a45520dc25a9c085
|
4
|
+
data.tar.gz: 9300d82908480f59eb59c85af1d9e281827dbbb1
|
7
5
|
SHA512:
|
8
|
-
metadata.gz:
|
9
|
-
|
10
|
-
ZjIyNjlhNzYzN2UzMjllZDNjZDg1YzUyYzVkMmUzMDcyNmNhOGRmYzNkZWE3
|
11
|
-
NjQzZThiN2UwMGY0MWM2NDcyMGIzMDdlOTYzOTZlNDRhZGZmZWE=
|
12
|
-
data.tar.gz: !binary |-
|
13
|
-
NjUwZGViMmE3YjY4MWM1NGM0Mjk4Zjk0MTM0MjJhMDBhMjE4YzBkNGIzM2Y3
|
14
|
-
ZGU2YjBiNmZkZmNjMGE0ZmYxM2FkZGJkNjAxMGFiODhjOTk5YTRhOWY0MDA4
|
15
|
-
OTBkYjMwZGRhNDEzZDA1ZmUzNTZlMzdlNDA3MDVhYTQ4ZGM5YWQ=
|
6
|
+
metadata.gz: 557e619ed321b65d305d3a606955081a10a3ca219fc444382b5844075be63619044e0b990a2cfccaa78e1594cc1f33045b51eedfbb22cd2ef41639835459c393
|
7
|
+
data.tar.gz: 5e46f19459ccc46baf1917a24b048c1e311afc7315137a27577b1c22294cf78c9999c6195eed25a4c1eb9c931b29faf3eaa33ba3f7e2b390c31ca30b983c23af
|
data/CHANGELOG.md
CHANGED
@@ -1,12 +1,13 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
-
## 0.29.1
|
4
|
-
|
5
|
-
* Fix: rescue NameError and NoMethodError on invalid type
|
6
|
-
|
7
3
|
## 0.30.0
|
8
4
|
|
9
5
|
* Add experimental support for multiple operation callbacks (Acfs.add_callback)
|
6
|
+
* Add experimental support for multiple and chained paths with placeholders
|
7
|
+
|
8
|
+
## 0.29.1
|
9
|
+
|
10
|
+
* Fix: rescue NameError and NoMethodError on invalid type
|
10
11
|
|
11
12
|
## 0.29.0
|
12
13
|
|
@@ -0,0 +1,307 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
+
<title>
|
7
|
+
File: README
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.6.1
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '';
|
20
|
+
framesUrl = "frames.html#!" + escape(window.location.href);
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="_index.html">Index</a> »
|
35
|
+
<span class="title">File: README</span>
|
36
|
+
|
37
|
+
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
+
</div>
|
40
|
+
|
41
|
+
<div id="search">
|
42
|
+
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
44
|
+
href="class_list.html">
|
45
|
+
Class List
|
46
|
+
</a>
|
47
|
+
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
49
|
+
href="method_list.html">
|
50
|
+
Method List
|
51
|
+
</a>
|
52
|
+
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
54
|
+
href="file_list.html">
|
55
|
+
File List
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<iframe id="search_frame"></iframe>
|
63
|
+
|
64
|
+
<div id="content"><div id='filecontents'><h1>Acfs - <em>API client for services</em></h1>
|
65
|
+
|
66
|
+
<p><a href="http://badge.fury.io/rb/acfs"><img src="https://badge.fury.io/rb/acfs.png" alt="Gem Version"></a>
|
67
|
+
<a href="https://travis-ci.org/jgraichen/acfs"><img src="https://travis-ci.org/jgraichen/acfs.png?branch=master" alt="Build Status"></a>
|
68
|
+
<a href="https://coveralls.io/r/jgraichen/acfs"><img src="https://coveralls.io/repos/jgraichen/acfs/badge.png?branch=master" alt="Coverage Status"></a>
|
69
|
+
<a href="https://codeclimate.com/github/jgraichen/acfs"><img src="https://codeclimate.com/github/jgraichen/acfs.png" alt="Code Climate"></a>
|
70
|
+
<a href="https://gemnasium.com/jgraichen/acfs"><img src="https://gemnasium.com/jgraichen/acfs.png" alt="Dependency Status"></a>
|
71
|
+
<a href="http://rubydoc.info/github/jgraichen/acfs/master/frames"><img src="https://raw.github.com/jgraichen/acfs/master/rubydoc.png" alt="RubyDoc Documentation"></a></p>
|
72
|
+
|
73
|
+
<p>Acfs is a library to develop API client libraries for single services within a larger service oriented application.</p>
|
74
|
+
|
75
|
+
<p>Acfs covers model and service abstraction, convenient query and filter methods, full middleware stack for pre-processing requests and responses on a per service level and automatic request queuing and parallel processing. See Usage for more.</p>
|
76
|
+
|
77
|
+
<h2>Installation</h2>
|
78
|
+
|
79
|
+
<p>Add this line to your application's Gemfile:</p>
|
80
|
+
|
81
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>acfs</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>~> 0.16.0</span><span class='tstring_end'>'</span></span>
|
82
|
+
</code></pre>
|
83
|
+
|
84
|
+
<p><strong>Note:</strong> Acfs is under development. I'll try to avoid changes to the public API but internal APIs may change quite often.</p>
|
85
|
+
|
86
|
+
<p>And then execute:</p>
|
87
|
+
|
88
|
+
<pre class="code ruby"><code class="ruby">> bundle
|
89
|
+
</code></pre>
|
90
|
+
|
91
|
+
<p>Or install it yourself as:</p>
|
92
|
+
|
93
|
+
<pre class="code ruby"><code class="ruby">> gem install acfs
|
94
|
+
</code></pre>
|
95
|
+
|
96
|
+
<h2>Usage</h2>
|
97
|
+
|
98
|
+
<p>First you need to define your service(s):</p>
|
99
|
+
|
100
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>UserService</span> <span class='op'><</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Service</span>
|
101
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_base_url'>base_url</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://users.myapp.org</span><span class='tstring_end'>'</span></span>
|
102
|
+
|
103
|
+
<span class='comment'># You can configure middlewares you want to use for the service here.
|
104
|
+
</span> <span class='comment'># Each service has it own middleware stack.
|
105
|
+
</span> <span class='comment'>#
|
106
|
+
</span> <span class='id identifier rubyid_use'>use</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>JsonDecoder</span>
|
107
|
+
<span class='id identifier rubyid_use'>use</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Middleware</span><span class='op'>::</span><span class='const'>MessagePackDecoder</span>
|
108
|
+
<span class='kw'>end</span>
|
109
|
+
</code></pre>
|
110
|
+
|
111
|
+
<p>This specifies where the <code>UserService</code> is located. You can now create some models representing resources served by the <code>UserService</code>.</p>
|
112
|
+
|
113
|
+
<pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>User</span>
|
114
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Model</span>
|
115
|
+
<span class='id identifier rubyid_service'>service</span> <span class='const'>UserService</span> <span class='comment'># Associate `User` model with `UserService`.
|
116
|
+
</span>
|
117
|
+
<span class='comment'># Define model attributes and types
|
118
|
+
</span> <span class='comment'># Types are needed to parse and generate request and response payload.
|
119
|
+
</span>
|
120
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='symbol'>:uuid</span> <span class='comment'># Types can be classes or symbols.
|
121
|
+
</span> <span class='comment'># Symbols will be used to load a class from `Acfs::Model::Attributes` namespace.
|
122
|
+
</span> <span class='comment'># Eg. `:uuid` will load class `Acfs::Model::Attributes::Uuid`.
|
123
|
+
</span>
|
124
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:string</span><span class='comma'>,</span> <span class='label'>default:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Anonymous</span><span class='tstring_end'>'</span></span>
|
125
|
+
<span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:age</span><span class='comma'>,</span> <span class='op'>::</span><span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Model</span><span class='op'>::</span><span class='const'>Attributes</span><span class='op'>::</span><span class='const'>Integer</span> <span class='comment'># Or use :integer
|
126
|
+
</span>
|
127
|
+
<span class='kw'>end</span>
|
128
|
+
</code></pre>
|
129
|
+
|
130
|
+
<p>The service and model classes can be shipped as a gem or git submodule to be included by the frontend application(s).</p>
|
131
|
+
|
132
|
+
<p>You can use the model there:</p>
|
133
|
+
|
134
|
+
<pre class="code ruby"><code class="ruby"><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>14</span>
|
135
|
+
|
136
|
+
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span> <span class='comment'>#=> false
|
137
|
+
</span>
|
138
|
+
<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># This will run all queued request as parallel as possible.
|
139
|
+
</span> <span class='comment'># For @user the following URL will be requested:
|
140
|
+
</span> <span class='comment'># `http://users.myapp.org/users/14`
|
141
|
+
</span>
|
142
|
+
<span class='ivar'>@model</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># => "..."
|
143
|
+
</span>
|
144
|
+
<span class='ivar'>@users</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
|
145
|
+
<span class='ivar'>@users</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span> <span class='comment'>#=> false
|
146
|
+
</span>
|
147
|
+
<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># Will request `http://users.myapp.org/users`
|
148
|
+
</span>
|
149
|
+
<span class='ivar'>@users</span> <span class='comment'>#=> [<User>, ...]
|
150
|
+
</span></code></pre>
|
151
|
+
|
152
|
+
<p>If you need multiple resources or dependent resources first define a "plan" how they can be loaded:</p>
|
153
|
+
|
154
|
+
<pre class="code ruby"><code class="ruby"><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span><span class='lparen'>(</span><span class='int'>5</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_user'>user</span><span class='op'>|</span>
|
155
|
+
<span class='comment'># Block will be executed right after user with id 5 is loaded
|
156
|
+
</span>
|
157
|
+
<span class='comment'># You can load additional resources also from other services
|
158
|
+
</span> <span class='comment'># Eg. fetch comments from `CommentSerivce`. The line below will
|
159
|
+
</span> <span class='comment'># load comments from `http://comments.myapp.org/comments?user=5`
|
160
|
+
</span> <span class='ivar'>@comments</span> <span class='op'>=</span> <span class='const'>Comment</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span> <span class='label'>user:</span> <span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span>
|
161
|
+
|
162
|
+
<span class='comment'># You can load multiple resources in parallel if you have multiple
|
163
|
+
</span> <span class='comment'># ids.
|
164
|
+
</span> <span class='ivar'>@friends</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>1</span><span class='comma'>,</span> <span class='int'>4</span><span class='comma'>,</span> <span class='int'>10</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_friends'>friends</span><span class='op'>|</span>
|
165
|
+
<span class='comment'># This block will be executed when all friends are loaded.
|
166
|
+
</span> <span class='comment'># [ ... ]
|
167
|
+
</span> <span class='kw'>end</span>
|
168
|
+
<span class='kw'>end</span>
|
169
|
+
|
170
|
+
<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># This call will fire all request as parallel as possible.
|
171
|
+
</span> <span class='comment'># The sequence above would look similar to:
|
172
|
+
</span> <span class='comment'>#
|
173
|
+
</span> <span class='comment'># Start Fin
|
174
|
+
</span> <span class='comment'># |===================| `Acfs.run`
|
175
|
+
</span> <span class='comment'># |====| /users/5
|
176
|
+
</span> <span class='comment'># | |==============| /comments?user=5
|
177
|
+
</span> <span class='comment'># | |======| /users/1
|
178
|
+
</span> <span class='comment'># | |=======| /users/4
|
179
|
+
</span> <span class='comment'># | |======| /users/10
|
180
|
+
</span>
|
181
|
+
<span class='comment'># Now we can access all resources:
|
182
|
+
</span>
|
183
|
+
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># => "John
|
184
|
+
</span><span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='comment'># => 25
|
185
|
+
</span><span class='ivar'>@friends</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># => "Miraculix"
|
186
|
+
</span></code></pre>
|
187
|
+
|
188
|
+
<p>Acfs has basic update support using <code>PUT</code> requests:</p>
|
189
|
+
|
190
|
+
<pre class="code ruby"><code class="ruby"><span class='ivar'>@user</span> <span class='op'>=</span> <span class='const'>User</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>5</span>
|
191
|
+
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Bob</span><span class='tstring_end'>"</span></span>
|
192
|
+
|
193
|
+
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># => true
|
194
|
+
</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># => false
|
195
|
+
</span>
|
196
|
+
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Or .save!
|
197
|
+
</span> <span class='comment'># Will PUT new resource to service synchronously.
|
198
|
+
</span>
|
199
|
+
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># => false
|
200
|
+
</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># => true
|
201
|
+
</span></code></pre>
|
202
|
+
|
203
|
+
<h2>Stubbing</h2>
|
204
|
+
|
205
|
+
<p>You can stub resources in applications using an Acfs service client:</p>
|
206
|
+
|
207
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># Enable stubs in spec helper
|
208
|
+
</span><span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_enable'>enable</span>
|
209
|
+
|
210
|
+
<span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
|
211
|
+
<span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span> <span class='const'>MyUser</span><span class='comma'>,</span> <span class='symbol'>:read</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='int'>1</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>return:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='int'>1</span><span class='comma'>,</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>age:</span> <span class='int'>32</span> <span class='rbrace'>}</span>
|
212
|
+
<span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span> <span class='const'>MyUser</span><span class='comma'>,</span> <span class='symbol'>:read</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='int'>2</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>raise:</span> <span class='symbol'>:not_found</span>
|
213
|
+
<span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_resource'>resource</span> <span class='const'>Session</span><span class='comma'>,</span> <span class='symbol'>:create</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='lbrace'>{</span> <span class='label'>ident:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>john@exmaple.org</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>s3cr3t</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>return:</span> <span class='lbrace'>{</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>longhash</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>user:</span> <span class='int'>1</span> <span class='rbrace'>}</span>
|
214
|
+
<span class='kw'>end</span>
|
215
|
+
|
216
|
+
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
|
217
|
+
<span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>1</span>
|
218
|
+
<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
|
219
|
+
|
220
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='int'>1</span>
|
221
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>'</span></span>
|
222
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='period'>.</span><span class='id identifier rubyid_age'>age</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='int'>32</span>
|
223
|
+
<span class='kw'>end</span>
|
224
|
+
|
225
|
+
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>should not find user number two</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
|
226
|
+
<span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>3</span>
|
227
|
+
|
228
|
+
<span class='id identifier rubyid_expect'>expect</span> <span class='lbrace'>{</span> <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_raise_error'>raise_error</span><span class='lparen'>(</span><span class='const'>Acfs</span><span class='op'>::</span><span class='const'>ResourceNotFound</span><span class='rparen'>)</span>
|
229
|
+
<span class='kw'>end</span>
|
230
|
+
|
231
|
+
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>should allow stub resource creation</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
|
232
|
+
<span class='id identifier rubyid_session'>session</span> <span class='op'>=</span> <span class='const'>Session</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span> <span class='label'>ident:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>john@exmaple.org</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>s3cr3t</span><span class='tstring_end'>'</span></span>
|
233
|
+
|
234
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>longhash</span><span class='tstring_end'>'</span></span>
|
235
|
+
<span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='id identifier rubyid_session'>session</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_be'>be</span> <span class='op'>==</span> <span class='int'>1</span>
|
236
|
+
<span class='kw'>end</span>
|
237
|
+
</code></pre>
|
238
|
+
|
239
|
+
<p>By default Acfs raises an error when a non stubbed resource should be requested. You can switch of the behavior:</p>
|
240
|
+
|
241
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
|
242
|
+
<span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Stub</span><span class='period'>.</span><span class='id identifier rubyid_allow_requests'>allow_requests</span> <span class='op'>=</span> <span class='kw'>true</span>
|
243
|
+
<span class='kw'>end</span>
|
244
|
+
|
245
|
+
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>'</span></span> <span class='kw'>do</span>
|
246
|
+
<span class='id identifier rubyid_user'>user</span> <span class='op'>=</span> <span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>1</span>
|
247
|
+
<span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># Would have raised Acfs::RealRequestNotAllowedError
|
248
|
+
</span> <span class='comment'># Will run real request to user service instead.
|
249
|
+
</span><span class='kw'>end</span>
|
250
|
+
</code></pre>
|
251
|
+
|
252
|
+
<h2>Roadmap</h2>
|
253
|
+
|
254
|
+
<ul>
|
255
|
+
<li>Update
|
256
|
+
|
257
|
+
<ul>
|
258
|
+
<li>Better new? detection eg. storing ETag from request resources.</li>
|
259
|
+
<li>Use PATCH for with only changed attributes and <code>If-Unmodifed-Since</code>
|
260
|
+
and <code>If-Match</code> header fields if resource was surly loaded from service
|
261
|
+
and not created with an id (e.g <code>User.new id: 5, name: "john"</code>).</li>
|
262
|
+
<li>Conflict detection (ETag / If-Unmodified-Since)</li>
|
263
|
+
</ul></li>
|
264
|
+
<li>High level features
|
265
|
+
|
266
|
+
<ul>
|
267
|
+
<li>Support for custom mime types on client and server side. (<code>application/vnd.myservice.user.v2+msgpack</code>)</li>
|
268
|
+
<li>Server side components
|
269
|
+
|
270
|
+
<ul>
|
271
|
+
<li>Reusing model definitions for generating responses?</li>
|
272
|
+
<li>Rails responders providing REST operations with integrated ETag,
|
273
|
+
Modified Headers, conflict detection, ...</li>
|
274
|
+
</ul></li>
|
275
|
+
<li>Pagination? Filtering? (If service API provides such features.)</li>
|
276
|
+
<li>Messaging Queue support for services and models</li>
|
277
|
+
</ul></li>
|
278
|
+
<li>Documentation</li>
|
279
|
+
</ul>
|
280
|
+
|
281
|
+
<h2>Contributing</h2>
|
282
|
+
|
283
|
+
<ol>
|
284
|
+
<li>Fork it</li>
|
285
|
+
<li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
|
286
|
+
<li>Add specs for your feature</li>
|
287
|
+
<li>Implement your feature</li>
|
288
|
+
<li>Commit your changes (<code>git commit -am 'Add some feature'</code>)</li>
|
289
|
+
<li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
|
290
|
+
<li>Create new Pull Request</li>
|
291
|
+
</ol>
|
292
|
+
|
293
|
+
<h2>License</h2>
|
294
|
+
|
295
|
+
<p>MIT License</p>
|
296
|
+
|
297
|
+
<p>Copyright (c) 2013 Jan Graichen. MIT license, see LICENSE for more details.</p>
|
298
|
+
</div></div>
|
299
|
+
|
300
|
+
<div id="footer">
|
301
|
+
Generated on Thu May 23 21:23:35 2013 by
|
302
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
303
|
+
0.8.6.1 (ruby-2.0.0).
|
304
|
+
</div>
|
305
|
+
|
306
|
+
</body>
|
307
|
+
</html>
|
@@ -0,0 +1,29 @@
|
|
1
|
+
module Acfs::Model::Attributes
|
2
|
+
|
3
|
+
# @api public
|
4
|
+
#
|
5
|
+
# DateTime attribute type. Use it in your model as an attribute type:
|
6
|
+
#
|
7
|
+
# @example
|
8
|
+
# class User< Acfs::Resoruce
|
9
|
+
# attribute :name, :uuid
|
10
|
+
# end
|
11
|
+
#
|
12
|
+
class Uuid < Base
|
13
|
+
|
14
|
+
# @api public
|
15
|
+
#
|
16
|
+
# Cast given object to DateTime.
|
17
|
+
# Expect
|
18
|
+
#
|
19
|
+
# @param [Object] obj Object to cast.
|
20
|
+
# @return [DateTime] Casted object as DateTime.
|
21
|
+
#
|
22
|
+
def cast_type(obj)
|
23
|
+
return nil if nil_allowed? and obj.blank?
|
24
|
+
return obj if obj.is_a? ::DateTime
|
25
|
+
return ::DateTime.iso8601(obj.iso8601) if obj.is_a? Time or obj.is_a? Date
|
26
|
+
return ::DateTime.iso8601(obj)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
data/lib/acfs/version.rb
CHANGED
data/spec/support/service.rb
CHANGED
@@ -85,10 +85,3 @@ class Single < Acfs::SingletonResource
|
|
85
85
|
attribute :score, :integer
|
86
86
|
attribute :user_id, :integer
|
87
87
|
end
|
88
|
-
|
89
|
-
# DRAFT: Singular resource
|
90
|
-
#class Singular < Acfs::Resource
|
91
|
-
# service UserService, singular: true
|
92
|
-
#
|
93
|
-
# attribute :name, :string
|
94
|
-
#end
|
metadata
CHANGED
@@ -1,97 +1,97 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: acfs
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.31.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Jan Graichen
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2014-02-
|
11
|
+
date: 2014-02-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: activesupport
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
16
16
|
requirements:
|
17
|
-
- -
|
17
|
+
- - '>='
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: '3.1'
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
|
-
- -
|
24
|
+
- - '>='
|
25
25
|
- !ruby/object:Gem::Version
|
26
26
|
version: '3.1'
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: activemodel
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
|
-
- -
|
31
|
+
- - '>='
|
32
32
|
- !ruby/object:Gem::Version
|
33
33
|
version: '3.1'
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
|
-
- -
|
38
|
+
- - '>='
|
39
39
|
- !ruby/object:Gem::Version
|
40
40
|
version: '3.1'
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: actionpack
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- -
|
45
|
+
- - '>='
|
46
46
|
- !ruby/object:Gem::Version
|
47
47
|
version: '3.1'
|
48
48
|
type: :runtime
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- -
|
52
|
+
- - '>='
|
53
53
|
- !ruby/object:Gem::Version
|
54
54
|
version: '3.1'
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: multi_json
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
58
58
|
requirements:
|
59
|
-
- -
|
59
|
+
- - '>='
|
60
60
|
- !ruby/object:Gem::Version
|
61
61
|
version: '0'
|
62
62
|
type: :runtime
|
63
63
|
prerelease: false
|
64
64
|
version_requirements: !ruby/object:Gem::Requirement
|
65
65
|
requirements:
|
66
|
-
- -
|
66
|
+
- - '>='
|
67
67
|
- !ruby/object:Gem::Version
|
68
68
|
version: '0'
|
69
69
|
- !ruby/object:Gem::Dependency
|
70
70
|
name: typhoeus
|
71
71
|
requirement: !ruby/object:Gem::Requirement
|
72
72
|
requirements:
|
73
|
-
- -
|
73
|
+
- - '>='
|
74
74
|
- !ruby/object:Gem::Version
|
75
75
|
version: 0.6.5
|
76
76
|
type: :runtime
|
77
77
|
prerelease: false
|
78
78
|
version_requirements: !ruby/object:Gem::Requirement
|
79
79
|
requirements:
|
80
|
-
- -
|
80
|
+
- - '>='
|
81
81
|
- !ruby/object:Gem::Version
|
82
82
|
version: 0.6.5
|
83
83
|
- !ruby/object:Gem::Dependency
|
84
84
|
name: rack
|
85
85
|
requirement: !ruby/object:Gem::Requirement
|
86
86
|
requirements:
|
87
|
-
- -
|
87
|
+
- - '>='
|
88
88
|
- !ruby/object:Gem::Version
|
89
89
|
version: '0'
|
90
90
|
type: :runtime
|
91
91
|
prerelease: false
|
92
92
|
version_requirements: !ruby/object:Gem::Requirement
|
93
93
|
requirements:
|
94
|
-
- -
|
94
|
+
- - '>='
|
95
95
|
- !ruby/object:Gem::Version
|
96
96
|
version: '0'
|
97
97
|
- !ruby/object:Gem::Dependency
|
@@ -119,6 +119,7 @@ files:
|
|
119
119
|
- LICENSE
|
120
120
|
- README.md
|
121
121
|
- acfs.gemspec
|
122
|
+
- doc/file.README.html
|
122
123
|
- lib/acfs.rb
|
123
124
|
- lib/acfs/adapter/base.rb
|
124
125
|
- lib/acfs/adapter/typhoeus.rb
|
@@ -143,6 +144,7 @@ files:
|
|
143
144
|
- lib/acfs/model/attributes/integer.rb
|
144
145
|
- lib/acfs/model/attributes/list.rb
|
145
146
|
- lib/acfs/model/attributes/string.rb
|
147
|
+
- lib/acfs/model/attributes/uuid.rb
|
146
148
|
- lib/acfs/model/dirty.rb
|
147
149
|
- lib/acfs/model/initialization.rb
|
148
150
|
- lib/acfs/model/loadable.rb
|
@@ -206,14 +208,14 @@ require_paths:
|
|
206
208
|
- lib
|
207
209
|
required_ruby_version: !ruby/object:Gem::Requirement
|
208
210
|
requirements:
|
209
|
-
- -
|
211
|
+
- - '>='
|
210
212
|
- !ruby/object:Gem::Version
|
211
213
|
version: '0'
|
212
214
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
213
215
|
requirements:
|
214
|
-
- -
|
216
|
+
- - '>='
|
215
217
|
- !ruby/object:Gem::Version
|
216
|
-
version:
|
218
|
+
version: '0'
|
217
219
|
requirements: []
|
218
220
|
rubyforge_project:
|
219
221
|
rubygems_version: 2.2.1
|
@@ -248,3 +250,4 @@ test_files:
|
|
248
250
|
- spec/spec_helper.rb
|
249
251
|
- spec/support/response.rb
|
250
252
|
- spec/support/service.rb
|
253
|
+
has_rdoc:
|