iprofiler 0.1.1 → 0.1.2

data/README.markdown

@@ -6,26 +6,53 @@ Travis CI : [![Build Status](https://secure.travis-ci.org/kandadaboggu/iprofiler
 
 ## Installation
 
-    [sudo] gem install iprofiler
+Add the following line to your Gemfile.
 
-## Usage
+    gem 'iprofiler'
+    bundle install
 
-    require 'rubygems'
-    require 'iprofiler'
+## Usage
 
-    # get your api keys at https://www.linkedin.com/secure/developer
-    client = Iprofiler::Client.new('your_consumer_key', 'your_consumer_secret')
-    reply = client.company_lookup(:ip_address => "10.10.20.30")
+**Setting the connection parameters globally**
+ 
+    Iprofiler.configure do |config|
+      config.api_key = "foo" 
+      config.api_secret = "bar"
+      config.api_host = "http://localhost:3000"
+    end
+    client = Iprofiler::Client.new
+ 
+ 
+**Setting the connection parameters per connection**
+ 
+    client = Iprofiler::Client.new ("foo", "bar", "http://localhost:3000")
+ 
+**Invoking the API**
+ 
+    client = Iprofiler::Client.new
+    client.company_lookup(:company_name => "Bank Of America")    
+    client.company_lookup(:ip_address => "10.10.10.2")
+    client.company_lookup(:domain => "bankofamerica.com")
+    client.company_lookup(:url => "accipitercom.com")
+    
+**Error/ISP handling**
+ 
+    reply = client.company_lookup(:ip_address => "2.228.11.0")    
     if reply.status == :found
-      company = reply.company
-      if company.type == :isp
+      if reply.company.type == "company"
+        puts "Processed Company"
       else
+        puts "Ignored ISP"
       end
-    else
-      reply.code
-      reply.message
+    elsif reply.status == :not_found
+      puts "Not found"
+    elsif reply.status == :insufficient_input
+      puts "Invalid input"
+    elsif reply.status == :error
+      puts "Error #{reply.error}"
     end
 
+
 ## TODO
 
 

data/README.md

@@ -0,0 +1,4 @@
+iprofiler
+=========
+
+Ruby API for accessing the Iprofile API's

data/changelog.markdown

@@ -1,5 +1,15 @@
 # Changelog
 
-## 0.0.1 - March 05, 2013
+## 0.1.0 - March 05, 2013
 
 * Initial release
+
+## 0.1.1 - March 08, 2013
+
+* Added missing authentication parameter check
+
+## 0.1.2 - March 08, 2013
+
+* Symbolized the type value in company structure
+* Updated README.markdown
+

data/lib/iprofiler/client.rb

@@ -80,8 +80,6 @@ module Iprofiler
       return Mash.new.tap do |reply|
         reply.status = :error
         reply.code = 400
-
-        missing = CONNECTION_PARAMETERS.none?{ |attr| send(attr).nil?}
         reply.error = "Invalid or missing API connection parameter(s)[#{missing_credentials.join(",")}]"
       end
     end
@@ -92,6 +90,9 @@ module Iprofiler
         reply.code = code
         if code == 200
           reply.status = reply.status.to_sym
+          if reply.status == :found
+            reply.company.type = reply.company.type.to_sym
+          end
         else
           reply.status = :error
         end

data/lib/iprofiler/version.rb

@@ -3,7 +3,7 @@ module Iprofiler
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 1
-    PATCH = 1
+    PATCH = 2
     PRE   = nil
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
   end

data/spec/cases/api_spec.rb

@@ -99,18 +99,21 @@ describe Iprofiler::Api do
       reply = client.company_lookup(:company_name => company.name)
       reply.code.should eq(200)
       reply.status.should eq(:found)
+      reply.company.type.should eq(:company)
     end
 
     it "should be able to query using domain name" do
       reply = client.company_lookup(:domain => company.url)
       reply.code.should eq(200)
       reply.status.should eq(:found)
+      reply.company.type.should eq(:company)
     end
 
     it "should be able to query using ip address" do
       reply = client.company_lookup(:ip_address => company.ip_address)
       reply.code.should eq(200)
       reply.status.should eq(:found)
+      reply.company.type.should eq(:company)
     end
 
     it "should be able to query using employee email id" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iprofiler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -171,6 +171,7 @@ files:
 - Gemfile
 - LICENSE
 - README.markdown
+- README.md
 - Rakefile
 - changelog.markdown
 - iprofiler.gemspec