ipstack 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 79566f77f9a1814cbfa641c27cc579e9029c317e7c66a6ed9bd765a4657cb1c4
-  data.tar.gz: 58372672c88fcd8f5aaeb1a016be04e94fa350697684e232fe22b33b2b3c29cb
+  metadata.gz: 412b55aa9741be14e2f8f8df76e93dae4856354c917118cb45084903fff0f833
+  data.tar.gz: ba32b6b878a746814cc64d8230316d0634984735c03b50320ce21559ef3d39c4
 SHA512:
-  metadata.gz: a6d7a438521b642b1b18ebb3f0d0971786db0e66d349539a73c33e423c529669f456d4a9d6d6d9b1b7e6566692c93540cb1b51e6190e533a83f9e5d81dfca573
-  data.tar.gz: f6a658795fd33d063497752bc8c2c9e6fd8370cfc2b62c023a5b20431b451ac2525a0efc3ac45105e24e6dbfc6ae102d48ea09d94d725cf47fac32e804c9b74c
+  metadata.gz: 2f7975f01d53b72a4e2e6ff9901eed1b52aa93902535cca7a435e41ae13df5a00fc905bfdd11a0ec95fc368eba1a6d50b1f99caf176432125dc362fdeeb5f134
+  data.tar.gz: 1a5e2c1244283b62a7c67ededce73e7f7b75636f4b912ad689597d21ada181ad3125eb9efbfd87c3c1bde53db71c052b5c3a083557b5426d843fe131852c04eb

data/Gemfile

@@ -2,7 +2,5 @@ source 'https://rubygems.org'
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-gem 'pry'
-
 # Specify your gem's dependencies in ipstack.gemspec
 gemspec

data/README.md

@@ -1,4 +1,4 @@
-# (Unofficial) Ipstack
+# (Unofficial) Ipstack Gem for API requests
 
 ## Installation
 
@@ -18,17 +18,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+* All endpoints listed in https://ipstack.com/documentation can be found under Ipstack::API (.check, .standard, .bulk)
+* Returned data is automatically converted into ruby usable forms
+    * **JSON** will be passed through JSON.parse to return a Ruby data structure (a Hash)
+    * **XML** through Nokogiri::XML
+    * To disable this, you can set the _return_raw_ to true under optionals.
+* Only basic checks are performed to be sure your parameters for the method are there or != nil/empty. You'll want to still rely on errors returned from the api itself. See documentation.
 
-## Development
+Here are examples:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+
+irb(main):008:0> Ipstack::API.check
+=> {"ip"=>"73.152.49.135", "type"=>"ipv4", "continent_code"=>"NA", "continent_name"=>"North America", "country_code"=>"US", "country_name"=>"United States", "region_code"=>"VA", "region_name"=>"Virginia", "city"=>"Ashburn", "zip"=>"20147", "latitude"=>39.018, "longitude"=>-77.539, "location"=>{"geoname_id"=>4744870, "capital"=>"Washington D.C.", "languages"=>[{"code"=>"en", "name"=>"English", "native"=>"English"}], "country_flag"=>"http://assets.ipstack.com/flags/us.svg", "country_flag_emoji"=>"🇺🇸", "country_flagmoji_unicode"=>"U+1F1FA U+1F1F8", "calling_code"=>"1", "is_eu"=>false}}
+
+irb(main):007:0> Ipstack::API.standard('134.201.250.155',{fields: 'city,region_name,zip'})
+=> {"city"=>"Huntington Beach", "region_name"=>"California", "zip"=>"92648"}
+
+irb(main):010:0> Ipstack::API.bulk('134.201.250.155,73.152.49.135',{fields: 'city,region_name,zip'})
+=> {"success"=>false, "error"=>{"code"=>303, "type"=>"batch_not_supported_on_plan", "info"=>"Bulk requests are not supported on your plan. Please upgrade your subscription."}}
 
-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).
+# Returning XML
+  
+irb(main):001:0> Ipstack::API.check({output: 'xml'})
+=> #<Nokogiri::XML::Document:0x3fe9c31604f8 name="document" children=[#<Nokogiri::XML::Element:0x3fe9c31601b0 name="result" children=[#<Nokogiri::XML::Element:0x3fe9c315de9c name="ip" children=[#<Nokogiri::XML::Text:0x3fe9c315db68 "73.152.49.135">]>, #<Nokogiri::XML::Element:0x3fe9c315d30c . . .
+     
+# Returning raw json or xml
+  
+irb(main):002:0> Ipstack::API.check({return_raw: true})
+=> "{\"ip\":\"73.152.49.135\",\"type\":\"ipv4\",\"continent_code\":\"NA\",\"continent_name\":\"North America\",\"country_code\":\"US\",\"country_name\":\"United States\",\"region_code\":\"VA\",\"region_name\":\"Virginia\",\"city\":\"Ashburn\",\"zip\":\"20147\",\"latitude\":39.018,\"longitude\":-77.539,\"location\":{\"geoname_id\":4744870,\"capital\":\"Washington D.C.\",\"languages\":[{\"code\":\"en\",\"name\":\"English\",\"native\":\"English\"}],\"country_flag\":\"http:\\/\\/assets.ipstack.com\\/flags\\/us.svg\",\"country_flag_emoji\":\"\\ud83c\\uddfa\\ud83c\\uddf8\",\"country_flag_emoji_unicode\":\"U+1F1FA U+1F1F8\",\"calling_code\":\"1\",\"is_eu\":false}}"
+
+irb(main):003:0> Ipstack::API.standard('73.152.49.135',{output: 'xml', return_raw: true})
+=> "<?xml version=\"1.0\"?>\n<result><ip>73.152.49.135</ip><type>ipv4</type><continent_code>NA</continent_code><continent_name>North America</continent_name><country_code>US</country_code><country_name>United States</country_name><region_code>VA</region_code><region_name>Virginia</region_name><city>Ashburn</city><zip>20147</zip><latitude>39.018</latitude><longitude>-77.539</longitude><location><geoname_id>4744870</geoname_id><capital>Washington D.C.</capital><languages><code>en</code><name>English</name><native>English</native></languages><country_flag>http://assets.ipstack.com/flags/us.svg</country_flag><country_flag_emoji>&#x1F1FA;&#x1F1F8;</country_flag_emoji><country_flag_emoji_unicode>U+1F1FA U+1F1F8</country_flag_emoji_unicode><calling_code>1</calling_code><is_eu></is_eu></location></result>\n"
+
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ipstack. 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.
+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
 
@@ -36,4 +63,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Ipstack project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ipstack/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Ipstack project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/NorseGaud/ipstack/blob/master/CODE_OF_CONDUCT.md).

data/lib/ipstack/api.rb

@@ -1,16 +1,20 @@
 require 'net/http'
 require 'openssl'
 require 'json'
+require 'nokogiri'
 
 module Ipstack
   class API
     # Make sure we can access parameters of the object
-    attr_accessor :api_url, :content_type, :access_key, :optionals, :params_uri
+    attr_accessor :api_url, :content_type, :access_key, :optionals, :params_uri, :return_raw
     def initialize(optionals = {}, access_key = ENV['IPSTACK_ACCESS_KEY'])
 
       raise ArgumentError, 'Requires a hash of optional values found on https://ipstack.com/documentation' unless optionals.is_a?(Hash)
       raise ArgumentError, '\'access_key\' (api key) cannot be nil. Obtain your key from https://ipstack.com/quickstart and set it as ENV[\'IPSTACK_ACCESS_KEY\']' if access_key.nil? || access_key == ''
 
+      @return_raw = optionals[:return_raw]
+      optionals.delete(:return_raw) # remove it from optionals since we each optionals for our url params
+
       @api_url = 'http://api.ipstack.com/'
       @access_key = access_key
       @params_uri = "?access_key=#{access_key}"
@@ -24,31 +28,35 @@ module Ipstack
       # TODO: HTTP/HTTPS support
       #http.use_ssl = false
       # https.verify_mode = OpenSSL::SSL::VERIFY_NONE # SSL not signed? Don't care!
-      request = Net::HTTP::Get.new(query_ips.nil? || query_ips == '' ? "/check#{object.params_uri}" : "/#{query_ips}#{object.params_uri}")
+      request = Net::HTTP::Get.new(query_ips.nil? || query_ips.empty? ? "/check#{object.params_uri}" : "/#{query_ips}#{object.params_uri}")
       response = http.request(request)
       case response
       when Net::HTTPSuccess
-        object.optionals[:output] == 'xml' ? Nokogiri::XML(response.body) : JSON.parse(response.body)
+        if object.return_raw
+          response.body
+        else
+          object.optionals[:output] == 'xml' ? Nokogiri::XML(response.body) : JSON.parse(response.body)
+        end
       else
         return response
         #"HTTP Error: #{response.code} #{response.message} : #{response.body}"
       end
     end
 
-    # https://ipstack.com/documentation
     def self.standard(ip, optionals = {})
       api_request_object = Ipstack::API.new(optionals)
-      raise('Requires a single IP') if ip.include?(',')
+      raise ArgumentError, 'Requires a single IP as first parameter' if ip.nil? || ip.empty? || ip.is_a?(Hash)
       Ipstack::API.make_request(api_request_object,ip)
     end
 
     def self.bulk(ips, optionals = {})
       api_request_object = Ipstack::API.new(optionals)
-      raise('Requires a list of IPs comma separated') unless ips.include?(',') && ips.match(/((25[0-5]|2[0-4]\d|[01]?\d\d?)\.(25[0-5]|2[0-4]\d|[01]?\d\d?)\.(25[0-5]|2[0-4]\d|[01]?\d\d?)\.(25[0-5]|2[0-4]\d|[01]?\d\d?)(,\n|,?$))/)
+      raise ArgumentError, 'Requires a list of IPs comma separated as first parameter' if ips.nil? || ips.empty? || ip.is_a?(Hash) || !( ips.include?(',') && ips.match(/((25[0-5]|2[0-4]\d|[01]?\d\d?)\.(25[0-5]|2[0-4]\d|[01]?\d\d?)\.(25[0-5]|2[0-4]\d|[01]?\d\d?)\.(25[0-5]|2[0-4]\d|[01]?\d\d?)(,\n|,?$))/) )
       Ipstack::API.make_request(api_request_object,ips)
     end
 
     def self.check(optionals = {})
+      raise ArgumentError,'Only optionals hash allowed as first parameter' unless optionals.is_a?(Hash) || optionals.empty?
       api_request_object = Ipstack::API.new(optionals)
       Ipstack::API.make_request(api_request_object)
     end

data/lib/ipstack/version.rb

@@ -1,3 +1,3 @@
 module Ipstack
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ipstack
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Nathan Pierce
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-08 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler