primo_central_counter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e47cedcc636353d5b8623c3693ace12af43eea52
+  data.tar.gz: 34f1cd2abf6c872a71cd69c23a79b6411b7ba312
+SHA512:
+  metadata.gz: cfea6a88d35200f722856f356e709fa2e70912f4a39c07a71b5b8cf3414d238c27e24c044b14a3a67451860bcfe1f9b1b19acff9cf973e967de84c7ba425ded8
+  data.tar.gz: 7c0a88a1b36ada00437370da2928ae0790ff673db98af980d4125faf1f5a780818e8147f7ac9291a8a0a163232c7fefb7ce09dfe74dd9177730c57cf7f660dcc

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in your gemspec
+gemspec
+
+if !ENV["CI"] && RUBY_ENGINE == "ruby"
+  group :development do
+    gem "pry",                "~> 0.9.12.6"
+    gem "pry-byebug",         "<= 1.3.2"
+    gem "pry-rescue",         "~> 1.4.1"
+    gem "pry-stack_explorer", "~> 0.4.9.1"
+    gem "pry-syntax-hacks",   "~> 0.0.6"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Michael Sievers
+
+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,47 @@
+# PrimoCentralCounter
+
+This utility tries to count the number of records in Primo Central. Therefor it issues search requests which should result in disjunct results (e.g. `a*`, `b*` in field `sid`) and retrieves `TOTALHITS` for each search result.
+
+## Installation
+
+    $ gem install primo_central_counter
+
+## Usage
+
+```
+Usage: primo_central_counter [options]
+
+    -u, --base-url=BASE_URL                Primo base url (e.g. http://primo.kobv.de) *required*
+    -i, --institution=INSTITUTION          Institution (e.g. PAD) *required*
+    -c, --on-campus=ON_CAMPUS              Set the on_campus flag (default: true)
+    -f, --index-field=INDEX_FIELD          Index field to use (default: sid)
+        --log-level=LOG_LEVEL              Enable logging (e.g. info or debug)
+    -v, --version                          Display version
+    -h, --help                             Display usage informations
+```
+
+The output is (Excel) CSV on STDOUT. If you enable logging, this will be outputted on STDERR.
+
+### Examples
+
+```
+primo_central_counter -u http://primo.kobv.de -i PAD > ./output.csv
+```
+
+```
+primo_central_counter -u http://primo.kobv.de -i PAD -l info 1> ./output.csv 2> ./messages.txt
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ubpb/primo_central_counter.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "primo_central_counter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/primo_central_counter

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "primo_central_counter"
+
+PrimoCentralCounter::Cli.new(ARGV)

data/lib/primo_central_counter/cli.rb

@@ -0,0 +1,77 @@
+require "logger"
+require_relative "../primo_central_counter"
+require_relative "./counter"
+require_relative "./option_parser"
+require_relative "./soap_discoverer"
+
+class PrimoCentralCounter::Cli
+  def initialize(argv = [])
+    @options = {
+      index_field: "sid",
+      log_level: "error",
+      on_campus: true
+    }
+
+    option_parser(@options).parse!(argv)
+
+    @logger = ::Logger.new(STDERR).tap do |_new_logger|
+      _new_logger.level = ::Logger.const_get @options[:log_level].upcase
+    end
+
+    if @options[:base_url] && @options[:institution] && !@options[:help] && !@options[:version]
+      call
+    elsif @options[:version]
+      puts "#{PrimoCentralCounter::VERSION}"
+    else
+      puts option_parser.help
+    end
+  end
+
+  def call
+    searcher_url = PrimoCentralCounter::SoapDiscoverer.call(@options[:base_url], logger: @logger)
+    queries = [("a".."z").to_a, (0..9).to_a.map(&:to_s)].flatten(1).map { |_char| "#{_char}*" }
+    result = PrimoCentralCounter::Counter.call(searcher_url, queries, @options.merge(logger: @logger))
+    sum = result.inject(0) do |_sum, (_query, _count)|
+      _sum + _count
+    end
+
+    puts sum
+  end
+
+  #
+  private
+  #
+  def option_parser(result = {})
+    PrimoCentralCounter::OptionParser.new(nil, 38) do |_option_parser|
+      _option_parser.banner = "Usage: primo_central_counter [options]\n\n"
+
+      _option_parser.on("-u", "--base-url=BASE_URL", "Primo base url (e.g. http://primo.kobv.de) *required*") do |_value|
+        result[:base_url] = _value
+      end
+
+      _option_parser.on("-i", "--institution=INSTITUTION", "Institution (e.g. PAD) *required*") do |_value|
+        result[:institution] = _value
+      end
+
+      _option_parser.on("-c", "--on-campus=ON_CAMPUS", "Set the on_campus flag (default: #{@options[:on_campus]})") do |_value|
+        result[:index_field] = ["true", "yes", "ja", "1"].include?(value.to_s.downcase) ? true : false
+      end
+      
+      _option_parser.on("-f", "--index-field=INDEX_FIELD", "Index field to use (default: #{@options[:index_field]})") do |_value|
+        result[:index_field] = _value
+      end
+
+      _option_parser.on("--log-level=LOG_LEVEL", "Enable logging (e.g. info or debug)") do |_value|
+        result[:log_level] = _value
+      end
+
+      _option_parser.on("-v", "--version", "Display version") do |_value|
+        result[:version] = true
+      end
+
+      _option_parser.on("-h", "--help", "Display usage informations") do
+        result[:help] = true
+      end
+    end
+  end
+end

data/lib/primo_central_counter/counter.rb

@@ -0,0 +1,76 @@
+require "net/http"
+require "rexml/document"
+require "uri"
+require_relative "../primo_central_counter"
+
+class PrimoCentralCounter::Counter
+  def self.call(searcher_url, queries, options = {})
+    index_field = options[:index_field]
+    institution = options[:institution]
+    logger = options[:logger]
+    on_campus = options[:on_campus]
+    uri = URI.parse(searcher_url)
+
+    # http://stackoverflow.com/questions/11269224/ruby-https-post-with-headers
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    queries.each_with_object({}) do |_query, _hash|
+      request = Net::HTTP::Post.new(uri.path)
+      request["Content-Type"] = "application/xml" # necessary since new soap endpoint (else -> premature end of file error)
+      request["SOAPAction"] = "searchBrief"
+      request.body = soap_request(
+        index_field: index_field,
+        query: _query,
+        institution: institution,
+        on_campus: on_campus
+      )
+
+      response = http.request(request)
+      total_hits = response.body.match(/TOTALHITS[^\s]+/)[0][/\d+/].to_i
+
+      log_info(logger, "Retriving TOTALHITS for #{institution} #{index_field}:\"#{_query}\" (on_campus: #{on_campus}) ... #{total_hits.to_s.rjust(9)}")
+      _hash[_query] = total_hits
+    end
+  end
+
+  private
+
+  def self.log_info(logger, message)
+    logger.info(message) if logger
+  end
+
+  def self.soap_request(options = {})
+    <<-xml
+<?xml version="1.0" encoding="UTF-8"?>
+<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:impl="http://primo.kobv.de/PrimoWebServices/services/searcher" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ins0="http://xml.apache.org/xml-soap">
+  <env:Body>
+    <impl:searchBrief>
+      <searchRequestStr>
+        <![CDATA[
+          <searchRequest xmlns="http://www.exlibris.com/primo/xsd/wsRequest" xmlns:uic="http://www.exlibris.com/primo/xsd/primoview/uicomponents">
+            <PrimoSearchRequest xmlns="http://www.exlibris.com/primo/xsd/search/request">
+              <QueryTerms>
+                <BoolOpeator>AND</BoolOpeator>
+                <QueryTerm>
+                  <IndexField>#{options[:index_field]}</IndexField>
+                  <PrecisionOperator>contains</PrecisionOperator>
+                  <Value>#{options[:query]}</Value>
+                </QueryTerm>
+              </QueryTerms>
+              <StartIndex>1</StartIndex>
+              <BulkSize>0</BulkSize>
+              <Locations>
+                <uic:Location type="adaptor" value="primo_central_multiple_fe"/>               
+              </Locations>
+            </PrimoSearchRequest>
+            <institution>#{options[:institution]}</institution>
+            <onCampus>#{options[:on_campus]}</onCampus>
+          </searchRequest>
+        ]]>
+      </searchRequestStr>
+    </impl:searchBrief>
+  </env:Body>
+</env:Envelope>
+    xml
+  end
+end

data/lib/primo_central_counter/option_parser.rb

@@ -0,0 +1,33 @@
+require "optparse"
+require_relative "../primo_central_counter"
+
+# This class wraps the original OptionParser to "repair" some bad behaviour.
+class PrimoCentralCounter::OptionParser < ::OptionParser
+  # Usually, OptionParser adds default handlers for help, version, etc. This is
+  # a undocumented behavoir and some cases not intended, because the default
+  # handler also stops execution immediately. Thatswhy we remove some of them.
+  def add_officious
+    super
+    base.long.reject! { |_key, _| _key == "help" || _key == "version" }
+  end
+
+  # The original option parser stops processing if it sees any options it does
+  # not know. This implementation uses order!, which is a lower level OptionParser
+  # method to get the requested behavior. Because #parse uses #parse! internally,
+  # this automatically fixes #parse.
+  def parse!(argv)
+    unprocessed_options = []
+
+    begin
+      order!(argv) do |_non_option|
+        unprocessed_options << _non_option
+      end
+    rescue InvalidOption => e
+      unprocessed_options << e.args.first
+      retry
+    end
+    .tap do
+      argv.concat(unprocessed_options)
+    end
+  end
+end

data/lib/primo_central_counter/soap_discoverer.rb

@@ -0,0 +1,22 @@
+require "net/http"
+require "rexml/document"
+require "uri"
+require_relative "../primo_central_counter"
+
+class PrimoCentralCounter::SoapDiscoverer
+  def self.call(primo_base_url, options = {})
+    logger = options[:logger]
+
+    log_info(logger, "Retriving WSDL")
+    wsdl_url = URI.parse("#{primo_base_url}/PrimoWebServices/services/searcher?wsdl")
+    response = Net::HTTP.get_response(wsdl_url)
+    doc = REXML::Document.new response.body
+    doc.elements["//wsdl:service//wsdlsoap:address"].attributes["location"]
+  end
+
+  private
+
+  def self.log_info(logger, message)
+    logger.info(message) if logger
+  end
+end

data/lib/primo_central_counter/version.rb

@@ -0,0 +1,3 @@
+module PrimoCentralCounter
+  VERSION = "0.2.0"
+end

data/lib/primo_central_counter.rb

@@ -0,0 +1,10 @@
+require "primo_central_counter/version"
+
+begin
+  require "pry"
+rescue LoadError
+end
+
+module PrimoCentralCounter
+  require_relative "./primo_central_counter/cli"
+end

data/primo_central_counter.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "primo_central_counter/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "primo_central_counter"
+  spec.version       = PrimoCentralCounter::VERSION
+  spec.authors       = ["Michael Sievers"]
+
+  spec.summary       = %q{A small utility which tries to count the number of records in Primo Central.}
+  spec.homepage      = "https://github.com/ubpb/primo_central_counter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: primo_central_counter
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Michael Sievers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email: 
+executables:
+- primo_central_counter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/primo_central_counter
+- lib/primo_central_counter.rb
+- lib/primo_central_counter/cli.rb
+- lib/primo_central_counter/counter.rb
+- lib/primo_central_counter/option_parser.rb
+- lib/primo_central_counter/soap_discoverer.rb
+- lib/primo_central_counter/version.rb
+- primo_central_counter.gemspec
+homepage: https://github.com/ubpb/primo_central_counter
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A small utility which tries to count the number of records in Primo Central.
+test_files: []