Skip to content

Commit 843b065

Browse files
author
Georgi Neykov
committed
docs(General): Update the CHANGELOG, README, Javadoc adn project version
1 parent ed56b3c commit 843b065

File tree

106 files changed

+1840
-520
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+1840
-520
lines changed

CHANGELOG.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,48 @@
11
Changelog
22
==========
33

4+
Version 2.3.0 (23.10.2019)
5+
--------------------------
6+
7+
#### Composer
8+
9+
- Add the `methodName()` property to `Call<T>` to allow for better error reporting.
10+
- Add the API method name in the stacktrace when an error is thrown via an `Observable` created with a RxJava adapter.
11+
- Add the ability to override the target endpoint of a `Call<T>` is being made by adding a single `Endpoint` method
12+
parameter. Example:
13+
```java
14+
interface MyInterface {
15+
@Method("someapicall")
16+
Call<ResponseBody> getResponseBody(Endpoint endpoint);
17+
18+
@Method("someapicallwithparams")
19+
Call<ResponseBody> getResponseBody(@Request SomeRequest request, Endpoint endpoint);
20+
}
21+
```
22+
- Extract the composer-related annotations in a separate module and the `composer-annotations` maven artifact.
23+
24+
#### Client
25+
26+
- Add an `endpoint()` property to `ResponseData` that returns the source `Endpoint`.
27+
28+
#### Serialization
29+
30+
- Give a better error message when trying to serialize a type as a request parameter not resulting in a single value.
31+
32+
#### Protocol
33+
34+
- Update to Okio 1.17.4
35+
- Drop the peeking source implementation in favor of the one shipped with Okio.
36+
- `BytesReader` instances returned from `BytesReader.peek()` will not close their parent when being closed.
37+
- `BytesReader` instances returned from `BytesReader.peek()` will throw exceptions if used when their
38+
parent has bytes consumed beyond the peek start point.
39+
40+
#### General
41+
42+
- Update to Gradle 5.6.2
43+
- Refactor the project build scripts
44+
45+
446
Version 2.2.3 (19.09.2018)
547
--------------------------
648

@@ -107,11 +149,11 @@ Example:
107149

108150
Calling:
109151
```java
110-
collectionAdapter.serialize(writer, collection);
152+
collectionAdapter.serialize(writer, collection);
111153
```
112154
is equivalent to:
113155
```java
114-
writer.writeValue("some value,some value,some value");
156+
writer.writeValue("some value,some value,some value");
115157
```
116158

117159
#### Composer

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,13 @@ api.copy(...)
5959
<dependency>
6060
<groupId>com.pcloud.pcloud-networking-java</groupId>
6161
<artifactId>composer</artifactId>
62-
<version>2.2.3</version>
62+
<version>2.3.0</version>
6363
<type>pom</type>
6464
</dependency>
6565
```
6666

6767
```groovy
68-
compile 'com.pcloud.pcloud-networking-java:composer:2.2.3'
68+
compile 'com.pcloud.pcloud-networking-java:composer:2.3.0'
6969
```
7070

7171
### Client
@@ -87,13 +87,13 @@ The `binapi-client` module contains a network client for composing and executing
8787
<dependency>
8888
<groupId>com.pcloud.pcloud-networking-java</groupId>
8989
<artifactId>binapi-client</artifactId>
90-
<version>2.2.3</version>
90+
<version>2.3.0</version>
9191
<type>pom</type>
9292
</dependency>
9393
```
9494

9595
```groovy
96-
compile 'com.pcloud.pcloud-networking-java:binapi-client:2.2.3'
96+
compile 'com.pcloud.pcloud-networking-java:binapi-client:2.3.0'
9797
```
9898

9999
--------------------------------------------------------------------------------
@@ -115,13 +115,13 @@ The `serialization` module contains a library for serializing Java objects to bi
115115
<dependency>
116116
<groupId>com.pcloud.pcloud-networking-java</groupId>
117117
<artifactId>serialization</artifactId>
118-
<version>2.2.3</version>
118+
<version>2.3.0</version>
119119
<type>pom</type>
120120
</dependency>
121121
```
122122

123123
```groovy
124-
compile 'com.pcloud.pcloud-networking-java:serialization:2.2.3'
124+
compile 'com.pcloud.pcloud-networking-java:serialization:2.3.0'
125125
```
126126
--------------------------------------------------------------------------------
127127
### Protocol
@@ -142,13 +142,13 @@ The `protocol` module contains the core logic for writing/reading data in the fo
142142
<dependency>
143143
<groupId>com.pcloud.pcloud-networking-java</groupId>
144144
<artifactId>protocol</artifactId>
145-
<version>2.2.3</version>
145+
<version>2.3.0</version>
146146
<type>pom</type>
147147
</dependency>
148148
```
149149

150150
```groovy
151-
compile 'com.pcloud.pcloud-networking-java:protocol:2.2.3'
151+
compile 'com.pcloud.pcloud-networking-java:protocol:2.3.0'
152152
```
153153

154154

docs/allclasses-frame.html

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Mar 23 19:14:27 EET 2018 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Wed Oct 23 16:41:34 EEST 2019 -->
66
<title>All Classes</title>
7-
<meta name="date" content="2018-03-23">
7+
<meta name="date" content="2019-10-23">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -28,7 +28,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
2828
<li><a href="com/pcloud/networking/api/DataApiResponse.html" title="class in com.pcloud.networking.api" target="classFrame">DataApiResponse</a></li>
2929
<li><a href="com/pcloud/networking/protocol/DataSink.html" title="class in com.pcloud.networking.protocol" target="classFrame">DataSink</a></li>
3030
<li><a href="com/pcloud/networking/protocol/DataSource.html" title="class in com.pcloud.networking.protocol" target="classFrame">DataSource</a></li>
31-
<li><a href="com/pcloud/networking/client/internal/tls/DefaultHostnameVerifier.html" title="class in com.pcloud.networking.client.internal.tls" target="classFrame">DefaultHostnameVerifier</a></li>
3231
<li><a href="com/pcloud/networking/client/Endpoint.html" title="class in com.pcloud.networking.client" target="classFrame">Endpoint</a></li>
3332
<li><a href="com/pcloud/networking/client/EndpointProvider.html" title="interface in com.pcloud.networking.client" target="classFrame"><span class="interfaceName">EndpointProvider</span></a></li>
3433
<li><a href="com/pcloud/networking/protocol/ForwardingProtocolReader.html" title="class in com.pcloud.networking.protocol" target="classFrame">ForwardingProtocolReader</a></li>
@@ -38,7 +37,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
3837
<li><a href="com/pcloud/networking/serialization/GuardedSerializationTypeAdapter.html" title="class in com.pcloud.networking.serialization" target="classFrame">GuardedSerializationTypeAdapter</a></li>
3938
<li><a href="com/pcloud/networking/api/Interactor.html" title="interface in com.pcloud.networking.api" target="classFrame"><span class="interfaceName">Interactor</span></a></li>
4039
<li><a href="com/pcloud/networking/client/Interactor.html" title="interface in com.pcloud.networking.client" target="classFrame"><span class="interfaceName">Interactor</span></a></li>
41-
<li><a href="com/pcloud/utils/IOUtils.html" title="class in com.pcloud.utils" target="classFrame">IOUtils</a></li>
4240
<li><a href="com/pcloud/networking/api/Method.html" title="annotation in com.pcloud.networking.api" target="classFrame">Method</a></li>
4341
<li><a href="com/pcloud/networking/api/MultiCall.html" title="interface in com.pcloud.networking.api" target="classFrame"><span class="interfaceName">MultiCall</span></a></li>
4442
<li><a href="com/pcloud/networking/client/MultiCall.html" title="interface in com.pcloud.networking.client" target="classFrame"><span class="interfaceName">MultiCall</span></a></li>
@@ -64,19 +62,13 @@ <h1 class="bar">All&nbsp;Classes</h1>
6462
<li><a href="com/pcloud/networking/client/ResponseBody.html" title="class in com.pcloud.networking.client" target="classFrame">ResponseBody</a></li>
6563
<li><a href="com/pcloud/networking/client/ResponseData.html" title="class in com.pcloud.networking.client" target="classFrame">ResponseData</a></li>
6664
<li><a href="com/pcloud/networking/api/ResponseInterceptor.html" title="interface in com.pcloud.networking.api" target="classFrame"><span class="interfaceName">ResponseInterceptor</span></a></li>
67-
<li><a href="com/pcloud/networking/api/adapters/RxObservableCallAdapter.html" title="class in com.pcloud.networking.api.adapters" target="classFrame">RxObservableCallAdapter</a></li>
68-
<li><a href="com/pcloud/networking/api/adapters/RxSingleCallAdapter.html" title="class in com.pcloud.networking.api.adapters" target="classFrame">RxSingleCallAdapter</a></li>
6965
<li><a href="com/pcloud/networking/protocol/SerializationException.html" title="class in com.pcloud.networking.protocol" target="classFrame">SerializationException</a></li>
70-
<li><a href="com/pcloud/networking/serialization/adapters/TimestampDateTypeAdapter.html" title="class in com.pcloud.networking.serialization.adapters" target="classFrame">TimestampDateTypeAdapter</a></li>
71-
<li><a href="com/pcloud/networking/serialization/adapters/TimestampDateTypeAdapterFactory.html" title="class in com.pcloud.networking.serialization.adapters" target="classFrame">TimestampDateTypeAdapterFactory</a></li>
7266
<li><a href="com/pcloud/networking/serialization/Transformer.html" title="class in com.pcloud.networking.serialization" target="classFrame">Transformer</a></li>
7367
<li><a href="com/pcloud/networking/serialization/Transformer.Builder.html" title="class in com.pcloud.networking.serialization" target="classFrame">Transformer.Builder</a></li>
7468
<li><a href="com/pcloud/networking/serialization/TypeAdapter.html" title="class in com.pcloud.networking.serialization" target="classFrame">TypeAdapter</a></li>
7569
<li><a href="com/pcloud/networking/serialization/TypeAdapterFactory.html" title="interface in com.pcloud.networking.serialization" target="classFrame"><span class="interfaceName">TypeAdapterFactory</span></a></li>
76-
<li><a href="com/pcloud/utils/Types.html" title="class in com.pcloud.utils" target="classFrame">Types</a></li>
7770
<li><a href="com/pcloud/networking/protocol/TypeToken.html" title="enum in com.pcloud.networking.protocol" target="classFrame">TypeToken</a></li>
7871
<li><a href="com/pcloud/networking/serialization/UnserializableTypeException.html" title="class in com.pcloud.networking.serialization" target="classFrame">UnserializableTypeException</a></li>
79-
<li><a href="com/pcloud/networking/client/internal/Utils.html" title="class in com.pcloud.networking.client.internal" target="classFrame">Utils</a></li>
8072
<li><a href="com/pcloud/networking/protocol/ValueReader.html" title="class in com.pcloud.networking.protocol" target="classFrame">ValueReader</a></li>
8173
<li><a href="com/pcloud/networking/protocol/ValueWriter.html" title="class in com.pcloud.networking.protocol" target="classFrame">ValueWriter</a></li>
8274
</ul>

docs/allclasses-noframe.html

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Mar 23 19:14:27 EET 2018 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Wed Oct 23 16:41:34 EEST 2019 -->
66
<title>All Classes</title>
7-
<meta name="date" content="2018-03-23">
7+
<meta name="date" content="2019-10-23">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
<script type="text/javascript" src="script.js"></script>
1010
</head>
@@ -28,7 +28,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
2828
<li><a href="com/pcloud/networking/api/DataApiResponse.html" title="class in com.pcloud.networking.api">DataApiResponse</a></li>
2929
<li><a href="com/pcloud/networking/protocol/DataSink.html" title="class in com.pcloud.networking.protocol">DataSink</a></li>
3030
<li><a href="com/pcloud/networking/protocol/DataSource.html" title="class in com.pcloud.networking.protocol">DataSource</a></li>
31-
<li><a href="com/pcloud/networking/client/internal/tls/DefaultHostnameVerifier.html" title="class in com.pcloud.networking.client.internal.tls">DefaultHostnameVerifier</a></li>
3231
<li><a href="com/pcloud/networking/client/Endpoint.html" title="class in com.pcloud.networking.client">Endpoint</a></li>
3332
<li><a href="com/pcloud/networking/client/EndpointProvider.html" title="interface in com.pcloud.networking.client"><span class="interfaceName">EndpointProvider</span></a></li>
3433
<li><a href="com/pcloud/networking/protocol/ForwardingProtocolReader.html" title="class in com.pcloud.networking.protocol">ForwardingProtocolReader</a></li>
@@ -38,7 +37,6 @@ <h1 class="bar">All&nbsp;Classes</h1>
3837
<li><a href="com/pcloud/networking/serialization/GuardedSerializationTypeAdapter.html" title="class in com.pcloud.networking.serialization">GuardedSerializationTypeAdapter</a></li>
3938
<li><a href="com/pcloud/networking/api/Interactor.html" title="interface in com.pcloud.networking.api"><span class="interfaceName">Interactor</span></a></li>
4039
<li><a href="com/pcloud/networking/client/Interactor.html" title="interface in com.pcloud.networking.client"><span class="interfaceName">Interactor</span></a></li>
41-
<li><a href="com/pcloud/utils/IOUtils.html" title="class in com.pcloud.utils">IOUtils</a></li>
4240
<li><a href="com/pcloud/networking/api/Method.html" title="annotation in com.pcloud.networking.api">Method</a></li>
4341
<li><a href="com/pcloud/networking/api/MultiCall.html" title="interface in com.pcloud.networking.api"><span class="interfaceName">MultiCall</span></a></li>
4442
<li><a href="com/pcloud/networking/client/MultiCall.html" title="interface in com.pcloud.networking.client"><span class="interfaceName">MultiCall</span></a></li>
@@ -64,19 +62,13 @@ <h1 class="bar">All&nbsp;Classes</h1>
6462
<li><a href="com/pcloud/networking/client/ResponseBody.html" title="class in com.pcloud.networking.client">ResponseBody</a></li>
6563
<li><a href="com/pcloud/networking/client/ResponseData.html" title="class in com.pcloud.networking.client">ResponseData</a></li>
6664
<li><a href="com/pcloud/networking/api/ResponseInterceptor.html" title="interface in com.pcloud.networking.api"><span class="interfaceName">ResponseInterceptor</span></a></li>
67-
<li><a href="com/pcloud/networking/api/adapters/RxObservableCallAdapter.html" title="class in com.pcloud.networking.api.adapters">RxObservableCallAdapter</a></li>
68-
<li><a href="com/pcloud/networking/api/adapters/RxSingleCallAdapter.html" title="class in com.pcloud.networking.api.adapters">RxSingleCallAdapter</a></li>
6965
<li><a href="com/pcloud/networking/protocol/SerializationException.html" title="class in com.pcloud.networking.protocol">SerializationException</a></li>
70-
<li><a href="com/pcloud/networking/serialization/adapters/TimestampDateTypeAdapter.html" title="class in com.pcloud.networking.serialization.adapters">TimestampDateTypeAdapter</a></li>
71-
<li><a href="com/pcloud/networking/serialization/adapters/TimestampDateTypeAdapterFactory.html" title="class in com.pcloud.networking.serialization.adapters">TimestampDateTypeAdapterFactory</a></li>
7266
<li><a href="com/pcloud/networking/serialization/Transformer.html" title="class in com.pcloud.networking.serialization">Transformer</a></li>
7367
<li><a href="com/pcloud/networking/serialization/Transformer.Builder.html" title="class in com.pcloud.networking.serialization">Transformer.Builder</a></li>
7468
<li><a href="com/pcloud/networking/serialization/TypeAdapter.html" title="class in com.pcloud.networking.serialization">TypeAdapter</a></li>
7569
<li><a href="com/pcloud/networking/serialization/TypeAdapterFactory.html" title="interface in com.pcloud.networking.serialization"><span class="interfaceName">TypeAdapterFactory</span></a></li>
76-
<li><a href="com/pcloud/utils/Types.html" title="class in com.pcloud.utils">Types</a></li>
7770
<li><a href="com/pcloud/networking/protocol/TypeToken.html" title="enum in com.pcloud.networking.protocol">TypeToken</a></li>
7871
<li><a href="com/pcloud/networking/serialization/UnserializableTypeException.html" title="class in com.pcloud.networking.serialization">UnserializableTypeException</a></li>
79-
<li><a href="com/pcloud/networking/client/internal/Utils.html" title="class in com.pcloud.networking.client.internal">Utils</a></li>
8072
<li><a href="com/pcloud/networking/protocol/ValueReader.html" title="class in com.pcloud.networking.protocol">ValueReader</a></li>
8173
<li><a href="com/pcloud/networking/protocol/ValueWriter.html" title="class in com.pcloud.networking.protocol">ValueWriter</a></li>
8274
</ul>

docs/com/pcloud/networking/api/ApiComposer.Builder.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Mar 23 19:14:25 EET 2018 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Wed Oct 23 16:41:34 EEST 2019 -->
66
<title>ApiComposer.Builder</title>
7-
<meta name="date" content="2018-03-23">
7+
<meta name="date" content="2019-10-23">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>

docs/com/pcloud/networking/api/ApiComposer.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Mar 23 19:14:25 EET 2018 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Wed Oct 23 16:41:34 EEST 2019 -->
66
<title>ApiComposer</title>
7-
<meta name="date" content="2018-03-23">
7+
<meta name="date" content="2019-10-23">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>

docs/com/pcloud/networking/api/ApiResponse.html

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_91) on Fri Mar 23 19:14:25 EET 2018 -->
5+
<!-- Generated by javadoc (1.8.0_91) on Wed Oct 23 16:41:34 EEST 2019 -->
66
<title>ApiResponse</title>
7-
<meta name="date" content="2018-03-23">
7+
<meta name="date" content="2019-10-23">
88
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../../../../script.js"></script>
1010
</head>
@@ -196,7 +196,10 @@ <h3>Method Summary</h3>
196196
</tr>
197197
<tr id="i3" class="rowColor">
198198
<td class="colFirst"><code>java.lang.String</code></td>
199-
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/pcloud/networking/api/ApiResponse.html#toString--">toString</a></span>()</code>&nbsp;</td>
199+
<td class="colLast"><code><span class="memberNameLink"><a
200+
href="../../../../com/pcloud/networking/api/ApiResponse.html#toString--">toString</a></span>()</code>
201+
<div class="block">Returns a string representation of the object.</div>
202+
</td>
200203
</tr>
201204
</table>
202205
<ul class="blockList">
@@ -315,9 +318,32 @@ <h4>isSuccessful</h4>
315318
<li class="blockList">
316319
<h4>toString</h4>
317320
<pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
321+
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code>java.lang.Object</code></span>
322+
</div>
323+
<div class="block">Returns a string representation of the object. In general, the
324+
<code>toString</code> method returns a string that
325+
"textually represents" this object. The result should
326+
be a concise but informative representation that is easy for a
327+
person to read.
328+
It is recommended that all subclasses override this method.
329+
<p>
330+
The <code>toString</code> method for class <code>Object</code>
331+
returns a string consisting of the name of the class of which the
332+
object is an instance, the at-sign character `<code>@</code>', and
333+
the unsigned hexadecimal representation of the hash code of the
334+
object. In other words, this method returns a string equal to the
335+
value of:
336+
<blockquote>
337+
<pre>
338+
getClass().getName() + '@' + Integer.toHexString(hashCode())
339+
</pre>
340+
</blockquote>
341+
</div>
318342
<dl>
319343
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
320344
<dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
345+
<dt><span class="returnLabel">Returns:</span></dt>
346+
<dd>a string representation of the object.</dd>
321347
</dl>
322348
</li>
323349
</ul>

0 commit comments

Comments
 (0)