ipgeolocation_io 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f940be534e7ca3bdcdfc7185b1d14f5ecab038b2
-  data.tar.gz: d458bc31a51f613cdb44a9a3fe5182d14c658c00
+  metadata.gz: 9996be4bdc452ebe11bc89a2fbcc5467d146fb25
+  data.tar.gz: 20473f2d14eeccd8ad21860a1ce64b0e85359eee
 SHA512:
-  metadata.gz: ce97cbeefc633ae4246b3c1b19a4229f5270fb0a413a0d58e1c098eee7e24024fe11a72915985b9c516a24a84c2a6cdf9963619b78046bf421c9a5ec49b56cec
-  data.tar.gz: ecc0ea4ab8f3f139d8ca90c8ac806bea86004620bd7cddac8985533dc0c4fb6a1f8f03eabbf8768a0922bc0de15d639bbde0da58788a738e8188ae33daf58046
+  metadata.gz: c24508aa89db806387788de7eea878046bc34c321f0b0a7f2b97f4269c46417a34d358dfdbd4d1a09bb10e8c284efeebfa2703fab4ea00e64f2614521f77e0fd
+  data.tar.gz: bf6f9724dca89499f28441aeab22fb2f7c8551da6edc07bc83f9a597279ac356fc177a3cd73d4af949c3216a2e6d902ae77f40b87f17f21221fbce52c3f5b129

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 ahsan nawaz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# IpgeolocationIo
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ipgeolocation_io`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ipgeolocation_io'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipgeolocation_io
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ipgeolocation_io. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the IpgeolocationIo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ipgeolocation_io/blob/master/CODE_OF_CONDUCT.md).

data/lib/ipgeolocation_io.rb

@@ -0,0 +1,6 @@
+require "ipgeolocation_io/version"
+
+module IpgeolocationIo
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/ipgeolocation_io/Geolocation.rb

@@ -0,0 +1,67 @@
+require_relative "GeolocationCurrency"
+require_relative "GeolocationTimezone"
+require 'json'
+class Geolocation
+  attr_reader :status;
+  attr_reader :message;
+  attr_reader :ip;
+  attr_reader :continentCode;
+  attr_reader :continentName;
+  attr_reader :countryCode2;
+  attr_reader :countryCode3;
+  attr_reader :countryName;
+  attr_reader :countryCapital;
+  attr_reader :stateProvince;
+  attr_reader :district;
+  attr_reader :city;
+  attr_reader :zipCode;
+  attr_reader :latitude;
+  attr_reader :longitude;
+  attr_reader :isEU;
+  attr_reader :callingCode;
+  attr_reader :countryTLD;
+  attr_reader :languages;
+  attr_reader :countryFlag;
+  attr_reader :isp;
+  attr_reader :connectionType;
+  attr_reader :organization;
+  attr_reader :geonameID;
+  attr_reader :currency;
+  attr_reader :timezone;
+
+  def initialize(json)
+    @status = json["status"].to_i;
+    if @status != 200 || json["message"] != nil
+      @message = json["message"].to_s;
+    else
+      @ip = json["ip"];
+      @continentCode = json["continent_code"];
+      @continentName = json["continent_name"];
+      @countryCode2 = json["country_code2"];
+      @countryCode3 = json["country_code3"];
+      @countryName = json["country_name"];
+      @countryCapital = json["country_capital"];
+      @stateProvince = json["state_prov"];
+      @district = json["district"];
+      @city = json["city"];
+      @zipcode = json["zipcode"];
+      @latitude = json["latitude"];
+      @longitude = json["longitude"];
+      @isEU = json["is_eu"];
+      @callingCode = json["calling_code"];
+      @countryTLD = json["country_tld"];
+      @languages = json["languages"];
+      @countryFlag = json["country_flag"];
+      @isp = json["isp"];
+      @connectionType = json["connection_type"];
+      @organization = json["organization"];
+      @geonameID = json["geoname_id"];
+      if(json["currency"] != nil)
+        @currency = GeolocationCurrency.new(json["currency"]);
+      end
+      if(json["time_zone"] != nil)
+        @timezone = GeolocationTimezone.new(json["time_zone"]);
+      end
+    end
+  end
+end

data/lib/ipgeolocation_io/GeolocationCurrency.rb

@@ -0,0 +1,10 @@
+class GeolocationCurrency
+
+  attr_reader :name
+  attr_reader :code
+
+  def initialize(json)
+    @name = json["name"];
+    @code = json["code"];
+  end
+end

data/lib/ipgeolocation_io/GeolocationParams.rb

@@ -0,0 +1,27 @@
+
+class GeolocationParams
+  attr_accessor :ip
+  attr_accessor :fields
+  attr_accessor :lang
+  attr_accessor :ips;
+
+  def initialize
+    @ip = "";
+    @fields = "";
+    @lang = "en";
+    @ips = Array.new(0);
+  end
+
+  def ips=(ips)
+    if @ips.length > 50
+      begin
+        raise ArgumentError, 'Max. number of IP addresses cannot be more than 50.'
+      rescue ArgumentError => e
+        puts e.message
+      end
+    else
+      @ips = ips;
+    end
+  end
+
+end

data/lib/ipgeolocation_io/GeolocationTimezone.rb

@@ -0,0 +1,16 @@
+class GeolocationTimezone
+
+  attr_reader :name
+  attr_reader :offset
+  attr_reader :currentTime
+  attr_reader :isDST
+  attr_reader :dstSavings
+
+  def initialize(json)
+    @name = json["name"];
+    @offset = json["offset"];
+    @currentTime = json["current_time"];
+    @isDST = json["is_dst"];
+    @dstSavings = json["dst_savings"];
+  end
+end

data/lib/ipgeolocation_io/IPGeolocationAPI.rb

@@ -0,0 +1,165 @@
+require_relative "Strings"
+require_relative "Geolocation"
+require_relative "Timezone"
+require 'json'
+require 'net/https'
+class IPGeolocationAPI
+  attr_reader :apiKey;
+  def initialize(apiKey)
+    begin
+      if Strings.isNullOrEmpty(apiKey)
+        raise ArgumentError, 'API key must not be null or empty'
+      else
+        @apiKey = apiKey;
+      end
+    rescue ArgumentError => e
+      puts e.message
+    end
+  end
+
+  def getGeolocation(geolocationParams = nil)
+    if geolocationParams==nil
+      apiResponse = getGeolocationResponse(nil);
+      return Geolocation.new(apiResponse);
+    else
+      apiResponse = getGeolocationResponse(geolocationParams);
+      return Geolocation.new(apiResponse);
+    end
+  end
+
+  def getGeolocationResponse(geolocationParams)
+    urlParams = buildGeolocationUrlParams(geolocationParams);
+    return callAPIEndpoint("ipgeo", urlParams);
+  end
+
+  def buildGeolocationUrlParams(geolocationParams)
+    urlParams = "apiKey="+@apiKey;
+    if geolocationParams != nil
+      if !Strings.isNullOrEmpty(geolocationParams.ip)
+        urlParams = urlParams + "&ip=";
+        urlParams = urlParams + geolocationParams.ip;
+      end
+      if !Strings.isNullOrEmpty(geolocationParams.fields)
+        urlParams = urlParams + "&fields=";
+        urlParams = urlParams + geolocationParams.fields;
+      end
+      if !Strings.isNullOrEmpty(geolocationParams.lang)
+        urlParams = urlParams + "&lang=";
+        urlParams = urlParams + geolocationParams.lang;
+      end
+    end
+    return urlParams;
+  end
+
+  def getTimezone(timezoneParams = nil)
+    if timezoneParams==nil
+      apiResponse = getTimezoneResponse(nil);
+      return Timezone.new(apiResponse);
+    else
+      apiResponse = getTimezoneResponse(timezoneParams)
+      return Timezone.new(apiResponse);
+    end
+  end
+
+  def getTimezoneResponse(timezoneParams)
+    urlParams = buildTimezoneUrlParams(timezoneParams);
+    return callAPIEndpoint("timezone", urlParams);
+  end
+
+  def buildTimezoneUrlParams(timezoneParams)
+    urlParams = "apiKey="+@apiKey
+    if timezoneParams != nil
+      if !Strings.isNullOrEmpty(timezoneParams.ip)
+        urlParams = urlParams+"&ip="
+        urlParams = urlParams+timezoneParams.ip
+      end
+
+      if !Strings.isNullOrEmpty(timezoneParams.timezone)
+        urlParams = urlParams+"&tz="
+        urlParams = urlParams+timezoneParams.timezone
+      end
+
+      latitude = timezoneParams.latitude;
+      longitude = timezoneParams.longitude;
+
+      if latitude != 1000.0 && longitude != 1000.0
+        urlParams = urlParams + "&lat="
+        urlParams = urlParams + latitude.to_s
+        urlParams = urlParams + "&long="
+        urlParams = urlParams + longitude.to_s
+      end
+    end
+    return urlParams
+  end
+
+  def callAPIEndpoint(endpoint, urlParams)
+    url = "https://api.ipgeolocation.io/" + endpoint + "?" + urlParams;
+    responseMap = Hash.new
+    begin
+      uri = URI.parse(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      resp = http.get("/" + endpoint + "?" + urlParams)
+      responseCode = resp.code
+      jsonString = resp.body
+      if Strings.isNullOrEmpty(responseCode) || Strings.isNullOrEmpty(jsonString)
+        responseCode = "422";
+        jsonString = "{\"message\":\"Something went wrong while parsing IP Geolocation API response\"}";
+      end
+    rescue StandardError => e
+      responseCode = "422";
+      jsonString = "{\"message\":\"Something went wrong while connecting to IP Geolocation API\"}";
+    rescue ArgumentError => e
+      responseCode = "422";
+      jsonString = "{\"message\":\"Something went wrong while parsing IP Geolocation API response\"}";
+    end
+    responseMap = JSON.parse(jsonString)
+    responseMap['status'] = responseCode
+    return responseMap
+  end
+
+  def getBulkGeolocation(geolocationParams)
+    data = Hash.new
+    data["ips"] =  geolocationParams.ips;
+    urlParams = buildGeolocationUrlParams(geolocationParams);
+    apiResponse = callBulkGeolocationAPIEndpoint(data, urlParams);
+    geolocations = Array.new
+    for response in apiResponse
+      geolocations.push(Geolocation.new(response));
+    end
+    return geolocations;
+  end
+
+  def callBulkGeolocationAPIEndpoint(ipAddresses, urlParams)
+    uri = URI.parse("https://api.ipgeolocation.io/ipgeo-bulk" + "?" + urlParams);
+    begin
+      header = {'Content-Type': 'text/json'}
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+      request.body = ipAddresses.to_json
+      response = http.request(request)
+      responseCode = response.code
+      jsonString = response.body
+      if Strings.isNullOrEmpty(responseCode) || Strings.isNullOrEmpty(jsonString)
+        responseCode = "422";
+        jsonString = "{\"message\":\"Something went wrong while parsing IP Geolocation API response\"}";
+      end
+    rescue StandardError => e
+      responseCode = "422";
+      jsonString = "{\"message\":\"Something went wrong while connecting to IP Geolocation API\"}";
+    rescue ArgumentError => e
+      responseCode = "422";
+      jsonString = "{\"message\":\"Something went wrong while parsing IP Geolocation API response\"}";
+    end
+    mapList = Array.new
+    list = JSON.parse(jsonString)
+    list.each do |item|
+      if !item['status']
+        item['status'] = '200'
+      end
+      mapList.push(item)
+    end
+    return mapList
+  end
+end

data/lib/ipgeolocation_io/Strings.rb

@@ -0,0 +1,11 @@
+class Strings
+  def self.nullToEmpty(s)
+    if(s == nil)
+      s = "";
+    end
+    return s;
+  end
+  def self.isNullOrEmpty(str)
+    return str == nil || str == ''
+  end
+end

data/lib/ipgeolocation_io/Timezone.rb

@@ -0,0 +1,49 @@
+require_relative "TimezoneGeo"
+class Timezone
+  attr_reader :status;
+  attr_reader :message;
+  attr_reader :timezone;
+  attr_reader :timezoneOffset;
+  attr_reader :date;
+  attr_reader :dateTime;
+  attr_reader :dateTimeTxt;
+  attr_reader :dateTimeWti;
+  attr_reader :dateTimeYmd;
+  attr_reader :dateTimeUnix;
+  attr_reader :time24;
+  attr_reader :time12;
+  attr_reader :week;
+  attr_reader :month;
+  attr_reader :year;
+  attr_reader :yearAbbr;
+  attr_reader :isDST;
+  attr_reader :dstSavings;
+  attr_reader :timezoneGeo;
+
+  def initialize(json)
+    @status = json["status"].to_i;
+    if @status != 200 || json["message"] != nil
+      @message = json["message"].to_s;
+    else
+      @timezone = json["timezone"];
+      @timezoneOffset = json["timezone_offset"];
+      @date = json["date"];
+      @dateTime = json["date_time"];
+      @dateTimeTxt = json["date_time_txt"];
+      @dateTimeWti = json["date_time_wti"];
+      @dateTimeYmd = json["date_time_ymd"];
+      @dateTimeUnix = json["date_time_unix"];
+      @time24 = json["time_24"];
+      @time12 = json["time_12"];
+      @week = json["week"];
+      @month = json["month"];
+      @year = json["year"];
+      @yearAbbr = json["year_abbr"];
+      @isDST = json["is_dst"];
+      @dstSavings = json["dst_savings"];
+      if json["geo"] != nil
+        @timezoneGeo = TimezoneGeo.new(json["geo"]);
+      end
+    end
+  end
+end

data/lib/ipgeolocation_io/TimezoneGeo.rb

@@ -0,0 +1,24 @@
+class TimezoneGeo
+  attr_reader :countryCode2;
+  attr_reader :countryCode3;
+  attr_reader :countryName;
+  attr_reader :stateProvince;
+  attr_reader :district;
+  attr_reader :city;
+  attr_reader :zipCode;
+  attr_reader :latitude;
+  attr_reader :longitude;
+
+  def initialize(json)
+    @countryCode2 = json["country_code2"];
+    @countryCode3 = json["country_code3"];
+    @countryName = json["country_name"];
+    @stateProvince = json["state_prov"];
+    @district = json["district"];
+    @city = json["city"];
+    @zipCode = json["zipcode"];
+    @latitude = json["latitude"];
+    @longitude = json["longitude"];
+  end
+
+end

data/lib/ipgeolocation_io/TimezoneParams.rb

@@ -0,0 +1,20 @@
+class TimezoneParams
+  attr_accessor :timezone;
+  attr_accessor :ip;
+  attr_accessor :lang;
+  attr_accessor :latitude;
+  attr_accessor :longitude;
+
+  def initialize()
+    @timezone = "";
+    @ip = "";
+    @lang = "en";
+    @latitude = 1000.0;
+    @longitude = 1000.0;
+  end
+
+  def setLocation(latitude, longitude)
+    @latitude = latitude;
+    @longitude = longitude;
+  end
+end

data/lib/ipgeolocation_io/version.rb

@@ -0,0 +1,3 @@
+module IpgeolocationIo
+  VERSION = "0.1.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ipgeolocation_io
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - ahsan nawaz
@@ -62,8 +62,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE.txt
+- README.md
 - bin/console
 - bin/setup
+- lib/ipgeolocation_io.rb
+- lib/ipgeolocation_io/Geolocation.rb
+- lib/ipgeolocation_io/GeolocationCurrency.rb
+- lib/ipgeolocation_io/GeolocationParams.rb
+- lib/ipgeolocation_io/GeolocationTimezone.rb
+- lib/ipgeolocation_io/IPGeolocationAPI.rb
+- lib/ipgeolocation_io/Strings.rb
+- lib/ipgeolocation_io/Timezone.rb
+- lib/ipgeolocation_io/TimezoneGeo.rb
+- lib/ipgeolocation_io/TimezoneParams.rb
+- lib/ipgeolocation_io/version.rb
 homepage: https://ipgeolocation.io/
 licenses:
 - MIT