acfs 0.41.1 → 0.42.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/acfs/model/attributes/dict.rb +29 -0
- data/lib/acfs/version.rb +2 -2
- data/spec/acfs/model/attributes/dict_spec.rb +50 -0
- metadata +5 -3
- data/doc/file.README.html +0 -398
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 59a4956dd778b88066cb532992954728f8a38001
|
|
4
|
+
data.tar.gz: 4a2f14333a5665525a7726687025e2090178364a
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5acf90afb3909391f0110986b30728154607038ec3d19c71b9234a40cd5570aee2efdd94ab9e10c450d34245ceac7582fa88ecef22bfe337ae8f5cdd8f512e95
|
|
7
|
+
data.tar.gz: 720856b5184ac360193393672befdf31df29fce15b5c77fcc2d875f2e03ded3d4851867bf62a4cc9a9919868614990ac489a38db39abf220b45911b70393cb6c
|
data/CHANGELOG.md
CHANGED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
module Acfs::Model::Attributes
|
|
2
|
+
|
|
3
|
+
# @api public
|
|
4
|
+
#
|
|
5
|
+
# Dict attribute type. Use it in your model as an attribute type:
|
|
6
|
+
#
|
|
7
|
+
# @example
|
|
8
|
+
# class User
|
|
9
|
+
# include Acfs::Model
|
|
10
|
+
# attribute :opts, :dict
|
|
11
|
+
# end
|
|
12
|
+
#
|
|
13
|
+
class Dict < Base
|
|
14
|
+
|
|
15
|
+
# @api public
|
|
16
|
+
#
|
|
17
|
+
# Cast given object to a dict/hash.
|
|
18
|
+
#
|
|
19
|
+
# @param [Object] obj Object to cast.
|
|
20
|
+
# @return [Hash] Casted object as hash.
|
|
21
|
+
# @raise [TypeError] If object cannot be casted to a hash.
|
|
22
|
+
#
|
|
23
|
+
def cast_type(obj)
|
|
24
|
+
return obj if obj.is_a? Hash
|
|
25
|
+
return obj.to_h if obj.respond_to? :to_h
|
|
26
|
+
raise TypeError.new "Cannot cast #{obj.inspect} to hash."
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
data/lib/acfs/version.rb
CHANGED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
require 'spec_helper'
|
|
2
|
+
|
|
3
|
+
describe Acfs::Model::Attributes::Dict do
|
|
4
|
+
let(:model) { Class.new.tap { |c| c.send :include, Acfs::Model }}
|
|
5
|
+
subject { Acfs::Model::Attributes::Dict.new }
|
|
6
|
+
|
|
7
|
+
describe '.cast' do
|
|
8
|
+
context 'with hash' do
|
|
9
|
+
let(:sample) { {3 => true, "asfd" => 4} }
|
|
10
|
+
|
|
11
|
+
it 'should return unmodified hash' do
|
|
12
|
+
expect(subject.cast(sample)).to be sample
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
context 'with not hashable object' do
|
|
17
|
+
let(:sample) { Object.new }
|
|
18
|
+
|
|
19
|
+
it 'should raise a TypeError' do
|
|
20
|
+
expect {
|
|
21
|
+
subject.cast(sample)
|
|
22
|
+
}.to raise_error TypeError
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
context 'with hashable object' do
|
|
27
|
+
let(:sample) do
|
|
28
|
+
o = Object.new
|
|
29
|
+
class << o
|
|
30
|
+
def to_h
|
|
31
|
+
{3 => 4, 'test' => true}
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
o
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
it 'should cast object to hash' do
|
|
38
|
+
expect(subject.cast(sample)).to eq 3 => 4, 'test' => true
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
context 'with hash subclass' do
|
|
43
|
+
let(:sample) { HashWithIndifferentAccess.new :test => :foo, 34 => 12 }
|
|
44
|
+
|
|
45
|
+
it 'should return obj unmodified' do
|
|
46
|
+
expect(subject.cast(sample)).to be sample
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: acfs
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.42.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-09-
|
|
11
|
+
date: 2014-09-20 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: activesupport
|
|
@@ -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
|
|
@@ -140,6 +139,7 @@ files:
|
|
|
140
139
|
- lib/acfs/model/attributes/base.rb
|
|
141
140
|
- lib/acfs/model/attributes/boolean.rb
|
|
142
141
|
- lib/acfs/model/attributes/date_time.rb
|
|
142
|
+
- lib/acfs/model/attributes/dict.rb
|
|
143
143
|
- lib/acfs/model/attributes/float.rb
|
|
144
144
|
- lib/acfs/model/attributes/integer.rb
|
|
145
145
|
- lib/acfs/model/attributes/list.rb
|
|
@@ -179,6 +179,7 @@ files:
|
|
|
179
179
|
- spec/acfs/middleware/msgpack_spec.rb
|
|
180
180
|
- spec/acfs/model/attributes/boolean_spec.rb
|
|
181
181
|
- spec/acfs/model/attributes/date_time_spec.rb
|
|
182
|
+
- spec/acfs/model/attributes/dict_spec.rb
|
|
182
183
|
- spec/acfs/model/attributes/float_spec.rb
|
|
183
184
|
- spec/acfs/model/attributes/list_spec.rb
|
|
184
185
|
- spec/acfs/model/attributes/uuid_spec.rb
|
|
@@ -239,6 +240,7 @@ test_files:
|
|
|
239
240
|
- spec/acfs/middleware/msgpack_spec.rb
|
|
240
241
|
- spec/acfs/model/attributes/boolean_spec.rb
|
|
241
242
|
- spec/acfs/model/attributes/date_time_spec.rb
|
|
243
|
+
- spec/acfs/model/attributes/dict_spec.rb
|
|
242
244
|
- spec/acfs/model/attributes/float_spec.rb
|
|
243
245
|
- spec/acfs/model/attributes/list_spec.rb
|
|
244
246
|
- spec/acfs/model/attributes/uuid_spec.rb
|
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
|
-
— 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> »
|
|
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'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.21.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> <span class='op'><</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'>'</span><span class='tstring_content'>Anonymous</span><span class='tstring_end'>'</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'>#=> 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'># => "..."
|
|
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'>#=> 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'>#=> [<User>, ...]
|
|
149
|
-
</span></code></pre>
|
|
150
|
-
|
|
151
|
-
<p>If you need multiple resources or dependent resources first define a "plan" 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'># => "John
|
|
183
|
-
</span><span class='ivar'>@comments</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='comment'># => 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'># => "Miraculix"
|
|
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'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'>"</span><span class='tstring_content'>Bob</span><span class='tstring_end'>"</span></span>
|
|
201
|
-
|
|
202
|
-
<span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_changed?'>changed?</span> <span class='comment'># => true
|
|
203
|
-
</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># => 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'># => false
|
|
209
|
-
</span><span class='ivar'>@user</span><span class='period'>.</span><span class='id identifier rubyid_persisted?'>persisted?</span> <span class='comment'># => 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'><</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'>'</span><span class='tstring_content'>Anonymous</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>Max</span><span class='tstring_end'>'</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 < Acfs::Resource
|
|
254
|
-
...
|
|
255
|
-
end
|
|
256
|
-
|
|
257
|
-
class Pc < Computer end
|
|
258
|
-
class Mac < 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
|
-
{ "id": 5, "type": "Computer"},
|
|
266
|
-
{ "id": 6, "type": "Mac"},
|
|
267
|
-
{ "id": 8, "type": "Pc"}
|
|
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'># => 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'># => 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'># => 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'>'</span><span class='tstring_content'>acfs/rspec</span><span class='tstring_end'>'</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'>'</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>
|
|
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'>'</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>
|
|
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'>'</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>John Smith</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>should not find user number two</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>should allow stub resource creation</span><span class='tstring_end'>'</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'>'</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>
|
|
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'>'</span><span class='tstring_content'>longhash</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>should find user number one</span><span class='tstring_end'>'</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: "john"</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 'Add some feature'</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>
|