phishtank 0.1.0 → 0.1.1

data/ChangeLog.md

@@ -0,0 +1,10 @@
+# PhishTank
+## v0.1.1 / 2012-03-13
+* Rename Request and Data to FeedRequest and FeedData
+  * This breaks semver, so to the none of you that have installed this, my apologies.
+* Add URL search API interface.
+
+## v0.1.0 / 2012-03-13 
+* First release!
+* Basic request handling, update checks, caching, and data parsing.
+* Specs

data/README.md

@@ -21,9 +21,9 @@ or w/ Bundler, add the following to the Gemfile.
       c.etag = "ETag" #optional
     end
     
-    PhishTank.update!
+    PhishTank.update_feed!
     
-    data = PhishTank::Data.new
+    data = PhishTank::FeedData.new
     
     data.entries.first 
     # => #<OpenStruct:0x1021026f8
@@ -41,8 +41,10 @@ or w/ Bundler, add the following to the Gemfile.
     #    }
     #>
     
+    PhishTank.search("http://www.google.com/") #=> false
+    PhishTank.search("http://suspiciousurl.com/") #=> OpenStruct w/ PhishTank details
+    
 Read specs for more details.
 
 ## TODO
-* Add interface for [checking URL's](http://www.phishtank.com/api_info.php)
-* Add errors for service-specific rate limiting errors
+You can see and contribute to the list of TODO items in [issues](https://github.com/ezkl/phishtank/issues?sort=created&labels=todo&direction=desc&state=open).

data/lib/phishtank.rb

@@ -1,7 +1,11 @@
+require 'typhoeus'
+require 'nokogiri'
+
 require "phishtank/version"
 require "phishtank/configuration"
-require "phishtank/request"
-require "phishtank/data"
+require "phishtank/feed_request"
+require "phishtank/feed_data"
+require "phishtank/url_request"
 
 module PhishTank
   BASE_URI = "http://data.phishtank.com"
@@ -16,11 +20,15 @@ module PhishTank
     @configuration ||= Configuration.new
   end
   
-  def self.update!
-    request = Request.new
+  def self.update_feed!
+    request = FeedRequest.new
     request.get_update if request.update?
   end
   
+  def self.search(url)
+    URLRequest.new(url).search
+  end
+  
   def self.api_key
     @configuration.api_key
   end

data/lib/phishtank/{data.rb → feed_data.rb}

@@ -1,8 +1,7 @@
-require 'nokogiri'
 require 'ostruct'
 
 module PhishTank
-  class Data
+  class FeedData
     attr_reader :file, :doc, :entries
         
     def initialize(data_file_path = nil)

data/lib/phishtank/{request.rb → feed_request.rb}

@@ -1,7 +1,5 @@
-require 'typhoeus'
-
 module PhishTank
-  class Request    
+  class FeedRequest    
     attr_accessor :etag
     
     def initialize(etag = nil)

data/lib/phishtank/url_request.rb

@@ -0,0 +1,55 @@
+require 'ostruct'
+
+module PhishTank
+  class URLRequest
+    attr_reader :url, :doc
+    
+    def initialize(url)
+      @url = URI.encode(url)
+    end
+    
+    def search
+      response = Typhoeus::Request.post(search_uri, :params => params)
+      parse_response(response.body)
+      
+      if in_database?
+        result_data
+      else
+        false
+      end
+    end
+    
+    def in_database?
+      in_database = @doc.xpath("/response/results/url0/in_database").text
+      in_database =~ /true/ ? true : false 
+    end
+    
+    def result_data
+      search_result = @doc.xpath("/response/results/url0")
+      result = OpenStruct.new
+      result.url          = search_result.at("url").text
+      result.in_database  = true
+      result.phish_id     = search_result.at("phish_id").text
+      result.detail_page  = search_result.at("phish_detail_page").text
+      result.verified     = search_result.at("verified").text
+      result.verified_at  = search_result.at("verified_at").text
+      result.valid        = search_result.at("valid").text
+      # result.submitted_at = search_result.at("submitted_at").text
+      result
+    end
+    
+    def params
+      { :format   => "XML",
+        :app_key  => PhishTank.configuration.api_key,
+        :url      => @url }
+    end
+    
+    def search_uri
+      "http://checkurl.phishtank.com/checkurl/"
+    end
+    
+    def parse_response(body)
+      @doc = Nokogiri::XML(body)
+    end
+  end
+end

data/lib/phishtank/version.rb

@@ -1,3 +1,3 @@
 module PhishTank
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/cassettes/invalid_search.yml

@@ -0,0 +1,65 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://checkurl.phishtank.com/checkurl/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        V2VkLCAxNCBNYXIgMjAxMiAwMjozNTo0NSBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi45IChEZWJpYW4pIFBIUC81LjIuNi0xK2xlbm55OSB3aXRo
+        IFN1aG9zaW4tUGF0Y2g=
+      !binary "WC1Qb3dlcmVkLUJ5":
+      - !binary |-
+        UEhQLzUuMi42LTErbGVubnk5
+      !binary "WC1SZXF1ZXN0LUxpbWl0LUludGVydmFs":
+      - !binary |-
+        MzAwIFNlY29uZHM=
+      !binary "WC1SZXF1ZXN0LUxpbWl0":
+      - !binary |-
+        MjUw
+      !binary "WC1SZXF1ZXN0LUNvdW50":
+      - !binary |-
+        MQ==
+      !binary "VmFyeQ==":
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        Mjcw
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        Y2xvc2U=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC94bWw=
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KCTxyZXNw
+        b25zZT4KCQk8bWV0YT4KCQkJPHRpbWVzdGFtcD4yMDEyLTAzLTE0VDAyOjM1
+        OjQ1KzAwOjAwPC90aW1lc3RhbXA+CgkJCTxzZXJ2ZXJpZD5lNTZkZWZjYzwv
+        c2VydmVyaWQ+CgkJCTxyZXF1ZXN0aWQ+MTkyLjE2OC4wLjEwNy40ZjYwMDQw
+        MTM3ODBhNC4yMTIzNDUxMjwvcmVxdWVzdGlkPgoJCTwvbWV0YT4KCQk8cmVz
+        dWx0cz4KCQkJPHVybDA+CgkJCQk8dXJsPjwhW0NEQVRBW2h0dHA6Ly93d3cu
+        Z29vZ2xlLmNvbS8/cT1zZWFyY2ggcXVlcnldXT48L3VybD4KCQkJCTxpbl9k
+        YXRhYmFzZT5mYWxzZTwvaW5fZGF0YWJhc2U+CgkJCTwvdXJsMD4KCQk8L3Jl
+        c3VsdHM+Cgk8L3Jlc3BvbnNlPgo=
+    http_version: !binary |-
+      MS4x
+  recorded_at: Wed, 14 Mar 2012 02:34:06 GMT
+recorded_with: VCR 2.0.0

data/spec/cassettes/valid_search.yml

@@ -0,0 +1,71 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://checkurl.phishtank.com/checkurl/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers: {}
+  response:
+    status:
+      code: 200
+      message: !binary |-
+        T0s=
+    headers:
+      !binary "RGF0ZQ==":
+      - !binary |-
+        V2VkLCAxNCBNYXIgMjAxMiAwMjo0NDoyMyBHTVQ=
+      !binary "U2VydmVy":
+      - !binary |-
+        QXBhY2hlLzIuMi45IChEZWJpYW4pIFBIUC81LjIuNi0xK2xlbm55OSB3aXRo
+        IFN1aG9zaW4tUGF0Y2g=
+      !binary "WC1Qb3dlcmVkLUJ5":
+      - !binary |-
+        UEhQLzUuMi42LTErbGVubnk5
+      !binary "WC1SZXF1ZXN0LUxpbWl0LUludGVydmFs":
+      - !binary |-
+        MzAwIFNlY29uZHM=
+      !binary "WC1SZXF1ZXN0LUxpbWl0":
+      - !binary |-
+        MjUw
+      !binary "WC1SZXF1ZXN0LUNvdW50":
+      - !binary |-
+        MQ==
+      !binary "VmFyeQ==":
+      - !binary |-
+        QWNjZXB0LUVuY29kaW5n
+      !binary "Q29udGVudC1FbmNvZGluZw==":
+      - !binary |-
+        Z3ppcA==
+      !binary "Q29udGVudC1MZW5ndGg=":
+      - !binary |-
+        Mzcx
+      !binary "Q29ubmVjdGlvbg==":
+      - !binary |-
+        Y2xvc2U=
+      !binary "Q29udGVudC1UeXBl":
+      - !binary |-
+        dGV4dC94bWw=
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KCTxyZXNw
+        b25zZT4KCQk8bWV0YT4KCQkJPHRpbWVzdGFtcD4yMDEyLTAzLTE0VDAyOjQ0
+        OjIzKzAwOjAwPC90aW1lc3RhbXA+CgkJCTxzZXJ2ZXJpZD4yZDVjMmNiPC9z
+        ZXJ2ZXJpZD4KCQkJPHJlcXVlc3RpZD4xOTIuMTY4LjAuMTA3LjRmNjAwNjA3
+        ZDBkZjMxLjAxMjQ2MjM1PC9yZXF1ZXN0aWQ+CgkJPC9tZXRhPgoJCTxyZXN1
+        bHRzPgoJCQk8dXJsMD4KCQkJCTx1cmw+PCFbQ0RBVEFbaHR0cDovL3d3dy5n
+        cm92ZXNnYXMuY28udWsvVEFNRmlkZWxpZGFkZS9jbGllbnRldGFtLmh0bV1d
+        PjwvdXJsPgoJCQkJPGluX2RhdGFiYXNlPnRydWU8L2luX2RhdGFiYXNlPgoJ
+        CQkJPHBoaXNoX2lkPjEzODk3NTM8L3BoaXNoX2lkPgoJCQkJPHBoaXNoX2Rl
+        dGFpbF9wYWdlPjwhW0NEQVRBW2h0dHA6Ly93d3cucGhpc2h0YW5rLmNvbS9w
+        aGlzaF9kZXRhaWwucGhwP3BoaXNoX2lkPTEzODk3NTNdXT48L3BoaXNoX2Rl
+        dGFpbF9wYWdlPgoJCQkJPHZlcmlmaWVkPnRydWU8L3ZlcmlmaWVkPgoJCQkJ
+        PHZlcmlmaWVkX2F0PjIwMTItMDMtMTNUMjI6NTE6NDMrMDA6MDA8L3Zlcmlm
+        aWVkX2F0PgoJCQkJPHZhbGlkPnRydWU8L3ZhbGlkPgoJCQk8L3VybDA+CgkJ
+        PC9yZXN1bHRzPgoJPC9yZXNwb25zZT4K
+    http_version: !binary |-
+      MS4x
+  recorded_at: Wed, 14 Mar 2012 02:41:45 GMT
+recorded_with: VCR 2.0.0

data/spec/phishtank/{data_spec.rb → feed_data_spec.rb}

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe PhishTank::Data do
+describe PhishTank::FeedData do
   context "success" do
     before(:all) do
       PhishTank.configure do |c|

data/spec/phishtank/{request_spec.rb → feed_request_spec.rb}

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe PhishTank::Request do  
+describe PhishTank::FeedRequest do  
   describe "#update?" do
     before(:all) do
       PhishTank.api_key = API_KEY

data/spec/phishtank/url_request_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe PhishTank::URLRequest do
+  subject do
+    PhishTank.configure { |c| c.api_key = API_KEY }
+    described_class.new("http://www.google.com/?q=search query")
+  end
+  
+  it "should URI-encode the search URL" do
+    subject.url.should eq "http://www.google.com/?q=search%20query"
+  end
+  
+  it "should have a search URI" do
+    subject.search_uri.should eq "http://checkurl.phishtank.com/checkurl/"
+  end
+  
+  it "should respond to search" do
+    subject.should respond_to(:search)
+  end
+  
+  describe "#search" do
+    context "valid search", :vcr => { :cassette_name => "valid search" } do
+      subject { described_class.new("http://www.grovesgas.co.uk/TAMFidelidade/clientetam.htm").search }
+      it "should return a struct of data" do
+        subject.should be_kind_of(OpenStruct)
+      end
+      
+      it "should have a bunch of attributes" do
+        subject.url.should eq "http://www.grovesgas.co.uk/TAMFidelidade/clientetam.htm"
+        subject.in_database.should eq true
+        subject.phish_id.should eq "1389753"
+      end
+    end
+    
+    context "invalid search", :vcr => { :cassette_name => "invalid search" } do
+      it "should return false" do
+        subject.search.should eq false
+      end
+    end
+  end
+  
+  describe "#params" do
+    its(:params)  { should include(:format => "XML") }
+    its(:params)  { should include(:app_key => API_KEY)}
+    its(:params)  { should include(:url => "http://www.google.com/?q=search%20query") }
+  end
+end

data/spec/phishtank_spec.rb

@@ -24,5 +24,7 @@ describe PhishTank do
     its(:etag)            { should eq "123456" }
   end
   
-  it { should respond_to(:update!) }
+  it { should respond_to(:update_feed!) }
+  
+  it { should respond_to(:search) }
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phishtank
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -86,6 +86,7 @@ files:
 - .rspec
 - .rvmrc
 - .travis.yml
+- ChangeLog.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -93,16 +94,20 @@ files:
 - Rakefile
 - lib/phishtank.rb
 - lib/phishtank/configuration.rb
-- lib/phishtank/data.rb
-- lib/phishtank/request.rb
+- lib/phishtank/feed_data.rb
+- lib/phishtank/feed_request.rb
+- lib/phishtank/url_request.rb
 - lib/phishtank/version.rb
 - phishtank.gemspec
+- spec/cassettes/invalid_search.yml
 - spec/cassettes/no_update_needed.yml
 - spec/cassettes/update_needed.yml
+- spec/cassettes/valid_search.yml
 - spec/fixtures/online-valid.xml
 - spec/phishtank/configuration_spec.rb
-- spec/phishtank/data_spec.rb
-- spec/phishtank/request_spec.rb
+- spec/phishtank/feed_data_spec.rb
+- spec/phishtank/feed_request_spec.rb
+- spec/phishtank/url_request_spec.rb
 - spec/phishtank_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/ezkl/phishtank
@@ -119,7 +124,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1039292126321332298
+      hash: -3595057374130271825
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -128,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1039292126321332298
+      hash: -3595057374130271825
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.18
@@ -137,11 +142,14 @@ specification_version: 3
 summary: Provides a simple interface to work with OpenDNS's PhishTank developer API
   by handling caching and parsing of PhishTank data.
 test_files:
+- spec/cassettes/invalid_search.yml
 - spec/cassettes/no_update_needed.yml
 - spec/cassettes/update_needed.yml
+- spec/cassettes/valid_search.yml
 - spec/fixtures/online-valid.xml
 - spec/phishtank/configuration_spec.rb
-- spec/phishtank/data_spec.rb
-- spec/phishtank/request_spec.rb
+- spec/phishtank/feed_data_spec.rb
+- spec/phishtank/feed_request_spec.rb
+- spec/phishtank/url_request_spec.rb
 - spec/phishtank_spec.rb
 - spec/spec_helper.rb