ruby-taxii2 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59094f4d94c54c1468ac70bb38ed293f0d7faa99b4626d409742060c48b0bd74
-  data.tar.gz: c7d004ebbb8774848c1874db3ebc93f4f27eccc5662193d9ed5c0e2cb3872c40
+  metadata.gz: 63e72e43df228b51f6e48e1dce072dd46b5ea9b78a21976e15652db519cb0bfb
+  data.tar.gz: 1087dc2974412eee95183b7ad4cad21b2368fc0125216c717a53b3bb0754aaf7
 SHA512:
-  metadata.gz: 325da7bd11690bf0837a17809526cd051c3482dbae094af1740b2561b0a5492809ea51ff093f568d63eba48a196eb363b5d56491b50bdde7de2a025f2a852d0b
-  data.tar.gz: 7ab0a2f04941f2884c9c5a3100b4991f414b37e84f3a6d6aaf1733d3ccaeafe2f9399a54cbfc1e80e42f9eea670db8695ec740d854310ad02b90cd7408cd11b6
+  metadata.gz: 20c9964fd2ef313301bb39011b997e7ae48047fba14c1de0d87aacc4abb5e4fddc6360d332abed47eeaad6a342a4d5fb263d76d496bcf4561eb2e277709dfe34
+  data.tar.gz: 8006a381beb5cdd27a967d630323b999b07fe7c163382c80bafc90745614bccb5acb38c85e3b9c45a8a9b92c638e98c1f7d6b8ddb6099fa7a933940e3d5b61d8

data/.github/workflows/rspec.yml

@@ -12,6 +12,7 @@ jobs:
         os: [ubuntu-latest, windows-latest]
         ruby: ['2.7', '3.0', '3.1', head]
     runs-on: ${{ matrix.os }}
+    permissions: write-all
     steps:
     - uses: actions/checkout@v3
     - name: Set up Ruby
@@ -21,4 +22,10 @@ jobs:
         bundler: latest
     - run: bundle
     - run: bundle exec rspec
+    - name: SimpleCov Ruby ${{ matrix.ruby }}
+      uses: joshmfrankel/simplecov-check-action@main
+      if: ${{ matrix.os == 'ubuntu-latest' && matrix.ruby == '3.1' }}
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        check_job_name: SimpleCov ${{ matrix.ruby }}
     - run: bundle exec gem build

data/README.md

@@ -28,7 +28,7 @@ require 'taxii'
 # You can use a json file configuration
 # client = Taxii::configure(config: 'my.config.json')
 # or a direct configuration
-client = Taxii::configure(user: 'user', pass: 'pass', url: 'url')
+client = Taxii::configure(user: 'user', pass: 'pass', url: 'url', logger: Logger.new(STDOUT))
 collections = client.discover_collections
 
 # List collections (name, type and availability)
@@ -47,20 +47,16 @@ poll_request_message = Taxii::Messages::PollRequest.new(
 )
 
 client.get_content_blocks(poll_request_message).each do |message|
-  begin
-    # Try to parse the response as a Content_Block
-    pp Taxii::Messages::ContentBlock.new(message)
-    # You can also convert it to json
-    # pp Taxii::Messages::ContentBlock.new(message).as_json
-  rescue
-    puts 'This is not a ContentBlock'
-  end
+  message = Taxii.parse(body)
+  puts "Received a #{message.class}"
+  puts message.as_json if message.is_a?(Taxii::Messages::ContentBlock)
 end
 ```
 
-## Development
-
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/crondaemon/ruby-taxii2.
+
+# See also
+
+Ruby Stix2: https://github.com/crondaemon/ruby-stix2

data/lib/taxii/client.rb

@@ -2,12 +2,10 @@ module Taxii
   module Client
     def self.included(klass)
       klass.class_eval do
-        attr_accessor :url, :user, :pass, :client_cert, :client_key, :ca_cert
+        attr_accessor :url, :user, :pass, :logger, :client_cert, :client_key, :ca_cert
         attr_reader   :xml
         def initialize(*args)
           Hash[*args].each {|k,v| self.send(format('%s=',k),v)}
-          @user ||= 'admin'
-          @pass ||= 'avalanche'
           @xml = Nori.new(strip_namespaces: true)
           self
         end
@@ -42,7 +40,9 @@ module Taxii
       payload  = Taxii::Messages::DiscoveryRequest.new.to_xml
       response = build_request(url: self.url, payload: payload).execute
       parsed   = xml.parse(response.body)
-      parsed['Discovery_Response'].fetch('Service_Instance',[])
+      discovery_response = parsed['Discovery_Response']
+      raise("Error getting Discovery_Response: #{parsed}") if !discovery_response
+      discovery_response.fetch('Service_Instance', [])
     end
 
     def discovery_service_url
@@ -61,18 +61,22 @@ module Taxii
       @poll_service_url ||= get_service_address('POLL')
     end
 
-    def discover_feeds(url = self.collection_management_service_url)
+    def discover_feeds(url: self.collection_management_service_url, format: Taxii::Messages::TAXII_10_HEADERS)
       msg  = Taxii::Messages::FeedInformationRequest.new.to_xml
-      http  = build_request(url: url, payload: msg, format: Taxii::Messages::TAXII_10_HEADERS)
+      http  = build_request(url: url, payload: msg, format: format)
       parsed  = xml.parse(http.execute.body)
-      parsed['Feed_Information_Response'].fetch('Feed', [])
+      feed_information_response = parsed['Feed_Information_Response']
+      raise("Error getting Feed_Information_Response: #{parsed}") if !feed_information_response
+      feed_information_response.fetch('Feed', [])
     end
 
-    def discover_collections(url = self.collection_management_service_url)
+    def discover_collections(url: self.collection_management_service_url, format: Taxii::Messages::TAXII_10_HEADERS)
       msg  = Taxii::Messages::CollectionInformationRequest.new.to_xml
-      http  = build_request(url: url, payload: msg, format: Taxii::Messages::TAXII_10_HEADERS)
+      http  = build_request(url: url, payload: msg, format: format)
       parsed  = xml.parse(http.execute.body)
-      parsed['Collection_Information_Response'].fetch('Collection', [])
+      collection_information_response = parsed['Collection_Information_Response']
+      raise("Error getting Collection_Information_Response: #{parsed}") if !collection_information_response
+      collection_information_response.fetch('Collection', [])
     end
 
     def scheme_protocol

data/lib/taxii/messages/content_block.rb

@@ -1,28 +1,8 @@
-require 'json'
-
 module Taxii
   module Messages
-    class ContentBlock < Hashie::Dash
-      def initialize(body)
-        parsed = Nori.new(strip_namespaces: true).parse(body)
-        @body = parsed['Content_Block']['Content']
-        @body
-      end
-
-      def to_s
-        @body.to_s
-      end
-
-      def inspect
-        self.to_s
-      end
-
-      def as_json
-        JSON.parse(@body)
-      end
-
-      def pretty_print(pp)
-        puts self.to_s
+    class ContentBlock < Message
+      def self.object_path
+        ['Content_Block', 'Content']
       end
     end
   end

data/lib/taxii/messages/exclusive_begin_timestamp.rb

@@ -0,0 +1,13 @@
+module Taxii
+  module Messages
+    class ExclusiveBeginTimestamp < Message
+      def self.object_path
+        ['Exclusive_Begin_Timestamp']
+      end
+
+      def as_json
+        @body
+      end
+    end
+  end
+end

data/lib/taxii/messages/inclusive_end_timestamp.rb

@@ -0,0 +1,13 @@
+module Taxii
+  module Messages
+    class InclusiveEndTimestamp < Message
+      def self.object_path
+        ['Inclusive_End_Timestamp']
+      end
+
+      def as_json
+        @body
+      end
+    end
+  end
+end

data/lib/taxii/messages/message.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+module Taxii
+  module Messages
+    class Message
+      def initialize(body)
+        parsed = Nori.new(strip_namespaces: true).parse(body)
+        @body = parsed.dig(*self.class.object_path)
+      end
+
+      def to_s
+        @body.to_s
+      end
+
+      def inspect
+        self.to_s
+      end
+
+      def as_json
+        JSON.parse(@body)
+      end
+
+      def pretty_print(pp)
+        puts self.to_s
+      end
+    end
+  end
+end

data/lib/taxii/messages/record_count.rb

@@ -0,0 +1,9 @@
+module Taxii
+  module Messages
+    class RecordCount < Message
+      def self.object_path
+        ['Record_Count']
+      end
+    end
+  end
+end

data/lib/taxii/poll_client.rb

@@ -31,6 +31,7 @@ module Taxii
         @content_xml = Nokogiri::XML(response.body, nil, nil, PARSE_OPTIONS)
 
         blocks += response_blocks
+        @logger.info("#{blocks.count} blocks received") if @logger
       end
 
       blocks
@@ -61,7 +62,9 @@ module Taxii
         when Taxii::Messages::PollRequest, Taxii::Messages::PollFulfillmentRequest
           request_message.to_xml
         else
+          # :nocov:
           fail ArgumentError, 'request message must be String or PollRequest'
+          # :nocov:
       end
     end
   end

data/lib/taxii/version.rb

@@ -1,3 +1,3 @@
 module Taxii
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/lib/taxii.rb

@@ -9,6 +9,7 @@ require 'json'
 require 'taxii/version'
 require 'taxii/time_extensions'
 require 'taxii/messages'
+require 'taxii/messages/message'
 require 'taxii/messages/parameters'
 require 'taxii/messages/discovery_request'
 require 'taxii/messages/poll_request'
@@ -16,6 +17,9 @@ require 'taxii/messages/poll_fulfillment_request'
 require 'taxii/messages/feed_information_request'
 require 'taxii/messages/collection_information_request'
 require 'taxii/messages/content_block'
+require 'taxii/messages/record_count'
+require 'taxii/messages/exclusive_begin_timestamp'
+require 'taxii/messages/inclusive_end_timestamp'
 require 'taxii/client'
 require 'taxii/poll_client'
 
@@ -27,7 +31,7 @@ module Taxii
     pass = options[:pass]
     url = options[:url]
 
-    if user && pass && url
+    if url
       configuration = { user: user, pass: pass, url: url }
     elsif File.exist?(config)
       configuration = JSON.parse(File.read(config))
@@ -35,6 +39,8 @@ module Taxii
       raise('You must provide user+pass+url, ora a config file, or have a default $HOME/.taxii.json')
     end
 
+    configuration[:logger] = options[:logger]
+
     client.new(configuration)
   end
 
@@ -46,4 +52,18 @@ module Taxii
     PollClient.new(user: 'guest', pass: 'guest', url: 'http://taxiitest.mitre.org/services/discovery/')
   end
 
+  def self.parse(body)
+    parsed = Nori.new(strip_namespaces: true).parse(body)
+    if parsed['Content_Block']
+      Messages::ContentBlock.new(body)
+    elsif parsed['Exclusive_Begin_Timestamp']
+      Messages::ExclusiveBeginTimestamp.new(body)
+    elsif parsed['Inclusive_End_Timestamp']
+      Messages::InclusiveEndTimestamp.new(body)
+    elsif parsed['Record_Count']
+      Messages::RecordCount.new(body)
+    else
+      raise("Message unsupported. Objects: #{parsed.keys}")
+    end
+  end
 end

data/ruby-taxii.gemspec

@@ -8,6 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Taxii::VERSION
   spec.authors       = ['Dario Lombardo']
   spec.email         = ['lomato@gmail.com']
+  spec.license       = 'GPL-2.0-or-later'
 
   spec.summary       = %q{ ruby taxii client }
   spec.description   = %q{ implement api-alike for python libtaxii https://github.com/TAXIIProject/libtaxii }
@@ -18,21 +19,21 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'nokogiri'
-  spec.add_dependency 'nori'
-  spec.add_dependency 'gyoku'
-  spec.add_dependency 'hashie'
-  spec.add_dependency 'rest-client'
+  spec.add_dependency 'nokogiri', '~> 1.15.2'
+  spec.add_dependency 'nori', '~> 2.6.0'
+  spec.add_dependency 'gyoku', '~> 1.4.0'
+  spec.add_dependency 'hashie', '~> 5.0.0'
+  spec.add_dependency 'rest-client', '~> 2.1.0'
 
   spec.add_development_dependency 'bundler', '~> 2.3'
   spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'guard-bundler'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rspec', '~> 3.12.0'
+  spec.add_development_dependency 'guard', '~> 2.18.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7.3'
+  spec.add_development_dependency 'guard-bundler', '~> 3.0.1'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
+  spec.add_development_dependency 'vcr', '~> 6.1.0'
+  spec.add_development_dependency 'webmock', '~> 3.18.1'
+  spec.add_development_dependency 'pry', '~> 0.13.0'
+  spec.add_development_dependency 'pry-byebug', '~> 3.10.1'
 end

metadata

@@ -1,85 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: ruby-taxii2
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Dario Lombardo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.2
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: gyoku
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -112,128 +112,128 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.7.3
 - !ruby/object:Gem::Dependency
   name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.18.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.1
 description: " implement api-alike for python libtaxii https://github.com/TAXIIProject/libtaxii "
 email:
 - lomato@gmail.com
@@ -256,17 +256,22 @@ files:
 - lib/taxii/messages/collection_information_request.rb
 - lib/taxii/messages/content_block.rb
 - lib/taxii/messages/discovery_request.rb
+- lib/taxii/messages/exclusive_begin_timestamp.rb
 - lib/taxii/messages/feed_information_request.rb
+- lib/taxii/messages/inclusive_end_timestamp.rb
+- lib/taxii/messages/message.rb
 - lib/taxii/messages/parameters.rb
 - lib/taxii/messages/poll_fulfillment_request.rb
 - lib/taxii/messages/poll_request.rb
+- lib/taxii/messages/record_count.rb
 - lib/taxii/parsers/sax_poll_response.rb
 - lib/taxii/poll_client.rb
 - lib/taxii/time_extensions.rb
 - lib/taxii/version.rb
 - ruby-taxii.gemspec
 homepage: https://github.com/crondaemon/ruby-taxii2
-licenses: []
+licenses:
+- GPL-2.0-or-later
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -283,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: ruby taxii client