acts_as_api 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: e16fbb94ed887cceb26f045b1249335016a07682
4
- data.tar.gz: 40ad8d4be72657344be7ad856eb7c83b66dcf389
3
+ metadata.gz: 7f15149b411afbf4fa0bac53a8ddaf1491d2411c
4
+ data.tar.gz: 1d36f9afd8b51721a6be06a0b0e8cc0b523d192e
5
5
  SHA512:
6
- metadata.gz: d08be30be0f420cd61e61bb3da1e98b798d420e8c6a8be3afadafa1e897c0c3180f734a2c374baa711afbd07b56b09503fa3dd25eaf041622aa5b119cfbf8917
7
- data.tar.gz: 68debff236e8e0e78203841aa33c253949b36dfb518c3d5f75f9ad5bc7002ec01090c80dc0b441e57d363b6c141b36d1d2b1adaa60cb226c7900f3683c5383ed
6
+ metadata.gz: ae768bfd57b425098259630ad8ed0a0bc093c6f9e3854545bbc8fa03dcfc048772d59b2ed4498e8ded32b2d8a701b6571bfe74fbd18e31cf074e0c3158e4f438
7
+ data.tar.gz: efc12084e514fa4520d2e1773a32a535c8cc33f1d50d8a07cf942d47dd16a5c7cf650177c8ad6cbdf010474ccaaadd7a76bac351403cccc6e11b727a636e1a08
@@ -1,3 +1,7 @@
1
+ === 1.0.1 2017-08-04
2
+
3
+ * Updates spec suite to Rails 5.1.3
4
+
1
5
  === 1.0.0 2016-11-24
2
6
 
3
7
  * Ditch Ruby 1.8 syntax, overall modernization
@@ -59,13 +63,13 @@
59
63
 
60
64
  === 0.3.2 2011-04-20
61
65
 
62
- * Raise an exception if a specified api template is not found
66
+ * Raise an exception if a specified api template is not found
63
67
 
64
68
  === 0.3.1 2011-04-08
65
69
 
66
70
  * Added the :template option to specify sub templates
67
71
 
68
- * Fixed a bug concerning extended api templates
72
+ * Fixed a bug concerning extended api templates
69
73
 
70
74
  === 0.3.0 2011-02-22
71
75
 
data/README.md CHANGED
@@ -23,7 +23,7 @@ class User < ActiveRecord::Base
23
23
  end
24
24
  # will render json: { "user": { "first_name": "John", "age": 26 } }
25
25
 
26
- api_accessible :private, :extend => :public do |template|
26
+ api_accessible :private, extend: :public do |template|
27
27
  template.add :last_name
28
28
  template.add :email
29
29
  end
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta http-equiv="content-type" content="text/html;charset=utf-8">
5
5
  <title>acts_as_api</title>
6
- <meta content="A Ruby/Rails gem to easily generate web api reponses!" name="description" />
6
+ <meta content="A Ruby/Rails gem to easily generate web api responses!" name="description" />
7
7
  <meta content="Christian Bäuerlein" name="author" />
8
8
  <meta content="en" name="language" />
9
9
  <link rel="stylesheet" href="./docco.css">
@@ -202,8 +202,8 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
202
202
  </td>
203
203
  <td class=code>
204
204
  <div class='highlight'><pre> <span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
205
- <span class="nb">format</span><span class="o">.</span><span class="n">xml</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:xml</span> <span class="o">=&gt;</span> <span class="vi">@users</span><span class="p">,</span> <span class="ss">:root</span> <span class="o">=&gt;</span> <span class="ss">:users</span> <span class="p">}</span>
206
- <span class="nb">format</span><span class="o">.</span><span class="n">json</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:json</span> <span class="o">=&gt;</span> <span class="vi">@users</span><span class="p">,</span> <span class="ss">:root</span> <span class="o">=&gt;</span> <span class="ss">:users</span> <span class="p">}</span>
205
+ <span class="nb">format</span><span class="o">.</span><span class="n">xml</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">xml</span><span class="p">:</span> <span class="vi">@users</span><span class="p">,</span> <span class="ss">root</span><span class="p">:</span> <span class="ss">:users</span> <span class="p">}</span>
206
+ <span class="nb">format</span><span class="o">.</span><span class="n">json</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">json</span><span class="p">:</span> <span class="vi">@users</span><span class="p">,</span> <span class="ss">root</span><span class="p">:</span> <span class="ss">:users</span> <span class="p">}</span>
207
207
  <span class="k">end</span>
208
208
  <span class="k">end</span>
209
209
 
@@ -211,8 +211,8 @@ If you only want to expose the <code>first_name</code> and <code>last_name</code
211
211
  <span class="vi">@user</span> <span class="o">=</span> <span class="no">User</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">params</span><span class="o">[</span><span class="ss">:id</span><span class="o">]</span><span class="p">)</span>
212
212
 
213
213
  <span class="n">respond_to</span> <span class="k">do</span> <span class="o">|</span><span class="nb">format</span><span class="o">|</span>
214
- <span class="nb">format</span><span class="o">.</span><span class="n">xml</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:xml</span> <span class="o">=&gt;</span> <span class="vi">@user</span> <span class="p">}</span>
215
- <span class="nb">format</span><span class="o">.</span><span class="n">json</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">:json</span> <span class="o">=&gt;</span> <span class="vi">@user</span> <span class="p">}</span>
214
+ <span class="nb">format</span><span class="o">.</span><span class="n">xml</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">xml</span><span class="p">:</span> <span class="vi">@user</span> <span class="p">}</span>
215
+ <span class="nb">format</span><span class="o">.</span><span class="n">json</span> <span class="p">{</span> <span class="n">render_for_api</span> <span class="ss">:name_only</span><span class="p">,</span> <span class="ss">json</span><span class="p">:</span> <span class="vi">@user</span> <span class="p">}</span>
216
216
  <span class="k">end</span>
217
217
  <span class="k">end</span>
218
218
 
@@ -62,8 +62,8 @@ class UsersController < ApplicationController
62
62
  @users = User.all
63
63
  # Note that it's wise to add a `root` param when rendering lists.
64
64
  respond_to do |format|
65
- format.xml { render_for_api :name_only, :xml => @users, :root => :users }
66
- format.json { render_for_api :name_only, :json => @users, :root => :users }
65
+ format.xml { render_for_api :name_only, xml: @users, root: :users }
66
+ format.json { render_for_api :name_only, json: @users, root: :users }
67
67
  end
68
68
  end
69
69
 
@@ -71,8 +71,8 @@ class UsersController < ApplicationController
71
71
  @user = User.find(params[:id])
72
72
 
73
73
  respond_to do |format|
74
- format.xml { render_for_api :name_only, :xml => @user }
75
- format.json { render_for_api :name_only, :json => @user }
74
+ format.xml { render_for_api :name_only, xml: @user }
75
+ format.json { render_for_api :name_only, json: @user }
76
76
  end
77
77
  end
78
78
 
@@ -1,3 +1,3 @@
1
1
  module ActsAsApi
2
- VERSION = '1.0.0'.freeze
2
+ VERSION = '1.0.1'.freeze
3
3
  end
@@ -14,6 +14,6 @@ Gem::Specification.new do |s|
14
14
 
15
15
  s.files = Dir['{app,config,db,lib}/**/*'] + ['MIT-LICENSE', 'Rakefile', 'README.rdoc']
16
16
 
17
- s.add_dependency 'rails', '~> 5.0.0.1'
17
+ s.add_dependency 'rails', '~> 5.1.3'
18
18
  s.add_development_dependency 'sqlite3'
19
19
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: acts_as_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.0.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Christian Bäuerlein
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2016-11-24 00:00:00.000000000 Z
11
+ date: 2017-08-04 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activemodel
@@ -129,7 +129,6 @@ files:
129
129
  - spec/README.md
130
130
  - spec/active_record_dummy/.gitignore
131
131
  - spec/active_record_dummy/Gemfile
132
- - spec/active_record_dummy/README.rdoc
133
132
  - spec/active_record_dummy/Rakefile
134
133
  - spec/active_record_dummy/app/models/.gitkeep
135
134
  - spec/active_record_dummy/app/models/profile.rb
@@ -193,8 +192,6 @@ files:
193
192
  - spec/mongoid_dummy/script/rails
194
193
  - spec/shared_engine/.gitignore
195
194
  - spec/shared_engine/Gemfile
196
- - spec/shared_engine/MIT-LICENSE
197
- - spec/shared_engine/README.rdoc
198
195
  - spec/shared_engine/Rakefile
199
196
  - spec/shared_engine/app/controllers/shared_engine/application_controller.rb
200
197
  - spec/shared_engine/app/controllers/shared_engine/plain_objects_controller.rb
@@ -249,7 +246,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
249
246
  version: '0'
250
247
  requirements: []
251
248
  rubyforge_project:
252
- rubygems_version: 2.6.8
249
+ rubygems_version: 2.6.11
253
250
  signing_key:
254
251
  specification_version: 4
255
252
  summary: Makes creating XML/JSON responses in Rails 3, 4 and 5 easy and fun.
@@ -257,7 +254,6 @@ test_files:
257
254
  - spec/README.md
258
255
  - spec/active_record_dummy/.gitignore
259
256
  - spec/active_record_dummy/Gemfile
260
- - spec/active_record_dummy/README.rdoc
261
257
  - spec/active_record_dummy/Rakefile
262
258
  - spec/active_record_dummy/app/models/.gitkeep
263
259
  - spec/active_record_dummy/app/models/profile.rb
@@ -321,8 +317,6 @@ test_files:
321
317
  - spec/mongoid_dummy/script/rails
322
318
  - spec/shared_engine/.gitignore
323
319
  - spec/shared_engine/Gemfile
324
- - spec/shared_engine/MIT-LICENSE
325
- - spec/shared_engine/README.rdoc
326
320
  - spec/shared_engine/Rakefile
327
321
  - spec/shared_engine/app/controllers/shared_engine/application_controller.rb
328
322
  - spec/shared_engine/app/controllers/shared_engine/plain_objects_controller.rb
@@ -1,261 +0,0 @@
1
- == Welcome to Rails
2
-
3
- Rails is a web-application framework that includes everything needed to create
4
- database-backed web applications according to the Model-View-Control pattern.
5
-
6
- This pattern splits the view (also called the presentation) into "dumb"
7
- templates that are primarily responsible for inserting pre-built data in between
8
- HTML tags. The model contains the "smart" domain objects (such as Account,
9
- Product, Person, Post) that holds all the business logic and knows how to
10
- persist themselves to a database. The controller handles the incoming requests
11
- (such as Save New Account, Update Product, Show Post) by manipulating the model
12
- and directing data to the view.
13
-
14
- In Rails, the model is handled by what's called an object-relational mapping
15
- layer entitled Active Record. This layer allows you to present the data from
16
- database rows as objects and embellish these data objects with business logic
17
- methods. You can read more about Active Record in
18
- link:files/vendor/rails/activerecord/README.html.
19
-
20
- The controller and view are handled by the Action Pack, which handles both
21
- layers by its two parts: Action View and Action Controller. These two layers
22
- are bundled in a single package due to their heavy interdependence. This is
23
- unlike the relationship between the Active Record and Action Pack that is much
24
- more separate. Each of these packages can be used independently outside of
25
- Rails. You can read more about Action Pack in
26
- link:files/vendor/rails/actionpack/README.html.
27
-
28
-
29
- == Getting Started
30
-
31
- 1. At the command prompt, create a new Rails application:
32
- <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
-
34
- 2. Change directory to <tt>myapp</tt> and start the web server:
35
- <tt>cd myapp; rails server</tt> (run with --help for options)
36
-
37
- 3. Go to http://localhost:3000/ and you'll see:
38
- "Welcome aboard: You're riding Ruby on Rails!"
39
-
40
- 4. Follow the guidelines to start developing your application. You can find
41
- the following resources handy:
42
-
43
- * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
- * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
-
46
-
47
- == Debugging Rails
48
-
49
- Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
- will help you debug it and get it back on the rails.
51
-
52
- First area to check is the application log files. Have "tail -f" commands
53
- running on the server.log and development.log. Rails will automatically display
54
- debugging and runtime information to these files. Debugging info will also be
55
- shown in the browser on requests from 127.0.0.1.
56
-
57
- You can also log your own messages directly into the log file from your code
58
- using the Ruby logger class from inside your controllers. Example:
59
-
60
- class WeblogController < ActionController::Base
61
- def destroy
62
- @weblog = Weblog.find(params[:id])
63
- @weblog.destroy
64
- logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
- end
66
- end
67
-
68
- The result will be a message in your log file along the lines of:
69
-
70
- Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
-
72
- More information on how to use the logger is at http://www.ruby-doc.org/core/
73
-
74
- Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
- several books available online as well:
76
-
77
- * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
- * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
-
80
- These two books will bring you up to speed on the Ruby language and also on
81
- programming in general.
82
-
83
-
84
- == Debugger
85
-
86
- Debugger support is available through the debugger command when you start your
87
- Mongrel or WEBrick server with --debugger. This means that you can break out of
88
- execution at any point in the code, investigate and change the model, and then,
89
- resume execution! You need to install ruby-debug to run the server in debugging
90
- mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
-
92
- class WeblogController < ActionController::Base
93
- def index
94
- @posts = Post.all
95
- debugger
96
- end
97
- end
98
-
99
- So the controller will accept the action, run the first line, then present you
100
- with a IRB prompt in the server window. Here you can do things like:
101
-
102
- >> @posts.inspect
103
- => "[#<Post:0x14a6be8
104
- @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
- #<Post:0x14a6620
106
- @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
- >> @posts.first.title = "hello from a debugger"
108
- => "hello from a debugger"
109
-
110
- ...and even better, you can examine how your runtime objects actually work:
111
-
112
- >> f = @posts.first
113
- => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
- >> f.
115
- Display all 152 possibilities? (y or n)
116
-
117
- Finally, when you're ready to resume execution, you can enter "cont".
118
-
119
-
120
- == Console
121
-
122
- The console is a Ruby shell, which allows you to interact with your
123
- application's domain model. Here you'll have all parts of the application
124
- configured, just like it is when the application is running. You can inspect
125
- domain models, change values, and save to the database. Starting the script
126
- without arguments will launch it in the development environment.
127
-
128
- To start the console, run <tt>rails console</tt> from the application
129
- directory.
130
-
131
- Options:
132
-
133
- * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
- made to the database.
135
- * Passing an environment name as an argument will load the corresponding
136
- environment. Example: <tt>rails console production</tt>.
137
-
138
- To reload your controllers and models after launching the console run
139
- <tt>reload!</tt>
140
-
141
- More information about irb can be found at:
142
- link:http://www.rubycentral.org/pickaxe/irb.html
143
-
144
-
145
- == dbconsole
146
-
147
- You can go to the command line of your database directly through <tt>rails
148
- dbconsole</tt>. You would be connected to the database with the credentials
149
- defined in database.yml. Starting the script without arguments will connect you
150
- to the development database. Passing an argument will connect you to a different
151
- database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
- PostgreSQL and SQLite 3.
153
-
154
- == Description of Contents
155
-
156
- The default directory structure of a generated Ruby on Rails application:
157
-
158
- |-- app
159
- | |-- assets
160
- | |-- images
161
- | |-- javascripts
162
- | `-- stylesheets
163
- | |-- controllers
164
- | |-- helpers
165
- | |-- mailers
166
- | |-- models
167
- | `-- views
168
- | `-- layouts
169
- |-- config
170
- | |-- environments
171
- | |-- initializers
172
- | `-- locales
173
- |-- db
174
- |-- doc
175
- |-- lib
176
- | `-- tasks
177
- |-- log
178
- |-- public
179
- |-- script
180
- |-- test
181
- | |-- fixtures
182
- | |-- functional
183
- | |-- integration
184
- | |-- performance
185
- | `-- unit
186
- |-- tmp
187
- | |-- cache
188
- | |-- pids
189
- | |-- sessions
190
- | `-- sockets
191
- `-- vendor
192
- |-- assets
193
- `-- stylesheets
194
- `-- plugins
195
-
196
- app
197
- Holds all the code that's specific to this particular application.
198
-
199
- app/assets
200
- Contains subdirectories for images, stylesheets, and JavaScript files.
201
-
202
- app/controllers
203
- Holds controllers that should be named like weblogs_controller.rb for
204
- automated URL mapping. All controllers should descend from
205
- ApplicationController which itself descends from ActionController::Base.
206
-
207
- app/models
208
- Holds models that should be named like post.rb. Models descend from
209
- ActiveRecord::Base by default.
210
-
211
- app/views
212
- Holds the template files for the view that should be named like
213
- weblogs/index.html.erb for the WeblogsController#index action. All views use
214
- eRuby syntax by default.
215
-
216
- app/views/layouts
217
- Holds the template files for layouts to be used with views. This models the
218
- common header/footer method of wrapping views. In your views, define a layout
219
- using the <tt>layout :default</tt> and create a file named default.html.erb.
220
- Inside default.html.erb, call <% yield %> to render the view using this
221
- layout.
222
-
223
- app/helpers
224
- Holds view helpers that should be named like weblogs_helper.rb. These are
225
- generated for you automatically when using generators for controllers.
226
- Helpers can be used to wrap functionality for your views into methods.
227
-
228
- config
229
- Configuration files for the Rails environment, the routing map, the database,
230
- and other dependencies.
231
-
232
- db
233
- Contains the database schema in schema.rb. db/migrate contains all the
234
- sequence of Migrations for your schema.
235
-
236
- doc
237
- This directory is where your application documentation will be stored when
238
- generated using <tt>rake doc:app</tt>
239
-
240
- lib
241
- Application specific libraries. Basically, any kind of custom code that
242
- doesn't belong under controllers, models, or helpers. This directory is in
243
- the load path.
244
-
245
- public
246
- The directory available for the web server. Also contains the dispatchers and the
247
- default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
- server.
249
-
250
- script
251
- Helper scripts for automation and generation.
252
-
253
- test
254
- Unit and functional tests along with fixtures. When using the rails generate
255
- command, template test files will be generated for you and placed in this
256
- directory.
257
-
258
- vendor
259
- External libraries that the application depends on. Also includes the plugins
260
- subdirectory. If the app has frozen rails, those gems also go here, under
261
- vendor/rails/. This directory is in the load path.
@@ -1,20 +0,0 @@
1
- Copyright 2012 YOURNAME
2
-
3
- Permission is hereby granted, free of charge, to any person obtaining
4
- a copy of this software and associated documentation files (the
5
- "Software"), to deal in the Software without restriction, including
6
- without limitation the rights to use, copy, modify, merge, publish,
7
- distribute, sublicense, and/or sell copies of the Software, and to
8
- permit persons to whom the Software is furnished to do so, subject to
9
- the following conditions:
10
-
11
- The above copyright notice and this permission notice shall be
12
- included in all copies or substantial portions of the Software.
13
-
14
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -1,3 +0,0 @@
1
- = SharedEngine
2
-
3
- This project rocks and uses MIT-LICENSE.