urlvoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf6fe9bfff28dd1609ed82baf10375fa1be3b3a5
+  data.tar.gz: f6fc11c39ab7521a26a0164787d32cf8f4fa9ad9
+SHA512:
+  metadata.gz: 6ec056906535ea748b44da5b7e5b3d05eebbc0ac3992bfd2152b86ac8ff722e18952e410588ab61b5d0e2f3418c8a8865145814269abf0e953be29cf3699e9a8
+  data.tar.gz: b6a7656177e83270c5a28ffd8dca1e1d3a61ca8a8c13ff0d410220bc9a595413a9f03a249832a6a34d68b43bad3ce27be9f9a2177eef0a2bf439c2992b13381b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,30 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  Exclude:
+    - 'test/fixtures/*'
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/UnneededPercentQ:
+  Enabled: true
+
+Style/HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# Disabled Checks
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+SpaceAroundEqualsInParameterDefault:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+sudo: false
+branches:
+  except:
+    - gh-pages
+cache: bundler
+language: ruby
+rvm:
+  - 2.1
+before_install: gem update --remote bundler
+install:
+  - bundle install --retry=3
+script:
+  - bundle exec rake test
+  - bundle exec rake rubocop

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 pwelch
+
+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,85 @@
+# URLVoid API Gem
+
+Ruby Gem for [URLVoid API](http://www.urlvoid.com/api/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'urlvoid'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install urlvoid
+
+## Usage
+
+### URLVoid Host Response
+
+```ruby
+require 'urlvoid'
+
+api_key = 'MY_API_KEY'
+
+urlvoid = URLVoid::Host.info(api_key, 'google.com')
+
+# API Response
+urlvoid.response
+# =>
+{"details"=>
+  {"host"=>"google.com",
+   "updated"=>"1438544337",
+   "http_response_code"=>"200",
+   "domain_age"=>"874296000",
+   "google_page_rank"=>"9",
+   "alexa_rank"=>"1",
+   "connect_time"=>"0.028592",
+   "header_size"=>"840",
+   "download_size"=>"44685",
+   "speed_download"=>"309084",
+   "external_url_redirect"=>nil,
+   "ip"=>
+    {"addr"=>"216.58.211.78",
+     "hostname"=>"par03s14-in-f14.1e100.net",
+     "asn"=>"15169",
+     "asname"=>"Google Inc.",
+     "country_code"=>"US",
+     "country_name"=>"United States",
+     "region_name"=>"California",
+     "city_name"=>"Mountain View",
+     "continent_code"=>"NA",
+     "continent_name"=>"North America",
+     "latitude"=>"37.4192",
+     "longitude"=>"-122.057"}},
+ "detections"=>{"engines"=>{"engine"=>"PhishTank"}, "count"=>"1"},
+ "page_load"=>"0.00"}
+
+# API Reponse Detections
+urlvoid.detections
+# =>  {"engines"=>{"engine"=>"PhishTank"}, "count"=>"1"}
+```
+
+### URLVoid API Queries Remaining
+
+```ruby
+require 'urlvoid'
+
+api_key = 'MY_API_KEY'
+
+URLVoid::Stats.remaining_queries(api_key)
+# => 901
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/pwelch/urlvoid/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,14 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+task :default => :test

data/lib/urlvoid.rb

@@ -0,0 +1,4 @@
+require 'urlvoid/version'
+require 'urlvoid/base'
+require 'urlvoid/host'
+require 'urlvoid/stats'

data/lib/urlvoid/base.rb

@@ -0,0 +1,17 @@
+require 'rest-client'
+require 'nokogiri'
+require 'active_support/core_ext/hash'
+
+module URLVoid
+  class Base
+    # @return [String] string of API URI class method
+    def self.api_uri
+      'http://api.urlvoid.com/'
+    end
+
+    # @return [String] string of API URI instance method
+    def api_uri
+      self.class.api_uri
+    end
+  end
+end

data/lib/urlvoid/host.rb

@@ -0,0 +1,31 @@
+require_relative 'base'
+
+module URLVoid
+  class Host < Base
+    attr_reader :response
+
+    def initialize(response)
+      @response = response['response']
+    end
+
+    # @param [String] api_key for URLVoid API
+    # @param [String] host to check
+    # @param [Hash] opts hash for additional options
+    # @return [URLVoid::Host] Response
+    def self.info(api_key, hostname, opts={})
+      identifier = opts.fetch('identifier', 'api1000')
+
+      response = RestClient.get(
+        "#{api_uri}#{identifier}/#{api_key}/host/#{hostname}/"
+      )
+
+      doc = Nokogiri::XML(response)
+      new(Hash.from_xml(doc.to_s))
+    end
+
+    # @return [Hash] of detections
+    def detections
+      response['detections']
+    end
+  end
+end

data/lib/urlvoid/stats.rb

@@ -0,0 +1,19 @@
+require_relative 'base'
+
+module URLVoid
+  class Stats < Base
+    # @param [String] api_key for URLVoid API
+    # @param [Hash] opts hash for additional options
+    # @return [Fixnum] count of remaining API requests
+    def self.remaining_queries(api_key, opts={})
+      identifier = opts.fetch('identifier', 'api1000')
+
+      response = RestClient.get(
+        "#{api_uri}#{identifier}/#{api_key}/stats/remained/"
+      )
+
+      doc = Nokogiri::XML(response)
+      Hash.from_xml(doc.to_s)['response']['queriesRemained'].to_i
+    end
+  end
+end

data/lib/urlvoid/version.rb

@@ -0,0 +1,3 @@
+module URLVoid
+  VERSION = '0.1.0'
+end

data/test/base_test.rb

@@ -0,0 +1,24 @@
+require './test/test_helper'
+
+class URLVoidBaseTest < Minitest::Test
+  def test_class_exists
+    assert URLVoid::Base
+  end
+
+  # Instance Method
+  def test_api_uri_instance_method
+    base_uri = 'http://api.urlvoid.com/'
+    vt_base  = URLVoid::Base.new
+
+    assert vt_base.api_uri.is_a?(String)
+    assert vt_base.api_uri, base_uri
+  end
+
+  # Class Method
+  def test_api_uri_class_method
+    base_uri = 'http://api.urlvoid.com/'
+
+    assert URLVoid::Base.api_uri.is_a?(String)
+    assert URLVoid::Base.api_uri, base_uri
+  end
+end

data/test/fixtures/host.yml

@@ -0,0 +1,73 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.urlvoid.com/api1000/testapikey/host/google.com/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 03 Aug 2015 02:22:31 GMT
+      Content-Type:
+      - text/xml
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <response>
+        <details>
+         <host>google.com</host>
+         <updated>1438544337</updated>
+         <http_response_code>200</http_response_code>
+         <domain_age>874296000</domain_age>
+         <google_page_rank>9</google_page_rank>
+         <alexa_rank>1</alexa_rank>
+         <connect_time>0.028592</connect_time>
+         <header_size>840</header_size>
+         <download_size>44685</download_size>
+         <speed_download>309084</speed_download>
+         <external_url_redirect></external_url_redirect>
+         <ip>
+        <addr>216.58.211.78</addr>
+        <hostname>par03s14-in-f14.1e100.net</hostname>
+        <asn>15169</asn>
+        <asname>Google Inc.</asname>
+        <country_code>US</country_code>
+        <country_name>United States</country_name>
+        <region_name>California</region_name>
+        <city_name>Mountain View</city_name>
+        <continent_code>NA</continent_code>
+        <continent_name>North America</continent_name>
+        <latitude>37.4192</latitude>
+        <longitude>-122.057</longitude>
+         </ip>
+        </details>
+        <detections>
+        <engines>
+         <engine>PhishTank</engine>
+        </engines>
+         <count>1</count>
+        </detections>
+        <page_load>0.00</page_load>
+        </response>
+    http_version:
+  recorded_at: Mon, 03 Aug 2015 02:02:23 GMT
+recorded_with: VCR 2.9.3

data/test/fixtures/stats_remain.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.urlvoid.com/api1000/testapikey/stats/remained/
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*; q=0.5, application/xml"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 03 Aug 2015 02:20:32 GMT
+      Content-Type:
+      - text/xml
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+    body:
+      encoding: UTF-8
+      string: |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <response>
+        <queriesRemained>995</queriesRemained>
+        <page_load>0.00</page_load>
+        </response>
+    http_version:
+  recorded_at: Mon, 03 Aug 2015 02:00:24 GMT
+recorded_with: VCR 2.9.3

data/test/host_test.rb

@@ -0,0 +1,26 @@
+require './test/test_helper'
+
+class URLVoidHostTest < Minitest::Test
+  def setup
+    @api_key = 'testapikey'
+  end
+
+  def test_class_exists
+    assert URLVoid::Host
+  end
+
+  def test_host_info_response
+    VCR.use_cassette('host') do
+      urlvoid_host_info = URLVoid::Host.info(@api_key, 'google.com')
+      assert urlvoid_host_info.response.is_a?(Hash)
+    end
+  end
+
+  def test_host_info_detections
+    VCR.use_cassette('host') do
+      urlvoid_host_info = URLVoid::Host.info(@api_key, 'google.com')
+      assert urlvoid_host_info.detections.is_a?(Hash)
+      assert urlvoid_host_info.detections['count'] == '1'
+    end
+  end
+end

data/test/stats_test.rb

@@ -0,0 +1,18 @@
+require './test/test_helper'
+
+class URLVoidStatsTest < Minitest::Test
+  def setup
+    @api_key = 'testapikey'
+  end
+
+  def test_class_exists
+    assert URLVoid::Stats
+  end
+
+  def test_queries_remain
+    VCR.use_cassette('stats_remain') do
+      urlvoid_stats = URLVoid::Stats.remaining_queries(@api_key)
+      assert urlvoid_stats.is_a?(Fixnum)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'urlvoid'
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'vcr'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'test/fixtures'
+  c.hook_into :webmock
+end

data/test/urlvoid_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class URLVoidTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::URLVoid::VERSION
+  end
+end

data/urlvoid.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'urlvoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'urlvoid'
+  spec.version     = URLVoid::VERSION
+  spec.authors     = ['pwelch']
+  spec.email       = ['paul@pwelch.net']
+
+  spec.summary     = 'Gem for URLVoid API.'
+  spec.description = 'Gem for URLVoid API.'
+  spec.homepage    = 'https://github.com/urlvoid'
+  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 'rest-client'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'nokogiri'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: urlvoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pwelch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for URLVoid API.
+email:
+- paul@pwelch.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/urlvoid.rb
+- lib/urlvoid/base.rb
+- lib/urlvoid/host.rb
+- lib/urlvoid/stats.rb
+- lib/urlvoid/version.rb
+- test/base_test.rb
+- test/fixtures/host.yml
+- test/fixtures/stats_remain.yml
+- test/host_test.rb
+- test/stats_test.rb
+- test/test_helper.rb
+- test/urlvoid_test.rb
+- urlvoid.gemspec
+homepage: https://github.com/urlvoid
+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.8
+signing_key: 
+specification_version: 4
+summary: Gem for URLVoid API.
+test_files:
+- test/base_test.rb
+- test/fixtures/host.yml
+- test/fixtures/stats_remain.yml
+- test/host_test.rb
+- test/stats_test.rb
+- test/test_helper.rb
+- test/urlvoid_test.rb