acfs 0.36.0 → 0.36.0.1.b293

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,15 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 1c5364d90eee9f5a8e3d1b9f2a09691477af080b
4
- data.tar.gz: 9fc266bfd44e30eb919503502de08d9e94a8dc34
2
+ !binary "U0hBMQ==":
3
+ metadata.gz: !binary |-
4
+ NTIyNWI5NTY3NDMzNmM0NTViN2JiYmY1MTM0NzgyNjU0ODg1ZDlkNQ==
5
+ data.tar.gz: !binary |-
6
+ YTQ0MmY5NmM1NzE4NTYyYTEwY2JiMTQzMzliYmExYzBlNjAwZjk4Yw==
5
7
  SHA512:
6
- metadata.gz: 2ebecb5425555be0f1158ec588676ce4c345a24d2b6efa6d88423020ac1685af32581ce780e7285fbaddbf0172404e2da3c3ca6a29159da9a5df004d3cce6f27
7
- data.tar.gz: 1e1c0633e0899844f185c376715ddd1578cf3ee43b41e227918b482aca822c5a2531d7133f86b4eebc8fc9369d83ff132afb5c074965c98951d2809f519f6c09
8
+ metadata.gz: !binary |-
9
+ MDczNDJjNGQxYzlkZDJkMGUxYjcyZGUxMDE1MDdmY2U4MmJiNzZhMWJmYjMz
10
+ NjFmZjI1MDc3YjBhMmQwYThlNjhiYTAxNzY4MDViYWViNTVjZDI3OWExMzU3
11
+ YzI4ZDAyMTgxMjNkZjEyNzlhNmYwMGNiOWJlNjE1NWJkZjM2NGE=
12
+ data.tar.gz: !binary |-
13
+ NDBhOTY0ODVkOGRiZjY3MDU0ZWRmNTdlZGZiYWY5ZGM4ZTNhYzBiZjQ2ZDU3
14
+ ZWUwYzc3NzllOGY5YWViNTgxNzZhYTliMTg0YTk0ZGEyNTRkZDBmYjQ0OTQ0
15
+ ZTY3YjYyYzhhZDY3Njg5NzZmZTQyYTc0YjNmYjQ4NjUxMzE3NjM=
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.36.0
4
+ version: 0.36.0.1.b293
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
@@ -157,7 +156,6 @@ files:
157
156
  - lib/acfs/model/service.rb
158
157
  - lib/acfs/model/validation.rb
159
158
  - lib/acfs/operation.rb
160
- - lib/acfs/parameter_decoder.rb
161
159
  - lib/acfs/request.rb
162
160
  - lib/acfs/request/callbacks.rb
163
161
  - lib/acfs/resource.rb
@@ -217,14 +215,14 @@ require_paths:
217
215
  - lib
218
216
  required_ruby_version: !ruby/object:Gem::Requirement
219
217
  requirements:
220
- - - ">="
218
+ - - ! '>='
221
219
  - !ruby/object:Gem::Version
222
220
  version: '0'
223
221
  required_rubygems_version: !ruby/object:Gem::Requirement
224
222
  requirements:
225
- - - ">="
223
+ - - ! '>'
226
224
  - !ruby/object:Gem::Version
227
- version: '0'
225
+ version: 1.3.1
228
226
  requirements: []
229
227
  rubyforge_project:
230
228
  rubygems_version: 2.2.2
@@ -266,4 +264,3 @@ test_files:
266
264
  - spec/support/response.rb
267
265
  - spec/support/service.rb
268
266
  - spec/support/shared/find_callbacks.rb
269
- has_rdoc:
data/doc/file.README.html DELETED
@@ -1,398 +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.7.3
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="http://b.repl.ca/v1/rubydoc-here-blue.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.21.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> <span class='op'>&lt;</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>Resource</span>
114
- <span class='id identifier rubyid_service'>service</span> <span class='const'>UserService</span> <span class='comment'># Associate `User` model with `UserService`.
115
- </span>
116
- <span class='comment'># Define model attributes and types
117
- </span> <span class='comment'># Types are needed to parse and generate request and response payload.
118
- </span>
119
- <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.
120
- </span> <span class='comment'># Symbols will be used to load a class from `Acfs::Model::Attributes` namespace.
121
- </span> <span class='comment'># Eg. `:uuid` will load class `Acfs::Model::Attributes::Uuid`.
122
- </span>
123
- <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>
124
- <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
125
- </span>
126
- <span class='kw'>end</span>
127
- </code></pre>
128
-
129
- <p>The service and model classes can be shipped as a gem or git submodule to be included by the frontend application(s).</p>
130
-
131
- <p>You can use the model there:</p>
132
-
133
- <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>
134
-
135
- <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span> <span class='comment'>#=&gt; false
136
- </span>
137
- <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.
138
- </span> <span class='comment'># For @user the following URL will be requested:
139
- </span> <span class='comment'># `http://users.myapp.org/users/14`
140
- </span>
141
- <span class='ivar'>@model</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># =&gt; &quot;...&quot;
142
- </span>
143
- <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>
144
- <span class='ivar'>@users</span><span class='period'>.</span><span class='id identifier rubyid_loaded?'>loaded?</span> <span class='comment'>#=&gt; false
145
- </span>
146
- <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`
147
- </span>
148
- <span class='ivar'>@users</span> <span class='comment'>#=&gt; [&lt;User&gt;, ...]
149
- </span></code></pre>
150
-
151
- <p>If you need multiple resources or dependent resources first define a &quot;plan&quot; how they can be loaded:</p>
152
-
153
- <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>
154
- <span class='comment'># Block will be executed right after user with id 5 is loaded
155
- </span>
156
- <span class='comment'># You can load additional resources also from other services
157
- </span> <span class='comment'># Eg. fetch comments from `CommentSerivce`. The line below will
158
- </span> <span class='comment'># load comments from `http://comments.myapp.org/comments?user=5`
159
- </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>
160
-
161
- <span class='comment'># You can load multiple resources in parallel if you have multiple
162
- </span> <span class='comment'># ids.
163
- </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>
164
- <span class='comment'># This block will be executed when all friends are loaded.
165
- </span> <span class='comment'># [ ... ]
166
- </span> <span class='kw'>end</span>
167
- <span class='kw'>end</span>
168
-
169
- <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.
170
- </span> <span class='comment'># The sequence above would look similar to:
171
- </span> <span class='comment'>#
172
- </span> <span class='comment'># Start Fin
173
- </span> <span class='comment'># |===================| `Acfs.run`
174
- </span> <span class='comment'># |====| /users/5
175
- </span> <span class='comment'># | |==============| /comments?user=5
176
- </span> <span class='comment'># | |======| /users/1
177
- </span> <span class='comment'># | |=======| /users/4
178
- </span> <span class='comment'># | |======| /users/10
179
- </span>
180
- <span class='comment'># Now we can access all resources:
181
- </span>
182
- <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='comment'># =&gt; &quot;John
183
- </span><span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='comment'># =&gt; 25
184
- </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;
185
- </span></code></pre>
186
-
187
- <p>Use <code>.find_by</code> to get first element only. <code>.find_by</code> will call the <code>index</code>-Action and return the first resource. Optionally passed params will be sent as <code>GET</code> parameters and can be used for filtering in the service&#39;s controller.
188
- ```ruby
189
- @user = User.find_by age: 24</p>
190
-
191
- <p>Acfs.run # Will request <code>http://users.myapp.org/users?age=24</code></p>
192
-
193
- <p>@user # Contains the first user object returned by the index action
194
- ``<code>
195
- If no object can be found,</code>.find_by<code>will return</code>nil<code>. The optional callback will then be called with</code>nil<code>as parameter. Use</code>.find_by!<code>to raise an</code>Acfs::ResourceNotFound<code>exception if no object can be found.</code>.find_by!` will only invoke the optional callback if an object was successfully loaded.</p>
196
-
197
- <p>Acfs has basic update support using <code>PUT</code> requests:</p>
198
-
199
- <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>
200
- <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>
201
-
202
- <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># =&gt; true
203
- </span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># =&gt; false
204
- </span>
205
- <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># Or .save!
206
- </span> <span class='comment'># Will PUT new resource to service synchronously.
207
- </span>
208
- <span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># =&gt; false
209
- </span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># =&gt; true
210
- </span></code></pre>
211
-
212
- <h2>Singleton resources</h2>
213
-
214
- <p>Singletons can be used in Acfs by creating a new resource which inherits from <code>SingletonResource</code>:</p>
215
-
216
- <pre class="code ruby"><code class="ruby"><span class='kw'>class</span> <span class='const'>Single</span> <span class='op'>&lt;</span> <span class='const'>Acfs</span><span class='op'>::</span><span class='const'>SingletonResource</span>
217
- <span class='id identifier rubyid_service'>service</span> <span class='const'>UserService</span> <span class='comment'># Associate `Single` model with `UserService`.
218
- </span>
219
- <span class='comment'># Define model attributes and types as with regular resources
220
- </span>
221
- <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>
222
- <span class='id identifier rubyid_attribute'>attribute</span> <span class='symbol'>:age</span><span class='comma'>,</span> <span class='symbol'>:integer</span>
223
-
224
- <span class='kw'>end</span>
225
- </code></pre>
226
-
227
- <p>The following code explains the routing for singleton resource requests:</p>
228
-
229
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_single'>my_single</span> <span class='op'>=</span> <span class='const'>Single</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
230
- <span class='id identifier rubyid_mysingle'>mysingle</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># sends POST request to /single
231
- </span>
232
- <span class='id identifier rubyid_my_single'>my_single</span> <span class='op'>=</span> <span class='const'>Single</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span>
233
- <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># sends GET request to /single
234
- </span>
235
- <span class='id identifier rubyid_my_single'>my_single</span><span class='period'>.</span><span class='id identifier rubyid_age'>age</span> <span class='op'>=</span> <span class='int'>28</span>
236
- <span class='id identifier rubyid_my_single'>my_single</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span> <span class='comment'># sends PUT request to /single
237
- </span>
238
- <span class='id identifier rubyid_my_single'>my_single</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='comment'># sends DELETE request to /single
239
- </span></code></pre>
240
-
241
- <p>You also can pass parameters to the find call, these will sent as GET params to the index action:</p>
242
-
243
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_my_single'>my_single</span> <span class='op'>=</span> <span class='const'>Single</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>Max</span><span class='tstring_end'>&#39;</span></span>
244
- <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span> <span class='comment'># sends GET request with param to /single?name=Max
245
- </span></code></pre>
246
-
247
- <h2>Resource Inheritance</h2>
248
-
249
- <p>Acfs provides a resource inheritance similar to ActiveRecord Single Table Inheritance. If a
250
- <code>type</code> attribute exists and is a valid subclass of your resource they will be converted
251
- to you subclassed resources:</p>
252
-
253
- <pre class="code ruby"><code class="ruby">class Computer &lt; Acfs::Resource
254
- ...
255
- end
256
-
257
- class Pc &lt; Computer end
258
- class Mac &lt; Computer end
259
- </code></pre>
260
-
261
- <p>With the following response on <code>GET /computers</code> the collection will contain the appropriate
262
- subclass resources:</p>
263
-
264
- <pre class="code json"><code class="json">[
265
- { &quot;id&quot;: 5, &quot;type&quot;: &quot;Computer&quot;},
266
- { &quot;id&quot;: 6, &quot;type&quot;: &quot;Mac&quot;},
267
- { &quot;id&quot;: 8, &quot;type&quot;: &quot;Pc&quot;}
268
- ]
269
- </code></pre>
270
-
271
- <pre class="code ruby"><code class="ruby"><span class='ivar'>@computers</span> <span class='op'>=</span> <span class='const'>Computer</span><span class='period'>.</span><span class='id identifier rubyid_all'>all</span>
272
-
273
- <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
274
-
275
- <span class='ivar'>@computer</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='comment'># =&gt; Computer
276
- </span><span class='ivar'>@computer</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='comment'># =&gt; Mac
277
- </span><span class='ivar'>@computer</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span> <span class='comment'># =&gt; Pc
278
- </span></code></pre>
279
-
280
- <h2>Stubbing</h2>
281
-
282
- <p>You can stub resources in applications using an Acfs service client:</p>
283
-
284
- <pre class="code ruby"><code class="ruby"><span class='comment'># spec_helper.rb
285
- </span>
286
- <span class='comment'># This will enable stabs before each spec and clear internal state
287
- </span><span class='comment'># after each spec.
288
- </span><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>acfs/rspec</span><span class='tstring_end'>&#39;</span></span>
289
- </code></pre>
290
-
291
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
292
- <span class='ivar'>@stub</span> <span class='op'>=</span> <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>
293
- <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>
294
- <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>
295
- <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'>:update</span><span class='comma'>,</span> <span class='label'>with:</span> <span class='id identifier rubyid_lambda'>lambda</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_op'>op</span><span class='op'>|</span> <span class='id identifier rubyid_op'>op</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='symbol'>:my_var</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='label'>raise:</span> <span class='int'>400</span>
296
- <span class='kw'>end</span>
297
-
298
- <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>
299
- <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>
300
- <span class='const'>Acfs</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span>
301
-
302
- <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>
303
- <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>
304
- <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>
305
-
306
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='ivar'>@stub</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to'>to</span> <span class='id identifier rubyid_has_called'>has_called</span>
307
- <span class='id identifier rubyid_expect'>expect</span><span class='lparen'>(</span><span class='ivar'>@stub</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_not'>to_not</span> <span class='id identifier rubyid_have_called'>have_called</span> <span class='int'>5</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span>
308
- <span class='kw'>end</span>
309
-
310
- <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>
311
- <span class='const'>MyUser</span><span class='period'>.</span><span class='id identifier rubyid_find'>find</span> <span class='int'>3</span>
312
-
313
- <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>
314
- <span class='kw'>end</span>
315
-
316
- <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>
317
- <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>
318
-
319
- <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>
320
- <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>
321
- <span class='kw'>end</span>
322
- </code></pre>
323
-
324
- <p>By default Acfs raises an error when a non stubbed resource should be requested. You can switch of the behavior:</p>
325
-
326
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span>
327
- <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>
328
- <span class='kw'>end</span>
329
-
330
- <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>
331
- <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>
332
- <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
333
- </span> <span class='comment'># Will run real request to user service instead.
334
- </span><span class='kw'>end</span>
335
- </code></pre>
336
-
337
- <h2>Roadmap</h2>
338
-
339
- <ul>
340
- <li>Update
341
-
342
- <ul>
343
- <li>Better new? detection eg. storing ETag from request resources.</li>
344
- <li>Use PATCH for with only changed attributes and <code>If-Unmodifed-Since</code>
345
- and <code>If-Match</code> header fields if resource was surly loaded from service
346
- and not created with an id (e.g <code>User.new id: 5, name: &quot;john&quot;</code>).</li>
347
- <li>Conflict detection (ETag / If-Unmodified-Since)</li>
348
- </ul></li>
349
- <li>High level features
350
-
351
- <ul>
352
- <li>Support for custom mime types on client and server side. (<code>application/vnd.myservice.user.v2+msgpack</code>)</li>
353
- <li>Server side components
354
-
355
- <ul>
356
- <li>Reusing model definitions for generating responses?</li>
357
- <li>Rails responders providing REST operations with integrated ETag,
358
- Modified Headers, conflict detection, ...</li>
359
- </ul></li>
360
- <li>Pagination? Filtering? (If service API provides such features.)</li>
361
- </ul></li>
362
- <li>Documentation</li>
363
- </ul>
364
-
365
- <h2>Contributing</h2>
366
-
367
- <ol>
368
- <li>Fork it</li>
369
- <li>Create your feature branch (<code>git checkout -b my-new-feature</code>)</li>
370
- <li>Add specs for your feature</li>
371
- <li>Implement your feature</li>
372
- <li>Commit your changes (<code>git commit -am &#39;Add some feature&#39;</code>)</li>
373
- <li>Push to the branch (<code>git push origin my-new-feature</code>)</li>
374
- <li>Create new Pull Request</li>
375
- </ol>
376
-
377
- <h2>Contributors</h2>
378
-
379
- <ul>
380
- <li><a href="https://github.com/nicolas-fricke">Nicolas Fricke</a></li>
381
- <li><a href="https://github.com/tino-junge">Tino Junge</a></li>
382
- </ul>
383
-
384
- <h2>License</h2>
385
-
386
- <p>MIT License</p>
387
-
388
- <p>Copyright (c) 2013 Jan Graichen. MIT license, see LICENSE for more details.</p>
389
- </div></div>
390
-
391
- <div id="footer">
392
- Generated on Fri Mar 7 20:03:40 2014 by
393
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
394
- 0.8.7.3 (ruby-2.1.1).
395
- </div>
396
-
397
- </body>
398
- </html>
@@ -1,37 +0,0 @@
1
- module Acfs::ParameterDecoder
2
-
3
- module Functions
4
- def self.deep_decode(hash)
5
- return hash unless hash.is_a? Hash
6
-
7
- hash.each_pair do |key, value|
8
- if value.is_a? Hash
9
- deep_decode(value)
10
- hash[key] = decode_typhoeus_array(value)
11
- end
12
- end
13
- end
14
-
15
- def self.decode_typhoeus_array(hash)
16
- if typhoeus_encoded? hash
17
- hash.inject([]) do |memo, (key, val)|
18
- memo[Integer(key)] = val
19
- memo
20
- end
21
- else
22
- hash
23
- end
24
- end
25
-
26
- def self.typhoeus_encoded?(hash)
27
- return false if hash.empty?
28
- self.keys.sort == (0...hash.keys.size).map { |i| i.to_s }
29
- end
30
- end
31
-
32
- def self.included(base)
33
- base.send :before_filter do
34
- Functions.deep_decode params
35
- end
36
- end
37
- end