Skip to content

Commit e2b0eca

Browse files
author
Damian Staszewski
authored
Merge pull request #22 from stachu540/dev
2.0.1 Patch
2 parents a0c203c + 0061dc9 commit e2b0eca

File tree

22 files changed

+427
-282
lines changed

22 files changed

+427
-282
lines changed

‎.codacy.yml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
engines:
2+
checkstyle:
3+
enabled: true
4+
5+
exclude_paths:
6+
- src/test/**

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ script:
1313
- mvn test -DskipTest=false -Dmaven.javadoc.skip=true -P !build-extras -B
1414
- mvn cobertura:cobertura -Dmaven.javadoc.skip=true -P !build-extras -B
1515
after_success:
16-
- bash <(curl -s https://codecov.io/bash)
16+
- mvn codacy:coverage -Dmaven.javadoc.skip=true -P !build-extras -B

‎README.md‎

Lines changed: 9 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
[![Build Status](https://travis-ci.org/stachu540/HiRezAPI.svg)](https://travis-ci.org/stachu540/HiRezAPI)
2-
[![codecov](https://codecov.io/gh/stachu540/HiRezAPI/branch/master/graph/badge.svg)](https://codecov.io/gh/stachu540/HiRezAPI)
2+
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ee16a92996a3425d87403780aa18f316)](https://www.codacy.com/app/stachu540/HiRezAPI?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=stachu540/HiRezAPI&amp;utm_campaign=Badge_Grade)
3+
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/ee16a92996a3425d87403780aa18f316)](https://www.codacy.com/app/stachu540/HiRezAPI?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=stachu540/HiRezAPI&amp;utm_campaign=Badge_Coverage)
34
[![Javadocs](https://img.shields.io/badge/Javadoc-v2.0-brightgreen.svg)](https://jitpack.io/com/github/stachu540/HiRezAPI/v2.0/javadoc/)
45
[![Release](https://jitpack.io/v/stachu540/HiRezAPI.svg)](https://jitpack.io/#stachu540/HiRezAPI)
56

@@ -11,17 +12,15 @@ Java-Based API Wrapper for Hi-Rez Studios games. Currently supports:
1112

1213
## Features
1314

14-
All features will be on [Projects](https://github.com/stachu540/HiRezAPI/projects) tab:
15-
* [Core of Script](https://github.com/stachu540/HiRezAPI/projects/3)
16-
* [Smite API](https://github.com/stachu540/HiRezAPI/projects/1)
17-
* [Paladins API](https://github.com/stachu540/HiRezAPI/projects/2)
15+
All features will be on [Project](https://github.com/stachu540/HiRezAPI/projects/4) tab
1816

19-
## Usage
17+
## Getting Started
2018

21-
1. To access the APIs you'll need your own set of credentials which consist of a Developer ID (**devId**) and an Authentication Key (**authKey**). To getting those credentials, you need filling form on this link:
22-
https://fs12.formsite.com/HiRez/form48/secure_index.html
19+
### Request API access
20+
To access the APIs you'll need your own set of credentials which consist of a Developer ID (devId) and an Authentication Key (authKey). To getting those credentials, you need filling form on this link: https://fs12.formsite.com/HiRez/form48/secure_index.html
21+
22+
### Sample supported builds
2323

24-
2. Choose your Build
2524
#### Maven
2625
Add to `pom.xml` build.
2726
```xml
@@ -61,49 +60,7 @@ dependencies {
6160
...
6261
```
6362

64-
4. To starting using script try to using example below:
65-
66-
For examples I will use example credentials
67-
**DevId**: 1004
68-
**AuthKey**: 23DF3C7E9BD14D84BF892AD206B6755C
69-
70-
a. For Smite **PC** i want getting player info for "HiRezTina"
71-
```java
72-
package example;
73-
74-
import com.github.stachu540.hirezapi.HiRezAPI; // Main class
75-
import com.github.stachu540.hirezapi.api.Smite; // for importing enum platforms
76-
77-
class SmitePlayer {
78-
public static void main(String[] args) {
79-
HiRezAPI api = new HiRezAPI("1004", "23DF3C7E9BD14D84BF892AD206B6755C");
80-
Smite smite = api.getFor(com.github.stachu540.hirezapi.enums.url.Smite.PC);
81-
// cause data returning as JSONArray i will use toJsonArray() method
82-
System.out.println(smite.getPlayer("HiRezTina"));
83-
}
84-
}
85-
```
86-
87-
b. For Paladins **XBOX** i want know about server status.
88-
89-
90-
```java
91-
package example;
92-
93-
import com.github.stachu540.hirezapi.HiRezAPI; // Main class
94-
import com.github.stachu540.hirezapi.api.Paladins; // for importing enum platforms
95-
96-
class PaladinsStatusServer {
97-
public static void main(String[] args) {
98-
HiRezAPI api = new HiRezAPI("1004", "23DF3C7E9BD14D84BF892AD206B6755C");
99-
Paladins paladins = api.getFor(com.github.stachu540.hirezapi.enums.url.Paladins.XBOX);
100-
// cause data returning as JSONArray i will use toJsonArray() method
101-
System.out.println(mydata.getServerStatus());
102-
}
103-
}
104-
```
105-
106-
For some more detail's, check out [source documentation](https://stachu540.github.io/HiRezAPI/).
63+
For starting using script check [Wiki page](https://github.com/stachu540/HiRezAPI/wiki/Example-Usage).
10764

10865
## Question and suggestions
10966
Any more questions or some suggestions changes are welcome. Don't be shy, just open your [Issues](https://github.com/stachu540/HiRezAPI/issues) if you have some problem. [Pull Request's](https://github.com/stachu540/HiRezAPI/pulls) and any other contribution are welcome.

‎checkstyle.xml‎

Lines changed: 237 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,237 @@
1+
<?xml version="1.0"?>
2+
<!DOCTYPE module PUBLIC
3+
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4+
"http://checkstyle.sourceforge.net/dtds/configuration_1_3.dtd">
5+
6+
<!--
7+
Checkstyle configuration that checks the Google coding conventions from Google Java Style
8+
that can be found at https://google.github.io/styleguide/javaguide.html.
9+
10+
Checkstyle is very configurable. Be sure to read the documentation at
11+
http://checkstyle.sf.net (or in your downloaded distribution).
12+
13+
To completely disable a check, just comment it out or delete it from the file.
14+
15+
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
16+
-->
17+
18+
<module name = "Checker">
19+
<property name="charset" value="UTF-8"/>
20+
21+
<property name="severity" value="warning"/>
22+
23+
<property name="fileExtensions" value="java, properties, xml"/>
24+
<!-- Checks for whitespace -->
25+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
26+
<module name="FileTabCharacter">
27+
<property name="eachLine" value="true"/>
28+
</module>
29+
30+
<module name="TreeWalker">
31+
<module name="OuterTypeFilename"/>
32+
<module name="IllegalTokenText">
33+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
34+
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
35+
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
36+
</module>
37+
<module name="AvoidEscapedUnicodeCharacters">
38+
<property name="allowEscapesForControlCharacters" value="true"/>
39+
<property name="allowByTailComment" value="true"/>
40+
<property name="allowNonPrintableEscapes" value="true"/>
41+
</module>
42+
<module name="LineLength">
43+
<property name="max" value="100"/>
44+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
45+
</module>
46+
<module name="AvoidStarImport"/>
47+
<module name="OneTopLevelClass"/>
48+
<module name="NoLineWrap"/>
49+
<module name="EmptyBlock">
50+
<property name="option" value="TEXT"/>
51+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
52+
</module>
53+
<module name="NeedBraces"/>
54+
<module name="LeftCurly"/>
55+
<module name="RightCurly">
56+
<property name="id" value="RightCurlySame"/>
57+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
58+
</module>
59+
<module name="RightCurly">
60+
<property name="id" value="RightCurlyAlone"/>
61+
<property name="option" value="alone"/>
62+
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
63+
</module>
64+
<module name="WhitespaceAround">
65+
<property name="allowEmptyConstructors" value="true"/>
66+
<property name="allowEmptyMethods" value="true"/>
67+
<property name="allowEmptyTypes" value="true"/>
68+
<property name="allowEmptyLoops" value="true"/>
69+
<message key="ws.notFollowed"
70+
value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
71+
<message key="ws.notPreceded"
72+
value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
73+
</module>
74+
<module name="OneStatementPerLine"/>
75+
<module name="MultipleVariableDeclarations"/>
76+
<module name="ArrayTypeStyle"/>
77+
<module name="MissingSwitchDefault"/>
78+
<module name="FallThrough"/>
79+
<module name="UpperEll"/>
80+
<module name="ModifierOrder"/>
81+
<module name="EmptyLineSeparator">
82+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
83+
</module>
84+
<module name="SeparatorWrap">
85+
<property name="id" value="SeparatorWrapDot"/>
86+
<property name="tokens" value="DOT"/>
87+
<property name="option" value="nl"/>
88+
</module>
89+
<module name="SeparatorWrap">
90+
<property name="id" value="SeparatorWrapComma"/>
91+
<property name="tokens" value="COMMA"/>
92+
<property name="option" value="EOL"/>
93+
</module>
94+
<module name="SeparatorWrap">
95+
<!-- ELLIPSIS is EOL until https://github.com/google/styleguide/issues/258 -->
96+
<property name="id" value="SeparatorWrapEllipsis"/>
97+
<property name="tokens" value="ELLIPSIS"/>
98+
<property name="option" value="EOL"/>
99+
</module>
100+
<module name="SeparatorWrap">
101+
<!-- ARRAY_DECLARATOR is EOL until https://github.com/google/styleguide/issues/259 -->
102+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
103+
<property name="tokens" value="ARRAY_DECLARATOR"/>
104+
<property name="option" value="EOL"/>
105+
</module>
106+
<module name="SeparatorWrap">
107+
<property name="id" value="SeparatorWrapMethodRef"/>
108+
<property name="tokens" value="METHOD_REF"/>
109+
<property name="option" value="nl"/>
110+
</module>
111+
<module name="PackageName">
112+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
113+
<message key="name.invalidPattern"
114+
value="Package name ''{0}'' must match pattern ''{1}''."/>
115+
</module>
116+
<module name="TypeName">
117+
<message key="name.invalidPattern"
118+
value="Type name ''{0}'' must match pattern ''{1}''."/>
119+
</module>
120+
<module name="MemberName">
121+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
122+
<message key="name.invalidPattern"
123+
value="Member name ''{0}'' must match pattern ''{1}''."/>
124+
</module>
125+
<module name="ParameterName">
126+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
127+
<message key="name.invalidPattern"
128+
value="Parameter name ''{0}'' must match pattern ''{1}''."/>
129+
</module>
130+
<module name="CatchParameterName">
131+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
132+
<message key="name.invalidPattern"
133+
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
134+
</module>
135+
<module name="LocalVariableName">
136+
<property name="tokens" value="VARIABLE_DEF"/>
137+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
138+
<message key="name.invalidPattern"
139+
value="Local variable name ''{0}'' must match pattern ''{1}''."/>
140+
</module>
141+
<module name="ClassTypeParameterName">
142+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
143+
<message key="name.invalidPattern"
144+
value="Class type name ''{0}'' must match pattern ''{1}''."/>
145+
</module>
146+
<module name="MethodTypeParameterName">
147+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
148+
<message key="name.invalidPattern"
149+
value="Method type name ''{0}'' must match pattern ''{1}''."/>
150+
</module>
151+
<module name="InterfaceTypeParameterName">
152+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
153+
<message key="name.invalidPattern"
154+
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
155+
</module>
156+
<module name="NoFinalizer"/>
157+
<module name="GenericWhitespace">
158+
<message key="ws.followed"
159+
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
160+
<message key="ws.preceded"
161+
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
162+
<message key="ws.illegalFollow"
163+
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
164+
<message key="ws.notPreceded"
165+
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
166+
</module>
167+
<module name="Indentation">
168+
<property name="basicOffset" value="2"/>
169+
<property name="braceAdjustment" value="0"/>
170+
<property name="caseIndent" value="2"/>
171+
<property name="throwsIndent" value="4"/>
172+
<property name="lineWrappingIndentation" value="4"/>
173+
<property name="arrayInitIndent" value="2"/>
174+
</module>
175+
<module name="AbbreviationAsWordInName">
176+
<property name="ignoreFinal" value="false"/>
177+
<property name="allowedAbbreviationLength" value="1"/>
178+
</module>
179+
<module name="OverloadMethodsDeclarationOrder"/>
180+
<module name="VariableDeclarationUsageDistance"/>
181+
<module name="CustomImportOrder">
182+
<property name="sortImportsInGroupAlphabetically" value="true"/>
183+
<property name="separateLineBetweenGroups" value="true"/>
184+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
185+
</module>
186+
<module name="MethodParamPad"/>
187+
<module name="NoWhitespaceBefore">
188+
<property name="tokens" value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
189+
<property name="allowLineBreaks" value="true"/>
190+
</module>
191+
<module name="ParenPad"/>
192+
<module name="OperatorWrap">
193+
<property name="option" value="NL"/>
194+
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
195+
</module>
196+
<module name="AnnotationLocation">
197+
<property name="id" value="AnnotationLocationMostCases"/>
198+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
199+
</module>
200+
<module name="AnnotationLocation">
201+
<property name="id" value="AnnotationLocationVariables"/>
202+
<property name="tokens" value="VARIABLE_DEF"/>
203+
<property name="allowSamelineMultipleAnnotations" value="true"/>
204+
</module>
205+
<module name="NonEmptyAtclauseDescription"/>
206+
<module name="JavadocTagContinuationIndentation"/>
207+
<module name="SummaryJavadoc">
208+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
209+
</module>
210+
<module name="JavadocParagraph"/>
211+
<module name="AtclauseOrder">
212+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
213+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
214+
</module>
215+
<module name="JavadocMethod">
216+
<property name="scope" value="public"/>
217+
<property name="allowMissingParamTags" value="true"/>
218+
<property name="allowMissingThrowsTags" value="true"/>
219+
<property name="allowMissingReturnTag" value="true"/>
220+
<property name="minLineCount" value="2"/>
221+
<property name="allowedAnnotations" value="Override, Test"/>
222+
<property name="allowThrowsTagsForSubclasses" value="true"/>
223+
</module>
224+
<module name="MethodName">
225+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
226+
<message key="name.invalidPattern"
227+
value="Method name ''{0}'' must match pattern ''{1}''."/>
228+
</module>
229+
<module name="SingleLineJavadoc">
230+
<property name="ignoreInlineTags" value="false"/>
231+
</module>
232+
<module name="EmptyCatchBlock">
233+
<property name="exceptionVariableName" value="expected"/>
234+
</module>
235+
<module name="CommentsIndentation"/>
236+
</module>
237+
</module>

‎codecov.yml‎

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)