mini_api 0.1.0 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/lib/mini_api/model_responder.rb +19 -3
- data/lib/mini_api/version.rb +1 -1
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c6068dbc415de617d267b2e42d438eb85f36fdbbf0d083cf63efe86042130f96
|
4
|
+
data.tar.gz: 31f694de691b4c4d271d0d38273a5df7476aa6bb2118ecceadeca639ca7883f9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 287a2711d205b18d07fb6295e36bf132ef64953aa6d91a2f2f8699fdecaf82cc5fe0cd3a2292235f523ecf36ce6983c40b6d99a3a5d89418fe295ef4c834275c
|
7
|
+
data.tar.gz: 8045d230ca7765a976b34ec73b5fe9020bdf7b40f662de12a1e1b5a0e72cd2c446c3d859f91e0921467c179eb6a6b0aa2fdc2af39dc3ba169586937775934d2f
|
data/README.md
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
[![Test Coverage](https://api.codeclimate.com/v1/badges/ec2939be693459b7ce4d/test_coverage)](https://codeclimate.com/github/leoncruz/api-responder/test_coverage)
|
4
4
|
|
5
5
|
# Mini Api
|
6
|
-
A gem to standardize json responses in Rails applications, highly inspired on [Responders](https
|
6
|
+
A gem to standardize json responses in Rails applications, highly inspired on [Responders](https://github.com/heartcombo/responders)
|
7
7
|
|
8
8
|
## Table of Contents
|
9
9
|
- [Usage](#usage)
|
@@ -26,7 +26,7 @@ And then execute:
|
|
26
26
|
$ bundle
|
27
27
|
```
|
28
28
|
|
29
|
-
|
29
|
+
You must install [Kaminari](https://github.com/kaminari/kaminari) to handle pagination
|
30
30
|
and [Active Model Serializers](http://github.com/rails-api/active_model_serializers) to handle data serialization
|
31
31
|
|
32
32
|
## Usage
|
@@ -23,9 +23,13 @@ module MiniApi
|
|
23
23
|
if resource_has_errors?
|
24
24
|
{ errors: @resource.errors.messages }.merge(body)
|
25
25
|
else
|
26
|
-
{ data: serialiable_body(@resource) }.merge(body)
|
26
|
+
{ data: serialiable_body(@resource).as_json }.merge(body)
|
27
27
|
end
|
28
28
|
|
29
|
+
# This is for an problem with ActiveModelSerializer that adds an error
|
30
|
+
# attribute when resource is an ActiveModel instance
|
31
|
+
body[:data] = body[:data].except('errors') if body[:data]&.key?('errors')
|
32
|
+
|
29
33
|
@controller.render json: body, status: status_code
|
30
34
|
end
|
31
35
|
|
@@ -40,9 +44,9 @@ module MiniApi
|
|
40
44
|
|
41
45
|
return :unprocessable_entity if resource_has_errors?
|
42
46
|
|
43
|
-
return :created if
|
47
|
+
return :created if previously_new_record?
|
44
48
|
|
45
|
-
return :no_content
|
49
|
+
return :no_content if destroyed?
|
46
50
|
|
47
51
|
:ok
|
48
52
|
end
|
@@ -57,5 +61,17 @@ module MiniApi
|
|
57
61
|
default: ''
|
58
62
|
)
|
59
63
|
end
|
64
|
+
|
65
|
+
def previously_new_record?
|
66
|
+
return true if @resource.is_a?(ActiveRecord::Base) && @resource.previously_new_record?
|
67
|
+
|
68
|
+
false
|
69
|
+
end
|
70
|
+
|
71
|
+
def destroyed?
|
72
|
+
return true if @resource.is_a?(ActiveRecord::Base) && !@resource.persisted?
|
73
|
+
|
74
|
+
false
|
75
|
+
end
|
60
76
|
end
|
61
77
|
end
|
data/lib/mini_api/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: mini_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.2
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Leon Cruz
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2023-06-
|
11
|
+
date: 2023-06-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: rails
|
@@ -48,6 +48,10 @@ homepage:
|
|
48
48
|
licenses:
|
49
49
|
- MIT
|
50
50
|
metadata:
|
51
|
+
homepage_uri: https://github.com/leoncruz/mini_api
|
52
|
+
documentation_uri: https://www.rubydoc.info/gems/mini_api/
|
53
|
+
source_code_uri: https://github.com/leoncruz/mini_api
|
54
|
+
bug_tracker_uri: https://github.com/leoncruz/mini_api/issues
|
51
55
|
rubygems_mfa_required: 'true'
|
52
56
|
post_install_message:
|
53
57
|
rdoc_options: []
|