ip_info 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42bc6e3ffc7e7a2d01a8d4cd37d8242c5cfdf7a1
+  data.tar.gz: d9f01ec880f73c97e04e8c6f19085c42194f54ea
+SHA512:
+  metadata.gz: 32e3730317b72b704ae250707d026448d629fd0bfce4299e16e30ca7e932431013f2e02833550c4ab0d8f19e4070ddf7de9382dd55d07eb295d50027f3b0884b
+  data.tar.gz: 2c8e44d0b5c2e3c9f7de520eaf8faff3f9683efeb207eaffdd9bd0b06e8daebb2299f1bd3992656fa0945f94fb7b9c9d520b2d096d525f3f5012b394d8e55a1d

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.gem
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.2.1
+script: 'bundle exec rspec'

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ipinfodb.gemspec
+gemspec
+
+group :test do
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Maxim Djuliy
+
+MIT License
+
+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,48 @@
+# IpInfo Gem
+
+[![Build Status](https://travis-ci.org/max-si-m/ipinfo.svg?branch=master)](https://travis-ci.org/max-si-m/ipinfo)
+
+Find location from an IP address. 
+This's simple gem for [http://ipinfodb.com/](http://ipinfodb.com/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ipinfo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ipinfo
+
+## Usage
+Use your api key for site, you can get it [here](http://ipinfodb.com/account.php)
+Api key also can be stored in environment variable `ENV['IP_INFO_KEY']`.
+```ruby
+ip_info = IpInfo::API.new()   
+```
+And use `#lookup` for geting information about *ip*:
+
+```ruby
+ip_info.lookup('209.85.227.104', type: 'city', time_zone: true)
+```
+or *domain*:
+
+```ruby
+ip_info.lookup('devbattles.com', type: 'country')
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ipinfo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ipinfo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ip_info/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ip_info"
+  spec.version       = IpInfo::VERSION
+  spec.authors       = ["Maxim Djuliy"]
+  spec.email         = ["mak7.dj@gmail.com"]
+  spec.description   = %q{API interface for http://ipinfodb.com }
+  spec.summary       = "Using for getting information about ip"
+  spec.homepage      = "https://github.com/max-si-m/ipinfodb"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.13.5"
+  
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'vcr', '~> 2.9', '>= 2.9.3'
+  spec.add_development_dependency 'webmock', '~>1.21'
+  spec.add_development_dependency 'dotenv', '~>2.0'
+end

data/lib/ip_info.rb

@@ -0,0 +1,9 @@
+require "httparty"
+require "ipinfo/version"
+require "ipinfo/parser"
+require "ipinfo/request"
+require "ipinfo/api"
+
+module IpInfo
+  # Your code goes here...
+end

data/lib/ip_info/api.rb

@@ -0,0 +1,44 @@
+require "ip_info"
+
+module IpInfo
+  class API
+    include HTTParty
+    include IpInfo::API::Request
+    include IpInfo::API::Parser
+
+    class ApiKeyError < ArgumentError; end
+
+    base_uri "http://api.ipinfodb.com/v3/ip-"
+    format :json
+
+    attr_accessor :api_key
+    
+    # Using for adding adding api_key for requests
+    # API_KEY you can get from: http://ipinfodb.com/account.php
+    #
+    # Api key also can be stored in environment variable ENV['IP_INFO_KEY'].
+    #
+    # It takes one arguments:
+    # * +api_key+: string of api_key 
+    #
+    # ==== Example:
+    #   ip_info = IpInfo::API.new()   
+    def initialize()
+      self.api_key ||= ENV['IP_INFO_KEY']
+      raise ApiKeyError.new("Error! Add your API key") if api_key.nil?
+    end
+    
+    # Retreive the remote location of a given ip address.
+    #
+    # It takes two optional arguments:
+    # * +type+: can either be +:country+ (default) or +:city+
+    # * +time_zone+: can either be +false+ (default) or +true+
+    #
+    # ==== Example:
+    #   ip_info.lookup('209.85.227.104', type: 'city', time_zone: true)
+    def lookup(ip, options = {})
+      query(ip, options)
+    end
+
+  end
+end

data/lib/ip_info/parser.rb

@@ -0,0 +1,21 @@
+require "json"
+
+module IpInfo
+  class API
+    module Parser
+      class InvalidParamsError < ArgumentError; end
+
+      def parse_response(response)        
+        result = convert_keys response
+        raise InvalidParamsError.new(result[:status_message]) if result[:status_code] == "ERROR"
+        result
+      end
+
+      private
+        def convert_keys(response)
+          raise InvalidParamsError.new("Params must be presence") if response.nil?
+          response.inject({}) {|hsh, (key,value)| hsh[key.to_s.gsub(/[A-Z]/){|s| '_' + s.downcase}.gsub(/^_/, '').to_sym] = value; hsh}
+        end
+    end
+  end
+end

data/lib/ip_info/request.rb

@@ -0,0 +1,21 @@
+module IpInfo
+  class API
+    module Request
+      def query data, options = {}
+        ip = data.sub(/^https?\:\/\//, '').sub(/^www./,'')  
+
+        type = (options[:type] == "city") ? "city" : "country" 
+        time_zone = (options[:time_zone] == true ) ? true : false
+
+        params = {} 
+        params[:key] = self.api_key
+        params[:ip]  = ip
+        params[:timezone] = time_zone
+        params[:format] = "json"
+
+        response = self.class.get("#{type}/", query: params)
+        parse_response(response.parsed_response)
+      end
+    end
+  end
+end

data/lib/ip_info/version.rb

@@ -0,0 +1,3 @@
+module IpInfo
+  VERSION = "0.3.0"
+end

data/spec/ip_info/api_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe IpInfo::API do
+  let(:ip)          { 'devbattles.com'  }
+  let(:ip_info)     { IpInfo::API.new() }
+
+  it "set api_key", :vcr do
+    expect(ip_info.api_key).to eq(ENV["IP_INFO_KEY"])
+  end
+
+  it "raise errors with empty api_key", :vcr  do  	
+    expect{IpInfo::API.new(nil)}.to raise_error(ArgumentError)
+  end
+
+  it "check type of request", :vcr do    
+    expect(ip_info.lookup(ip)).to be_kind_of(Hash)
+  end
+end

data/spec/ip_info/parser_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+#using IpInfo::API instanse for access to IpInfo::Parser
+describe IpInfo::API::Parser do
+  let(:ip_info)		{ IpInfo::API.new() }
+
+  let(:response) do
+  {
+    "statusCode" => "OK",
+    "statusMessage" => "",
+    "ipAddress" => "64.233.191.255",
+    "countryCode" => "US",
+    "countryName" => "United States",
+    "regionName" => "California",
+    "cityName" => "Mountain View",
+    "zipCode" => "94043",
+    "latitude" => "37.406",
+    "longitude" => "-122.079",
+    "timeZone" => "-07:00"	
+	}
+  end
+
+  context "check #parse_response params" do
+    it "must return Hash" do
+      res = ip_info.parse_response(response)
+      expect(res).to be_kind_of(Hash)
+    end
+
+    it "raise error for bad data" do
+      response["statusCode"] = "ERROR"
+      response["statusMessage"] = "Some errors"
+
+      expect{ip_info.parse_response(response)}.to raise_error(ArgumentError)
+    end
+  end
+
+  context "check #convert_keys params" do
+    it "convert array to hash" do
+      res = ip_info.send('convert_keys',response)
+      expect(res).to be_kind_of(Hash)
+    end
+    it "raise error for empty response" do
+      expect{ip_info.send('convert_keys',nil)}.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/ip_info/request_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+#using IpInfo::API instanse for access to IpInfo::Request
+describe IpInfo::API::Request do
+  let(:address_url)  { 'devbattles.com'  }
+  let(:address_ip) 	 { '64.233.191.255'  }
+  let(:ip_info)      { IpInfo::API.new() }
+
+  context "check #query params" do
+    it "must be one param" do
+      expect{ip_info.query()}.to raise_error(ArgumentError)
+    end
+    it "second param is optioanl", :vcr do  
+      expect(ip_info.query(address_ip)).to be_kind_of(Hash)
+    end
+  end
+
+  context "check #query response", :vcr do
+    context "ip address" do
+      it "check valid ip address without params" do
+        expect(ip_info.query(address_ip)).to eq({:status_code=>"OK", :status_message=>"", :ip_address=>"64.233.191.255", :country_code=>"US", :country_name=>"United States"})
+      end
+
+      it "check valid ip address with city params" do
+        expect(ip_info.query(address_ip, type:'city')).to eq({:status_code=>"OK", :status_message=>"", :ip_address=>"64.233.191.255", :country_code=>"US", :country_name=>"United States", :region_name=>"California", :city_name=>"Mountain View", :zip_code=>"94043", :latitude=>"37.406", :longitude=>"-122.079", :time_zone=>"-07:00"})
+      end
+
+      it "check valid ip address with both params" do
+        expect(ip_info.query(address_ip, type:'city', time_zone: true)).to eq({:status_code=>"OK", :status_message=>"", :ip_address=>"64.233.191.255", :country_code=>"US", :country_name=>"United States", :region_name=>"California", :city_name=>"Mountain View", :zip_code=>"94043", :latitude=>"37.406", :longitude=>"-122.079", :time_zone=>"-07:00"})
+      end
+    end
+    context "url address" do
+      it "check valid url address without params" do
+        expect(ip_info.query(address_url)).to eq({:status_code=>"OK", :status_message=>"", :ip_address=>"104.236.167.162", :country_code=>"US", :country_name=>"United States"})
+      end
+
+      it "check valid url address with city params" do
+        expect(ip_info.query(address_url, type:'city')).to eq({:status_code=>"OK", :status_message=>"", :ip_address=>"104.236.167.162", :country_code=>"US", :country_name=>"United States", :region_name=>"California", :city_name=>"San Francisco", :zip_code=>"94102", :latitude=>"37.7749", :longitude=>"-122.419", :time_zone=>"-07:00"})
+      end
+
+      it "check valid url address with both params" do
+        expect(ip_info.query(address_url, type:'city', time_zone: true)).to eq({:status_code=>"OK", :status_message=>"", :ip_address=>"104.236.167.162", :country_code=>"US", :country_name=>"United States", :region_name=>"California", :city_name=>"San Francisco", :zip_code=>"94102", :latitude=>"37.7749", :longitude=>"-122.419", :time_zone=>"-07:00"})
+      end
+    end
+    context "invalid response" do
+      it "ip address" do
+        expect{ip_info.query("invalid ip")}.to raise_error(ArgumentError)
+      end
+      it "url address" do
+        expect{ip_info.query("invalid url")}.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/ip_info' # load gem
+
+require 'dotenv'
+require 'vcr'
+require 'support/vcr'
+
+Dotenv.load

data/spec/support/vcr.rb

@@ -0,0 +1,12 @@
+VCR.configure do |config|
+  config.cassette_library_dir = 'spec/cassettes'
+  config.hook_into :webmock
+  config.filter_sensitive_data('api_key') { ENV["IP_INFO_KEY"] }
+end
+
+RSpec.configure do |c|
+  c.around(:each, :vcr) do |example|
+    name = example.metadata[:full_description].split(/\s+/, 2).join("/").downcase.gsub(/\s+/,"_")
+    VCR.use_cassette(name) { example.call }
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: ip_info
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Maxim Djuliy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 'API interface for http://ipinfodb.com '
+email:
+- mak7.dj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ipinfo.gemspec
+- lib/ip_info.rb
+- lib/ip_info/api.rb
+- lib/ip_info/parser.rb
+- lib/ip_info/request.rb
+- lib/ip_info/version.rb
+- spec/ip_info/api_spec.rb
+- spec/ip_info/parser_spec.rb
+- spec/ip_info/request_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb
+homepage: https://github.com/max-si-m/ipinfodb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Using for getting information about ip
+test_files:
+- spec/ip_info/api_spec.rb
+- spec/ip_info/parser_spec.rb
+- spec/ip_info/request_spec.rb
+- spec/spec_helper.rb
+- spec/support/vcr.rb