All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • help.swgoh.api.SwgohAPIClient Maven / Gradle / Ivy

    Go to download

    A collection of Java helper classes that allow for easy and immediate access to the api.swgoh.help endpoints.

    There is a newer version: 4.3.0
    Show newest version
    package help.swgoh.api;

import com.google.gson.Gson;
import help.swgoh.api.exception.SwgohAPIDuplicateRequestException;
import help.swgoh.api.exception.SwgohAPIException;
import help.swgoh.api.exception.SwgohAPINotFoundException;
import help.swgoh.api.exception.SwgohAPIRateLimitException;
import help.swgoh.api.exception.SwgohAPITimeoutException;
import help.swgoh.api.image.ImageRequest;
import help.swgoh.api.image.ShipImageRequest;
import help.swgoh.api.image.ToonImageRequest;
import help.swgoh.api.response.RegistrationResponse;
import org.apache.commons.io.IOUtils;

import javax.imageio.ImageIO;
import java.awt.image.BufferedImage;
import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;

public class SwgohAPIClient implements SwgohAPI
{
    private final String username;
    private final String password;
    private final String defaultLanguage;
    private final Boolean defaultEnums;

    SwgohAPIClient( SwgohAPISettings settings )
    {
        username = settings.getUsername();
        password = settings.getPassword();
        defaultLanguage = settings.getDefaultLanguage() == null ? null : settings.getDefaultLanguage().getSwgohCode();
        defaultEnums = settings.getDefaultEnums();
    }

    public enum API
    {
        signin( "/auth/signin" ),
        player( "/swgoh/player" ),
        guild( "/swgoh/guild" ),
        units( "/swgoh/units" ),
        roster( "/swgoh/roster" ),
        data( "/swgoh/data" ),
        zetas( "/swgoh/zetas" ),
        squads( "/swgoh/squads" ),
        events( "/swgoh/events" ),
        battles( "/swgoh/battles" ),
        registration( "/registration" ),
        ;

        private static final String URL_BASE = "https://api.swgoh.help";
        private static final Gson GSON = new Gson();
        private static final SwgohAPIToken TOKEN = new SwgohAPIToken();

        private final String path;

        API( String path )
        {
            this.path = path;
        }

        public CompletableFuture call( String username, String password, Map payload )
        {
            return CompletableFuture.supplyAsync( () -> getJson( username, password, payload ) );
        }

        public  CompletableFuture call( String username, String password, Map payload, Class resultType )
        {
            return CompletableFuture.supplyAsync( () -> GSON.fromJson( getJson( username, password, payload ), resultType ) );
        }

        private String getJson( String username, String password, Map payload )
        {
            try
            {
                try ( BufferedReader br = new BufferedReader( new InputStreamReader( getAuthorizedConnection( username, password, payload ).getInputStream() ) ) )
                {
                    StringBuilder sb = new StringBuilder();
                    String line;
                    while ( ( line = br.readLine() ) != null )
                    {
                        sb.append( line ).append( "\n" );
                    }
                    return sb.toString();
                }
            }
            catch ( FileNotFoundException exception )
            {
                throw new SwgohAPINotFoundException( exception );
            }
            catch ( IOException ioException )
            {
                if ( ioException.getMessage() != null )
                {
                    if ( ioException.getMessage().contains( "429" ) || ioException.getMessage().contains( "502" ) )
                    {
                        throw new SwgohAPIRateLimitException( ioException );
                    }
                    else if ( ioException.getMessage().contains( "409" ) )
                    {
                        throw new SwgohAPIDuplicateRequestException( ioException );
                    }
                    else if ( ioException.getMessage().contains( "504" ) )
                    {
                        throw new SwgohAPITimeoutException( ioException );
                    }
                }

                throw new SwgohAPIException( "Unable to complete request.", ioException );
            }
        }

        private HttpURLConnection getAuthorizedConnection( String username, String password, Map payload ) throws IOException
        {
            if ( TOKEN.access_token == null )
            {
                synchronized ( TOKEN )
                {
                    if ( TOKEN.access_token == null )
                    {
                        login( username, password );
                    }
                }
            }

            byte[] postData = GSON.toJson( payload ).getBytes( StandardCharsets.UTF_8 );
            HttpURLConnection connection = createConnection( this, postData );
            connection.setRequestProperty( "Authorization", "Bearer " + TOKEN.access_token );
            connection.setRequestProperty( "Content-Type", "application/json" );

            try( DataOutputStream outputStream = new DataOutputStream( connection.getOutputStream() ) )
            {
                outputStream.write( postData );
            }

            return connection;
        }

        private static HttpURLConnection createConnection( API api, byte[] postData ) throws IOException
        {
            HttpURLConnection connection = (HttpURLConnection) api.getUrl().openConnection();
            connection.setRequestMethod( "POST" );

            connection.setDoOutput( true );
            connection.setInstanceFollowRedirects( false );
            connection.setUseCaches( false );
            connection.setRequestProperty( "Content-Type", "application/x-www-form-urlencoded" );
            connection.setRequestProperty( "charset", "utf-8" );
            connection.setRequestProperty( "Content-Length", postData.length+"" );

            return connection;
        }

        public static void login( String username, String password )
        {
            try
            {
                SwgohAPIToken token = fetchToken( username, password );

                CompletableFuture.runAsync( () -> {
                    try { Thread.sleep( (token.expires_in - 5) * 1000 ); } catch ( Exception exception ) {}
                } ).thenRun( () -> TOKEN.access_token = null );

                TOKEN.access_token = token.access_token;
            }
            catch ( Throwable exception )
            {
                throw new SwgohAPIException( "Unable to authorize with API.", exception );
            }
        }

        private static SwgohAPIToken fetchToken( String username, String password ) throws IOException
        {
            String loginCredentials = "username=" + username +
                                      "&password=" + password +
                                      "&grant_type=password" +
                                      "&client_id=abc" +
                                      "&client_secret=123";

            byte[] postData = loginCredentials.getBytes( StandardCharsets.UTF_8 );
            HttpURLConnection connection = createConnection( API.signin, postData );

            try( DataOutputStream outputStream = new DataOutputStream( connection.getOutputStream() ) )
            {
                outputStream.write( postData );
            }

            return GSON.fromJson( new InputStreamReader( connection.getInputStream() ), SwgohAPIToken.class );
        }

        private URL getUrl() throws MalformedURLException
        {
            return new URL( URL_BASE + path );
        }
    }

    @Override
    public CompletableFuture getPlayers( List allyCodes, Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "allycodes", allyCodes );
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, filter );

        return API.player.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getPlayers( List allyCodes, Boolean enums, Language language, PlayerField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "allycodes", allyCodes );
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.player.call( username, password, payload );
    }

    @Override
    public CompletableFuture getGuild( int allyCode, Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCode );
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, filter );

        return API.guild.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getGuild( int allyCode, Boolean enums, Language language, GuildField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCode );
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.guild.call( username, password, payload );
    }

    @Override
    public CompletableFuture getLargeGuild( int allyCode, Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCode );
        payload.put( "roster", true );
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, filter );

        return API.guild.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getLargeGuild( int allyCode, Boolean enums, Language language, GuildField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCode );
        payload.put( "roster", true );
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.guild.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getGuildUnits( int allyCode, boolean includeMods, Boolean enums, Language language, GuildField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCode );
        payload.put( "units", true );
        payload.put( "mods", includeMods );
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.guild.call( username, password, payload );
    }

    @Override
    public CompletableFuture getRosters( List allyCodes, Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCodes );
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, filter );

        return API.roster.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getUnits( List allyCodes, boolean includeMods, Boolean enums, Language language, UnitsField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "allycode", allyCodes );
        payload.put( "mods", includeMods );
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.units.call( username, password, payload );
    }

    @Override
    public CompletableFuture getZetaRecommendations( SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();

        createProjection( payload, filter );

        return API.zetas.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getZetaRecommendations( ZetaRecommendationField... fields )
    {
        Map payload = new HashMap<>();

        createProjection( payload, fields );

        return API.zetas.call( username, password, payload );
    }

    @Override
    public CompletableFuture getSquadRecommendations( SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();

        createProjection( payload, filter );

        return API.squads.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getSquadRecommendations( SquadRecommendationField... fields )
    {
        Map payload = new HashMap<>();

        createProjection( payload, fields );

        return API.squads.call( username, password, payload );
    }

    @Override
    public CompletableFuture getEvents( Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, filter );

        return API.events.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getEvents( Boolean enums, Language language, EventField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.events.call( username, password, payload );
    }

    @Override
    public CompletableFuture getBattles( Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, filter );

        return API.battles.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getBattles( Boolean enums, Language language, BattleField... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        createProjection( payload, fields );

        return API.battles.call( username, password, payload );
    }

    @Override
    public CompletableFuture getSupportData( Collection collection, Map matchCriteria, Language language, SwgohAPIFilter filter )
    {
        Map payload = new HashMap<>();
        payload.put( "collection", collection.name() );
        payload.put( "enums", defaultEnums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        if ( matchCriteria != null )
        {
            payload.put( "match", matchCriteria );
        }

        createProjection( payload, filter );

        return API.data.call( username, password, payload );
    }

    @Deprecated
    @Override
    public CompletableFuture getSupportData( Collection collection, Map matchCriteria, Boolean enums, Language language, String... fields )
    {
        Map payload = new HashMap<>();
        payload.put( "collection", collection.name() );
        payload.put( "enums", enums == null ? defaultEnums : enums );
        payload.put( "language", language == null ? defaultLanguage : language.getSwgohCode() );

        if ( matchCriteria != null )
        {
            payload.put( "match", matchCriteria );
        }

        createProjection( payload, fields );

        return API.data.call( username, password, payload );
    }

    @Override
    public CompletableFuture register( Map allyCodeDiscordIdMappings )
    {
        Map payload = new HashMap<>();

        List> mappings = new ArrayList<>();
        for ( Integer allyCode : allyCodeDiscordIdMappings.keySet() )
        {
            List mapping = new ArrayList<>();
            mapping.add( allyCode );
            mapping.add( allyCodeDiscordIdMappings.get( allyCode ) );
            mappings.add( mapping );
        }

        payload.put( "put", mappings );

        return API.registration.call( username, password, payload, RegistrationResponse.class );
    }

    @Override
    public CompletableFuture unregister( List allyCodes, List discordIds )
    {
        Map payload = new HashMap<>();

        List allyCodesOrDiscordIds = new ArrayList<>();
        if ( allyCodes != null )
        {
            allyCodesOrDiscordIds.addAll( allyCodes );
        }

        if ( discordIds != null )
        {
            allyCodesOrDiscordIds.addAll( discordIds );
        }

        payload.put( "del", allyCodesOrDiscordIds );

        return API.registration.call( username, password, payload, RegistrationResponse.class );
    }

    @Override
    public CompletableFuture getRegistrationByAllyCodes( List allyCodes )
    {
        Map payload = new HashMap<>();
        payload.put( "get", allyCodes );

        return API.registration.call( username, password, payload, RegistrationResponse.class );
    }

    @Override
    public CompletableFuture getRegistrationByDiscordIds( List discordIds )
    {
        Map payload = new HashMap<>();
        payload.put( "get", discordIds );

        return API.registration.call( username, password, payload, RegistrationResponse.class );
    }

    @Override
    public CompletableFuture getImage( ImageRequest imageRequest )
    {
        return CompletableFuture.supplyAsync( () -> {
            try
            {
                if ( imageRequest instanceof ToonImageRequest )
                {
                    ToonImageRequest request = (ToonImageRequest) imageRequest;
                    return getImage( getToonImageUrl( request.getBaseId(), getToonImageParameters( request ) ) );
                }
                else if ( imageRequest instanceof ShipImageRequest )
                {
                    ShipImageRequest request = (ShipImageRequest) imageRequest;
                    return getImage( getShipImageUrl( request.getBaseId(), getShipImageParamters( request ) ) );
                }

                throw new IllegalArgumentException( "Invalid imageRequest" );
            }
            catch ( Exception exception )
            {
                throw new SwgohAPIException( "Unable to complete request.", exception );
            }
        } );
    }

    @Override
    public CompletableFuture getBufferedImage( ImageRequest imageRequest )
    {
        return CompletableFuture.supplyAsync( () -> {
            try
            {
                if ( imageRequest instanceof ToonImageRequest )
                {
                    ToonImageRequest request = (ToonImageRequest) imageRequest;
                    return getBufferedImage( getToonImageUrl( request.getBaseId(), getToonImageParameters( request ) ) );
                }
                else if ( imageRequest instanceof ShipImageRequest )
                {
                    ShipImageRequest request = (ShipImageRequest) imageRequest;
                    return getBufferedImage( getShipImageUrl( request.getBaseId(), getShipImageParamters( request ) ) );
                }

                throw new IllegalArgumentException( "Invalid imageRequest" );
            }
            catch ( Exception exception )
            {
                throw new SwgohAPIException( "Unable to complete request.", exception );
            }
        } );
    }

    private Map getToonImageParameters( ToonImageRequest toonImageRequest )
    {
        Map parameters = new HashMap<>();
        if ( toonImageRequest.getGear() != null )
        {
            parameters.put( "gear", toonImageRequest.getGear().ordinal() + 1 );
            if ( toonImageRequest.isDisplayRomanNumeral() )
            {
                parameters.put( "roman", toonImageRequest.getGear() );
            }
        }
        if ( toonImageRequest.getLevel() != null )
        {
            parameters.put( "level", toonImageRequest.getLevel() );
        }
        if ( toonImageRequest.getRarity() != null )
        {
            parameters.put( "rarity", toonImageRequest.getRarity() );
        }
        if ( toonImageRequest.getZetas() != null )
        {
            parameters.put( "zetas", toonImageRequest.getZetas() );
        }
        if ( toonImageRequest.getBackgroundColor() != null )
        {
            String hex = Integer.toHexString( toonImageRequest.getBackgroundColor().getRGB() ).substring( 2 ).toUpperCase();
            parameters.put( "bg", hex );
        }

        return parameters;
    }

    private Map getShipImageParamters( ShipImageRequest shipImageRequest )
    {
        Map parameters = new HashMap<>();
        if ( shipImageRequest.getLevel() != null )
        {
            parameters.put( "level", shipImageRequest.getLevel() );
        }
        if ( shipImageRequest.getRarity() != null )
        {
            parameters.put( "rarity", shipImageRequest.getRarity() );
        }
        if ( shipImageRequest.getBackgroundColor() != null )
        {
            String hex = Integer.toHexString( shipImageRequest.getBackgroundColor().getRGB() ).substring( 2 ).toUpperCase();
            parameters.put( "bg", hex );
        }

        StringBuilder pilots = new StringBuilder();
        String prefix = "";
        String delimiter = "-";
        for ( ShipImageRequest.Pilot pilot : shipImageRequest.getPilots() )
        {
            pilots.append( prefix ).append( pilot.baseId ).append( delimiter ).append( pilot.rarity ).append( delimiter ).append( pilot.level ).append( delimiter ).append( pilot.gear ).append( delimiter ).append( pilot.zetas );
            prefix = "%7C";
        }

        if ( pilots.length() > 0 )
        {
            parameters.put( "pilots", pilots.toString() );
        }

        return parameters;
    }

    private byte[] getImage( URL imageUrl ) throws IOException
    {
        try ( InputStream is = imageUrl.openStream() )
        {
            return IOUtils.toByteArray( is );
        }
    }

    private BufferedImage getBufferedImage( URL imageUrl ) throws IOException
    {
        try ( InputStream is = imageUrl.openStream() )
        {
            return ImageIO.read( is );
        }
    }

    private URL getToonImageUrl( String baseId, Map parameters ) throws MalformedURLException
    {
        return getImageUrl( baseId, false, parameters );
    }

    private URL getShipImageUrl( String baseId, Map parameters ) throws MalformedURLException
    {
        return getImageUrl( baseId, true, parameters );
    }

    private URL getImageUrl( String baseId, boolean isShip, Map parameters ) throws MalformedURLException
    {
        StringBuilder parameterString = new StringBuilder();
        String prefix = "?";
        for ( String key : parameters.keySet() )
        {
            parameterString.append( prefix ).append( key ).append( "=" ).append( parameters.get( key ) );
            prefix = "&";
        }

        return new URL( API.URL_BASE + "/image/" + (isShip ? "ship" : "char") + "/" + baseId + parameterString );
    }

    private void createProjection( Map payload, Enum... fields )
    {
        if ( fields != null && fields.length > 0 )
        {
            List stringFields = new ArrayList<>();
            for ( Enum field : fields )
            {
                stringFields.add( field.name() );
            }

            createProjection( payload, stringFields.toArray( new String[]{} ) );
        }
    }

    private void createProjection( Map payload, SwgohAPIFilter filter )
    {
        if ( filter != null && filter.getFilters().size() > 0 )
        {
            payload.put( "project", convertInnerFilters( filter ) );
        }
    }

    private Map convertInnerFilters( SwgohAPIFilter filter )
    {
        Map fieldsMap = new HashMap<>();
        for ( Object element : filter.getFilters() )
        {
            if ( element instanceof SwgohAPIFilter.InnerFilter )
            {
                fieldsMap.put( ((SwgohAPIFilter.InnerFilter) element).element, convertInnerFilters( ((SwgohAPIFilter.InnerFilter) element).filter ) );
            }
            else
            {
                fieldsMap.put( (String)element, 1 );
            }
        }

        return fieldsMap;
    }

    private void createProjection( Map payload, String... fields )
    {
        if ( fields != null && fields.length > 0 )
        {
            Map fieldsMap = new HashMap<>();
            for ( String field : fields )
            {
                fieldsMap.put( field, 1 );
            }
            payload.put( "project", fieldsMap );
        }
    }
}
    
    
    
    

    




    
    
    © 2015 - 2025 Weber Informatics LLC | Privacy Policy