ip_info 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b26fd0a616f52de15a94cd82937c078808a022e6
-  data.tar.gz: 8696df49bcce4071de7570d982b22e5d40dbcedc
+  metadata.gz: 5f526a57b67936ef68324a637a79510a5b908d8e
+  data.tar.gz: 97047dbf56a678255d482f53bb3488a06358f9d1
 SHA512:
-  metadata.gz: 7eb5c34f631fa38021f3358f74fc7fd71696a2568546dbb000525a1058fd4555a4336bc367dedc825bdf4f9dfe6e4198cf9f79794ee7c6dec01985367c0c46dd
-  data.tar.gz: 2c4fd318d77c59eb7b7db7ca068268736f9cafc8d0081347b84d8805ba68faf51eb7cdf017c5a4f2fc6ef504a3ff0f0167af576b8473afec696a644cd62cc190
+  metadata.gz: 8a9d9218022eef92084e724318c5780085955ff87bc4c34a0447bca8cb54c1ac38314e0447fe8dc04dcee71dc690b25f22e8d96e1b52894231bcf246b11c318e
+  data.tar.gz: 849569ac1a4b0bd33786b72ae70f84e50ec23252027e770335b8aff6d30848d9a3cfdbe2a63147b4384060544546e9ac9c2313d1b3114621c71e5178e1cb1211

data/README.md

@@ -1,6 +1,6 @@
 # IpInfo Gem
 
-[![Build Status](https://travis-ci.org/max-si-m/ipinfo.svg?branch=master)](https://travis-ci.org/max-si-m/ipinfo)
+[![Build Status](https://travis-ci.org/max-si-m/ip_info.svg?branch=master)](https://travis-ci.org/max-si-m/ip_info)
 
 Find location from an IP address. 
 This's simple gem for [http://ipinfodb.com/](http://ipinfodb.com/)
@@ -23,9 +23,8 @@ Or install it yourself as:
 
 ## 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()   
+ip_info = IpInfo::API.new(api_key: "<YOUR_API_KEY>")
 ```
 And use `#lookup` for geting information about *ip*:
 

data/lib/ip_info/api.rb

@@ -12,22 +12,23 @@ module IpInfo
     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'].
+    # Constructor yields a block to allow more complicated object configuration.
     #
-    # It takes one arguments:
+    # It takes options with single optional key:
     # * +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?
+    def initialize(options = {})
+      yield self if block_given?
+
+      self.api_key ||= options.fetch(:api_key) { fail ApiKeyError.new("API key is missing.") }
     end
-    
+
     # Retreive the remote location of a given ip address.
     #
     # It takes two optional arguments:

data/lib/ip_info/parser.rb

@@ -5,17 +5,25 @@ module IpInfo
     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
+      def parse_response(response)
+        convert_keys(response).tap do |result|
+          raise InvalidParamsError.new(result[:status_message]) if result[:status_code] == "ERROR"
+        end
       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}
+
+      def convert_keys(response)
+        raise InvalidParamsError.new("Params must be present") if response.nil?
+
+        response.each_with_object({}) do |(key, value), hsh|
+          hsh[to_snake_case(key)] = value
         end
+      end
+
+      def to_snake_case(key)
+        key.to_s.gsub(/[A-Z]/) { |s| '_' + s.downcase }.gsub(/^_/, '').to_sym
+      end
     end
   end
 end

data/lib/ip_info/request.rb

@@ -1,17 +1,25 @@
 module IpInfo
   class API
     module Request
-      def query data, options = {}
+      REQUEST_TYPES = %w{city country}
+
+      def query(data, options = {})
         ip = data.sub(/^https?\:\/\//, '').sub(/^www./,'')  
 
-        type = (options[:type] == "city") ? "city" : "country" 
-        time_zone = (options[:time_zone] == true ) ? true : false
+        type = options.fetch(:type, 'country')
+
+        unless REQUEST_TYPES.include?(type)
+          raise ArgumentError.new("Wrong request type (available: #{REQUEST_TYPES.join(",")})")
+        end
+
+        time_zone = options.fetch(:time_zone, false)
 
-        params = {} 
-        params[:key] = self.api_key
-        params[:ip]  = ip
-        params[:timezone] = time_zone
-        params[:format] = "json"
+        params = {
+          key:      api_key,
+          ip:       ip,
+          timezone: time_zone,
+          format:   "json"
+        }
 
         response = self.class.get("#{type}/", query: params)
         parse_response(response.parsed_response)

data/lib/ip_info/version.rb

@@ -1,3 +1,3 @@
 module IpInfo
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/ip_info/api_spec.rb

@@ -2,17 +2,17 @@ require 'spec_helper'
 
 describe IpInfo::API do
   let(:ip)          { 'devbattles.com'  }
-  let(:ip_info)     { IpInfo::API.new() }
+  let(:ip_info)     { IpInfo::API.new(api_key: ENV["IP_INFO_KEY"]) }
 
   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)
+  it "raise errors with empty api_key", :vcr do
+    expect{IpInfo::API.new()}.to raise_error(ArgumentError)
   end
 
-  it "check type of request", :vcr do    
+  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

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 #using IpInfo::API instanse for access to IpInfo::Parser
 describe IpInfo::API::Parser do
-  let(:ip_info)		{ IpInfo::API.new() }
+  let(:ip_info) { IpInfo::API.new(api_key: ENV['IP_INFO_KEY']) }
 
   let(:response) do
   {

data/spec/ip_info/request_spec.rb

@@ -4,7 +4,7 @@ require 'spec_helper'
 describe IpInfo::API::Request do
   let(:address_url)  { 'devbattles.com'  }
   let(:address_ip) 	 { '64.233.191.255'  }
-  let(:ip_info)      { IpInfo::API.new() }
+  let(:ip_info)      { IpInfo::API.new(api_key: ENV['IP_INFO_KEY']) }
 
   context "check #query params" do
     it "must be one param" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ip_info
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Maxim Djuliy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-19 00:00:00.000000000 Z
+date: 2015-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty