acfs 0.29.0 → 0.29.0.1.b254

Sign up to get free protection for your applications and to get access to all the features.
Files changed (3) hide show
  1. checksums.yaml +13 -5
  2. metadata +18 -20
  3. data/doc/file.README.html +0 -307
checksums.yaml CHANGED
@@ -1,7 +1,15 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 429e55b920c1ce1b4282539b709d86305ad82850
4
- data.tar.gz: 2ce41f9c849259172e560ce1739c8a6a00634f75
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ ODA1MDU2MWE0YTA2Y2Q0MzZhNTgxNmQ4YzIxOTQzOTNmNGExYjg0YQ==
5
+ data.tar.gz: !binary |-
6
+ ZjY0OTllYzNhOTNjNzEzMjg0YjRiY2E4Yzc1ZWRmNjIzZjkyNWFiYw==
5
7
  SHA512:
6
- metadata.gz: 72db1b934827013cef440a6af2fad34d314d3181e11139c6675543d736ef9d1f96dd0f7e804686b3ff26d65d4b6101042a2f0cb810ca63c2363b6c643c2b387d
7
- data.tar.gz: 378ef2c8d270771320094318ddbbe44284609b696104996b74b4f80ffde8d08c986b05ce39b4325ee868a2c16af8d2d847c1543720270ab3246a996f0478715e
8
+ metadata.gz: !binary |-
9
+ MzUxNmIzMmNiYTRlOGJiYTgzNmRlYmExMDAzZDM2OWYyODAyODhmODM2ZGNh
10
+ ZmYzMzFmMGI3MDEzZDlkMGM2MzdiYWE5OTdkNmIyNzYzYmE1YTFkODM3NDFm
11
+ OTQzZjBiMzE5NDhkZTQ0Y2Y4YWY4MjgxMTk2ZGY4ZTBmMDRmMjk=
12
+ data.tar.gz: !binary |-
13
+ MTcxOTQwYjllMTEwMDhlN2NiMWQ2YWZhY2I3ZTI0ZGEwMzAzYTNiYjkyYTY5
14
+ MGZjYTU2NDlhZDdlZWQzZjM0MjYxZWYxOWE0YTU2ODUyOWEwNTVjNjQ0NzBl
15
+ MDhkMTM5NTkwM2M1OTg0Y2RlMTc3YThhNTkwMjg5ZjZiNDlhN2Y=
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: acfs
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.29.0
4
+ version: 0.29.0.1.b254
5
5
  platform: ruby
6
6
  authors:
7
7
  - Jan Graichen
@@ -14,98 +14,98 @@ dependencies:
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
98
98
  name: bundler
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
- - - "~>"
101
+ - - ~>
102
102
  - !ruby/object:Gem::Version
103
103
  version: '1.3'
104
104
  type: :development
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
- - - "~>"
108
+ - - ~>
109
109
  - !ruby/object:Gem::Version
110
110
  version: '1.3'
111
111
  description: API Client For Services
@@ -119,7 +119,6 @@ files:
119
119
  - LICENSE
120
120
  - README.md
121
121
  - acfs.gemspec
122
- - doc/file.README.html
123
122
  - lib/acfs.rb
124
123
  - lib/acfs/adapter/base.rb
125
124
  - lib/acfs/adapter/typhoeus.rb
@@ -205,14 +204,14 @@ require_paths:
205
204
  - lib
206
205
  required_ruby_version: !ruby/object:Gem::Requirement
207
206
  requirements:
208
- - - ">="
207
+ - - ! '>='
209
208
  - !ruby/object:Gem::Version
210
209
  version: '0'
211
210
  required_rubygems_version: !ruby/object:Gem::Requirement
212
211
  requirements:
213
- - - ">="
212
+ - - ! '>'
214
213
  - !ruby/object:Gem::Version
215
- version: '0'
214
+ version: 1.3.1
216
215
  requirements: []
217
216
  rubyforge_project:
218
217
  rubygems_version: 2.2.1
@@ -247,4 +246,3 @@ test_files:
247
246
  - spec/spec_helper.rb
248
247
  - spec/support/response.rb
249
248
  - spec/support/service.rb
250
- has_rdoc:
data/doc/file.README.html DELETED
@@ -1,307 +0,0 @@
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
- &mdash; 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> &raquo;
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&#39;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'>&#39;</span><span class='tstring_content'>acfs</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~&gt; 0.16.0</span><span class='tstring_end'>&#39;</span></span>
82
- </code></pre>
83
-
84
- <p><strong>Note:</strong> Acfs is under development. I&#39;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">&gt; bundle
89
- </code></pre>
90
-
91
- <p>Or install it yourself as:</p>
92
-
93
- <pre class="code ruby"><code class="ruby">&gt; 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'>&lt;</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'>&#39;</span><span class='tstring_content'>http://users.myapp.org</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>Anonymous</span><span class='tstring_end'>&#39;</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'>#=&gt; 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'># =&gt; &quot;...&quot;
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'>#=&gt; 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'>#=&gt; [&lt;User&gt;, ...]
150
- </span></code></pre>
151
-
152
- <p>If you need multiple resources or dependent resources first define a &quot;plan&quot; 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'># =&gt; &quot;John
184
- </span><span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='comment'># =&gt; 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'># =&gt; &quot;Miraculix&quot;
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'>&quot;</span><span class='tstring_content'>Bob</span><span class='tstring_end'>&quot;</span></span>
192
-
193
- <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># =&gt; true
194
- </span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># =&gt; 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'># =&gt; false
200
- </span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># =&gt; 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'>&#39;</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>john@exmaple.org</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>s3cr3t</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>longhash</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>should not find user number two</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>should allow stub resource creation</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>john@exmaple.org</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>password:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>s3cr3t</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>longhash</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>&#39;</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: &quot;john&quot;</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 &#39;Add some feature&#39;</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>