securitytrails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 261c6c00d23d6df4749ada457317fadaeb83fc1bbea5aba1fc1e028f1ec6ea03
+  data.tar.gz: 44f57b73d27c6eba24cf25494d210ffd1245223abc1575a33b13f11a0bfd2f5b
+SHA512:
+  metadata.gz: 5134e81d04585fcba97b0453e10cfeaa31d10443ae97878b8e1f6ef0e19db77c7b7527bc11938c3fd6747648a2e14e43a8ae383bedb6ee318cf4610684224af5
+  data.tar.gz: 7b9e4405bc2d2412db7d66dcfb07680df402ebd52f4223ddbb279224b027f311c5ab018e45e732cf1c8a707aa478a47bdd2279dc94d60a9e18795d51217ca7d2

data/.gitignore

@@ -0,0 +1,50 @@
+*.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
+
+## 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

data/.rspec

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

data/.rspec_status

@@ -0,0 +1,16 @@
+example_id                            | status | run_time        |
+------------------------------------- | ------ | --------------- |
+./spec/clients/domain_spec.rb[1:1:1]  | passed | 0.00564 seconds |
+./spec/clients/domain_spec.rb[1:2:1]  | passed | 0.00746 seconds |
+./spec/clients/domain_spec.rb[1:3:1]  | passed | 0.00589 seconds |
+./spec/clients/domain_spec.rb[1:4:1]  | passed | 0.00717 seconds |
+./spec/clients/domain_spec.rb[1:5:1]  | passed | 0.00577 seconds |
+./spec/clients/domains_spec.rb[1:1:1] | passed | 0.00811 seconds |
+./spec/clients/domains_spec.rb[1:2:1] | passed | 0.00705 seconds |
+./spec/clients/history_spec.rb[1:1:1] | passed | 0.00653 seconds |
+./spec/clients/history_spec.rb[1:2:1] | passed | 0.04772 seconds |
+./spec/clients/history_spec.rb[1:3:1] | passed | 0.00545 seconds |
+./spec/clients/ips_spec.rb[1:1:1]     | passed | 0.00531 seconds |
+./spec/clients/ips_spec.rb[1:2:1]     | passed | 0.00507 seconds |
+./spec/clients/ips_spec.rb[1:3:1]     | passed | 0.00484 seconds |
+./spec/securitytrails_spec.rb[1:1]    | passed | 0.00085 seconds |

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in securitytrails.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 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,75 @@
+# SecurityTrails
+
+[![Build Status](https://travis-ci.org/ninoseki/securitytrails.svg?branch=master)](https://travis-ci.org/ninoseki/securitytrails)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/797d576993224ddb9fdd54280417812b)](https://www.codacy.com/app/ninoseki/securitytrails?utm_source=github.com&utm_medium=referral&utm_content=ninoseki/securitytrails&utm_campaign=Badge_Grade)
+[![Coverage Status](https://coveralls.io/repos/github/ninoseki/securitytrails/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/securitytrails?branch=master)
+
+[SecurityTrails](https://securitytrails.com) API wrapper for Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'securitytrails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install securitytrails
+
+## Usage
+
+```ruby
+require "securitytrails"
+
+# When given nothing, it tries to load your API key from ENV["SECURITYTRAILS_API_KEY"]
+api = SecurityTrails::API.new
+# or you can pass your API key as an argument
+api = SecurityTrails::API.new(YOUR_API_KEY)
+
+# Domain details
+# https://docs.securitytrails.com/v1.0/reference#domains
+api.domain.get_by_hostname("github.com")
+api.domain.get_subdomains("github.com")
+api.domain.get_tags("github.com")
+api.domain.get_associated_domains("github.com")
+api.domain.get_whois("github.com")
+
+# Domain search
+# https://docs.securitytrails.com/v1.0/reference#domain-search
+api.domains.search(
+    filter: {
+        ipv4: "1.1.1.1"
+})
+api.domains.stats(
+    filter: {
+        ipv4: "1.1.1.1"
+    }
+)
+
+# History
+# https://docs.securitytrails.com/v1.0/reference#history
+api.history.get_dns_history("github.com", "a")
+api.history.get_all_dns_history("github.com", "a")
+api.history.get_whois_history("github.com")
+
+
+# IPs
+# https://docs.securitytrails.com/v1.0/reference#ips
+api.ips.explore("8.8.8.8")
+api.ips.search("ptr_part = 'ns1'")
+api.ips.stats("ptr_part = 'amazon.com'")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/securitytrails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "securitytrails"
+
+# 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/lib/securitytrails.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "securitytrails/version"
+
+require "securitytrails/api"
+require "securitytrails/client"
+
+require "securitytrails/clients/domain"
+require "securitytrails/clients/domains"
+require "securitytrails/clients/history"
+require "securitytrails/clients/ips"
+
+module SecurityTrails
+  class Error < StandardError; end
+end

data/lib/securitytrails/api.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SecurityTrails
+  class API
+    attr_reader :domain
+    attr_reader :domains
+    attr_reader :history
+    attr_reader :ips
+
+    def initialize(api_key = ENV["SECURITYTRAILS_API_KEY"])
+      raise(ArgumentError, "'api_key' argument is required") unless api_key
+
+      @domain   = Clients::Domain.new(api_key)
+      @domains  = Clients::Domains.new(api_key)
+      @history  = Clients::History.new(api_key)
+      @ips      = Clients::IPs.new(api_key)
+    end
+  end
+end

data/lib/securitytrails/client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "net/https"
+
+module SecurityTrails
+  class Client
+    attr_reader :api_key
+
+    HOST = "api.securitytrails.com"
+    VERSION = 1
+    URL = "https://#{HOST}/v#{VERSION}"
+
+    def initialize(api_key)
+      @api_key = api_key
+    end
+
+    private
+
+    def url_for(path)
+      URI(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 request(req)
+      Net::HTTP.start(HOST, 443, https_options) do |http|
+        response = http.request(req)
+        if response.code == '200'
+          yield JSON.parse(response.body)
+        else
+          raise(Error, "unsupported response code returned: #{response.code}")
+        end
+      end
+    end
+
+    def get(path, params = {}, &block)
+      url = url_for(path)
+      params["apikey"] = api_key
+      url.query = URI.encode_www_form(params)
+
+      get = Net::HTTP::Get.new(url)
+      request(get, &block)
+    end
+
+    def post(path, params = {}, &block)
+      url = url_for(path)
+      url.query = "apikey=#{api_key}"
+
+      post = Net::HTTP::Post.new(url)
+      post.body = params.is_a?(Hash) ? params.to_json : params.to_s
+      request(post, &block)
+    end
+  end
+end

data/lib/securitytrails/clients/domain.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module SecurityTrails
+  module Clients
+    class Domain < Client
+      def get_by_hostname(hostname)
+        get("/domain/#{hostname}") { |json| json }
+      end
+
+      def get_subdomains(hostname)
+        get("/domain/#{hostname}/subdomains") { |json| json }
+      end
+
+      def get_tags(hostname)
+        get("/domain/#{hostname}/tags") { |json| json }
+      end
+
+      def get_associated_domains(hostname)
+        get("/domain/#{hostname}/associated") { |json| json }
+      end
+
+      def get_whois(hostname)
+        get("/domain/#{hostname}/whois") { |json| json }
+      end
+    end
+  end
+end

data/lib/securitytrails/clients/domains.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SecurityTrails
+  module Clients
+    class Domains < Client
+      def search(params)
+        post("/domains/list", params) { |json| json }
+      end
+
+      def stats(params)
+        post("/domains/stats", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/securitytrails/clients/history.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module SecurityTrails
+  module Clients
+    class History < Client
+      def get_dns_history(hostname, type, page = 1)
+        get("/history/#{hostname}/dns/#{type.downcase}", page: page) { |json| json }
+      end
+
+      def get_all_dns_history(hostname, type)
+        first_page = get_dns_history(hostname, type, 1)
+        pages = first_page["pages"].to_i
+
+        records = []
+        records << first_page["records"]
+
+        (2..pages).each do |page_idx|
+          next_page = get_dns_history(hostname, type, page_idx)
+          records << next_page["records"]
+        end
+
+        first_page["records"] = records.flatten
+        first_page
+      end
+
+      def get_whois_history(hostname)
+        get("/history/#{hostname}/whois/") { |json| json }
+      end
+    end
+  end
+end

data/lib/securitytrails/clients/ips.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module SecurityTrails
+  module Clients
+    class IPs < Client
+      def explore(ipaddress)
+        get("/ips/nearby/#{ipaddress}") { |json| json }
+      end
+
+      def search(query)
+        post("/ips/list", query: query) { |json| json }
+      end
+
+      def stats(query)
+        post("/ips/stats", query: query) { |json| json }
+      end
+    end
+  end
+end

data/lib/securitytrails/version.rb

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

data/securitytrails.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "securitytrails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "securitytrails"
+  spec.version       = SecurityTrails::VERSION
+  spec.authors       = ["Manabu Niseki"]
+  spec.email         = ["manabu.niseki@gmail.com"]
+
+  spec.summary       = "SecurityTrails API wrapper for Ruby"
+  spec.description   = "SecurityTrails API wrapper for Ruby"
+  spec.homepage      = "https://github.com/ninoseki/securitytrails"
+  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", "~> 1.17"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "dotenv", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 4.0"
+  spec.add_development_dependency "webmock", "~> 3.4"
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: securitytrails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Manabu Niseki
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: SecurityTrails API wrapper for Ruby
+email:
+- manabu.niseki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rspec_status"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/securitytrails.rb
+- lib/securitytrails/api.rb
+- lib/securitytrails/client.rb
+- lib/securitytrails/clients/domain.rb
+- lib/securitytrails/clients/domains.rb
+- lib/securitytrails/clients/history.rb
+- lib/securitytrails/clients/ips.rb
+- lib/securitytrails/version.rb
+- securitytrails.gemspec
+homepage: https://github.com/ninoseki/securitytrails
+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.7.6
+signing_key: 
+specification_version: 4
+summary: SecurityTrails API wrapper for Ruby
+test_files: []