Merge pull request #36 from ipinfo/umar/flag-currency-continent

added flag currency and continent

Author: UmanShahzad

README.md

@@ -207,7 +207,59 @@ public class Main {
 }
 ```
 
-This file must follow the same layout as seen [here](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/eu.json)
+#### Internationalization
+
+This library provides a system to lookup if a country is a member of the European Union (EU), emoji and unicode of country's flag, code and symbol of country's currency and continent code and name through ISO2 country codes.
+
+Following are the file that are loaded by default:
+- [eu.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/eu.json) 
+- [flags.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/flags.json) 
+- [currency.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/currency.json) 
+- [continent.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/continent.json) 
+
+If you wish to provide a different file, just use the following system in the builder:
+
+```java
+import io.ipinfo.api.IPinfo;
+import io.ipinfo.api.errors.RateLimitedException;
+import io.ipinfo.api.model.IPResponse;
+
+public class Main {
+    public static void main(String... args) {
+        IPinfo ipInfo = new IPinfo.Builder()
+                .setToken("YOUR TOKEN")
+                .setEUCountryFile(new File("path/to/file.json"))
+                .setCountryFlagFile(new File("path/to/file.json"))
+                .setCountryCurrencyFile(new File("path/to/file.json"))
+                .setContinentFile(new File("path/to/file.json"))
+                .build();
+
+        try {
+            IPResponse response = ipInfo.lookupIP("8.8.8.8");
+
+            // Print out whether the country is a member of the EU
+            System.out.println(response.isEU());
+
+            // CountryFlag{emoji='🇺🇸',unicode='U+1F1FA U+1F1F8'}
+            System.out.println(response.getCountryFlag());
+
+            // CountryCurrency{code='USD',symbol='$'}
+            System.out.println(response.getCountryCurrency());
+
+            // Continent{code='NA',name='North America'}
+            System.out.println(response.getContinent());
+        } catch (RateLimitedException ex) {
+            // Handle rate limits here.
+        }
+    }
+}
+```
+
+The files must follow the same layout as seen 
+- [eu.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/eu.json) 
+- [flags.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/flags.json) 
+- [currency.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/currency.json) 
+- [continent.json](https://github.com/ipinfo/java-ipinfo/blob/master/src/main/resources/continent.json) 
 
 #### Location Information
 

src/main/java/io/ipinfo/api/IPinfo.java

@@ -8,6 +8,9 @@
 import io.ipinfo.api.context.Context;
 import io.ipinfo.api.errors.RateLimitedException;
 import io.ipinfo.api.model.ASNResponse;
+import io.ipinfo.api.model.Continent;
+import io.ipinfo.api.model.CountryCurrency;
+import io.ipinfo.api.model.CountryFlag;
 import io.ipinfo.api.model.IPResponse;
 import io.ipinfo.api.model.MapResponse;
 import io.ipinfo.api.request.ASNRequest;
@@ -362,6 +365,12 @@ public static class Builder {
                 new File(this.getClass().getClassLoader().getResource("en_US.json").getFile());
         private File euCountryFile =
                 new File(this.getClass().getClassLoader().getResource("eu.json").getFile());
+        private File countryFlagFile =
+                new File(this.getClass().getClassLoader().getResource("flags.json").getFile());
+        private File countryCurrencyFile =
+                new File(this.getClass().getClassLoader().getResource("currency.json").getFile());
+        private File continentFile =
+                new File(this.getClass().getClassLoader().getResource("continent.json").getFile());
         private OkHttpClient client = new OkHttpClient.Builder().build();
         private String token = "";
         private Cache cache = new SimpleCache(Duration.ofDays(1));
@@ -386,6 +395,21 @@ public Builder setEUCountryFile(File file) {
             return this;
         }
 
+        public Builder setCountryFlagFile(File file) {
+            this.countryFlagFile = file;
+            return this;
+        }
+
+        public Builder setCountryCurrencyFile(File file) {
+            this.countryCurrencyFile = file;
+            return this;
+        }
+
+        public Builder setContinentFile(File file) {
+            this.continentFile = file;
+            return this;
+        }
+
         public Builder setCache(Cache cache) {
             this.cache = cache;
             return this;
@@ -394,19 +418,31 @@ public Builder setCache(Cache cache) {
         public IPinfo build() {
             Type type = new TypeToken<Map<String, String>>(){}.getType();
             Type euCountriesType = new TypeToken<List<String>>(){}.getType();
+            Type countriesFlagsType = new TypeToken<Map<String, CountryFlag>>(){}.getType();
+            Type countriesCurrencyType = new TypeToken<Map<String, CountryCurrency>>(){}.getType();
+            Type continentType = new TypeToken<Map<String, Continent>>(){}.getType();
             Gson gson = new Gson();
             Map<String, String> map;
+            Map<String, CountryFlag> countriesFlags;
+            Map<String, CountryCurrency> countriesCurrencies;
+            Map<String, Continent> continents;
             List<String> euList;
 
             try {
                 map = Collections.unmodifiableMap(gson.fromJson(new FileReader(countryFile), type));
+                countriesFlags = Collections.unmodifiableMap(gson.fromJson(new FileReader(countryFlagFile), countriesFlagsType));
+                countriesCurrencies = Collections.unmodifiableMap(gson.fromJson(new FileReader(countryCurrencyFile), countriesCurrencyType));
+                continents = Collections.unmodifiableMap(gson.fromJson(new FileReader(continentFile), continentType));
                 euList = Collections.unmodifiableList(gson.fromJson(new FileReader(euCountryFile), euCountriesType));
             } catch (Exception e) {
                 map = Collections.unmodifiableMap(new HashMap<>());
+                countriesFlags = Collections.unmodifiableMap(new HashMap<>());
+                countriesCurrencies = Collections.unmodifiableMap(new HashMap<>());
+                continents = Collections.unmodifiableMap(new HashMap<>());
                 euList = Collections.unmodifiableList(new ArrayList<>());
             }
 
-            return new IPinfo(client, new Context(map, euList), token, cache);
+            return new IPinfo(client, new Context(map, euList, countriesFlags, countriesCurrencies, continents), token, cache);
         }
     }
 

src/main/java/io/ipinfo/api/context/Context.java

@@ -3,19 +3,47 @@
 import java.util.List;
 import java.util.Map;
 
+import io.ipinfo.api.model.Continent;
+import io.ipinfo.api.model.CountryCurrency;
+import io.ipinfo.api.model.CountryFlag;
+
 public class Context {
     private final Map<String, String> countryMap;
+    private final Map<String, CountryFlag> countriesFlags;
+    private final Map<String, CountryCurrency> countriesCurrencies;
+    private final Map<String, Continent> continents;
     private final List<String> euCountries;
 
-    public Context(Map<String, String> countryMap, List<String> euCountries) {
-        this.countryMap = countryMap;
-        this.euCountries = euCountries;
-    }
+    public Context(
+        Map<String, String> countryMap, 
+        List<String> euCountries, 
+        Map<String, CountryFlag> countriesFlags, 
+        Map<String, CountryCurrency> countriesCurrencies,
+        Map<String, Continent> continents) 
+        {
+            this.countryMap = countryMap;
+            this.euCountries = euCountries;
+            this.countriesFlags = countriesFlags;
+            this.countriesCurrencies = countriesCurrencies;
+            this.continents = continents;
+        }
 
     public String getCountryName(String countryCode) {
         return countryMap.get(countryCode);
     }
 
+    public CountryFlag getCountryFlag(String countryCode) {
+        return countriesFlags.get(countryCode);
+    }
+
+    public CountryCurrency getCountryCurrency(String countryCode) {
+        return countriesCurrencies.get(countryCode);
+    }
+
+    public Continent getContinent(String countryCode) {
+        return continents.get(countryCode);
+    }
+
     public boolean isEU(String countryCode) {
         return euCountries.contains(countryCode);
     }

src/main/java/io/ipinfo/api/model/Continent.java

@@ -0,0 +1,30 @@
+package io.ipinfo.api.model;
+
+public class Continent {
+    private final String code;
+    private final String name;
+
+    public Continent(
+            String code,
+            String name
+    ) {
+        this.code = code;
+        this.name = name;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public String toString() {
+        return "Continent{" +
+                "code='" + code + '\'' +
+                ",name='" + name + '\'' +
+                '}';
+    }
+}

src/main/java/io/ipinfo/api/model/CountryCurrency.java

@@ -0,0 +1,30 @@
+package io.ipinfo.api.model;
+
+public class CountryCurrency {
+    private final String code;
+    private final String symbol;
+
+    public CountryCurrency(
+            String code,
+            String symbol
+    ) {
+        this.code = code;
+        this.symbol = symbol;
+    }
+
+    public String getCode() {
+        return code;
+    }
+
+    public String getSymbol() {
+        return symbol;
+    }
+
+    @Override
+    public String toString() {
+        return "CountryCurrency{" +
+                "code='" + code + '\'' +
+                ",symbol='" + symbol + '\'' +
+                '}';
+    }
+}

src/main/java/io/ipinfo/api/model/CountryFlag.java

@@ -0,0 +1,30 @@
+package io.ipinfo.api.model;
+
+public class CountryFlag {
+    private final String emoji;
+    private final String unicode;
+
+    public CountryFlag(
+            String emoji,
+            String unicode
+    ) {
+        this.emoji = emoji;
+        this.unicode = unicode;
+    }
+
+    public String getEmoji() {
+        return emoji;
+    }
+
+    public String getUnicode() {
+        return unicode;
+    }
+
+    @Override
+    public String toString() {
+        return "CountryFlag{" +
+                "emoji='" + emoji + '\'' +
+                ",unicode='" + unicode + '\'' +
+                '}';
+    }
+}

src/main/java/io/ipinfo/api/model/IPResponse.java

@@ -112,6 +112,18 @@ public Boolean isEU() {
         return context.isEU(getCountryCode());
     }
 
+    public CountryFlag getCountryFlag() {
+        return context.getCountryFlag(getCountryCode());
+    }
+
+    public CountryCurrency getCountryCurrency() {
+        return context.getCountryCurrency(getCountryCode());
+    }
+
+    public Continent getContinent() {
+        return context.getContinent(getCountryCode());
+    }
+
     public String getLocation() {
         return loc;
     }