sonar-client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9e04adb9fca3c12bc9ae907eaa64df648c568ca6
+  data.tar.gz: f363d98148215460920438b61f5c0f025224bbdb
+SHA512:
+  metadata.gz: d80394c4745caba23f50df647c3b83ecfa0dccbbc76afe1986021f7f904e14bdf1d4a3c11b86ecee306e9ddc6247ff5b70aa3d48fad4213aea3aacaf5646c44a
+  data.tar.gz: 40263868a73f583575e963a2573a82a39b8e3c00ce0f37ba37d5f4c7ddda6c0d67fb17c98ecdb6dda8bc68fcdf71c10915fbcfd56945545496a9a71b1ab5ed58

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/cassette
+test/tmp
+test/version_tmp
+tmp
+
+# OSX
+.DS_Store
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Specific to RubyMotion
+.dat*
+.repl_history
+build/
+
+# 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,2 @@
+--color
+--format d

data/.rubocop.yml

@@ -0,0 +1,7 @@
+Style/StringLiterals:
+  Enabled: false
+  Description: 'Single quotes are preferred when string interpolation is not needed.'
+
+Metrics/LineLength:
+  Enabled: true
+  Max: 120

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sonar-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,94 @@
+PATH
+  remote: .
+  specs:
+    sonar-client (0.0.1)
+      awesome_print
+      faraday_middleware (~> 0.9.0)
+      hashie (~> 2.0.3)
+      multi_json
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.0)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.3.6)
+    api_matchers (0.5.1)
+      activesupport (>= 3.2.5)
+      nokogiri (>= 1.5.2)
+      rspec (>= 2.14)
+    awesome_print (1.6.1)
+    crack (0.4.2)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.9.1)
+      faraday (>= 0.7.4, < 0.10)
+    hashie (2.0.5)
+    i18n (0.7.0)
+    json (1.8.2)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.10.1)
+    multipart-post (2.0.0)
+    nokogiri (1.6.5)
+      mini_portile (~> 0.6.0)
+    rake (10.4.2)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    safe_yaml (1.0.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.7.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.9.1)
+      docile (~> 1.1.0)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    thor (0.19.1)
+    thread_safe (0.3.4)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    vcr (2.8.0)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.7.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_matchers
+  bundler
+  rake
+  rspec
+  shoulda
+  simplecov
+  simplecov-rcov
+  sonar-client!
+  vcr (~> 2.8.0)
+  webmock (~> 1.8.0)
+  yard

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rapid7, Inc.
+
+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,81 @@
+sonar-client
+===============
+
+Ruby API Wrapper and CLI for [Sonar](https://sonar.labs.rapid7.com)
+
+## Installation
+
+Install the gem by running
+
+    gem install sonar-client
+
+or add this line to your application's Gemfile:
+
+    gem 'sonar-client'
+
+And then execute:
+
+    $ bundle install
+
+## Gem usage
+
+```ruby
+    require 'sonar'
+
+    # If you're using Rails 3+, create an initializer
+    # config/initializers/sonar.rb
+    Sonar.configure do |config|
+      config.api_url        = 'https://sonar.labs.rapid7.com'
+      config.api_version    = 'v2'
+      config.email          = 'email@example.com'
+      config.access_token   = 'YOURTOKEN'
+    end
+
+    # If you're using straight ruby (no Rails),
+    # create a Sonar::Client Object
+    options = {
+      api_url: 'https://sonar.labs.rapid7.com',
+      api_version: 'v2',
+      access_token: 'YOURTOKEN',
+      email: 'email@example.com'
+    }
+    client = Sonar::Client.new(options)
+
+    # Create a Client Object expecting you have an initializer in place
+    # Sonar::Client Object
+    client = Sonar::Client.new
+
+    # Get fdns
+    client.search(fdns: 'rapid7.com')
+    # => responds with a Hashie object
+```
+
+## CLI dev setup
+
+From the project root directory
+```
+$ rake install
+sonar-client 0.0.1 built to pkg/sonar-client-0.0.1.gem.
+sonar-client (0.0.1) installed.
+$ sonar
+```
+
+On the first run, sonar will setup a sonar.rc config file in your user folder.  Run `sonar config` to view the full path to your config file.  Here's what your file will look like when it's first created:
+```
+email: YOUR_EMAIL
+access_token: SONAR_TOKEN
+api_url: https://sonar.labs.rapid7.com
+```
+Replace YOUR_EMAIL with the email you used to register on the [Sonar website](https://sonar.labs.rapid7.com).  Replace SONAR_TOKEN with your API token found on the [Settings page](https://sonar.labs.rapid7.com/users/edit) of the Sonar website.  Enclosing quotes around these two credentials are not needed.
+
+## CLI usage
+
+Typing `sonar help` will list all the available commands. You can type `sonar help TASK` to get help for a specific command.  If running locally from the root project directory, you may need to prefix `sonar` commands with `bundle exec`.  A rdns search command might look like `bundle exec sonar search rdns .rapid7.com`.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b feature/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 new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/sonar

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'bundler/setup'
+require 'sonar'
+
+begin
+  Sonar::CLI.start(ARGV)
+rescue Interrupt
+  puts 'Quitting...'
+end

data/lib/sonar/certificate.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module Sonar
+  module Certificate
+    ##
+    # Get certificate based on sha1 id
+    # /api/v2/certificates/1e80c24b97c928bb1db7d4d3c05475a6a40a1186
+    #
+    # @return [Hashie::Mash] with response of certificate
+    def get_certificate(options = {})
+      response = get("/api/#{Sonar.api_version}/certificates/#{options[:sha1]}", options)
+      response if response
+    end
+  end
+end

data/lib/sonar/cli/cli.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'thor'
+require 'sonar/cli/rcfile'
+require 'awesome_print'
+
+module Sonar
+  class CLI < Thor
+    class_option 'profile', aliases: '-P', type: :string, default: File.join(File.expand_path('~'), Sonar::RCFile::FILENAME),
+                            desc: 'Path to Sonar RC file', banner: 'FILE'
+
+    def initialize(*)
+      @rcfile = Sonar::RCFile.instance.load_file
+      @client = Sonar::Client.new(email: @rcfile["email"], access_token: @rcfile["access_token"], api_url: @rcfile["api_url"])
+      super
+    end
+
+    desc 'profile', 'Display the current profile from sonar.rc'
+    def profile
+      ap @rcfile
+    end
+
+    desc 'usage', 'Display API usage for current user.'
+    def usage
+      ap @client.usage
+    end
+
+    desc 'search [QUERY TYPE] [QUERY TERM]', 'Search anything from Sonar.'
+    def search(type, term)
+      @query = {}
+      @query[type.to_sym] = term
+      ap @client.search(@query)
+    end
+
+    desc 'types', 'List all Sonar query types.'
+    def types
+      ap Search::QUERY_TYPES_MAP
+    end
+
+    desc 'config', 'Update Sonar config file'
+    def config
+      # TODO: add a way to set config
+      puts "Your config file is located at #{RCFile.instance.path}"
+    end
+  end
+end

data/lib/sonar/cli/rcfile.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+require 'singleton'
+require 'yaml'
+
+module Sonar
+  class RCFile
+    include Singleton
+
+    attr_accessor :path
+    FILENAME = 'sonar.rc'
+
+    def initialize
+      @path = File.join(File.expand_path('~'), FILENAME)
+      @data = load_file
+    end
+
+    def create_file
+      File.open(@path, 'w') do |f|
+        f.puts 'email: YOUR_EMAIL'
+        f.puts 'access_token: SONAR_TOKEN'
+        f.puts 'api_url: https://sonar.labs.rapid7.com'
+      end
+      puts "Config file setup at: #{@path}"
+    end
+
+    def load_file
+      create_file unless File.exist?(@path)
+      YAML.load_file(@path)
+    end
+  end
+end

data/lib/sonar/client.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require 'forwardable'
+require 'sonar/request'
+require 'sonar/certificate'
+require 'sonar/search'
+require 'sonar/user'
+require 'sonar/cli/cli'
+
+module Sonar
+  class Client
+    extend Forwardable
+
+    include Request
+    include Certificate
+    include Search
+    include User
+
+    attr_accessor :api_url, :api_version, :access_token, :email
+
+    ##
+    # Create a new Sonar::Client object
+    #
+    # @params options[Hash]
+    def initialize(options = {})
+      @api_url        = options[:api_url]       || Sonar.api_url       || "https://sonar.labs.rapid7.com"
+      @api_version    = options[:api_version]   || Sonar.api_version   || "v2"
+      @access_token   = options[:access_token]  || Sonar.access_token
+      @email          = options[:email]         || Sonar.email
+    end
+
+    ##
+    # Create a Faraday::Connection object
+    #
+    # @return [Faraday::Connection]
+    def connection
+      params = {}
+      @conn = Faraday.new(url: api_url, params: params, headers: default_headers, ssl: { verify: true }) do |faraday|
+        faraday.use FaradayMiddleware::Mashify
+        faraday.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+        faraday.use FaradayMiddleware::FollowRedirects
+        faraday.adapter Faraday.default_adapter
+      end
+      @conn.headers['X-Sonar-Token'] = access_token
+      @conn.headers['X-Sonar-Email'] = email
+      @conn
+    end
+
+    ##
+    # Generic GET of Sonar search Objects
+    def get_search_endpoint(type, params = {})
+      url = "/api/#{api_version}/search/#{type}"
+      if params[:limit]
+        RequestIterator.new(url, connection, params)
+      else
+        get(url, params)
+      end
+    end
+
+    ##
+    # Generic GET of Sonar Objects
+    def get_endpoint(type, params = {})
+      url = "/api/#{api_version}/#{type}"
+      get(url, params)
+    end
+
+    ##
+    # Generic POST to Sonar
+    def post_to_sonar(type, params = {})
+      url = "/api/#{api_version}/#{type}"
+      post(url, params)
+    end
+
+    private
+
+    def default_headers
+      {
+        accept: 'application/json',
+        content_type: 'application/json',
+        user_agent: "Sonar #{Sonar::VERSION} Ruby Gem"
+      }
+    end
+  end
+end

data/lib/sonar/request.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+require 'multi_json'
+
+module Sonar
+  module Request
+    def extract_params(params)
+      # extract something from Sonar if needed
+      params
+    end
+
+    def get(path, options = {})
+      request(:get, path, options)
+    end
+
+    def post(path, options = {})
+      request(:post, path, options)
+    end
+
+    def put(path, options = {})
+      request(:put, path, options)
+    end
+
+    def request(method, path, options)
+      response = connection.send(method) do |request|
+        options.delete(:connection)
+        case method
+        when :get
+          request.url(path, options)
+        when :post, :put
+          request.path = path
+          request.body = MultiJson.encode(options) unless options.empty?
+        end
+      end
+
+      response.body
+    end
+
+    class RequestIterator
+      include Request
+
+      attr_accessor :url, :connection, :params
+
+      def initialize(url, connection, params = {})
+        self.url = url
+        self.connection = connection
+        self.params = params
+      end
+
+      def each
+        more = true
+        records_rcvd = 0
+        while more && records_rcvd < params[:limit]
+          # TODO: refactor to not pass around the connection
+          params[:connection] = connection
+          resp = get(url, params)
+          params[:iterator_id] = resp.iterator_id
+          records_rcvd += resp['collection'].size
+          more = resp['more']
+          yield resp
+        end
+      end
+    end
+  end
+end

data/lib/sonar/search.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+module Sonar
+  module Search
+    # Implemented search query types
+    QUERY_TYPES_MAP = {
+      'certificate' => 'Certificate lookup',
+      'certips'     => 'Certificate to IPs',
+      'rdns'        => 'IP to Reverse DNS Lookup or DNS Lookup to IP',
+      'fdns'        => 'Domains to IP or IPs to Domain',
+      'ipcerts'     => 'IP to Certificates',
+      'namecerts'   => 'Domain to Certificates',
+      'links_to'    => 'HTTP References to Domain',
+      'ports'       => 'Open Ports',
+      'processed'   => 'Open Ports (Processed)',
+      'raw'         => 'Open Ports (Raw)',
+      'sslcert'     => 'Certificate Details',
+      'whois_ip'    => 'Whois (IP)'
+    }
+
+    ##
+    # Get search
+    #
+    # params take in search type as key and query as value
+    # {fdns: 'rapid7.com'}
+    #
+    # @return [Hashie::Mash] with response of search
+    def search(params = {})
+      type_query = params.select { |k, _v| QUERY_TYPES_MAP.keys.include?(k.to_s) }.first
+      fail ArgumentError, "The query type provided is invalid or not yet implemented." unless type_query
+      type = type_query[0].to_sym
+      params[:q] = type_query[1]
+      params = extract_params(params)
+      get_search_endpoint(type, params)
+    end
+  end
+end

data/lib/sonar/user.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module Sonar
+  module User
+    def usage
+      get_search_endpoint("usage")
+    end
+  end
+end

data/lib/sonar/version.rb

@@ -0,0 +1,3 @@
+module Sonar
+  VERSION = "0.0.1"
+end

data/lib/sonar.rb

@@ -0,0 +1,28 @@
+require "faraday"
+require "faraday_middleware"
+require "sonar/cli/cli"
+require "sonar/client"
+require "sonar/version"
+
+module Sonar
+  class << self
+    attr_accessor :api_url, :api_version, :access_token, :email
+
+    ##
+    # Configure default
+    #
+    # @yield Sonar client object
+    def configure
+      load_defaults
+      yield self
+      true
+    end
+
+    private
+
+    def load_defaults
+      self.api_url ||= "https://sonar.labs.rapid7.com"
+      self.api_version ||= "v2"
+    end
+  end
+end

data/sonar-client.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sonar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sonar-client"
+  spec.version       = Sonar::VERSION
+  spec.authors       = ["Paul Deardorff & HD Moore"]
+  spec.email         = ["paul_deardorff@rapid7.com", "hd_moore@rapid7.com"]
+  spec.description   = 'API Wrapper for Sonar'
+  spec.summary       = spec.description
+  spec.homepage      = "https://sonar.labs.rapid7.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = ["sonar"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'faraday_middleware', '~> 0.9.0'
+  spec.add_dependency 'hashie', '~> 2.0.3'
+  spec.add_dependency 'multi_json'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'awesome_print'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov-rcov"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "vcr", '~> 2.8.0'
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "webmock", '~> 1.8.0'
+  spec.add_development_dependency "api_matchers"
+end

data/spec/fixtures/sonar.rc

@@ -0,0 +1,3 @@
+email: email@asdfasdfasfd.com
+access_token: asdfasdfasdfasdf
+api_url: https://sonar-staging.labs.rapid7.com/

data/spec/sonar/certificate_spec.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Sonar::Search do
+  let(:client) { Sonar::Client.new }
+
+  context "sha1 #get_certificate" do
+    it "should find the Rapid7 certificate by sha1" do
+      res = client.get_certificate(sha1: "1e80c24b97c928bb1db7d4d3c05475a6a40a1186")
+      expect(res.subject.CN).to eq("www.rapid7.com")
+    end
+  end
+end

data/spec/sonar/cli_spec.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Sonar::CLI do
+  context "with a valid profile" do
+    before do
+      Sonar::RCFile.instance.path = "#{fixtures_path}/sonar.rc"
+    end
+    it "should return the profile" do
+      output = capture(:stdout) { Sonar::CLI.start(['profile']) }
+      expect(output).to match(/email@asdfasdfasfd.com/)
+    end
+  end
+  context "without a config file" do
+    before do
+      Sonar::RCFile.instance.path = ""
+    end
+    xit "should create the missing config file" do
+    end
+  end
+end

data/spec/sonar/client_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Sonar::Client do
+  let(:client) { Sonar::Client.new }
+
+  it "creates a Faraday::Connection" do
+    expect(client.connection).to be_kind_of Faraday::Connection
+  end
+end

data/spec/sonar/search_spec.rb

@@ -0,0 +1,189 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Sonar::Search do
+  let(:client) { Sonar::Client.new }
+
+  describe "parameters" do
+    describe "query type" do
+      context "with an invalid query type" do
+        it "should raise an ArgumentError" do
+          expect { client.search(invalid: 'something.org') }.to raise_error(ArgumentError)
+        end
+      end
+    end
+
+    describe "exact" do
+      it "shouldn't match anything when #exact is true" do
+        resp = client.search(rdns: "1.1.", exact: true)
+        expect(resp["collection"].size).to eq(0)
+      end
+      it "should match when #exact is false" do
+        resp = client.search(rdns: "1.1.", exact: false)
+        expect(resp["collection"].first["address"]).to match(/^1.1./)
+      end
+    end
+
+    describe "limit" do
+      # The default size from APIv1/v2 is 1,000 records
+      context "specifying the :limit to 3000 on #search" do
+        let(:resp) { client.search(rdns: '.hp.com', limit: 3000) }
+
+        it "should return a RequestIterator" do
+          expect(resp.class).to eq(Sonar::Request::RequestIterator)
+        end
+        it "should return 3 x 1,000-record blocks" do
+          num_blocks = 0
+          resp.each do |resp_block|
+            expect(resp_block['collection'].size).to eq(1000)
+            num_blocks += 1
+          end
+          expect(num_blocks).to eq(3)
+        end
+      end
+    end
+  end
+
+  context "certificate" do
+    let(:resp) { client.search(certificate: '.hp.com') }
+
+    it "should provide certificate details" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  describe "rdns" do
+    context "rdnsname" do
+      let(:resp) { client.search(rdns: '208.118.227.10.rapid7.com') }
+
+      it "returns hashie response of search" do
+        expect(resp.class).to eq(Hashie::Mash)
+      end
+      it "rdnsname finds 208.118.227.10 for 208.118.227.10.rapid7.com" do
+        expect(resp['collection'].any? { |x| x['address'] == '208.118.227.10' }).to be(true)
+      end
+    end
+
+    context "rdnsip" do
+      let(:resp) { client.search(rdns: '188.40.56.11') }
+
+      it "rdnsip finds static.11.56.40.188.clients.your-server.de for 188.40.56.11" do
+        expect(resp['collection'].any? { |x| x['name'] == 'static.11.56.40.188.clients.your-server.de' }).to be(true)
+      end
+    end
+
+    context "validation" do
+      let(:resp) { client.search(rdns: '188.40.56.11@#&#') }
+
+      it "should error for invalid domain query type" do
+        expect(resp["error"]).to eq("Invalid query")
+        expect(resp["errors"].first).to eq("Expected a domain but got '188.40.56.11@#&#'")
+      end
+    end
+  end
+
+  describe "fdns" do
+    context "fdnsname" do
+      let(:resp) { client.search(fdns: 'rapid7.com') }
+
+      it "returns hashie response of search" do
+        expect(resp.class).to eq(Hashie::Mash)
+      end
+      it "finds fdnsname 208.118.227.10 for rapid7.com" do
+        expect(resp['collection'].any? { |x| x['address'] == '208.118.227.10' }).to be(true)
+      end
+    end
+
+    context "fdnsip" do
+      let(:resp) { client.search(fdns: '208.118.227.10') }
+
+      it "finds fdnsip rapid7.com at 208.118.227.10" do
+        expect(resp['collection'].any? { |x| x['address'] == 'rapid7.com' }).to be(true)
+      end
+    end
+
+    context "validation" do
+      let(:resp) { client.search(fdns: '188.40.56.11@#&#') }
+
+      it "should error for invalid domain query type" do
+        expect(resp["error"]).to eq("Invalid query")
+        expect(resp["errors"].first).to eq("Expected a domain but got '188.40.56.11@#&#'")
+      end
+    end
+  end
+
+  context "links_to" do
+    let(:resp) { client.search(links_to: 'rapid7.com') }
+
+    it "should provide links_to details" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  context "ipcerts" do
+    let(:resp) { client.search(ipcerts: '208.118.227.10') }
+
+    it "should provide ipcerts details" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  context "certips" do
+    let(:resp) { client.search(certips: '1e80c24b97c928bb1db7d4d3c05475a6a40a1186') }
+
+    it "should provide certips details" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  context "namecerts" do
+    let(:resp) { client.search(namecerts: '.rapid7.com') }
+
+    it "should provide namecerts details" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  context "sslcert" do
+    let(:resp) { client.search(sslcert: '1e80c24b97c928bb1db7d4d3c05475a6a40a1186') }
+
+    it "should provide sslcert details" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  context "whois_ip" do
+    let(:resp) { client.search(whois_ip: '208.118.227.10') }
+
+    it "should find rapid7.com" do
+      expect(resp['name']).to eq('TWDX-208-118-227-0-1')
+    end
+  end
+
+  # TODO: actually check response
+  context "raw" do
+    let(:resp) { client.search(raw: '208.118.227.10') }
+
+    it "should return a collection" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  # TODO: actually check response
+  context "processed" do
+    let(:resp) { client.search(processed: '208.118.227.10') }
+
+    it "should return a collection" do
+      expect(resp).to have_key('collection')
+    end
+  end
+
+  # TODO: actually check response
+  context "ports" do
+    let(:resp) { client.search(ports: '208.118.227.10') }
+
+    it "should return a collection" do
+      expect(resp).to have_key('collection')
+    end
+  end
+end

data/spec/sonar/user_spec.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Sonar::User do
+  let(:client) { Sonar::Client.new }
+
+  context "with a valid client querying usage" do
+    let(:res) { client.usage }
+
+    it "should show usage information for the user" do
+      expect(res.user.api_token).to_not be_nil
+      expect(res.current_api_hits).to be >= 0
+    end
+  end
+end

data/spec/sonar_spec.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require 'spec_helper'
+
+# Skip the configure in spec_helper so we can test defaults
+describe Sonar, skip_autoconfig: true do
+  let(:client) { Sonar::Client.new }
+  before :each do
+    reset_sonar_config
+  end
+
+  context "configure defaults" do
+    it "uses default API URL" do
+      expect(client.api_url).to eq 'https://sonar.labs.rapid7.com'
+    end
+    it "uses default API VERSION" do
+      expect(client.api_version).to eq 'v2'
+    end
+  end
+
+  context "handles custom configuration for url and version" do
+    let(:new_client) do
+      Sonar::Client.new(
+        api_url: 'https://somethingnew.com',
+        api_version: 'v1'
+      )
+    end
+
+    it "::Client API_URL configuration" do
+      expect(new_client.api_url).to eq 'https://somethingnew.com'
+    end
+    it "::Client API_VERSION configuration" do
+      expect(new_client.api_version).to eq 'v1'
+    end
+  end
+
+  context "when using a configure block and setting api_version" do
+    before do
+      Sonar.configure do |c|
+        c.api_version = "v3"
+      end
+    end
+
+    it "should have set the custom api_version" do
+      expect(Sonar.api_version).to eq("v3")
+    end
+    it "should use the default api_url" do
+      expect(Sonar.api_url).to eq("https://sonar.labs.rapid7.com")
+    end
+  end
+
+  context "when making a request to the client with bad creds" do
+    before do
+      Sonar.configure do |c|
+        c.email = "wrong@sowrong.com"
+        c.access_token = "somewrongkey"
+        c.api_version = "v2"
+        c.api_url = "https://sonar-staging.labs.rapid7.com"
+      end
+      client = Sonar::Client.new
+      @resp = client.search(rdns: "hp.com")
+    end
+
+    it "should return unauthorized" do
+      expect(@resp["error"]).to eq("Could not authenticate")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+require 'sonar'
+require 'active_support'
+require 'vcr'
+require 'simplecov'
+require 'simplecov-rcov'
+require 'api_matchers'
+
+class SimpleCov::Formatter::MergedFormatter
+  def format(result)
+    SimpleCov::Formatter::HTMLFormatter.new.format(result)
+    SimpleCov::Formatter::RcovFormatter.new.format(result)
+  end
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+SimpleCov.start do
+  add_filter '/vendor'
+end
+
+VCR.configure do |c|
+  c.allow_http_connections_when_no_cassette = true
+  c.cassette_library_dir = 'spec/cassette'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+  c.default_cassette_options = { record: :new_episodes }
+end
+
+RSpec.configure do |c|
+  c.include APIMatchers::RSpecMatchers
+
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+
+  #
+  # Add gem specific configuration for easy access
+  #
+  c.before(:each) do
+    # TODO: move to using a gem like VCR for faking HTTP requests.
+    # For now we'll test against the staging server using
+    # real creds stored in env.
+    Sonar.configure do |config|
+      unless ENV['SONAR_TOKEN'] && ENV['SONAR_EMAIL']
+        fail ArgumentError, "Please configure Sonar for testing by setting SONAR_TOKEN, SONAR_EMAIL,
+          and SONAR_API_URL in your environment."
+      end
+      config.api_url          = ENV['SONAR_API_URL'] || 'http://localhost:3000'
+      config.api_version      = 'v2'
+      config.access_token     = ENV['SONAR_TOKEN']
+      config.email            = ENV['SONAR_EMAIL']
+    end
+  end
+end
+
+def fixtures_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def reset_sonar_config
+  Sonar.api_version = nil
+  Sonar.api_url = nil
+end

metadata

@@ -0,0 +1,292 @@
+--- !ruby/object:Gem::Specification
+name: sonar-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Deardorff & HD Moore
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  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: thor
+  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: awesome_print
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: simplecov
+  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: simplecov-rcov
+  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: yard
+  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: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: api_matchers
+  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: API Wrapper for Sonar
+email:
+- paul_deardorff@rapid7.com
+- hd_moore@rapid7.com
+executables:
+- sonar
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/sonar
+- lib/sonar.rb
+- lib/sonar/certificate.rb
+- lib/sonar/cli/cli.rb
+- lib/sonar/cli/rcfile.rb
+- lib/sonar/client.rb
+- lib/sonar/request.rb
+- lib/sonar/search.rb
+- lib/sonar/user.rb
+- lib/sonar/version.rb
+- sonar-client.gemspec
+- spec/fixtures/sonar.rc
+- spec/sonar/certificate_spec.rb
+- spec/sonar/cli_spec.rb
+- spec/sonar/client_spec.rb
+- spec/sonar/search_spec.rb
+- spec/sonar/user_spec.rb
+- spec/sonar_spec.rb
+- spec/spec_helper.rb
+homepage: https://sonar.labs.rapid7.com
+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.3
+signing_key: 
+specification_version: 4
+summary: API Wrapper for Sonar
+test_files:
+- spec/fixtures/sonar.rc
+- spec/sonar/certificate_spec.rb
+- spec/sonar/cli_spec.rb
+- spec/sonar/client_spec.rb
+- spec/sonar/search_spec.rb
+- spec/sonar/user_spec.rb
+- spec/sonar_spec.rb
+- spec/spec_helper.rb
+has_rdoc: