Skip to content

Commit

Permalink
Merge pull request #51 from redouane59/develop
Browse files Browse the repository at this point in the history
V1.6
  • Loading branch information
redouane59 authored Aug 30, 2020
2 parents 1f75bdb + dcdd150 commit 3fcd43b
Show file tree
Hide file tree
Showing 36 changed files with 988 additions and 918 deletions.
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ This project is a JAVA library which allows you to consume the Twitter API.

[![Premium](https://img.shields.io/static/v1?label=Twitter%20API&message=Premium&color=794BC4&style=flat&logo=Twitter)](https://developer.twitter.com/en/docs/tweets/search/api-reference/premium-search)


## /!\ Development in progress... Any feedback is welcome :) /!\

### Configuration
Expand All @@ -15,8 +14,8 @@ In your pom.xml, add the following dependency :
```
<dependency>
<groupId>com.github.redouane59.twitter</groupId>
<artifactId>twitter-client</artifactId>
<version>1.5</version>
<artifactId>twittered</artifactId>
<version>1.6</version>
</dependency>
```
In order to use your own developer credentials, you have several options :
Expand Down Expand Up @@ -63,16 +62,21 @@ page.

### Available methods
See :
- [ITwitterClient.java](https://github.com/redouane59/twitter-client/blob/master/src/main/java/com/github/redouane59/twitter/ITwitterClient.java)
- [ITweet.java](https://github.com/redouane59/twitter-client/blob/master/src/main/java/com/github/redouane59/twitter/dto/tweet/ITweet.java)
- [IUser.java](https://github.com/redouane59/twitter-client/blob/master/src/main/java/com/github/redouane59/twitter/dto/user/IUser.java)
- [ITwitterClientV2.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/ITwitterClientV2.java)
- [ITwitterClientV1.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/ITwitterClientV1.java)
- [Tweet.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/dto/tweet/Tweet.java)
- [User.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/dto/user/User.java)

### Code samples
See :
- [ITwitterClientTest.java](https://github.com/redouane59/twittered/blob/master/src/test/java/com/github/redouane59/twitter/nrt/TwitterClientTest.java)

### Contribution
If you want to contribute to the project, don't hesitate to submit pull requests.
To add a new feature :
- Create the interface method in the related interface (i.e [ITwitterClient.java](https://github.com/redouane59/twitter-client/blob/master/src/main/java/com/github/redouane59/twitter/ITwitterClient.java))
- If needed, add the endpoint URL in [URLHelper.java](https://github.com/redouane59/twitter-client/blob/master/src/main/java/com/github/redouane59/twitter/helpers/URLHelper.java)
- Implement your method in the child class (i.e [TwitterClient.java](https://github.com/redouane59/twitter-client/blob/master/src/main/java/com/github/redouane59/twitter/TwitterClient.java))
- Create the interface method in the related interface (e.g [ITwitterClientV2.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/ITwitterClientV2.java))
- If needed, add the endpoint URL in [URLHelper.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/helpers/URLHelper.java)
- Implement your method in the child class (e.g [TwitterClient.java](https://github.com/redouane59/twittered/blob/master/src/main/java/com/github/redouane59/twitter/TwitterClient.java))
- Don't forget to add your unit tests in `src/test/java/com/github/redouane59/twitter/unit`

/!\ [JDK 12](https://jdk.java.net/12/) is needed to run the project /!\
Expand All @@ -85,4 +89,5 @@ To add a new feature :
[@mmornati](https://github.com/mmornati)
[@andypiper](https://github.com/andypiper)
[@igorbrigadir](https://github.com/igorbrigadir)
[@sparack](https://github.com/sparack)

16 changes: 8 additions & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
<modelVersion>4.0.0</modelVersion>

<groupId>com.github.redouane59.twitter</groupId>
<artifactId>twitter-client</artifactId>
<version>1.5</version>
<artifactId>twittered</artifactId>
<version>1.6</version>

<name>twitter-client</name>
<name>twittered</name>
<description>java client for twitter API</description>
<url>http://github.com/Redouane59/twitter-client</url>
<url>http://github.com/Redouane59/twittered</url>

<licenses>
<license>
Expand All @@ -29,10 +29,10 @@
</developers>

<scm>
<connection>scm:git:git://github.com/Redouane59/twitter-client.git</connection>
<developerConnection>scm:git:ssh://github.com:Redouane59/twitter-client.git
<connection>scm:git:git://github.com/Redouane59/twittered.git</connection>
<developerConnection>scm:git:ssh://github.com:Redouane59/twittered.git
</developerConnection>
<url>http://github.com/Redouane59/twitter-client</url>
<url>http://github.com/Redouane59/twittered</url>
</scm>

<distributionManagement>
Expand All @@ -49,7 +49,7 @@
<appengine.app.version>1</appengine.app.version>
<appengine.target.version>1.9.71</appengine.target.version>
<appengine-maven-plugin-version>1.3.2</appengine-maven-plugin-version>
<sonar.projectKey>redouane59_twitter-client</sonar.projectKey>
<sonar.projectKey>redouane59_twittered</sonar.projectKey>
<sonar.organization>redouane59</sonar.organization>
<sonar.host.url>https://sonarcloud.io</sonar.host.url>
<sonar.login>4a9a081c5fcd7861bf9fc84032a4bc9de08ae733</sonar.login>
Expand Down
300 changes: 0 additions & 300 deletions src/main/java/com/github/redouane59/twitter/ITwitterClient.java

This file was deleted.

Loading

0 comments on commit 3fcd43b

Please sign in to comment.