Merge pull request #184 from opentok/repo-metrics

Adding repo metric GitHub action

Author: yallen011

.github/workflows/metrics.yml

@@ -0,0 +1,17 @@
+name: Aggregit
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  recordMetrics:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: michaeljolley/aggregit@v1
+      with:
+        githubToken: ${{ secrets.GITHUB_TOKEN }}
+        project_id: ${{ secrets.project_id }}
+        private_key: ${{ secrets.private_key }}
+        client_email: ${{ secrets.client_email }}
+        firebaseDbUrl: ${{ secrets.firebaseDbUrl }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+devrel@vonage.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -1,7 +1,9 @@
 # OpenTok Java SDK
 
 [![Build Status](https://travis-ci.org/opentok/Opentok-Java-SDK.svg?branch=master)](https://travis-ci.org/opentok/Opentok-Java-SDK)
-[![codecov](https://codecov.io/gh/opentok/Opentok-Java-SDK/branch/master/graph/badge.svg)](https://codecov.io/gh/opentok/Opentok-Java-SDK)
+ [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+<img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
 
 The OpenTok Java SDK lets you generate
 [sessions](https://tokbox.com/developer/guides/create-session/) and
@@ -78,9 +80,9 @@ opentok.close();
 To create an OpenTok Session, use the `OpenTok` instance’s `createSession(SessionProperties properties)`
 method. The `properties` parameter is optional and it is used to specify two things:
 
-* Whether the session uses the OpenTok Media Router
-* A location hint for the OpenTok server.
-* Whether the session is automatically archived.
+- Whether the session uses the OpenTok Media Router
+- A location hint for the OpenTok server.
+- Whether the session is automatically archived.
 
 An instance can be initialized using the `com.opentok.SessionProperties.Builder` class.
 The `sessionId` property of the returned `com.opentok.Session` instance, which you can read using
@@ -199,10 +201,10 @@ The `Archive.OutputMode.COMPOSED` option is the default value for `outputMode`.
 You can only specify the `resolution` for composed archives using the `ArchiveProperties` builder. If you set the `resolution` property and also set the `outputMode` property to `Archive.OutputMode.INDIVIDUAL`, the method will throw an `InvalidArgumentException`.
 
 The accepted values for `resolution` are:
+
 - `"640x480"` (SD, the default)
 - `"1280x720"` (HD)
-> Please note that setting any other value for the `resolution` property will result in an exception.
-
+  > Please note that setting any other value for the `resolution` property will result in an exception.
 
 ```java
 import com.opentok.ArchiveProperties;
@@ -249,7 +251,8 @@ List<Archive> archives = opentok.listArchives(0, 50);
 // Get a list of the next 50 archives
 List<Archive> archives = opentok.listArchives(50, 50);
 ```
-You can also fetch the list of archives for a specific session ID , and optionally 
+
+You can also fetch the list of archives for a specific session ID , and optionally
 use the offset and count parameters as described above.
 
 ```java
@@ -268,7 +271,7 @@ into the `archiveMode()` method of the `SessionProperties.Builder` object you us
 `sessionProperties` parameter passed into the `OpenTok.createSession()` method (see "Creating
 Sessions," above).
 
-For composed archives, you can dynamically set the archive layout (while the archive is being recorded) using the `OpenTok.setArchiveLayout(String archiveId, ArchiveProperties properties)` 
+For composed archives, you can dynamically set the archive layout (while the archive is being recorded) using the `OpenTok.setArchiveLayout(String archiveId, ArchiveProperties properties)`
 method. See [Customizing the video layout for composed
 archives](https://tokbox.com/developer/guides/archiving/layout-control.html) for more information. Use the `ArchiveProperties` builder as follows:
 
@@ -321,7 +324,7 @@ For more information on archiving, see the
 ### Disconnecting Clients
 
 Your application server can disconnect a client from an OpenTok session by calling the `forceDisconnect(sessionId, connectionId)`
-method of the `com.opentok.OpenTok` instance. 
+method of the `com.opentok.OpenTok` instance.
 
 ```java
 opentok.forceDisconnect(sessionId, connectionId);
@@ -335,43 +338,42 @@ For more information on the force disconnect functionality and exception codes,
 
 You can send signals to all the connections in a session or to a specific connection:
 
-- `public void signal(String sessionId, SignalProperties props) throws OpenTokException , RequestException, InvalidArgumentException `
+- `public void signal(String sessionId, SignalProperties props) throws OpenTokException , RequestException, InvalidArgumentException`
 
 - `public void signal(String sessionId, String connectionId, SignalProperties props) throws OpenTokException , RequestException , InvalidArgumentException`
 
 The `SignalProperties` builder helps you to construct the signal data and type:
 
-
 ```java
 SignalProperties properties = new SignalProperties.Builder()
   .type("test")
   .data("This is a test string")
   .build();
- 
+
 opentok.signal(sessionId, properties);
 opentok.signal(sessionId, connectionId, properties);
 ```
 
 Make sure that the `type` string does not exceed the maximum length (128 bytes)
-and the `data` string does not exceed the maximum length (8 kB). 
+and the `data` string does not exceed the maximum length (8 kB).
 The `SignalProperties` builder does not currently check for these limitations.
 
 For more information on signaling and exception codes, refer to the documentation for the
 [OpenTok signaling](https://tokbox.com/developer/rest/#send_signal) REST method.
 
 ### Broadcasting
 
-You can broadcast OpenTok publishing streams to an HLS (HTTP live streaming) or 
-to RTMP streams. To successfully start broadcasting a session, at least one client must be 
+You can broadcast OpenTok publishing streams to an HLS (HTTP live streaming) or
+to RTMP streams. To successfully start broadcasting a session, at least one client must be
 connected to the session. You can only have one active live streaming broadcast at a time
 for a session (however, having more than one would not be useful).
-The live streaming broadcast can target one HLS endpoint and up to five 
+The live streaming broadcast can target one HLS endpoint and up to five
 RTMP servers simulteneously for a session. You can only start live streaming
 for sessions that use the OpenTok Media Router (with the media mode set to routed);
-you cannot use live streaming with sessions that have the media mode set to relayed. 
+you cannot use live streaming with sessions that have the media mode set to relayed.
 (See the [OpenTok Media Router and media
 modes](https://tokbox.com/developer/guides/create-session/#media-mode) developer guide).
- 
+
 You can start a broadcast using the `OpenTok.startBroadcast(sessionId, properties)` method,
 where the `properties` field is a `BroadcastProperties` object. Initalize a `BroadcastProperties`
 object as follows (see the [Opentok Broadcast](https://tokbox.com/developer/rest/#start_broadcast)
@@ -413,13 +415,13 @@ long createdAt;
 long updatedAt;
 String resolution;
 String status;
-List<Rtmp> rtmpList = new ArrayList<>();  //not more than 5 
+List<Rtmp> rtmpList = new ArrayList<>();  //not more than 5
 String hls;    // HLS url
 
 // The Rtmp class mimics the RtmpProperties
 ```
 
-To stop a broadcast use:  
+To stop a broadcast use:
 
 ```java
 Broadcast broadcast = opentok.stopBroadcast(broadcastId);
@@ -441,7 +443,7 @@ of a live broadcast dynamically using:
 ```java
 opentok.setBroadcastLayout(broadcastId, properties);
 
-//properties can be 
+//properties can be
 BroadcastProperties properties = new BroadcastProperties.Builder()
           .layout(new BroadcastLayout(BroadcastLayout.Type.VERTICAL))
           .build();
@@ -464,7 +466,7 @@ opentok.setStreamLayouts(sessionId, properties);
 ### Working with Streams
 
 You can get information about a stream by calling the `getStream(sessionId, streamId)` method
-of the `com.opentok.OpenTok` instance. 
+of the `com.opentok.OpenTok` instance.
 
 ```java
 // Get stream info from just a sessionId (fetched from a database)
@@ -494,18 +496,18 @@ Interconnect feature. This requires a SIP URI, the session ID you wish to add th
 stream to, and a token to connect to that session ID.
 
 To connect your SIP platform to an OpenTok session, call the
-`OpenTok.dial(String sessionId, String token, SipProperties properties)` method. 
-The audio from your end of the SIP call is added to the OpenTok session as an audio-only stream. 
+`OpenTok.dial(String sessionId, String token, SipProperties properties)` method.
+The audio from your end of the SIP call is added to the OpenTok session as an audio-only stream.
 The OpenTok Media Router mixes audio from other streams in the session and sends the mixed audio
 to your SIP endpoint. The call ends when your SIP server sends a BYE message (to terminate
 the call). You can also end a call using the `OpenTok.forceDisconnect(sessionId, connectionId)`
 method to disconnect the SIP client from the session (see [Disconnecting clients](#disconnecting-clients)).
 
 The OpenTok SIP gateway automatically ends a call after 5 minutes of inactivity
-(5 minutes without media received). Also, as a security measure, 
+(5 minutes without media received). Also, as a security measure,
 the OpenTok SIP gateway closes any SIP call that lasts longer than 6 hours.
 
-The SIP interconnect feature requires that you use an OpenTok session that uses the 
+The SIP interconnect feature requires that you use an OpenTok session that uses the
 OpenTok Media Router (a session with the media mode set to routed).
 
 To connect an OpenTok session to a SIP gateway:
@@ -528,8 +530,8 @@ SipProperties properties = new SipProperties.Builder()
 There are two sample applications included with the SDK. To get going as fast as possible, clone the whole
 repository and follow the Walkthroughs:
 
-*  [HelloWorld](sample/HelloWorld/README.md)
-*  [Archiving](sample/Archiving/README.md)
+- [HelloWorld](sample/HelloWorld/README.md)
+- [Archiving](sample/Archiving/README.md)
 
 ## Documentation
 
@@ -582,9 +584,11 @@ take two parameters: the session ID and a TokenOptions object.
 Interested in contributing? We :heart: pull requests! See the [Development](DEVELOPING.md) and
 [Contribution](CONTRIBUTING.md) guidelines.
 
-## Support
+## Getting Help
 
-See <https://support.tokbox.com> for all our support options.
+We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
 
-Find a bug? File it on the [Issues](https://github.com/opentok/opentok-java-sdk/issues) page. Hint:
-test cases are really helpful!
+- Open an issue on this repository
+- See <https://support.tokbox.com/> for support options
+- Tweet at us! We're [@VonageDev on Twitter](https://twitter.com/VonageDev)
+- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack)

src/main/java/com/opentok/Archive.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2019 TokBox, Inc.
+ * Copyright (C) 2020 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/ArchiveLayout.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2019 TokBox, Inc.
+ * Copyright (C) 2020 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/ArchiveList.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2019 TokBox, Inc.
+ * Copyright (C) 2020 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/ArchiveMode.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2019 TokBox, Inc.
+ * Copyright (C) 2020 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/ArchiveProperties.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2019 TokBox, Inc.
+ * Copyright (C) 2020 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.

src/main/java/com/opentok/Broadcast.java

@@ -1,6 +1,6 @@
 /**
  * OpenTok Java SDK
- * Copyright (C) 2019 TokBox, Inc.
+ * Copyright (C) 2020 TokBox, Inc.
  * http://www.tokbox.com
  *
  * Licensed under The MIT License (MIT). See LICENSE file for more information.