noids_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f84c41e5fda4436621de5c0dadb9939753f4a804
-  data.tar.gz: e43be3ae32af0efebd19f9086717ae313d95067c
+SHA256:
+  metadata.gz: d4e277f7ca5cb6bb3a0eba3670ee692b602b81e4bcdda3d3af6dff21d9c4337b
+  data.tar.gz: 6485dcabc35930a63069f921bdad1737ce4c909fb8254e0c74fccf352976932d
 SHA512:
-  metadata.gz: 9b2bb7f767b7568e7acabeadce6f245e435a9ddc568ad1791c007a74fcb9ccf4c5e7f0a155c4e7784f681edc6f6588a4dfec990c7a4591cf832f169c53539f23
-  data.tar.gz: 0babfde7d9a137eefa87b2b1c44f62022ac9a2dacbce3e91aa1e683e9de454c9fc4260b8b0600d351555365784dcef84db625b59ae43060bab8c284c6b640cf6
+  metadata.gz: 7ab807c004ef88ff8b5d07837b23b6d51907f986ef7da6b59e50d67469721f26eec679eebd2834ca3beca8ad99d6d63f42582c9c89b152aab54703db0106ad1a
+  data.tar.gz: 478760ee3bb0ae3459bd477d811dd0ef7de27d858f3be5c6b72bb26c149f4622b273a66f2a91683b1e9c6adff63d481128f1e3087f29fc063302dac128afcded

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    noids_client (0.0.1)
+      json (~> 1.8)
+      rest-client (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    json (1.8.6)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2020.1104)
+    netrc (0.11.0)
+    public_suffix (4.0.6)
+    rake (10.5.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    vcr (2.9.3)
+    webmock (3.10.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  byebug
+  noids_client!
+  rake (~> 10.3)
+  rspec (~> 3.0)
+  vcr (~> 2.8)
+  webmock (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -38,47 +38,28 @@ This limitation is imposed by the server.
 
 # Setting up a noids server
 
-A noids server is not provided by this repository.
-However, for testing or experimentation it is convinent to set up a noids server, which is not difficult.
+Follow the instructions at https://github.com/ndlib/noids
 
-## On a Mac with homebrew
+# Running tests
 
-First install a golang environment.
+You can run the test suite by `bundle exec rspec`. This will not hit a live noid
+server. The specs instead rely on recorded HTTP request/response pairs.
 
-    brew install go
-    mkdir ~/gocode
-    export GOPATH=~/gocode
-    export PATH=$GOPATH/bin:$PATH
+## Testing Noids::Client against a live noid server
 
-Install the noids server:
+First, you'll want to ensure that you've installed a noids server. Follow the
+directions over at https://github.com/ndlib/noids.
 
-    go get https://github.com/dbrower/noids
+Then run `bundle exec rake test_client_against_server`.
 
-Start it, and have it keep pools in memory.
+## Upstream Integrations
 
-    noids
-
-These pools will be lost when the server is restarted.
-To save the pools to disk use
-
-    noids -storage directory/to/use
-
-There are other options, including saving the pools to a database.
-See the documentation on the [noids server](https://github.com/dbrower/noids) page.
-
-You can test the server using `curl`.
-Note that the default port for the server to listen on is 13001.
-These commands will create a pool named 'test' which will generate ids using the template `.sddd`.
-Then 50 ids are minted, and the pool is advanced past the id `432`, so that `432` will never be minted by this pool.
-
-    curl 'http://localhost:13001/pools' -F 'name=test' -F 'template=.sddd'
-    curl 'http://localhost:13001/pools/test/mint' -F 'n=50'
-    curl 'http://localhost:13001/pools/test/advancePast' -F 'id=432'
-
-
-## On Linux
-
-Install a golang envrionment. This should be done using your package management system.
-e.g. `yum install golang`.
-Then follow the remaining steps above.
+You can incorporate a live yet local noid server in your upstream suite.
 
+```ruby
+require 'noids_client/integration_test'
+# Note: the block will be yielded after the server has had a chance
+# to spin up
+NoidsClient::IntegrationTest::NoidServerRunner.new.run do
+  # Code to run that requires a noid server
+end

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+
+desc "Test the current client against a NOIDs server (see https://github.com/ndlib/noids)"
+task :test_client_against_server do
+  require 'noids_client/integration_test'
+  NoidsClient::IntegrationTest.run(spawn_noids_server: true)
+end

data/lib/noids_client.rb

@@ -5,3 +5,5 @@ require 'noids_client/pool'
 require 'noids_client/connection'
 require 'noids_client/version'
 
+# NOTE: Do not require 'noids_client/integration_test' as that is
+# intended for upstream systems to leverage

data/lib/noids_client/integration_test.rb

@@ -0,0 +1,197 @@
+require 'noids_client'
+
+module NoidsClient
+  # A helper class that allows for downstream implementers of the noids_clients
+  # gem to run against a "live" noids server
+  #
+  # @example
+  #   require 'noids_client/integration_test'
+  #   NoidsClient::IntegrationTest.run
+  #
+  # @see #initialize for .run parameters
+  module IntegrationTest
+    class AssertionFailedError < RuntimeError
+    end
+    def self.default_logger
+      require 'logger'
+      Logger.new(STDOUT)
+    end
+
+    # @params spawn_noids_server [Boolean] rely on this script (and a configured
+    #           machine) to launch a new noids server
+    # @params logger [Logger] to report all the details
+    #
+    # @see TestRunner#initialize for kwargs options
+    # @see NoidServerRunner#initialize for kwargs options
+    #
+    # @raises AssertionFailedError if any of the integration tests fail
+    # @return true if all integration tests pass
+    def self.run(spawn_noids_server: false, logger: default_logger, **kwargs)
+      if spawn_noids_server
+        NoidServerRunner.new(logger: logger, **kwargs).run do
+          TestRunner.new(logger: logger, **kwargs).run
+        end
+      else
+        TestRunner.new(logger: logger, **kwargs).run
+      end
+    end
+
+
+    # A utility class to help running a NOIDs server within the context
+    #
+    # @example
+    #   require 'noids_client/integration_test'
+    #   NoidsClient::IntegrationTest::NoidServerRunner.new do
+    #     # thing that requires a noids server
+    #   end
+    #
+    class NoidServerRunner
+      # @param kwargs [Hash] the configuration options for the NoidsServer. Note,
+      #           you shouldn't need to pass parameters if you follow the noids
+      #           documentation
+      # @option logger [#debug, #info]
+      # @option storage_dir [String]
+      # @option file_utils [#mkdir_p, #rm_rf] the object that will manage cleaning
+      #           the storage_dir
+      # @option noids_command [String] the fully expanded to the noids command
+      # @option seconds_to_wait [Integer] how long to wait for the noids server to
+      #           fully boot
+      def initialize(**kwargs)
+        @logger = kwargs.fetch(:logger) { IntegrationTest.default_logger }
+        logger.debug("logger: #{logger.inspect}")
+        @storage_dir = kwargs.fetch(:storage_dir) { default_storage_dir }
+        logger.debug("storage_dir: #{storage_dir.inspect}")
+        @file_utils = kwargs.fetch(:file_utils) { default_file_utils }
+        logger.debug("file_utils: #{file_utils.inspect}")
+        @noids_command = kwargs.fetch(:noids_command) { default_noids_command }
+        logger.debug("noids_command: #{noids_command.inspect}")
+        @seconds_to_wait = kwargs.fetch(:seconds_to_wait) { SECONDS_TO_WAIT }
+        logger.debug("seconds_to_wait: #{seconds_to_wait}")
+      end
+
+      attr_reader :storage_dir, :noids_command, :logger, :file_utils, :seconds_to_wait
+
+      private
+
+      def default_storage_dir
+        File.join(ENV.fetch("HOME"), "noids_pool")
+      end
+
+      def default_noids_command
+        File.join(ENV.fetch("GOPATH"), "bin/noids")
+      end
+
+      def default_file_utils
+        require 'fileutils'
+        FileUtils
+      end
+
+      public
+
+      SECONDS_TO_WAIT = 5
+      def run
+        clean_storage!
+        process_id = Process.spawn("#{noids_command} --storage #{storage_dir}")
+        Process.detach(process_id)
+        logger.debug("Waiting #{seconds_to_wait} seconds for noids to start")
+        sleep(seconds_to_wait)
+        yield if block_given?
+      ensure
+        stop_noids!(process_id: process_id)
+      end
+
+      private
+
+      def clean_storage!
+        logger.info("Cleaning noids: #{storage_dir}")
+        file_utils.rm_rf(storage_dir)
+        file_utils.mkdir_p(storage_dir)
+      end
+
+      def start_noids!
+        # `$GOPATH/bin/noids --storage ~/noids_pool`
+        logger.info("Starting noids server…")
+        IO.popen("#{noids_command} --storage #{storage_dir}", err: [:child, :out])
+      end
+
+      def stop_noids!(process_id:)
+        logger.info("Shutting down server…")
+        Process.kill(:SIGINT, process_id)
+        return true
+      end
+    end
+
+
+    class TestRunner
+      # @param kwargs [Hash] the configuration options for the NoidsServer. Note,
+      #           you shouldn't need to pass parameters if you follow the noids
+      #           documentation
+      # @option logger [#debug, #info]
+      # @option noids_url [String]
+      # @option connection_class [#new] a connection class that implements the
+      #           NoidsClient::Connection object interface
+      def initialize(**kwargs)
+        @logger = kwargs.fetch(:logger) { IntegrationTest.default_logger }
+        logger.debug("logger: #{logger.inspect}")
+        @noids_url = kwargs.fetch(:noids_url) { default_noids_url }
+        @connection_class = kwargs.fetch(:connection_class) { default_connection_class }
+        connect!
+      end
+      attr_reader :noids_url, :logger, :connection, :connection_class
+
+      private
+
+      def connect!
+        logger.debug "Using #{noids_url} to connect via #{connection_class}"
+        @connection = connection_class.new(noids_url)
+      end
+
+      def default_noids_url
+        default_noids_url = "http://localhost:13001"
+        ENV.fetch("NOIDS_URL") do
+          default_noids_url
+        end
+      end
+
+      def default_logger
+        require 'logger'
+        Logger.new(STDOUT)
+      end
+
+      def default_connection_class
+        require 'noids_client'
+        NoidsClient::Connection
+      end
+
+      public
+
+      def run
+        assert(connection.pool_list.empty?, "Expected connection.pool_list to be empty")
+        new_pool = connection.new_pool("test", ".sddd")
+        assert(new_pool, "Expected to be able to create a pool")
+        assert(connection.pool_list.include?("test"), "Expected connection.pool_list to include test")
+        pool = connection.get_pool("test")
+        assert(pool.name == "test", "Expected pool to be named 'test'")
+        assert(pool.ids_used == 0, "Expected pool to have no used IDs")
+        ids = pool.mint(2)
+        assert(ids.size == 2, "Expected to mint 2 ids with `pool.mint(2)`")
+        assert(pool.close, "Expected close to be successful")
+        assert(pool.open, "Expected to be able to re-open the pool")
+        assert(pool.ids_used == 2, "Expected the previously minted ids to register as used")
+        return true
+      end
+
+      private
+
+      def assert(boolean_test, expectation_message)
+        if boolean_test # The test passed
+          logger.info expectation_message
+          return true
+        else
+          logger.fatal "FAILED EXPECTATION: #{expectation_message}"
+          raise AssertionFailedError,  "FAILED EXPECTATION: #{expectation_message}"
+        end
+      end
+    end
+  end
+end

data/lib/noids_client/version.rb

@@ -1,3 +1,3 @@
 module NoidsClient
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/noids_client.gemspec

@@ -8,23 +8,22 @@ Gem::Specification.new do |spec|
   spec.version     = NoidsClient::VERSION
   spec.summary     = 'Ruby client for a NOIDS server'
   spec.description = %q{Provides an idiomatic interface to the REST API of a noids server (see https://github.com/dbrower/noids)}
-  spec.authors     = ['Don Brower']
-  spec.email       = ['dbrower@nd.edu']
+  spec.authors     = ['Don Brower', "Jeremy Friesen"]
+  spec.email       = ['dbrower@nd.edu', "jeremy.n.friesen@gmail.com"]
   spec.license     = 'APACHE2'
-  spec.homepage    = 'https://github.com/ndlib/noids_client'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'rest-client', '~> 1.6'
+  spec.add_dependency 'rest-client', '~> 2.0'
   spec.add_dependency 'json', '~> 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'vcr', '~> 2.8'
-  spec.add_development_dependency 'webmock', '~> 1.17'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  spec.add_development_dependency 'byebug'
 end
-

data/spec/spec_helper.rb

@@ -4,6 +4,9 @@ require 'vcr'
 
 require 'noids_client'
 
+require 'webmock'
+WebMock.enable!
+
 VCR.configure do |c|
   c.cassette_library_dir = 'spec/cassettes'
   c.hook_into :webmock

metadata

@@ -1,127 +1,146 @@
 --- !ruby/object:Gem::Specification
 name: noids_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Don Brower
+- Jeremy Friesen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-20 00:00:00.000000000 Z
+date: 2020-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.8'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: '1.17'
+        version: '0'
 description: Provides an idiomatic interface to the REST API of a noids server (see
   https://github.com/dbrower/noids)
 email:
 - dbrower@nd.edu
+- jeremy.n.friesen@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - lib/noids_client.rb
 - lib/noids_client/connection.rb
+- lib/noids_client/integration_test.rb
 - lib/noids_client/pool.rb
 - lib/noids_client/version.rb
 - noids_client.gemspec
@@ -129,7 +148,7 @@ files:
 - spec/lib/integration_spec.rb
 - spec/lib/pool_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/ndlib/noids_client
+homepage: 
 licenses:
 - APACHE2
 metadata: {}
@@ -139,17 +158,16 @@ 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.1.11
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Ruby client for a NOIDS server
@@ -158,4 +176,3 @@ test_files:
 - spec/lib/integration_spec.rb
 - spec/lib/pool_spec.rb
 - spec/spec_helper.rb
-has_rdoc: