Merge pull request #3 from blueconic/master_pullreq2

Merge pull request 2

Author: paulrutter

README.md

@@ -20,20 +20,19 @@ In short, this is how our algorithm works:
 
 ## Notes
 * Although this library is very fast, implementing a cache is advisable. Since cache strategies differ per usecase, this library doesn't ship with one out of the box.
-* The followings BrowsCap fields are available:
+* All BrowsCap fields are available by configuration, but the following fields are loaded by default:
   * browser (e.g. Chrome)
   * browserType (e.g. Browser or Application)
   * browserMajorVersion (e.g. 61 in case of Chrome)
   * deviceType (e.g. Mobile Phone, Desktop, Tablet, Console, TV Device)
   * platform (e.g. Android, iOS, Win7, Win8, Win10)
   * platformVersion (e.g. 4.2, 10 depending on what the platform is)
-* The fields are not configurable.
+* The fields _are_ configurable by specifying a list of BrowsCapFields in the constructor of the UserAgentParser.
 * The CSV file is read in a streaming way, so it's processed line by line. This makes it more memory efficient than loading the whole into memory first.
 * 1000+ user agents are tested in the unit tests.
 
 ## Future
 Possible new features we're thinking of (and are not yet present):
-* Make the fields configurable and let Capabilities return a Map containing the given fields
 * Auto-update the BrowsCap CSV
 
 ## Maven
@@ -43,21 +42,32 @@ Add this to the dependencies in your pom.xml.
 <dependency>
   <groupId>com.blueconic</groupId>
   <artifactId>browscap-java</artifactId>
-  <version>1.0.4</version>
+  <version>1.1.0</version>
 </dependency>
 ```
 
 ## Usage
 ```java
+import com.blueconic.browscap.BrowsCapField;
 import com.blueconic.browscap.Capabilities;
 import com.blueconic.browscap.ParseException;
 import com.blueconic.browscap.UserAgentParser;
 import com.blueconic.browscap.UserAgentService;
 
 // ... class definition
 
+// create a parser with the default fields
 final UserAgentParser parser = new UserAgentService().loadParser(); // handle IOException and ParseException
 
+// or create a parser with a custom defined field list
+// the list of available fields can be seen inthe BrowsCapField enum
+final UserAgentParser parser =
+        new UserAgentService().loadParser(Arrays.asList(BrowsCapField.BROWSER, BrowsCapField.BROWSER_TYPE,
+                BrowsCapField.BROWSER_MAJOR_VERSION,
+                BrowsCapField.DEVICE_TYPE, BrowsCapField.PLATFORM, BrowsCapField.PLATFORM_VERSION,
+                BrowsCapField.RENDERING_ENGINE_VERSION, BrowsCapField.RENDERING_ENGINE_NAME,
+                BrowsCapField.PLATFORM_MAKER, BrowsCapField.RENDERING_ENGINE_MAKER));
+
 // It's also possible to supply your own ZIP file by supplying a correct path to a ZIP file in the constructor.
 // This can be used when a new BrowsCap version is released which is not yet bundled in this package.
 // final UserAgentParser parser = new UserAgentService("E:\\anil\\browscap.zip").loadParser();
@@ -66,13 +76,17 @@ final UserAgentParser parser = new UserAgentService().loadParser(); // handle IO
 final String userAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.81 Safari/537.36";
 final Capabilities capabilities = parser.parse(userAgent);
 
+// the default fields have getters
 final String browser = capabilities.getBrowser();
 final String browserType = capabilities.getBrowserType();
 final String browserMajorVersion = capabilities.getBrowserMajorVersion();
 final String deviceType = capabilities.getDeviceType();
 final String platform = capabilities.getPlatform();
 final String platformVersion = capabilities.getPlatformVersion();
 
+// the custom defined fields are available through a Map
+final String renderingEngineMaker = capabilities.getValues().get(BrowsCapField.RENDERING_ENGINE_MAKER);
+
 // do something with the values
 
 ```

pom.xml

@@ -4,7 +4,7 @@
     <groupId>com.blueconic</groupId>
     <artifactId>browscap-java</artifactId>
     <packaging>jar</packaging>
-    <version>1.0.4</version>
+    <version>1.1.0</version>
     <name>browscap-java</name>
     <description>A blazingly fast and memory efficient Java client on top of the BrowsCap CSV source files.</description>
 

src/main/java/com/blueconic/browscap/BrowsCapField.java

@@ -0,0 +1,72 @@
+package com.blueconic.browscap;
+
+public enum BrowsCapField {
+    IS_MASTER_PARENT("is_master_parent"),
+    IS_LITE_MODE("is_lite_mode"),
+    PARENT("parent"),
+    COMMENT("comment"),
+    BROWSER("browser"),
+    BROWSER_TYPE("browser_type"),
+    BROWSER_BITS("browser_bits"),
+    BROWSER_MAKER("browser_maker"),
+    BROWSER_MODUS("browser_modus"),
+    BROWSER_VERSION("browser_version"),
+    BROWSER_MAJOR_VERSION("browser_major_version"),
+    BROWSER_MINOR_VERSION("browser_minor_version"),
+    PLATFORM("platform"),
+    PLATFORM_VERSION("platform_version"),
+    PLATFORM_DESCRIPTION("platform_description"),
+    PLATFORM_BITS("platform_bits"),
+    PLATFORM_MAKER("platform_maker"),
+    IS_ALPHA("is_alpha"),
+    IS_BETA("is_beta"),
+    IS_WIN16("is_win16"),
+    IS_WIN32("is_win32"),
+    IS_WIN64("is_win64"),
+    IS_IFRAMES("is_iframes"),
+    IS_FRAMES("is_frames"),
+    IS_TABLES("is_tables"),
+    IS_COOKIES("is_cookies"),
+    IS_BACKGROUND_SOUNDS("is_background_sounds"),
+    IS_JAVASCRIPT("is_javascript"),
+    IS_VBSCRIPT("is_vbscript"),
+    IS_JAVA_APPLETS("is_java_applets"),
+    IS_ACTIVEX_CONTROLS("is_activex_controls"),
+    IS_MOBILE_DEVICES("is_mobile_device"),
+    IS_TABLET("is_tablet"),
+    IS_SYNDICATION_READER("is_syndication_reader"),
+    IS_CRAWLER("is_crawler"),
+    IS_FAKE("is_fake"),
+    IS_ANONYMIZED("is_anonymized"),
+    IS_MODIFIED("is_modified"),
+    CSS_VERSION("css_version"),
+    AOL_VERSION("aol_version"),
+    DEVICE_NAME("device_name"),
+    DEVICE_MAKER("device_maker"),
+    DEVICE_TYPE("device_type"),
+    DEVICE_POINTING_METHOD("device_pointing_method"),
+    DEVICE_CODE_NAME("device_code_name"),
+    DEVICE_BRAND_NAME("device_brand_name"),
+    RENDERING_ENGINE_NAME("rendering_engine_name"),
+    RENDERING_ENGINE_VERSION("rendering_engine_version"),
+    RENDERING_ENGINE_DESCRIPTION("rendering_engine_description"),
+    RENDERING_ENGINE_MAKER("rendering_engine_maker");
+
+    private final String myField;
+
+    /**
+     * @param the browscap field identifier
+     */
+    private BrowsCapField(final String fieldIdentifier) {
+        this.myField = fieldIdentifier;
+    }
+
+    /*
+     * (non-Javadoc)
+     * @see java.lang.Enum#toString()
+     */
+    @Override
+    public String toString() {
+        return myField;
+    }
+}

src/main/java/com/blueconic/browscap/Capabilities.java

@@ -1,5 +1,7 @@
 package com.blueconic.browscap;
 
+import java.util.Map;
+
 public interface Capabilities {
     String UNKNOWN_BROWSCAP_VALUE = "Unknown";
 
@@ -39,4 +41,10 @@ public interface Capabilities {
      */
     String getDeviceType();
 
+    /**
+     * Returns the Map of values with the fields passed to the parser while loading
+     * @return the map of values
+     */
+    Map<BrowsCapField, String> getValues();
+
 }

src/main/java/com/blueconic/browscap/UserAgentService.java

@@ -7,6 +7,8 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
+import java.util.Arrays;
+import java.util.List;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;
 
@@ -16,6 +18,10 @@
  * Service that manages the creation of user agent parsers. In the feature, this might be expanded so it also supports
  */
 public class UserAgentService {
+    public static final List<BrowsCapField> DEFAULT_FIELDS =
+            Arrays.asList(BrowsCapField.BROWSER, BrowsCapField.BROWSER_TYPE, BrowsCapField.BROWSER_MAJOR_VERSION,
+                    BrowsCapField.DEVICE_TYPE, BrowsCapField.PLATFORM, BrowsCapField.PLATFORM_VERSION);
+
     // The version of the browscap file this bundle depends on
     public static final int BUNDLED_BROWSCAP_VERSION = 6026;
     private String myZipFilePath;
@@ -38,6 +44,20 @@ public UserAgentService(final String zipFilePath) {
      * @return the user agent parser
      */
     public UserAgentParser loadParser() throws IOException, ParseException {
+        return createParserWithFields(DEFAULT_FIELDS);
+    }
+
+    /**
+     * Returns a parser based on the bundled BrowsCap version
+     * @param fields list
+     * @return the user agent parser
+     */
+    public UserAgentParser loadParser(final List<BrowsCapField> fields) throws IOException, ParseException {
+        return createParserWithFields(fields);
+    }
+
+    private UserAgentParser createParserWithFields(final List<BrowsCapField> fields)
+            throws IOException, ParseException, FileNotFoundException {
         // http://browscap.org/version-number
         try (final InputStream zipStream = getCsvFileStream();
                 final ZipInputStream zipIn = new ZipInputStream(zipStream)) {
@@ -46,7 +66,7 @@ public UserAgentParser loadParser() throws IOException, ParseException {
             // look for the first file that isn't a directory
             // that should be a BrowsCap .csv file
             if (!entry.isDirectory()) {
-                return new UserAgentFileParser().parse(new InputStreamReader(zipIn, UTF_8));
+                return new UserAgentFileParser().parse(new InputStreamReader(zipIn, UTF_8), fields);
             } else {
                 throw new IOException(
                         "Unable to find the BrowsCap CSV file in the ZIP file");

src/main/java/com/blueconic/browscap/impl/CapabilitiesImpl.java

@@ -1,84 +1,89 @@
 package com.blueconic.browscap.impl;
 
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+
+import com.blueconic.browscap.BrowsCapField;
 import com.blueconic.browscap.Capabilities;
 
 class CapabilitiesImpl implements Capabilities {
-    public final static Capabilities DEFAULT = new CapabilitiesImpl("Default Browser", "Default Browser",
-            UNKNOWN_BROWSCAP_VALUE,
-            UNKNOWN_BROWSCAP_VALUE,
-            UNKNOWN_BROWSCAP_VALUE,
-            UNKNOWN_BROWSCAP_VALUE);
+    public final static Capabilities DEFAULT = new CapabilitiesImpl(Collections.emptyMap());
 
-    private final String myBrowser;
-    private final String myBrowserType;
-    private final String myBrowserMajorVersion;
-    private final String myDeviceType;
-    private final String myPlatform;
-    private final String myPlatformVersion;
+    private final Map<BrowsCapField, String> myValues = new HashMap<>();
 
-    public CapabilitiesImpl(final String browser, final String browserType, final String browserMajorVersion,
-            final String deviceType, final String platform, final String platformVersion) {
+    public CapabilitiesImpl(
+            final Map<BrowsCapField, String> values) {
+        // default values first, for backwards compatibility
+        myValues.put(BrowsCapField.BROWSER, "Default Browser");
+        myValues.put(BrowsCapField.BROWSER_TYPE, "Default Browser");
+        myValues.put(BrowsCapField.BROWSER_MAJOR_VERSION, UNKNOWN_BROWSCAP_VALUE);
+        myValues.put(BrowsCapField.DEVICE_TYPE, UNKNOWN_BROWSCAP_VALUE);
+        myValues.put(BrowsCapField.PLATFORM, UNKNOWN_BROWSCAP_VALUE);
+        myValues.put(BrowsCapField.PLATFORM_VERSION, UNKNOWN_BROWSCAP_VALUE);
 
-        myBrowser = browser;
-        myBrowserType = browserType;
-        myBrowserMajorVersion = browserMajorVersion;
-        myDeviceType = deviceType;
-        myPlatform = platform;
-        myPlatformVersion = platformVersion;
+        myValues.putAll(values);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getBrowser() {
-        return myBrowser;
+        return myValues.get(BrowsCapField.BROWSER);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getBrowserType() {
-        return myBrowserType;
+        return myValues.get(BrowsCapField.BROWSER_TYPE);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getBrowserMajorVersion() {
-        return myBrowserMajorVersion;
+        return myValues.get(BrowsCapField.BROWSER_MAJOR_VERSION);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getPlatform() {
-        return myPlatform;
+        return myValues.get(BrowsCapField.PLATFORM);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getPlatformVersion() {
-        return myPlatformVersion;
+        return myValues.get(BrowsCapField.PLATFORM_VERSION);
     }
 
     /**
      * {@inheritDoc}
      */
     @Override
     public String getDeviceType() {
-        return myDeviceType;
+        return myValues.get(BrowsCapField.DEVICE_TYPE);
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public Map<BrowsCapField, String> getValues() {
+        return myValues;
     }
 
     @Override
     public String toString() {
-        return "Capabilities{browser='" + myBrowser + "', browserType='" + myBrowserType + "', browserMajorVersion='"
-                + myBrowserMajorVersion + "', deviceType='" + myDeviceType + "', platform='" + myPlatform
-                + "', platformVersion='" + myPlatformVersion + '}';
+        return "CapabilitiesImpl [myValues=" + myValues + "]";
     }
+
 }