Skip to content

Commit 1c07b31

Browse files
author
Idan Harel
committed
Viber Java SDK - Initial commit
0 parents  commit 1c07b31

149 files changed

Lines changed: 24048 additions & 0 deletions

File tree

Some content is hidden

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

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.gradle
2+
gradle.properties
3+
build/

‎LICENSE.md‎

Lines changed: 197 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,197 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
Copyright 2016 Viber Media S.à r.l.
178+
179+
Licensed under the Apache License, Version 2.0 (the "License");
180+
you may not use this file except in compliance with the License.
181+
You may obtain a copy of the License at
182+
183+
http://www.apache.org/licenses/LICENSE-2.0
184+
185+
Unless required by applicable law or agreed to in writing, software
186+
distributed under the License is distributed on an "AS IS" BASIS,
187+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
188+
See the License for the specific language governing permissions and
189+
limitations under the License.
190+
191+
192+
Dependencies License (MIT)
193+
==========================
194+
[underscore](https://www.npmjs.com/package/underscore)
195+
[body-parser](https://www.npmjs.com/package/body-parser)
196+
[express](https://www.npmjs.com/package/express)
197+
[needle](https://www.npmjs.com/package/needle)

‎README.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Viber Bot API
2+
Use this library to communicate with the Viber API to develop a bot for [Viber](https://developers.viber.com/).
3+
Please visit [Getting Started](https://developers.viber.com/customer/en/portal/articles/2567874-getting-started?b_id=15145) guide for more information about Viber API.
4+
5+
## License
6+
This library is released under the terms of the Apache 2.0 license. See [License](LICENSE.md) for more information.
7+
8+
## Library Prerequisites
9+
* Java >= 8
10+
* [Get your Viber Public Account authentication token](https://developers.viber.com/customer/en/portal/articles/2554141-create-a-public-account?b_id=15145).
11+
* SSL Certification - You'll need a trusted (ca.pem) certificate, not self-signed. You can find one at [Let's Encrypt](https://letsencrypt.org/) or buy one.
12+
13+
## Documentation
14+
### JavaDocs
15+
All public APIs are documented with JavaDocs. [The JavaDocs can be found here](docs/index.html)
16+
17+
### A simple overview:
18+
```java
19+
public void botExample() {
20+
ViberBot bot = new ViberBot(new BotProfile("SampleBot", "http://viber.com/avatar.jpg"), "YOUR_AUTH_TOKEN_HERE");
21+
bot.onMessageReceived((event, message, response) -> response.send(message));
22+
23+
// somewhere else in your webserver of choise:
24+
bot.incoming(Request.fromJsonString("..."));
25+
}
26+
```
27+
You can chose to use any webserver or framework you like. All you need to do is call the API with -
28+
```java
29+
bot.incoming(Request.fromJsonString("...")); // or
30+
bot.incoming(Request.fromInputStream("..."));
31+
```
32+
33+
### Should I be concerned with synchronizing my webserver threads? Is this library thread-safe?
34+
The Viber bot library is *thread-safe* and highly concurrent. You do not have to worry about synchronizing anything.
35+
All calls to `ViberBot#incoming()` go through a `BlockingQueue`, and ordering is retained.
36+
All I/O calls are directly executed on the same thread they were initially called on.
37+
38+
### Can I make I/O calls asynchronous and still retain thread-safety for my bot?
39+
Yes. You can pass an environment variable to control the I/O thread pool:
40+
`com.viber.bot.executor.strategy=[DIRECT|THREAD]` (default is DIRECT)
41+
`com.viber.bot.executor.threads=N` (default is `getRuntime().availableProcessors()`)
42+
43+
* Note: This will not change the way you use the library. You still don't have to synchronize anything.
44+
45+
### Do you supply a basic router for text messages?
46+
Well, funny you ask. Yes we do.
47+
**be careful**, messages sent to your router callback will also be emitted to *ViberBot#onMessageReceived*.
48+
```java
49+
public void botTextRouterExample() {
50+
bot.onTextMessage("(hi|hello)", (event, message, response) -> response.send("Hi " + event.getSender().getName()));
51+
}
52+
```
53+
54+
## Useful links:
55+
* Writing a custom keyboard JSON [described here](https://developers.viber.com/customer/en/portal/articles/2567880-keyboards?b_id=15145).
56+
* [Forbidden file formats list](https://developers.viber.com/customer/en/portal/articles/2541358-forbidden-file-formats?b_id=15145).
57+
* List of [Error Codes](https://developers.viber.com/customer/en/portal/articles/2541337-error-codes?b_id=15145).
58+
* List of [Events and Callbacks](https://developers.viber.com/customer/en/portal/articles/2541267-callbacks?b_id=15145).

‎build.gradle‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
group = projectGroup
2+
version = projectVersion
3+
4+
buildscript {
5+
repositories {
6+
mavenCentral()
7+
}
8+
}
9+
10+
repositories {
11+
mavenCentral()
12+
}
13+
14+
apply plugin: 'java'
15+
apply plugin: 'idea'
16+
apply plugin: 'maven'
17+
apply plugin: 'signing'
18+
19+
sourceCompatibility = projectSourceCompatibility
20+
21+
project.ext {
22+
slf4jVersion = '1.7.21'
23+
jacksonVersion = '2.8.5'
24+
findbugsVersion = '3.0.1'
25+
guavaVersion = '20.0'
26+
okhttp3Version = '3.4.2'
27+
}
28+
29+
dependencies {
30+
compile group: 'org.slf4j', name: 'slf4j-api', version: slf4jVersion
31+
compile group: 'com.squareup.okhttp3', name: 'okhttp', version: okhttp3Version
32+
compile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: jacksonVersion
33+
34+
compile group: 'com.google.code.findbugs', name: 'jsr305', version: findbugsVersion
35+
compile group: 'com.google.guava', name: 'guava', version: guavaVersion
36+
37+
testCompile group: 'junit', name: 'junit', version: '4.12'
38+
testCompile group: 'org.assertj', name: 'assertj-core', version: '3.5.2'
39+
testCompile group: 'org.mockito', name: 'mockito-all', version: '1.9.5'
40+
testCompile group: 'com.jayway.awaitility', name: 'awaitility', version: '1.7.0'
41+
}
42+
43+
sourceSets {
44+
main {
45+
java {
46+
srcDirs 'src/main/java'
47+
}
48+
}
49+
}
50+
51+
task wrapper(type: Wrapper) {
52+
gradleVersion = '2.13'
53+
}
54+
55+
task javadocJar(type: Jar) {
56+
classifier = 'javadoc'
57+
from javadoc
58+
}
59+
60+
task sourcesJar(type: Jar) {
61+
classifier = 'sources'
62+
from sourceSets.main.allSource
63+
}
64+
65+
artifacts {
66+
archives javadocJar, sourcesJar
67+
}
68+
69+
signing {
70+
sign configurations.archives
71+
}
72+
73+
uploadArchives {
74+
repositories {
75+
mavenDeployer {
76+
beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
77+
78+
repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
79+
authentication(userName: ossrhUsername, password: ossrhPassword)
80+
}
81+
82+
snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
83+
authentication(userName: ossrhUsername, password: ossrhPassword)
84+
}
85+
86+
pom.project {
87+
name 'Viber Bot'
88+
packaging 'jar'
89+
artifactId 'viber-bot'
90+
description 'Use this library to communicate with the Viber API to develop a bot for https://developers.viber.com/.'
91+
url 'https://developers.viber.com/'
92+
93+
scm {
94+
url 'https://github.com/Viber/viber-bot-java'
95+
}
96+
97+
licenses {
98+
license {
99+
name 'The Apache License, Version 2.0'
100+
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
101+
}
102+
}
103+
104+
developers {
105+
developer {
106+
id 'idan'
107+
name 'Idan Harel'
108+
email 'idanh@viber.com'
109+
}
110+
}
111+
}
112+
}
113+
}
114+
}

0 commit comments

Comments
 (0)