ip2proxy 3.1.0 → 3.2.0

raw patch · 4 files changed

+144/−4 lines, 4 filesdep +aesondep +http-clientdep +http-client-tlsPVP ok

version bump matches the API change (PVP)

Dependencies added: aeson, http-client, http-client-tls, http-types, uri-encode

API changes (from Hackage documentation)

Files

• ChangeLog.md +4/−0
• IP2Proxy.hs +1/−1
• IP2ProxyWebService.hs +136/−0
• ip2proxy.cabal +3/−3

@@ -1,5 +1,9 @@ # Revision history for ip2proxy +## 3.2.0  -- 2021-10-07++* Added support for IP2Proxy Web Service.+ ## 3.1.0  -- 2021-07-06  * Added provider field and exception handling for incorrect BIN database.

@@ -117,7 +117,7 @@     The 'getModuleVersion' function returns a string containing the module version.
 -}
 getModuleVersion :: String
-getModuleVersion = "3.1.0"
+getModuleVersion = "3.2.0"
 
 {-|
     The 'getPackageVersion' function returns a string containing the package version.

@@ -0,0 +1,136 @@+{-# LANGUAGE OverloadedStrings,TemplateHaskell #-}
+{-|
+Module      : IP2ProxyWebService
+Description : IP2Proxy Haskell package
+Copyright   : (c) IP2Location, 2021
+License     : MIT
+Maintainer  : sales@ip2location.com
+Stability   : experimental
+
+This Haskell package allows users to query an IP address to determine if it was being used as open proxy, web proxy, VPN anonymizer and TOR exits.
+
+IP2Proxy Web Service API subscription at https://www.ip2location.com/web-service/ip2proxy
+-}
+module IP2ProxyWebService (WSResult(..), WSConfig, openWS, lookUp, getCredit) where
+
+import Control.Exception
+import System.Exit
+import Data.Aeson as DA
+import Data.Aeson.TH
+import Network.HTTP.Client
+import Network.HTTP.Client.TLS (tlsManagerSettings)
+import Network.HTTP.Types.Status (statusCode)
+import Data.Maybe
+import Network.URI.Encode as URIE
+-- import Text.Regex.Base
+-- import Text.Regex.TDFA
+
+-- | Contains the web service configuration.
+data WSConfig = WSConfig {
+    -- | Web service API key
+    apiKey  :: String,
+    -- | API package
+    apiPackage :: String,
+    -- | Use SSL
+    useSSL :: Bool
+} deriving (Show)
+
+-- | Contains the web service results.
+data WSResult = WSResult {
+    -- | Response status or error
+    response  :: String,
+    -- | Country code
+    countryCode :: Maybe String,
+    -- | Country name
+    countryName :: Maybe String,
+    -- | Region name
+    regionName :: Maybe String,
+    -- | City name
+    cityName :: Maybe String,
+    -- | ISP name
+    isp :: Maybe String,
+    -- | Domain
+    domain :: Maybe String,
+    -- | Usage type
+    usageType :: Maybe String,
+    -- | Autonomous System Number
+    asn :: Maybe String,
+    -- | Autonomous System
+    as :: Maybe String,
+    -- | Proxy last seen in days
+    lastSeen :: Maybe String,
+    -- | Proxy type
+    proxyType :: Maybe String,
+    -- | Threat type
+    threat :: Maybe String,
+    -- | Whether is a proxy
+    isProxy :: Maybe String,
+    -- | VPN provider name
+    provider :: Maybe String
+} deriving (Show, Eq)
+
+$(deriveJSON defaultOptions ''WSResult)
+
+checkparams :: String -> String -> IO String
+checkparams apikey apipackage = do
+    return "OK"
+    --- regex part commented out due to cabal dependency issues
+    -- let apikeyok = apikey =~ ("^[0-9A-Z]{10}$" :: String) :: Bool
+    -- if apikeyok == False
+        -- then die(show "Invalid API key.")
+        -- else do
+            -- let apipackageok = apipackage =~ ("^PX[0-9]+$" :: String) :: Bool
+            -- if apipackageok == False
+                -- then die(show "Invalid package name.")
+                -- else return "OK"
+
+{-|
+    The 'openWS' function initializes the web service configuration.
+    It takes 3 arguments; the web service API key, the API package to call & whether to use SSL.
+-}
+openWS :: String -> String -> Bool -> IO WSConfig
+openWS apikey apipackage usessl = do
+    paramok <- checkparams apikey apipackage
+    return (WSConfig apikey apipackage usessl)
+
+{-|
+    The 'lookUp' function returns an WSResult containing proxy data for an IP address.
+    It takes 2 arguments; the web service configuration from 'openWS' function (WSConfig record) & either IPv4 or IPv6 address (String).
+-}
+lookUp :: WSConfig -> String -> IO WSResult
+lookUp myconfig ip = do
+    let key = apiKey myconfig
+    let package = apiPackage myconfig
+    let usessl = useSSL myconfig
+
+    paramok <- checkparams key package
+    let protocol = if usessl == True
+        then "https"
+        else "http"
+    manager <- newManager tlsManagerSettings
+    httprequest <- parseRequest $ protocol ++ "://api.ip2proxy.com/?key=" ++ key ++ "&package=" ++ package ++ "&ip=" ++ (URIE.encode ip)
+    httpresponse <- httpLbs httprequest manager
+    let json = responseBody httpresponse
+    let Just result = DA.decode json :: Maybe WSResult
+    return result
+
+{-|
+    The 'getCredit' function returns an WSResult containing web service credit balance for the API key.
+    It takes 1 argument; the web service configuration from 'openWS' function (WSConfig record).
+-}
+getCredit :: WSConfig -> IO WSResult
+getCredit myconfig = do
+    let key = apiKey myconfig
+    let package = apiPackage myconfig
+    let usessl = useSSL myconfig
+
+    paramok <- checkparams key package
+    let protocol = if usessl == True
+        then "https"
+        else "http"
+    manager <- newManager tlsManagerSettings
+    httprequest <- parseRequest $ protocol ++ "://api.ip2proxy.com/?key=" ++ key ++ "&check=true"
+    httpresponse <- httpLbs httprequest manager
+    let json = responseBody httpresponse
+    let Just result = DA.decode json :: Maybe WSResult
+    return result

@@ -10,7 +10,7 @@ -- PVP summary:      +-+------- breaking API changes
 --                   | | +----- non-breaking API additions
 --                   | | | +--- code changes with no API change
-version:             3.1.0
+version:             3.2.0
 
 -- A short (one-line) description of the package.
 synopsis:            IP2Proxy Haskell package for proxy detection.
@@ -51,7 +51,7 @@ 
 library
   -- Modules exported by the library.
-  exposed-modules:     IP2Proxy
+  exposed-modules:     IP2Proxy, IP2ProxyWebService
   
   -- Modules included in this library but not exported.
   -- other-modules:       
@@ -60,7 +60,7 @@   -- other-extensions:    
   
   -- Other library packages from which modules are imported.
-  build-depends:       base >=4.9 && <=4.15, bytestring >=0.10 && <0.12, binary >=0.8.4 && <0.9, iproute >=1.7 && <1.8
+  build-depends:       base >=4.9 && <=4.15, bytestring >=0.10 && <0.12, binary >=0.8.4 && <0.9, iproute >=1.7 && <1.8, aeson >=1.5 && <1.6, http-types >=0.12 && <0.13, http-client >=0.6 && <0.7, http-client-tls >=0.3 && <0.4, uri-encode >=1.5 && <1.6
   
   -- Directories containing source files.
   -- hs-source-dirs: