netsnmp 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 615bdc207baf5d3c7db16cfe106324acbc2f434937366ed6750d653df712f36c
-  data.tar.gz: d1601c013dadf943eb202964c43c2ac6a17eb40dddb9544577d901513eedcf08
+  metadata.gz: d6bb62b9abd416188660e04be1c12cf009b1df0e307030b9c239ea4b2acd73cc
+  data.tar.gz: ee88f7eb292f1a0077ab25e4677713290447e0e7755049bbe6db50f07d15d6a1
 SHA512:
-  metadata.gz: f3fbc65c63d1c3c8d0711e8c2c225d3d0442211f8875befa0c62b0de44dbe5e9e22d03b0e55ac49cf05bbac80c282be59c73f21503166c1582389e196b3948a7
-  data.tar.gz: 473a0f7f7f9f6d8fb9522bd809a7acd9644128bfdd471839a63e0ffb9b825b066cc1eb5e1be45f6a703fe94e18764212f6305b5f147ed04495eede058eb24b3b
+  metadata.gz: fc90cc626d4be2a04d598ec267bcfc108e87aea8e8a585a7611033fc56cb6c174a222250bb9eeeb05b2d03d058983b106c92c30ba3d91e922b171ecfbc37041a
+  data.tar.gz: '09dbbb277ae24d9b760c0de70738a02037da527d653d5e003632c1b41d808cc21c44034fb51bec63394a132fe3c30ffaac1adc846dc061ca483e13fc0719af97'

data/README.md

@@ -1,7 +1,6 @@
 # netsnmp
 
-[![Build Status](https://travis-ci.org/swisscom/ruby-netsnmp.svg?branch=master)](https://travis-ci.org/swisscom/ruby-netsnmp)
-[![Coverage Status](https://coveralls.io/repos/github/swisscom/ruby-netsnmp/badge.svg?branch=master)](https://coveralls.io/github/swisscom/ruby-netsnmp?branch=master)
+![Tests](https://github.com/swisscom/ruby-netsnmp/workflows/Tests/badge.svg)
 [![Code Climate](https://codeclimate.com/github/swisscom/ruby-netsnmp/badges/gpa.svg)](https://codeclimate.com/github/swisscom/ruby-netsnmp)
 [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/swisscom/ruby-netsnmp/master)
 
@@ -223,6 +222,7 @@ All encoding/decoding/encryption/decryption/digests are done using `openssl`, wh
 
 This library uses RSpec. The client specs are "integration" tests, in that we communicate with an [snmpsim-built snmp agent simulator](https://github.com/etingof/snmpsim).
 
+
 ### RSpec
 
 You can run all tests by typing:
@@ -234,37 +234,31 @@ You can run all tests by typing:
 ...
 ```
 
-### SNMP Simulator
-
-You can install the package yourself (ex: `pip install snmpsim`) and run the server locally, and then set the `SNMP_PORT` environment variable, where the snmp simulator is running.
 
-#### Docker
+### Docker
 
-The preferred way to use the snmp simulator is by using docker.
-
-In order to start the simulator container, run:
+The most straightforward way of running the tests is by using the `docker-compose` setup (which is also what's used in the CI). Run it against the ruby version you're targeting:
 
 ```
-> spec/support/spec.sh start
+> docker-compose -f docker-compose.yml -f docker-compose-ruby-${RUBY_MAJOR_VERSION}.${RUBY_MAJOR_VERSION}.yml run netsnmp
 ```
 
-after, you just need to set the `SNMP_PORT` variable to the port found typing:
+The CI runs the tests against all supported ruby versions. If changes break a specific version of ruby, make sure you commit appropriate changes addressing the edge case, or let me know in the issues board, so I can help.
 
-```
-> docker port test-snmp 1161/udp
-```
+### SNMP Simulator
 
-and run the tests. 
+The SNMP simulator runs in its own container in the `docker` setup.
 
-#### CI
+You can install the package yourself (ex: `pip install snmpsim`) and run the server locally, and then set the `SNMP_PORT` environment variable, where the snmp simulator is running.
 
-If you want to replicate what the CI is doing, just do:
+#### CI
 
-```
-> spec/support/spec.sh run
-```
+The job of the CI is:
 
-Which should: build and run the simulator container, run the tests, run rubocop, and remove all artifacts.
+* Run all the tests;
+* Make sure the tests cover an appropriate surface of the code;
+* Lint the code;
+* (for ruby 3.0) type check the code;
 
 
 ## Contributing

data/lib/netsnmp.rb

@@ -34,6 +34,18 @@ rescue LoadError
 end
 
 module NETSNMP
+  module StringExtensions
+    # If you wonder why this is there: the oauth feature uses a refinement to enhance the
+    # Regexp class locally with #match? , but this is never tested, because ActiveSupport
+    # monkey-patches the same method... Please ActiveSupport, stop being so intrusive!
+    # :nocov:
+    refine(String) do
+      def match?(*args)
+        !match(*args).nil?
+      end
+    end
+  end
+
   def self.debug=(io)
     @debug_output = io
   end

data/lib/netsnmp/client.rb

@@ -23,8 +23,7 @@ module NETSNMP
     #      puts client.get(oid: "1.3.6.1.2.1.1.5.0")
     #    end
     #
-    def initialize(**options)
-      version = options[:version]
+    def initialize(version: nil, **options)
       version = case version
                 when Integer then version # assume the use know what he's doing
                 when /v?1/ then 0
@@ -33,7 +32,7 @@ module NETSNMP
                 end
 
       @retries = options.fetch(:retries, RETRIES)
-      @session ||= version == 3 ? V3Session.new(options) : Session.new(options)
+      @session ||= version == 3 ? V3Session.new(**options) : Session.new(version: version, **options)
       return unless block_given?
       begin
         yield self

data/lib/netsnmp/oid.rb

@@ -4,13 +4,14 @@ module NETSNMP
   # Abstracts the OID structure
   #
   module OID
+    using StringExtensions unless String.method_defined?(:match?)
+
     OIDREGEX = /^[\d\.]*$/
 
     module_function
 
     def build(o)
       case o
-      when OID then o
       when Array
         o.join(".")
       when OIDREGEX
@@ -29,7 +30,7 @@ module NETSNMP
     # @return [true, false] whether the given OID belongs to the sub-tree
     #
     def parent?(parent_oid, child_oid)
-      child_oid.match(/\A#{parent_oid}\./)
+      child_oid.match?(/\A#{parent_oid}\./)
     end
   end
 end

data/lib/netsnmp/pdu.rb

@@ -55,7 +55,7 @@ module NETSNMP
               when :response  then 2
               else raise Error, "#{type} is not supported as type"
               end
-        new(args.merge(type: typ))
+        new(type: typ, **args)
       end
     end
 
@@ -64,7 +64,7 @@ module NETSNMP
     attr_reader :version, :community, :request_id
 
     def initialize(type:, headers:,
-                   request_id: nil,
+                   request_id: SecureRandom.random_number(MAXREQUESTID),
                    error_status: 0,
                    error_index: 0,
                    varbinds: [])
@@ -75,9 +75,9 @@ module NETSNMP
       @type = type
       @varbinds = []
       varbinds.each do |varbind|
-        add_varbind(varbind)
+        add_varbind(**varbind)
       end
-      @request_id = request_id || SecureRandom.random_number(MAXREQUESTID)
+      @request_id = request_id
       check_error_status(@error_status)
     end
 

data/lib/netsnmp/scoped_pdu.rb

@@ -9,6 +9,8 @@ module NETSNMP
       super(type: type, headers: [3, nil], **options)
     end
 
+    private
+
     def encode_headers_asn
       [OpenSSL::ASN1::OctetString.new(@engine_id || ""),
        OpenSSL::ASN1::OctetString.new(@context || "")]

data/lib/netsnmp/security_parameters.rb

@@ -24,7 +24,7 @@ module NETSNMP
 
     # @param [String] username the snmp v3 username
     # @param [String] engine_id the device engine id (initialized to '' for report)
-    # @param [Symbol, integer] security_level allowed snmp v3 security level (:auth_priv, :auh_no_priv, etc)
+    # @param [Symbol, integer] security_level allowed snmp v3 security level (:auth_priv, :auth_no_priv, etc)
     # @param [Symbol, nil] auth_protocol a supported authentication protocol (currently supported: :md5, :sha)
     # @param [Symbol, nil] priv_protocol a supported privacy protocol (currently supported: :des, :aes)
     # @param [String, nil] auth_password the authentication password
@@ -99,7 +99,7 @@ module NETSNMP
     # @note this method is used in the process of authenticating a message
     def sign(message)
       # don't sign unless you have to
-      return nil unless @auth_protocol
+      return unless @auth_protocol
 
       key = auth_key.dup
 
@@ -211,7 +211,7 @@ module NETSNMP
     end
 
     def authorizable?
-      @auth_protocol && @auth_protocol != :none
+      @auth_protocol != :none
     end
   end
 end

data/lib/netsnmp/session.rb

@@ -10,7 +10,7 @@ module NETSNMP
     def initialize(version: 1, community: "public", **options)
       @version   = version
       @community = community
-      validate(options)
+      validate(**options)
     end
 
     # Closes the session
@@ -36,23 +36,20 @@ module NETSNMP
     # @return [NETSNMP::PDU] the response pdu
     #
     def send(pdu)
-      encoded_request = encode(pdu)
+      encoded_request = pdu.to_der
       encoded_response = @transport.send(encoded_request)
-      decode(encoded_response)
+      PDU.decode(encoded_response)
     end
 
     private
 
-    def validate(**options)
-      proxy = options[:proxy]
+    def validate(host: nil, port: 161, proxy: nil, timeout: TIMEOUT, **)
       if proxy
         @proxy = true
         @transport = proxy
       else
-        host, port = options.values_at(:host, :port)
         raise "you must provide an hostname/ip under :host" unless host
-        port ||= 161 # default snmp port
-        @transport = Transport.new(host, port.to_i, timeout: options.fetch(:timeout, TIMEOUT))
+        @transport = Transport.new(host, port.to_i, timeout: timeout)
       end
       @version = case @version
                  when Integer then @version # assume the use know what he's doing
@@ -64,14 +61,6 @@ module NETSNMP
                  end
     end
 
-    def encode(pdu)
-      pdu.to_der
-    end
-
-    def decode(stream)
-      PDU.decode(stream)
-    end
-
     class Transport
       MAXPDUSIZE = 0xffff + 1
 

data/lib/netsnmp/v3_session.rb

@@ -4,7 +4,7 @@ module NETSNMP
   # Abstraction for the v3 semantics.
   class V3Session < Session
     # @param [String, Integer] version SNMP version (always 3)
-    def initialize(version: 3, context: "", **opts)
+    def initialize(context: "", **opts)
       @context = context
       @security_parameters = opts.delete(:security_parameters)
       super
@@ -19,8 +19,10 @@ module NETSNMP
     end
 
     # @see {NETSNMP::Session#send}
-    def send(*)
-      pdu, = super
+    def send(pdu)
+      encoded_request = encode(pdu)
+      encoded_response = @transport.send(encoded_request)
+      pdu, = decode(encoded_response)
       pdu
     end
 

data/lib/netsnmp/varbind.rb

@@ -6,7 +6,7 @@ module NETSNMP
   class Varbind
     attr_reader :oid, :value
 
-    def initialize(oid, value: nil, type: nil, **_opts)
+    def initialize(oid, value: nil, type: nil)
       @oid = OID.build(oid)
       @type = type
       @value = convert_val(value) if value

data/lib/netsnmp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NETSNMP
-  VERSION = "0.1.9"
+  VERSION = "0.2.0"
 end

data/sig/client.rbs

@@ -0,0 +1,24 @@
+module NETSNMP
+  class Client
+
+    def get: (*untyped) -> untyped
+           | (*untyped) { (PDU) -> void } -> untyped
+
+    def get_next: (*untyped) -> untyped
+                | (*untyped) { (PDU) -> void } -> untyped
+
+    def set: (*untyped) -> untyped
+           | (*untyped) { (PDU) -> void } -> untyped
+
+    def inform: (*untyped) -> untyped
+              | (*untyped) { (PDU) -> void } -> untyped
+
+    def walk: (oid: oid) -> _Each[oid_type, oid_value]
+
+    def close: () -> void
+
+    private
+
+    def initialize: (?version?: snmp_version, **untyped) -> untyped
+  end
+end

data/sig/message.rbs

@@ -0,0 +1,7 @@
+module NETSNMP
+  module Message
+    def self?.decode: (String stream, security_parameters: SecurityParameters) -> [ScopedPDU, String, Integer, Integer]
+
+    def self?.encode: (ScopedPDU pdu, security_parameters: SecurityParameters, ?engine_boots: Integer, ?engine_time: Integer) -> String
+  end
+end

data/sig/netsnmp.rbs

@@ -0,0 +1,23 @@
+module NETSNMP
+  interface _Logger
+    def <<: (string) -> void
+  end
+
+  interface _Authenticate
+    def reset: () -> void
+    def <<: (string) -> void
+    def digest: () -> String
+  end
+
+  interface _Encrypt
+    def encrypt: (String payload, engine_boots: Integer, engine_time: Integer) -> String
+
+    def decrypt: (String payload, salt: String, engine_boots: Integer, engine_time: Integer) -> String
+  end
+
+  type snmp_version = 0 | 1 | 3 | :v1 | :v2c | :v3 | nil
+
+  def self.debug=: (_Logger) -> void
+
+  def self.debug: { () -> string } -> void
+end

data/sig/oid.rbs

@@ -0,0 +1,18 @@
+module NETSNMP
+  type oid = String | Array[Integer]
+
+  type oid_type = Integer | :ipaddress | :counter32 | :gauge | :timetick | :opaque | :nsap | :counter64 | :uinteger
+
+  type oid_value = String | Integer | Timetick | true | false | nil | IPAddr
+
+  # type oid_options = {}
+
+  module OID
+
+    def self?.build: (oid) -> String
+
+    def self?.to_asn: (String oid) -> OpenSSL::ASN1::ObjectId
+
+    def self?.parent?: (String oid, String oid) -> bool
+  end
+end

data/sig/openssl.rbs

@@ -0,0 +1,20 @@
+module OpenSSL
+  module ASN1
+    class ASN1Data
+    end
+    class ObjectId < ASN1Data
+    end
+    class Primitive < ASN1Data
+    end
+    class Integer < ASN1Data
+    end
+    class OctetString < ASN1Data
+    end
+    class Sequence < ASN1Data
+    end
+  end
+end
+
+interface _ToAsn
+  def to_asn: () -> OpenSSL::ASN1::ASN1Data
+end

data/sig/pdu.rbs

@@ -0,0 +1,48 @@
+module NETSNMP
+  type pdu_type = :get | :getnext | :set | :inform | :trap | :response
+
+  class PDU
+
+    # type pdu_options = {
+    #   headers: [snmp_version?, String?],
+    #   ?request_id: String,
+    #   ?error_status: Integer,
+    #   ?error_index: Integer,
+    #   ?varbinds: Array[varbind_options]
+    # }
+
+    attr_reader varbinds: Array[Varbind]
+    attr_reader type: pdu_type
+    attr_reader version: snmp_version
+    attr_reader community: String
+    attr_reader request_id: Integer
+
+    def self.decode: (String der) -> PDU
+                   | (OpenSSL::ASN1::ASN1Data der) -> PDU
+
+    def self.build: (pdu_type, **untyped) -> PDU
+
+
+    def to_asn: () -> OpenSSL::ASN1::ASN1Data
+
+    def to_der: () -> String
+
+    def add_varbind: (oid: oid, **varbind_options) -> void
+    alias << add_varbind
+
+    private
+
+    def initialize: (
+      type: Integer,
+      headers: [snmp_version?, String?],
+      ?request_id: Integer,
+      ?error_status: Integer,
+      ?error_index: Integer,
+      ?varbinds: Array[varbind_options]
+    ) -> untyped
+
+    def encode_headers_asn: () -> [OpenSSL::ASN1::Integer, OpenSSL::ASN1::OctetString]
+
+    def check_error_status: (Integer) -> void
+  end
+end

data/sig/scoped_pdu.rbs

@@ -0,0 +1,15 @@
+module NETSNMP
+  class ScopedPDU < PDU
+    attr_reader engine_id: String
+
+    private
+
+    def initialize: (
+      type: Integer,
+      headers: [String?, String?],
+      **untyped
+    ) -> void
+
+    def encode_headers_asn: () -> [OpenSSL::ASN1::OctetString, OpenSSL::ASN1::OctetString]
+  end
+end

data/sig/security_parameters.rbs

@@ -0,0 +1,56 @@
+module NETSNMP
+  class SecurityParameters
+    type security_level = :noauth | :auth_no_priv | :auth_priv | 0 | 1 | 3 | nil
+
+    type auth_protocol = :md5 | :sha
+    type priv_protocol = :des | :aes
+
+
+    @auth_protocol: auth_protocol?
+    @auth_password: String?
+    @priv_protocol: priv_protocol?
+    @priv_password: String?
+    @digest: _Authenticate?
+    @encryption: _Encrypt?
+
+    attr_reader security_level: security_level
+    attr_reader username: String
+    attr_reader engine_id: String
+
+    def engine_id=: (String id) -> void
+
+    def encode: (_ToAsn, salt: OpenSSL::ASN1::ASN1Data, engine_time: Integer, engine_boots: Integer) -> [OpenSSL::ASN1::ASN1Data, OpenSSL::ASN1::ASN1Data]
+
+    def decode: (OpenSSL::ASN1::ASN1Data | String der, salt: OpenSSL::ASN1::ASN1Data | String, engine_time: Integer, engine_boots: Integer) -> OpenSSL::ASN1::ASN1Data
+
+    def sign: (String message) -> String?
+
+    def verify: (String stream, String salt) -> void
+
+    def must_revalidate?: () -> bool
+
+    private
+
+    def initialize: (
+      username: String,
+      ?engine_id: String,
+      ?security_level: security_level?,
+      ?auth_protocol: auth_protocol?,
+      ?auth_password: String?,
+      ?priv_protocol: priv_protocol?,
+      ?priv_password: String?,
+    ) -> untyped
+
+    def auth_key: () -> String
+
+    def priv_key: () -> String
+
+    def check_parameters: () -> void
+
+    def localize_key: (String key) -> String
+
+    def passkey: (String password) -> String
+
+    def authorizable?: () -> bool
+  end
+end

data/sig/session.rbs

@@ -0,0 +1,36 @@
+module NETSNMP
+  class Session
+    @transport: _Transport
+    @version: 0 | 1 | 3
+    @community: String?
+
+    def close: () -> void
+
+    def build_pdu: (pdu_type, *untyped) -> PDU
+
+    def send: (PDU) -> PDU
+
+    private
+
+    def initialize: (?version: snmp_version, ?community: String, **untyped) -> untyped
+   
+    def validate: (?host: String?, ?port: Integer, ?proxy: _Transport, ?timeout: Integer, **untyped) -> void
+
+    class Transport
+      def initialize: (String host, Integer port, timeout: Integer) -> untyped
+      def close: () -> void
+      def send: (String payload) -> String
+      def write: (String) -> void
+      def recv: () -> void
+
+      private
+
+      def wait: (:wait_readable | :wait_writable) -> void
+    end
+  end
+
+  interface _Transport
+    def close: () -> void
+    def send: (String payload) -> String
+  end
+end

data/sig/timeticks.rbs

@@ -0,0 +1,7 @@
+module NETSNMP
+  class Timetick < Numeric
+    @ticks: Integer
+
+    def to_asn: () -> OpenSSL::ASN1::ASN1Data
+  end
+end

data/sig/v3_session.rbs

@@ -0,0 +1,21 @@
+module NETSNMP
+  class V3Session < Session
+
+    def build_pdu: (pdu_type, *untyped) -> ScopedPDU
+
+    def send: (ScopedPDU pdu) -> ScopedPDU
+    		| (ScopedPDU pdu) -> [PDU, String, Integer, Integer]
+
+    private
+
+    def encode: (ScopedPDU) -> String
+
+    def initialize: (?context: String, **untyped) -> untyped
+
+    def security_parameters: () -> SecurityParameters
+
+    def probe_for_engine: () -> String
+
+    def decode: (String, ?security_parameters: SecurityParameters) -> [PDU, String, Integer, Integer]
+  end
+end

data/sig/varbind.rbs

@@ -0,0 +1,30 @@
+module NETSNMP
+  type varbind_options = untyped
+
+  class Varbind
+
+    type varbind_value = OpenSSL::ASN1::OctetString | OpenSSL::ASN1::Primitive | OpenSSL::ASN1::ASN1Data | oid_value
+
+    attr_reader oid: String
+    attr_reader value: oid_value
+
+    def to_asn: () -> OpenSSL::ASN1::Sequence
+
+    def to_der: () -> String
+
+    def convert_val: (varbind_value) -> oid_value
+
+
+    def convert_to_asn: (oid_type, oid_value) -> OpenSSL::ASN1::ASN1Data
+
+    def convert_application_asn: (OpenSSL::ASN1::ASN1Data asn) -> oid_value
+
+    private
+
+    def initialize: (oid, ?value: varbind_value, ?type: oid_type) -> untyped
+
+    def unpack_32bit_integer: (String) -> Integer
+
+    def unpack_64bit_integer: (String) -> Integer
+  end
+end

data/spec/client_spec.rb

@@ -3,11 +3,11 @@
 require_relative "support/request_examples"
 
 RSpec.describe NETSNMP::Client do
-  let(:host) { "localhost" }
+  let(:host) { SNMPHOST }
 
   let(:device_options) do
     {
-      peername: "localhost",
+      peername: SNMPHOST,
       port: SNMPPORT
     }
   end

data/spec/handlers/celluloid_spec.rb

@@ -31,14 +31,15 @@ RSpec.describe "with cellulloid", type: :celluloid do
     WALK
   end
 
+  before(:all) { Celluloid.boot }
   around(:each) do |example|
     within_io_actor { example.run }
   end
-  let(:proxy) { CelluloidHelpers::Proxy.new("localhost", SNMPPORT) }
+  let(:proxy) { CelluloidHelpers::Proxy.new(SNMPHOST, SNMPPORT) }
   after(:each) { proxy.close }
 
   it_behaves_like "an snmp client" do
-    subject { NETSNMP::Client.new(options) }
+    subject { NETSNMP::Client.new(**options) }
     let(:device_options) { { proxy: proxy } }
     let(:protocol_options) { user_options }
     let(:extra_options) { { version: 3, context: "a172334d7d97871b72241397f713fa12" } }

data/spec/session_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 RSpec.describe NETSNMP::Session do
-  let(:host) { "localhost" }
+  let(:host) { SNMPHOST }
   let(:options) do
     {
       version: "2c",
@@ -9,6 +9,6 @@ RSpec.describe NETSNMP::Session do
       port: SNMPPORT
     }
   end
-  subject { described_class.new(host, options) }
+  subject { described_class.new(host: host, **options) }
   after { subject.close }
 end

data/spec/spec_helper.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
 
-require "simplecov" if ENV["COVERAGE"]
-require "coveralls"
-Coveralls.wear!
+if ENV.key?("CI")
+  require "simplecov"
+  SimpleCov.command_name "#{RUBY_ENGINE}-#{RUBY_VERSION}"
+  SimpleCov.coverage_dir "coverage/#{RUBY_ENGINE}-#{RUBY_VERSION}"
+end
 
 if defined?(SimpleCov)
   SimpleCov.start do
@@ -17,7 +19,8 @@ Bundler.require(:default, :test)
 
 require "netsnmp"
 
-SNMPPORT = (ENV["SNMP_PORT"] || 1161).to_i
+SNMPPORT = ENV.fetch("SNMP_PORT", 1161).to_i
+SNMPHOST = ENV.fetch("SNMP_HOST", "localhost")
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

data/spec/support/request_examples.rb

@@ -3,7 +3,7 @@
 RSpec.shared_examples "an snmp client" do
   let(:device_options) do
     {
-      host: "localhost",
+      host: SNMPHOST,
       port: SNMPPORT
     }
   end
@@ -11,7 +11,7 @@ RSpec.shared_examples "an snmp client" do
   let(:extra_options) { {} }
   let(:options) { protocol_options.merge(device_options).merge(extra_options) }
 
-  subject { described_class.new(options) }
+  subject { described_class.new(**options) }
 
   describe "#get" do
     let(:value) { subject.get(oid: get_oid) }

data/spec/v3_session_spec.rb

@@ -7,19 +7,19 @@ RSpec.describe NETSNMP::V3Session do
       priv_protocol: :des, security_level: :auth_priv }
   end
   it "generates the security parameters handler" do
-    sess = described_class.new(security_options.merge(host: "localhost", port: SNMPPORT))
+    sess = described_class.new(**security_options.merge(host: SNMPHOST, port: SNMPPORT))
     # not generated yet
     expect(sess.instance_variable_get(:@security_parameters)).to be_a(NETSNMP::SecurityParameters)
   end
 
   it "allows to pass a custom one" do
-    sec_params = NETSNMP::SecurityParameters.new(security_options)
-    sess = described_class.new(host: "localhost", port: SNMPPORT, security_parameters: sec_params)
+    sec_params = NETSNMP::SecurityParameters.new(**security_options)
+    sess = described_class.new(host: SNMPHOST, port: SNMPPORT, security_parameters: sec_params)
     # not generated yet
     expect(sess.instance_variable_get(:@security_parameters)).to be(sec_params)
   end
 
   it "fails if the pass object doesn't follow the expected api" do
-    expect { described_class.new(host: "localhost", port: SNMPPORT, security_parameters: double) }.to raise_error(NETSNMP::Error)
+    expect { described_class.new(host: SNMPHOST, port: SNMPPORT, security_parameters: double) }.to raise_error(NETSNMP::Error)
   end
 end

metadata

@@ -1,75 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: netsnmp
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Tiago Cardoso
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.1.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.1'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: celluloid-io
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.17.2
+date: 2020-12-18 00:00:00.000000000 Z
+dependencies: []
 description: |2
       Wraps the net-snmp core usage into idiomatic ruby.
       It is designed to support as many environments and concurrency frameworks as possible.
@@ -78,17 +18,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".travis.yml"
 - AUTHORS
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - lib/netsnmp.rb
 - lib/netsnmp/client.rb
 - lib/netsnmp/encryption/aes.rb
@@ -105,7 +37,18 @@ files:
 - lib/netsnmp/v3_session.rb
 - lib/netsnmp/varbind.rb
 - lib/netsnmp/version.rb
-- netsnmp.gemspec
+- sig/client.rbs
+- sig/message.rbs
+- sig/netsnmp.rbs
+- sig/oid.rbs
+- sig/openssl.rbs
+- sig/pdu.rbs
+- sig/scoped_pdu.rbs
+- sig/security_parameters.rbs
+- sig/session.rbs
+- sig/timeticks.rbs
+- sig/v3_session.rbs
+- sig/varbind.rbs
 - spec/client_spec.rb
 - spec/handlers/celluloid_spec.rb
 - spec/oid_spec.rb
@@ -113,11 +56,8 @@ files:
 - spec/security_parameters_spec.rb
 - spec/session_spec.rb
 - spec/spec_helper.rb
-- spec/support/Dockerfile
 - spec/support/celluloid.rb
 - spec/support/request_examples.rb
-- spec/support/specs.sh
-- spec/support/stop_docker.sh
 - spec/timeticks_spec.rb
 - spec/v3_session_spec.rb
 - spec/varbind_spec.rb
@@ -126,7 +66,7 @@ licenses:
 - Apache-2.0
 metadata:
   allowed_push_host: https://rubygems.org/
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -142,23 +82,20 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - net-snmp
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: SNMP Client library
 test_files:
+- spec/timeticks_spec.rb
+- spec/spec_helper.rb
+- spec/session_spec.rb
 - spec/client_spec.rb
-- spec/handlers/celluloid_spec.rb
 - spec/oid_spec.rb
+- spec/varbind_spec.rb
+- spec/support/request_examples.rb
+- spec/support/celluloid.rb
 - spec/pdu_spec.rb
 - spec/security_parameters_spec.rb
-- spec/session_spec.rb
-- spec/spec_helper.rb
-- spec/support/Dockerfile
-- spec/support/celluloid.rb
-- spec/support/request_examples.rb
-- spec/support/specs.sh
-- spec/support/stop_docker.sh
-- spec/timeticks_spec.rb
 - spec/v3_session_spec.rb
-- spec/varbind_spec.rb
+- spec/handlers/celluloid_spec.rb

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci

data/.gitignore

@@ -1,14 +0,0 @@
-/coverage/
-/doc/
-/pkg/
-/tmp/
-/log/
-/.yardoc/
-/.bundle
-/Gemfile.lock
-/vendor
-.env
-
-*.DS_Store
-*.sw[po]
-*.nfs*

data/.rspec

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

data/.rubocop.yml

@@ -1,11 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  TargetRubyVersion: 2.3
-
-Layout/IndentHeredoc:
-  Enabled: false
-
-Style/NumericPredicate:
-  Exclude:
-    - lib/netsnmp.rb

data/.rubocop_todo.yml

@@ -1,69 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2018-02-07 22:49:11 +0000 using RuboCop version 0.52.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-Metrics/BlockLength:
-  Max: 200
-
-# Offense count: 17
-Metrics/AbcSize:
-  Max: 100
-
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 150
-
-# Offense count: 8
-Metrics/CyclomaticComplexity:
-  Max: 20
-
-# Offense count: 22
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Max: 50
-
-# Offense count: 2
-# Configuration parameters: CountKeywordArgs.
-Metrics/ParameterLists:
-  Max: 7
-
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 9
-
-# Offense count: 10
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/netsnmp.rb'
-    - 'lib/netsnmp/encryption/aes.rb'
-    - 'lib/netsnmp/encryption/des.rb'
-    - 'lib/netsnmp/encryption/none.rb'
-    - 'lib/netsnmp/scoped_pdu.rb'
-    - 'lib/netsnmp/session.rb'
-    - 'lib/netsnmp/timeticks.rb'
-
-# Offense count: 8
-# Cop supports --auto-correct.
-# Configuration parameters: Strict.
-Style/NumericLiterals:
-  MinDigits: 11
-
-  # Offense count: 264
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-# Offense count: 112
-# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 189

data/.travis.yml

@@ -1,28 +0,0 @@
-sudo: required
-services:
-  - docker
-
-install:
-  - gem i rubygems-update -v '<3' && update_rubygems
-  - bundle install --path .bundle
-
-script:
-  - spec/support/specs.sh run
-
-language: ruby
-rvm:
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - ruby-head
-  - jruby-head
-  - truffleruby
-matrix:
-  allow_failures:
-  - rvm: ruby-head
-  - rvm: jruby-head
-    # to figure out later
-  - rvm: truffleruby

data/Gemfile

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org/"
-ruby RUBY_VERSION
-
-gemspec
-
-gem "coveralls", require: false
-
-group :development do
-  gem "pry"
-end
-
-gem "nio4r", "~> 1.2" if RUBY_VERSION < "2.2"
-
-platforms :mri do
-  gem "pry-byebug", require: false
-  gem "stackprof", require: false
-  gem "xorcist", require: false
-end
-
-gem "rubocop", "0.52.1", require: false

data/Rakefile

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "coveralls/rake/task"
-require "rubocop/rake_task"
-
-desc "runs the tests and sends to coveralls server"
-Coveralls::RakeTask.new
-
-desc "runs the tests"
-RSpec::Core::RakeTask.new
-
-desc "Run rubocop"
-task :rubocop do
-  RuboCop::RakeTask.new
-end
-
-task default: [:spec]
-
-namespace :spec do
-  desc "runs the tests in coverage mode"
-  task :coverage do
-    ENV["COVERAGE"] = "true"
-    Rake::Task["spec"].execute
-  end
-
-  desc "runs tests, check coverage, pushes to coverage server"
-  task ci: ["spec:coverage", "coveralls:push", "rubocop"]
-end

data/netsnmp.gemspec

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require File.expand_path("../lib/netsnmp/version", __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.name        = "netsnmp"
-  gem.summary     = "SNMP Client library"
-  gem.description = <<-DESC
-    Wraps the net-snmp core usage into idiomatic ruby.
-    It is designed to support as many environments and concurrency frameworks as possible.
-  DESC
-  gem.requirements = ["net-snmp"]
-  gem.version     = NETSNMP::VERSION
-  gem.license     = "Apache-2.0"
-  gem.authors     = ["Tiago Cardoso"]
-  gem.email       = "cardoso_tiago@hotmail.com"
-  gem.homepage    = ""
-  gem.platform    = Gem::Platform::RUBY
-  gem.metadata["allowed_push_host"] = "https://rubygems.org/"
-
-  # Manifest
-  gem.files         = `git ls-files`.split("\n") - Dir["tmp/**/*"]
-  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-  gem.require_paths = ["lib"]
-
-  gem.add_development_dependency "rake", ["~> 10.1", ">= 10.1.0"]
-  gem.add_development_dependency "rspec", ["~> 3.5", ">= 3.5.0"]
-
-  gem.add_development_dependency "celluloid-io", ["~> 0.17", ">= 0.17.2"]
-end

data/spec/support/Dockerfile

@@ -1,14 +0,0 @@
-FROM python:2.7-alpine
-Maintainer Tiago Cardoso <cardoso_tiago@hotmail.com>
-
-RUN easy_install snmpsim==0.3.0
-RUN easy_install pycrypto==2.6.1
-EXPOSE 1161
-# Create non-privileged user
-RUN useradd -m snmp_server
-
-
-USER snmp_server
-ENTRYPOINT ["/usr/local/bin/snmpsimd.py"]
-
-CMD ["--help"]

data/spec/support/specs.sh

@@ -1,51 +0,0 @@
-#!/usr/bin/env bash
-
-function start {
-  docker pull honeyryderchuck/snmp-server-emulator:latest
-  docker run -d -p :1161/udp --name test-snmp -v $(pwd)/spec/support/snmpsim:/home/snmp_server/.snmpsim honeyryderchuck/snmp-server-emulator \
-  --v3-engine-id=000000000000000000000002 \
-  --agent-udpv4-endpoint=0.0.0.0:1161 --agent-udpv6-endpoint='[::0]:1161' \
-  --v3-user=simulator --v3-auth-key=auctoritas --v3-priv-key=privatus \
-  --v3-user=authmd5 --v3-auth-key=maplesyrup --v3-auth-proto=MD5 --v3-priv-proto=NONE \
-  --v3-user=authsha --v3-auth-key=maplesyrup --v3-auth-proto=SHA --v3-priv-proto=NONE \
-  --v3-user=authprivshaaes --v3-auth-key=maplesyrup --v3-auth-proto=SHA \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=AES \
-  --v3-user=authprivmd5aes --v3-auth-key=maplesyrup --v3-auth-proto=MD5 \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=AES \
-  --v3-user=authprivshades --v3-auth-key=maplesyrup --v3-auth-proto=SHA \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=DES \
-  --v3-user=authprivmd5des --v3-auth-key=maplesyrup --v3-auth-proto=MD5 \
-                           --v3-priv-key=maplesyrup --v3-priv-proto=DES \
-  --v3-user=unsafe --v3-auth-proto=NONE --v3-priv-proto=NONE
-
-}
-
-function run {
-  sleep 20 # give some time for the simulator to boot
-  
-  port="$(docker port test-snmp 1161/udp)"
-  export SNMP_PORT=$(echo $port | cut -d':' -f2)
-  
-  bundle exec rake spec:ci
-}
-
-function finish {
-  docker stop test-snmp
-  docker rm test-snmp
-}
-
-trap finish EXIT
-
-case "$1" in
-  start)
-    start
-    docker logs -f test-snmp
-    ;;
-  run)
-    start
-    run
-    ;;
-  *)
-    echo $"Usage: $0 {start|run}"
-    exit 1
-esac

data/spec/support/stop_docker.sh

@@ -1,5 +0,0 @@
-sudo docker stop test-snmp-emulator
-sudo docker rm test-snmp-emulator
-sudo docker rmi snmp-server-emulator
-
-