threatinator 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9b3ddb0e013a94d6675ff6f56a67f6fe5a30c3b
-  data.tar.gz: 0f502d65e4235795d0d4cf1a8874a31d9321e49e
+  metadata.gz: 9094ef4d662acb87c6f8425a90700527449fa7e6
+  data.tar.gz: ed120159fc6800df5902e105634c006844707f31
 SHA512:
-  metadata.gz: 9772c07ba057684f6814f984a8fd397a52266e78642b9faf1e2ffdb63e365b1f6ff6d6a80c9fac7253ab812a55656a66da46aee50d3ab9c7b4ac1556049d9ecf
-  data.tar.gz: 91aa0d43d7150bc5b36d45922b560a7486c2690c82825146beeeed5980730a92d3bc17b059743aaadfc305727e225a74ecb56dfc01ba758856b1b28b23af8c49
+  metadata.gz: c98dc47be2f5aabc58a776af93401cd1b01ef380216992fd9310794f08c21e63a03b212081ce1cd64e50b25022c7d8ea61a87fb693b76b8795200745b5a92c3c
+  data.tar.gz: a8a459c5103636ba1c45c500bafb650162145ef01897148a5c54e6e4e9db4f7960de94868159e91964cccd5042607b3b554096f4c1c35e74cf4fa59b534b9b7d

data/CHANGELOG.md

@@ -3,6 +3,11 @@ Next
 
 * Your contribution here.
 
+0.1.6
+====
+
+* Add JSON support: 'threatinator list --list.format=json'  - [@justfalter](https://github.com/justfalter)
+
 0.1.5
 ====
 

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

data/lib/threatinator/actions/list/action.rb

@@ -1,6 +1,7 @@
 require 'threatinator/action'
 require 'threatinator/exceptions'
 require 'csv'
+require 'multi_json'
 
 module Threatinator
   module Actions
@@ -11,8 +12,7 @@ module Threatinator
           @config = config
         end
 
-        def exec
-          io_out = $stdout
+        def output_table(io_out)
           feed_info = [['provider', 'name', 'type', 'link/path']]
           registry.each do |feed|
             info = [ feed.provider, feed.name ]
@@ -47,6 +47,40 @@ module Threatinator
           io_out.printf(fmt, *sep)
           io_out.puts("Total: #{feed_info.count}")
         end
+
+        def output_json(io_out)
+          feeds = []
+          registry.each do |feed|
+            info = {
+              provider: feed.provider,
+              name: feed.name,
+              type: 'unknown',
+              link: 'unknown'
+            }
+            fetcher = feed.fetcher_builder.call()
+            case fetcher
+            when Threatinator::Fetchers::Http
+              info[:type] = "http"
+              info[:link] = fetcher.url
+            end
+
+            feeds << info
+          end
+          feeds.sort! { |a,b| [a[:provider], a[:name]] <=> [b[:provider], b[:name]] }
+
+          io_out.write(MultiJson.dump(feeds))
+        end
+
+        def exec
+          case @config.format
+          when 'table'
+            output_table($stdout)
+          when 'json'
+            output_json($stdout)
+          else
+            raise ArgumentError, "Invalid argument for 'format' = '#{@config.format}'"
+          end
+        end
       end
     end
   end

data/lib/threatinator/actions/list/config.rb

@@ -4,6 +4,8 @@ module Threatinator
   module Actions
     module List
       class Config < Threatinator::Config::Base
+        attribute :format, String, default: lambda { |c,a| 'table' },
+          description: "The format in which to generate output: 'table' (default), 'json'"
       end
     end
   end

data/spec/threatinator/actions/list/action_spec.rb

@@ -1,93 +1,146 @@
 require 'spec_helper'
 require 'threatinator/actions/list/action'
 require 'threatinator/actions/list/config'
+require 'multi_json'
 
 describe Threatinator::Actions::List::Action do
   let(:feed_registry) { build(:feed_registry) }
   let(:config) { Threatinator::Actions::List::Config.new }
   let(:action) { described_class.new(feed_registry, config) }
 
-  describe "the header row, header separator, and footer separator" do
-    it "should vary the width of 'provider' based on the longest provider name" do
-      feed_registry.register(build(:feed, :mini, provider: 'A' * 10))
-      feed_registry.register(build(:feed, :mini, provider: 'A' * 20))
-      feed_registry.register(build(:feed, :mini, provider: 'A' * 30))
+  shared_examples_for 'table output' do
+    describe "the header row, header separator, and footer separator" do
+      it "should vary the width of 'provider' based on the longest provider name" do
+        1.upto(3) do |i|
+          feed_registry.register(build(:feed, :http, url: "http://#{i}", name:i.to_s, provider: ('A' * (10 * i))))
+        end
 
-      output = temp_stdout do
-        action.exec
+        output = temp_stdout do
+          action.exec
+        end
+        lines = output.lines.to_a
+        expect(lines[0]).to eq("provider                        name  type  link/path\n")
+        expect(lines[1]).to eq("------------------------------  ----  ----  ---------\n")
+        expect(lines[-2]).to eq("------------------------------  ----  ----  ---------\n")
+      end
+
+      it "should vary the width of 'name' based on the longest feed name" do
+        1.upto(3) do |i|
+          feed_registry.register(build(:feed, :http, url: "http://#{i}", provider:i.to_s, name: ('A' * (10 * i))))
+        end
+
+        output = temp_stdout do
+          action.exec
+        end
+        lines = output.lines.to_a
+        expect(lines[0]).to eq("provider  name                            type  link/path\n")
+        expect(lines[1]).to eq("--------  ------------------------------  ----  ---------\n")
+        expect(lines[-2]).to eq("--------  ------------------------------  ----  ---------\n")
       end
-      lines = output.lines.to_a
-      expect(lines[0]).to eq("provider                        name  type  link/path\n")
-      expect(lines[1]).to eq("------------------------------  ----  ----  ---------\n")
-      expect(lines[-2]).to eq("------------------------------  ----  ----  ---------\n")
-    end
 
-    it "should vary the width of 'name' based on the longest feed name" do
-      feed_registry.register(build(:feed, :mini, name: 'A' * 10))
-      feed_registry.register(build(:feed, :mini, name: 'A' * 20))
-      feed_registry.register(build(:feed, :mini, name: 'A' * 30))
+      it "should vary the width of 'link/path' based on the longest link name" do
+        1.upto(3) do |i|
+          feed_registry.register(build(:feed, :http, url: 'http://' + ('A' * (i * 10)), provider:i.to_s,name:i.to_s))
+        end
 
-      output = temp_stdout do
-        action.exec
+        output = temp_stdout do
+          action.exec
+        end
+        lines = output.lines.to_a
+        expect(lines[0]).to eq("provider  name  type  link/path                            \n")
+        expect(lines[1]).to eq("--------  ----  ----  -------------------------------------\n")
+        expect(lines[-2]).to eq("--------  ----  ----  -------------------------------------\n")
       end
-      lines = output.lines.to_a
-      expect(lines[0]).to eq("provider  name                            type  link/path\n")
-      expect(lines[1]).to eq("--------  ------------------------------  ----  ---------\n")
-      expect(lines[-2]).to eq("--------  ------------------------------  ----  ---------\n")
     end
 
-    it "should vary the width of 'link/path' based on the longest link name" do
-      feed_registry.register(build(:feed, :mini, url: 'http://' + ('A' * 10)))
-      feed_registry.register(build(:feed, :mini, url: 'http://' + ('A' * 20)))
-      feed_registry.register(build(:feed, :mini, url: 'http://' + ('A' * 30)))
+    describe "the list of feeds" do
+      it "should be sorted by provider name and then feed name" do
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_c' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_d' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_a' ))
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_d' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_c' ))
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_a' ))
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_b' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_b' ))
 
-      output = temp_stdout do
-        action.exec
+        output = temp_stdout do
+          action.exec
+        end
+        lines = output.lines.to_a
+        expect(lines[2]).to match(/^provider_a  feed_a  .*$/)
+        expect(lines[3]).to match(/^provider_a  feed_b  .*$/)
+        expect(lines[4]).to match(/^provider_a  feed_c  .*$/)
+        expect(lines[5]).to match(/^provider_a  feed_d  .*$/)
+        expect(lines[6]).to match(/^provider_b  feed_a  .*$/)
+        expect(lines[7]).to match(/^provider_b  feed_b  .*$/)
+        expect(lines[8]).to match(/^provider_b  feed_c  .*$/)
+        expect(lines[9]).to match(/^provider_b  feed_d  .*$/)
       end
-      lines = output.lines.to_a
-      expect(lines[0]).to eq("provider  name  type  link/path                            \n")
-      expect(lines[1]).to eq("--------  ----  ----  -------------------------------------\n")
-      expect(lines[-2]).to eq("--------  ----  ----  -------------------------------------\n")
     end
-  end
 
-  describe "the list of feeds" do
-    it "should be sorted by provider name and then feed name" do
-      feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_c' ))
-      feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_d' ))
-      feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_a' ))
-      feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_d' ))
-      feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_c' ))
-      feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_a' ))
-      feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_b' ))
-      feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_b' ))
-
-      output = temp_stdout do
-        action.exec
+    describe "the footer" do
+      it "should indicate the number of feeds" do
+        20.times do |i|
+          feed_registry.register(build(:feed))
+        end
+        output = temp_stdout do
+          action.exec
+        end
+        lines = output.lines.to_a
+        expect(lines[-1]).to eq("Total: 20\n")
       end
-      lines = output.lines.to_a
-      expect(lines[2]).to match(/^provider_a  feed_a  .*$/)
-      expect(lines[3]).to match(/^provider_a  feed_b  .*$/)
-      expect(lines[4]).to match(/^provider_a  feed_c  .*$/)
-      expect(lines[5]).to match(/^provider_a  feed_d  .*$/)
-      expect(lines[6]).to match(/^provider_b  feed_a  .*$/)
-      expect(lines[7]).to match(/^provider_b  feed_b  .*$/)
-      expect(lines[8]).to match(/^provider_b  feed_c  .*$/)
-      expect(lines[9]).to match(/^provider_b  feed_d  .*$/)
     end
   end
 
-  describe "the footer" do
-    it "should indicate the number of feeds" do
-      20.times do |i|
-        feed_registry.register(build(:feed))
-      end
-      output = temp_stdout do
-        action.exec
+  shared_examples_for 'json output' do
+    describe "the output" do
+      it "should be sorted by provider name and then feed name" do
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_c' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_d' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_a' ))
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_d' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_c' ))
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_a' ))
+        feed_registry.register(build(:feed, provider: 'provider_b', name: 'feed_b' ))
+        feed_registry.register(build(:feed, provider: 'provider_a', name: 'feed_b' ))
+
+        output = temp_stdout do
+          action.exec
+        end
+
+        data = MultiJson.load(output)
+        expect(data).to match(
+          [
+            {'provider' => 'provider_a', 'name' => 'feed_a', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_a', 'name' => 'feed_b', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_a', 'name' => 'feed_c', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_a', 'name' => 'feed_d', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_b', 'name' => 'feed_a', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_b', 'name' => 'feed_b', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_b', 'name' => 'feed_c', 'type' => kind_of(String), 'link' => kind_of(String)},
+            {'provider' => 'provider_b', 'name' => 'feed_d', 'type' => kind_of(String), 'link' => kind_of(String)}
+          ]
+        )
       end
-      lines = output.lines.to_a
-      expect(lines[-1]).to eq("Total: 20\n")
     end
   end
 
+  context "when list.format is not set" do
+    it_behaves_like 'table output'
+  end
+  context "when list.format == 'table'" do
+    before :each do
+      config.format = 'table'
+    end
+    it_behaves_like 'table output'
+  end
+
+  context "when list.format == 'json'" do
+    before :each do
+      config.format = 'json'
+    end
+    it_behaves_like 'json output'
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: threatinator
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mike Ryan
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-02 00:00:00.000000000 Z
+date: 2014-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus