123 |
124 |
125 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
10 | DEFAULT_JVM_OPTS=""
11 |
12 | APP_NAME="Gradle"
13 | APP_BASE_NAME=`basename "$0"`
14 |
15 | # Use the maximum available, or set MAX_FD != -1 to use that value.
16 | MAX_FD="maximum"
17 |
18 | warn ( ) {
19 | echo "$*"
20 | }
21 |
22 | die ( ) {
23 | echo
24 | echo "$*"
25 | echo
26 | exit 1
27 | }
28 |
29 | # OS specific support (must be 'true' or 'false').
30 | cygwin=false
31 | msys=false
32 | darwin=false
33 | case "`uname`" in
34 | CYGWIN* )
35 | cygwin=true
36 | ;;
37 | Darwin* )
38 | darwin=true
39 | ;;
40 | MINGW* )
41 | msys=true
42 | ;;
43 | esac
44 |
45 | # For Cygwin, ensure paths are in UNIX format before anything is touched.
46 | if $cygwin ; then
47 | [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
48 | fi
49 |
50 | # Attempt to set APP_HOME
51 | # Resolve links: $0 may be a link
52 | PRG="$0"
53 | # Need this for relative symlinks.
54 | while [ -h "$PRG" ] ; do
55 | ls=`ls -ld "$PRG"`
56 | link=`expr "$ls" : '.*-> \(.*\)$'`
57 | if expr "$link" : '/.*' > /dev/null; then
58 | PRG="$link"
59 | else
60 | PRG=`dirname "$PRG"`"/$link"
61 | fi
62 | done
63 | SAVED="`pwd`"
64 | cd "`dirname \"$PRG\"`/" >&-
65 | APP_HOME="`pwd -P`"
66 | cd "$SAVED" >&-
67 |
68 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
69 |
70 | # Determine the Java command to use to start the JVM.
71 | if [ -n "$JAVA_HOME" ] ; then
72 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
73 | # IBM's JDK on AIX uses strange locations for the executables
74 | JAVACMD="$JAVA_HOME/jre/sh/java"
75 | else
76 | JAVACMD="$JAVA_HOME/bin/java"
77 | fi
78 | if [ ! -x "$JAVACMD" ] ; then
79 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
80 |
81 | Please set the JAVA_HOME variable in your environment to match the
82 | location of your Java installation."
83 | fi
84 | else
85 | JAVACMD="java"
86 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
87 |
88 | Please set the JAVA_HOME variable in your environment to match the
89 | location of your Java installation."
90 | fi
91 |
92 | # Increase the maximum file descriptors if we can.
93 | if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
94 | MAX_FD_LIMIT=`ulimit -H -n`
95 | if [ $? -eq 0 ] ; then
96 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
97 | MAX_FD="$MAX_FD_LIMIT"
98 | fi
99 | ulimit -n $MAX_FD
100 | if [ $? -ne 0 ] ; then
101 | warn "Could not set maximum file descriptor limit: $MAX_FD"
102 | fi
103 | else
104 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
105 | fi
106 | fi
107 |
108 | # For Darwin, add options to specify how the application appears in the dock
109 | if $darwin; then
110 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
111 | fi
112 |
113 | # For Cygwin, switch paths to Windows format before running java
114 | if $cygwin ; then
115 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
116 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
158 | function splitJvmOpts() {
159 | JVM_OPTS=("$@")
160 | }
161 | eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
162 | JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
163 |
164 | exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"
165 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | JSONApi
2 | [](https://bintray.com/faogustavo/maven/JSONApi/_latestVersion)
3 | []()
4 | 
5 |
6 | =================================================================================================================================================================
7 |
8 | A simple way to implement JSONApi specifications to convert Models to Json and Json to Models.
9 |
10 | ## INSTALL
11 | Add this dependecy from jCenter:
12 |
13 | ```gradle
14 | compile 'com.gustavofao:JSONApi:${latestVersion}'
15 | ```
16 |
17 | If the installation fails, add this line to your top level gradle:
18 |
19 | ```gradle
20 | maven { url "http://dl.bintray.com/faogustavo/maven" }
21 | ```
22 |
23 | ## USAGE
24 | The first step to use the library is to initiate the deserializer with your classes.
25 | To show how it works, we will use the default JSON that is on jsonapi.org homepage and on [raw folder](/app/src/main/res/raw/data.json).
26 |
27 | ### FIRST STEP - *Create your models*
28 | All models to be converted need to:
29 |
30 | * Inherit from [Resource](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Models/Resource.java)
31 | * And have the [Type](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Annotations/Type.java) annotation.
32 |
33 | > **NOTE:**
34 | * Do not include a field name "id" or "type" as those two fields are taken care of by [Resource](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Models/Resource.java) and [Type](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Annotations/Type.java)
35 | * Do include an empty/ zero argument constructor
36 |
37 | ```java
38 | import com.gustavofao.jsonapi.Annotatios.Type;
39 | import com.gustavofao.jsonapi.Models.Resource;
40 |
41 | @Type("comments")
42 | public class Comment extends Resource {
43 |
44 | private String body;
45 | private Person author;
46 |
47 | /*
48 | Important: If you leave this out, de-serialisation might fail "... has no zero argument constructor"
49 | If you use proguard minify, add the rule mentioned in the end of this page.
50 | */
51 | public Comment() {}
52 |
53 | public String getBody() {
54 | return body;
55 | }
56 |
57 | public void setBody(String body) {
58 | this.body = body;
59 | }
60 |
61 | public Person getPerson() {
62 | return author;
63 | }
64 |
65 | public void setPerson(Person author) {
66 | this.author = author;
67 | }
68 | }
69 | ```
70 |
71 | ### SECOND STEP - *Instantiate the JSONApiConverter*
72 | The JSONApiConverter have to be instantiated with all your models.
73 |
74 | ```java
75 | JSONApiConverter api = new JSONApiConverter(Article.class, Comment.class, Person.class);
76 | ```
77 |
78 | ### THIRD STEP - *Serialize or deserialize*
79 |
80 | #### SERIALIZE INTO JSON
81 | To serialize one object, it have to be an instance or inherit from Resource and have to be passed as parameter to *toJson*.
82 | The return will be a String with the JSON.
83 |
84 | ```java
85 | Article article = new Article();
86 |
87 | //
88 | // SET VALUES HERE
89 | //
90 |
91 | String jsonValue = api.toJson(article);
92 | ```
93 |
94 | > **WARNING**
95 | > LINKS FIELDS ARE NOT GOING TO BE SERIALIZED. I'M WORKING ON IT FOR THE NEXT VERSION.
96 |
97 | #### DESERIALIZE FROM JSON
98 | To deserialize the JSON, you have to pass it as parameter for *fromJson* method.
99 | The return will be an JSONApiObject.
100 |
101 | ```java
102 | JSONApiObject obj = api.fromJson(json);
103 | if (obj.getData().size() > 0) {
104 | //Success
105 | if (obj.getData().size() == 1) {
106 | //Single Object
107 | Article article = obj.getData(0);
108 | } else {
109 | //List of Objects
110 | List resources = obj.getData();
111 | }
112 | } else {
113 | //Error or empty data
114 | }
115 | ```
116 |
117 | > **WARNING**
118 | > DATA WILL ALWAYS COME AS LIST. YOU HAVE TO VERIFY IF THERE IS ONLY ONE OR MORE. I'M WORKING ON IT TOO.
119 |
120 | ### TIPS
121 | #### ONE-TO-MANY RELATION
122 | To handle with one-to-many relation you have to use [JSONList](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Models/JSONList.java) with the type of the Object.
123 | Example below.
124 |
125 | #### CHANGE SERIALIZATION NAME
126 | To change the name of the object on the JSON you can use the Annotation [SerialName](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Annotations/SerialName.java) on your field.
127 | Example below.
128 |
129 | #### IGNORE FIELDS
130 | To ignore fields of the model you have to use the Annotation [Excluded](/JsonAPI/src/main/java/com/gustavofao/jsonapi/Annotations/Excluded.java) on your field.
131 | Example below.
132 |
133 | ```java
134 | import com.gustavofao.jsonapi.Annotatios.Excluded;
135 | import com.gustavofao.jsonapi.Annotatios.SerialName;
136 | import com.gustavofao.jsonapi.Annotatios.Type;
137 | import com.gustavofao.jsonapi.Models.JSONList;
138 | import com.gustavofao.jsonapi.Models.Resource;
139 |
140 | @Type("articles")
141 | public class Article extends Resource {
142 |
143 | private String title;
144 | private JSONList comments;
145 |
146 | @Excluded
147 | private String blah;
148 |
149 | @SerialName("author")
150 | private Person person;
151 |
152 | public String getTitle() {
153 | return title;
154 | }
155 |
156 | public void setTitle(String title) {
157 | this.title = title;
158 | }
159 |
160 | public Person getPerson() {
161 | return person;
162 | }
163 |
164 | public void setPerson(Person person) {
165 | this.person = person;
166 | }
167 |
168 | public JSONList getComments() {
169 | return comments;
170 | }
171 |
172 | public void setComments(JSONList comments) {
173 | this.comments = comments;
174 | }
175 | }
176 |
177 | ```
178 |
179 | #### MULTIPLE TYPE TO SAME OBJECT
180 | When you have different types for the same object you can use the annotation @Types(String[] value).
181 |
182 | ```java
183 | @Types({"test", "test02"})
184 | ```
185 |
186 | #### METADATA
187 | Meta data can be retrieved from the JSONApiObject using getMeta()
188 |
189 | ```java
190 | JSONApiObject obj = api.fromJson(json);
191 | JSONObject meta = obj.getMeta();
192 | ```
193 |
194 | ## ERRORS
195 | The documentation from errors can be found in [this link](http://jsonapi.org/examples/#error-objects-multiple-errors).
196 | To handle with it you have to check your **JSONApiObject** if it *hasErrors()*.
197 |
198 | ```java
199 | JSONApiObject obj = api.fromJson(json);
200 | if (obj.hasErrors()) {
201 | List errorList = obj.getErrors();
202 | //Do Something with the errors
203 | } else {
204 | //Handle with success conversion
205 | }
206 | ```
207 |
208 | The attributes from ErrorModel are:
209 | ```java
210 | private String status;
211 | private String title;
212 | private String detail;
213 | private ErrorSource source;
214 | ```
215 |
216 | And from ErrorSource:
217 | ```java
218 | private String pointer;
219 | private String parameter;
220 | ```
221 |
222 | ### Retrofit
223 | The library has integration with Retrofit.
224 | To use you have to pass the JSONConverterFactory as converterFactory and
225 |
226 | ```java
227 | Retrofit retrofit = new Retrofit.Builder()
228 | .addConverterFactory(JSONConverterFactory.create(Article.class, Comment.class, Person.class))
229 | .baseUrl(url)
230 | .build();
231 | ```
232 |
233 | All requests have to be with parameter from server **JSONApiObject**.
234 |
235 | ```java
236 | Call obj = service.testRequest();
237 | obj.enqueue(new Callback() {
238 | @Override
239 | public void onResponse(Call call, Response response) {
240 | if (response.body() != null) {
241 | if (response.body().hasErrors()) {
242 | List errorList = response.body().getErrors();
243 | //Do something with the errors
244 | } else {
245 | if (response.body().getData().size() > 0) {
246 | Toast.makeText(MainActivity.this, "Object With data", Toast.LENGTH_SHORT).show();
247 | } else {
248 | Toast.makeText(MainActivity.this, "No Items", Toast.LENGTH_SHORT).show();
249 | }
250 | }
251 | } else {
252 | try {
253 | JSONApiObject object = App.getConverter().fromJson(response.errorBody().string());
254 | handleErrors(object.getErrors());
255 | } catch (IOException e) {
256 | Toast.makeText(MainActivity.this, "Empty Body", Toast.LENGTH_SHORT).show();
257 | }
258 | }
259 | }
260 |
261 | @Override
262 | public void onFailure(Call call, Throwable t) {
263 | Toast.makeText(MainActivity.this, "Fail", Toast.LENGTH_SHORT).show();
264 | }
265 | });
266 | ```
267 |
268 | ## SERIALIZATION MAPS
269 |
270 | At this moment we can do the mapping listed above (java -> Json):
271 | * String -> String
272 | * Date -> String
273 | * char -> String
274 | * double -> Double
275 | * float -> Double
276 | * int -> Integer
277 | * boolean -> Boolean
278 | * Map -> JSONObject
279 | * Resouce -> Relationship + Include
280 |
281 |
282 | ## PROGUARD
283 |
284 | If you have `minifyEnabled` on your proguard, you have to add this rule to your proguard file.
285 | This way, you will not receive an error with the message "YourResource has no zero argument constructor".
286 |
287 | ```
288 | -keep public class * extends com.gustavofao.jsonapi.Models.Resource
289 | ```
290 |
291 | ## Next steps
292 | - [X] Configure CI and add build badge
293 | - [X] Add unit tests
294 | - [X] Use generics to get the value
295 | - [ ] Make resources variables protected [#21](https://github.com/faogustavo/JSONApi/issues/21)
296 | - [ ] Use custom attribute decoders
297 | - [ ] Create more samples
298 | - [ ] Parse JSONObjects and arrays/lists under attributes [#12](https://github.com/faogustavo/JSONApi/issues/12)
299 |
300 | ## License
301 | Copyright 2016 Gustavo Fão. All rights reserved.
302 |
303 | Licensed under the Apache License, Version 2.0 (the "License");
304 | you may not use this file except in compliance with the License.
305 | You may obtain a copy of the License at
306 |
307 | http://www.apache.org/licenses/LICENSE-2.0
308 |
309 | Unless required by applicable law or agreed to in writing, software
310 | distributed under the License is distributed on an "AS IS" BASIS,
311 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
312 | See the License for the specific language governing permissions and
313 | limitations under the License.
314 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/JsonAPI/src/main/java/com/gustavofao/jsonapi/JSONApiConverter.java:
--------------------------------------------------------------------------------
1 | package com.gustavofao.jsonapi;
2 |
3 | import android.util.Log;
4 |
5 | import com.gustavofao.jsonapi.Annotations.Excluded;
6 | import com.gustavofao.jsonapi.Annotations.Id;
7 | import com.gustavofao.jsonapi.Annotations.SerialName;
8 | import com.gustavofao.jsonapi.Annotations.Type;
9 | import com.gustavofao.jsonapi.Annotations.Types;
10 | import com.gustavofao.jsonapi.Models.ErrorModel;
11 | import com.gustavofao.jsonapi.Models.ErrorSource;
12 | import com.gustavofao.jsonapi.Models.JSONApiObject;
13 | import com.gustavofao.jsonapi.Models.JSONList;
14 | import com.gustavofao.jsonapi.Models.Links;
15 | import com.gustavofao.jsonapi.Models.Resource;
16 |
17 | import org.json.JSONArray;
18 | import org.json.JSONException;
19 | import org.json.JSONObject;
20 |
21 | import java.lang.reflect.Field;
22 | import java.text.ParseException;
23 | import java.text.SimpleDateFormat;
24 | import java.util.ArrayList;
25 | import java.util.Arrays;
26 | import java.util.Collection;
27 | import java.util.Date;
28 | import java.util.HashMap;
29 | import java.util.Iterator;
30 | import java.util.List;
31 | import java.util.Locale;
32 | import java.util.Map;
33 |
34 | public class JSONApiConverter {
35 |
36 | private static final String DATE_FORMAT_SERVER = "yyyy-MM-dd'T'HH:mm:ssZ";
37 |
38 | private SimpleDateFormat dateFormatter;
39 |
40 | private HashMap> classesIndex;
41 |
42 | public JSONApiConverter(Class extends Resource>... classes) {
43 | dateFormatter = new SimpleDateFormat(DATE_FORMAT_SERVER, Locale.US);
44 |
45 | classesIndex = new HashMap<>();
46 | List> classList = Arrays.asList(classes);
47 |
48 | for (Class extends Resource> c : classList) {
49 | if (c.getAnnotation(Type.class) != null) {
50 | String type = c.getAnnotation(Type.class).value();
51 | if (!classesIndex.containsKey(type))
52 | classesIndex.put(type, c);
53 | } else if (c.getAnnotation(Types.class) != null) {
54 | String[] types = c.getAnnotation(Types.class).value();
55 | for (String type : types) {
56 | if (!classesIndex.containsKey(type))
57 | classesIndex.put(type, c);
58 | }
59 | } else {
60 | Log.e("Classes", "No Annotation [" + c.getName() + "]");
61 | }
62 | }
63 | }
64 |
65 | public JSONApiConverter(HashMap> classesIndex) {
66 | dateFormatter = new SimpleDateFormat(DATE_FORMAT_SERVER, Locale.US);
67 | this.classesIndex = classesIndex;
68 | }
69 |
70 | public JSONApiConverter withDateFormat(SimpleDateFormat dateFormat) {
71 | this.dateFormatter = dateFormat;
72 | return this;
73 | }
74 |
75 | public JSONApiConverter withDateFormat(String format) {
76 | this.dateFormatter = new SimpleDateFormat(format, Locale.US);
77 | return this;
78 | }
79 |
80 | private Date parseDate(String date) throws ParseException {
81 | return dateFormatter.parse(date);
82 | }
83 |
84 | public String toJson(Resource resource) {
85 | JSONObject json = toJsonObject(resource);
86 | if (json != null)
87 | return json.toString();
88 | return null;
89 | }
90 |
91 | public String toJson(List extends Resource> resources) {
92 | JSONObject json = toJsonArray(resources);
93 | if (json != null)
94 | return json.toString();
95 | return null;
96 | }
97 |
98 | public JSONApiObject fromJson(String jsonObject) {
99 | JSONApiObject jsonApiObject = new JSONApiObject();
100 | try {
101 | JSONObject json = new JSONObject(jsonObject);
102 | HashMap includes = new HashMap<>();
103 |
104 | if (json.isNull("errors")) {
105 | if (!json.isNull("included")) {
106 | JSONArray included = json.getJSONArray("included");
107 | for (int i = 0; i < included.length(); i++) {
108 | JSONObject each = included.getJSONObject(i);
109 | String key = getResourceTag(each);
110 |
111 | includes.put(key, resourceFromJson(each, includes));
112 | }
113 |
114 | //Second pass to check if there is this item on relationships
115 | for (int i = 0; i < included.length(); i++) {
116 | JSONObject each = included.getJSONObject(i);
117 | String key = getResourceTag(each);
118 |
119 | includes.remove(key);
120 | includes.put(key, resourceFromJson(each, includes));
121 | }
122 | }
123 |
124 | if (!json.isNull("data")) {
125 | Object data = json.get("data");
126 | if (data instanceof JSONObject) {
127 | //Single Object
128 | JSONObject objectData = (JSONObject) data;
129 | jsonApiObject.addData(resourceFromJson(objectData, includes));
130 | } else if (data instanceof JSONArray) {
131 | //ListObjects
132 | JSONArray objectData = (JSONArray) data;
133 | for (int i = 0; i < objectData.length(); i++) {
134 | jsonApiObject.addData(resourceFromJson(objectData.getJSONObject(i), includes));
135 | }
136 | }
137 | }
138 |
139 | if (!json.isNull("links"))
140 | jsonApiObject.setLinks(linksFromJson(json.getJSONObject("links")));
141 |
142 | if (!json.isNull("meta"))
143 | jsonApiObject.setMeta(json.getJSONObject("meta"));
144 |
145 | Field hasErrors = jsonApiObject.getClass().getDeclaredField("hasErrors");
146 | boolean oldAcessible = hasErrors.isAccessible();
147 | hasErrors.setAccessible(true);
148 | hasErrors.setBoolean(jsonApiObject, false);
149 | hasErrors.setAccessible(oldAcessible);
150 | } else {
151 | JSONArray errorList = json.getJSONArray("errors");
152 | List errorModelList = new ArrayList<>();
153 | for (int i = 0; i < errorList.length(); i++) {
154 | ErrorModel error = new ErrorModel();
155 | JSONObject eachRow = errorList.getJSONObject(i);
156 |
157 | if (!eachRow.isNull("code"))
158 | error.setStatus(eachRow.getString("code"));
159 |
160 | if (!eachRow.isNull("detail"))
161 | error.setDetail(eachRow.getString("detail"));
162 |
163 | if (!eachRow.isNull("title"))
164 | error.setTitle(eachRow.getString("title"));
165 |
166 | if (!eachRow.isNull("source")) {
167 | ErrorSource source = new ErrorSource();
168 | JSONObject sourceJson = eachRow.getJSONObject("source");
169 |
170 | if (!sourceJson.isNull("parameter"))
171 | source.setParameter(sourceJson.getString("parameter"));
172 |
173 | if (!sourceJson.isNull("pointer"))
174 | source.setPointer(sourceJson.getString("pointer"));
175 |
176 | error.setSource(source);
177 | }
178 |
179 | errorModelList.add(error);
180 | }
181 |
182 | Field hasErrors = jsonApiObject.getClass().getDeclaredField("errors");
183 | boolean oldAcessible = hasErrors.isAccessible();
184 | hasErrors.setAccessible(true);
185 | hasErrors.set(jsonApiObject, errorModelList);
186 | hasErrors.setAccessible(oldAcessible);
187 | }
188 | } catch (Exception ex) {
189 | Log.e(JSONApiConverter.class.getSimpleName(), "Here _ " + ex.getMessage());
190 | ex.printStackTrace();
191 | }
192 | return jsonApiObject;
193 | }
194 |
195 | private Resource resourceFromJson(JSONObject jsonObject, HashMap includes)
196 | throws JSONException, IllegalAccessException, InstantiationException, ParseException, NoSuchFieldException {
197 | String typeString = jsonObject.getString("type");
198 | Resource resource = classesIndex.get(typeString).newInstance();
199 |
200 | Field idMainField = Resource.class.getDeclaredField("id");
201 | Field typeMainField = Resource.class.getDeclaredField("type");
202 | Field attrMainField = Resource.class.getDeclaredField("hasAttributes");
203 |
204 | boolean oldIdAccessible = idMainField.isAccessible();
205 | boolean oldTypeAccessible = typeMainField.isAccessible();
206 | boolean oldAccessibleAccessible = attrMainField.isAccessible();
207 |
208 | idMainField.setAccessible(true);
209 | if (!jsonObject.isNull("id")) {
210 | idMainField.set(resource, jsonObject.getString("id"));
211 | } else {
212 | idMainField.set(resource, "");
213 | }
214 | idMainField.setAccessible(oldIdAccessible);
215 |
216 | typeMainField.setAccessible(true);
217 | typeMainField.set(resource, typeString);
218 | typeMainField.setAccessible(oldTypeAccessible);
219 |
220 | attrMainField.setAccessible(true);
221 | attrMainField.setBoolean(resource, jsonObject.isNull("attributes"));
222 | attrMainField.setAccessible(oldAccessibleAccessible);
223 |
224 | //Pega os atributos da classe
225 | List fields = getFields(resource.getClass());
226 | HashMap fieldsHash = new HashMap<>();
227 |
228 | for (Field f : fields) {
229 | if (f.getAnnotation(SerialName.class) != null)
230 | fieldsHash.put(f.getAnnotation(SerialName.class).value(), f);
231 | else
232 | fieldsHash.put(f.getName(), f);
233 | }
234 |
235 | if (!jsonObject.isNull("attributes")) {
236 | //Separa os atributos do JSON
237 | JSONObject attributes = jsonObject.getJSONObject("attributes");
238 | Iterator it = attributes.keys();
239 |
240 | while (it.hasNext()) {
241 | String attr = it.next();
242 | Object value = attributes.get(attr);
243 |
244 | if (fieldsHash.containsKey(attr)) {
245 | Field currentField = fieldsHash.get(attr);
246 | Boolean oldAccessible = currentField.isAccessible();
247 | currentField.setAccessible(true);
248 |
249 | try {
250 | if (value instanceof String) {
251 | if (currentField.getType().equals(char.class))
252 | currentField.setChar(resource, String.valueOf(value).charAt(0));
253 | else if (currentField.getType().equals(String.class))
254 | currentField.set(resource, value);
255 | else if (currentField.getType().equals(Date.class))
256 | currentField.set(resource, parseDate(String.valueOf(value)));
257 | else if (currentField.getType().equals(double.class) || currentField.getType().equals(Double.class))
258 | currentField.set(resource, Double.valueOf(String.valueOf(value)));
259 | else if (currentField.getType().equals(float.class) || currentField.getType().equals(Float.class))
260 | currentField.set(resource, Float.valueOf(String.valueOf(value)));
261 | else
262 | Log.e("JSONApiConverter", "Type not setted (" + currentField.getType().getName() + ")");
263 | } else if (value instanceof Double || value instanceof Float) {
264 | if (currentField.getType().equals(float.class) || currentField.getType().equals(Float.class))
265 | currentField.setDouble(resource, (float) value);
266 | else if (currentField.getType().equals(double.class) || currentField.getType().equals(Double.class))
267 | currentField.setDouble(resource, (double) value);
268 | } else if (value instanceof Integer) {
269 | currentField.setInt(resource, (int) value);
270 | } else if (value instanceof Long) {
271 | currentField.setLong(resource, (long) value);
272 | } else if (value instanceof Character) {
273 | currentField.setChar(resource, (char) value);
274 | } else if (value instanceof Boolean) {
275 | currentField.setBoolean(resource, (boolean) value);
276 | } else if (value instanceof JSONObject) {
277 | JSONObject json = (JSONObject) value;
278 | Map data = new HashMap<>();
279 |
280 | Iterator keys = json.keys();
281 | while (keys.hasNext()) {
282 | String k = keys.next();
283 | data.put(k, json.get(k));
284 | }
285 |
286 | currentField.set(resource, data);
287 | } else if (value instanceof JSONArray) {
288 | JSONArray array = (JSONArray) value;
289 | List