dnstwister 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac91ca3ea81c0ec360b524cc74b6db69e45a3641916b266a2bb562c213e452a4
+  data.tar.gz: a4f9b6079e9117c69ebbcf6606a393f349e24dd6af8111e7b65eb4f9d1c2fd66
+SHA512:
+  metadata.gz: 20c7ceb669157c2b998d053d31365a2d75a924bca30d5fb0c0ee55602be74afe331957c9c7e97ab65534c56adefa72defe0a3898ddff0de67106ccdb9a46b065
+  data.tar.gz: 6636fe06803425f569bbcd477ff950ef025941517509546da6744b77231a6e8a83d11ebdba3659fed339f89cbdc7350dffdff28eaa6c026d435229519e961fea

data/.gitignore

@@ -0,0 +1,58 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+.env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+.rubocop-https?--*
+
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in DNSTwister.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Manabu Niseki
+
+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,37 @@
+# dnstwister
+
+[![Build Status](https://travis-ci.com/ninoseki/dnstwister.svg?branch=master)](https://travis-ci.com/ninoseki/dnstwister)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/dnstwister/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/dnstwister?branch=master)
+[![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/dnstwister/badge)](https://www.codefactor.io/repository/github/ninoseki/dnstwister)
+
+[dnstwister](https://dnstwister.report/) API wrapper for Ruby.
+
+## Installation
+
+```bash
+gem install dnstwister
+```
+
+## Usage
+
+```ruby
+require "dnstwister"
+
+api = DNSTwister::API.new
+
+domain = "example.com"
+
+res = api.fuzz(domain)
+fuzzy_doamins = res.dig("fuzzy_domains") || []
+p fuzzy_domains.map { |domain| domain.dig "domain" }
+# => ["example.com", "examplea.com", "exampleb.com", "examplec.com", "exampled.com", ...]
+
+api.safebrowsing domain
+api.ip domain
+api.parked domain
+api.whois domain
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "DNSTwister"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dnstwister.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dnstwister/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dnstwister"
+  spec.version       = DNSTwister::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "dnstwister API wrapper for Ruby"
+  spec.description   = "dnstwister API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/dnstwister"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "vcr", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 3.7"
+end

data/lib/dnstwister.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "dnstwister/version"
+
+require "dnstwister/base"
+require "dnstwister/api"
+
+module DNSTwister
+  class Error < StandardError; end
+end

data/lib/dnstwister/api.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module DNSTwister
+  class API < Base
+    #
+    # Calculates the dnstwist "fuzzy domains" for a domain
+    #
+    # @param [String] domain
+    #
+    # @return [Hash]
+    #
+    def fuzz(domain)
+      _get("/api/fuzz/#{to_hex(domain)}") { |json| json }
+    end
+
+    #
+    # Returns number of hits in Google Safe Browsing
+    #
+    # @param [String] domain
+    #
+    # @return [Hash]
+    #
+    def safebrowsing(domain)
+      _get("/api/safebrowsing/#{to_hex(domain)}") { |json| json }
+    end
+
+    #
+    # Resolves Domains to IPs
+    #
+    # @param [String] domain
+    #
+    # @return [Hash]
+    #
+    def ip(domain)
+      _get("/api/ip/#{to_hex(domain)}") { |json| json }
+    end
+
+    #
+    # Calculates "parked" scores from 0-1
+    #
+    # @param [String] domain
+    #
+    # @return [Hash]
+    #
+    def parked(domain)
+      _get("/api/parked/#{to_hex(domain)}") { |json| json }
+    end
+
+    #
+    # Calculates the dnstwist "fuzzy domains" for a domain.
+    #
+    # @param [String] domain
+    #
+    # @return [Hash]
+    #
+    def whois(domain)
+      _get("/api/whois/#{to_hex(domain)}") { |json| json }
+    end
+
+    private
+
+    #
+    # Converts string to hex
+    #
+    # @param [String] str String
+    #
+    # @return [String] Hex
+    #
+    def to_hex(str)
+      str.each_byte.map { |b| b.to_s(16) }.join
+    end
+  end
+end

data/lib/dnstwister/base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "json"
+require "net/https"
+require "uri"
+
+module DNSTwister
+  class Base
+    HOST = "dnstwister.report"
+    BASE_URL = "https://#{HOST}"
+
+    private
+
+    def url_for(path)
+      URI(BASE_URL + path)
+    end
+
+    def https_options
+      if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+        uri = URI(proxy)
+        {
+          proxy_address: uri.hostname,
+          proxy_port: uri.port,
+          proxy_from_env: false,
+          use_ssl: true
+        }
+      else
+        { use_ssl: true }
+      end
+    end
+
+    def make_request(req)
+      Net::HTTP.start(HOST, 443, https_options) do |http|
+        response = http.request(req)
+
+        code = response.code.to_i
+        body = response.body
+        json = JSON.parse(body)
+
+        case code
+        when 200
+          yield json
+        else
+          raise Error, "Unsupported response code returned: #{code}"
+        end
+      end
+    end
+
+    def build_request(type: "GET", path:, params: {})
+      uri = url_for(path)
+      uri.query = URI.encode_www_form(params) if type == "GET"
+
+      request = case type
+                when "GET"
+                  Net::HTTP::Get.new(uri)
+                else
+                  raise ArgumentError, "#{type} HTTP method is not supported"
+                end
+      request
+    end
+
+    def _get(path, params = {}, &block)
+      request = build_request(type: "GET", path: path, params: params)
+      make_request(request, &block)
+    end
+  end
+end

data/lib/dnstwister/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DNSTwister
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: dnstwister
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: dnstwister API wrapper for Ruby
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dnstwister.gemspec
+- lib/dnstwister.rb
+- lib/dnstwister/api.rb
+- lib/dnstwister/base.rb
+- lib/dnstwister/version.rb
+homepage: https://github.com/ninoseki/dnstwister
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: dnstwister API wrapper for Ruby
+test_files: []