pure_iterator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40c5cd37848eac435da6f66979b843eeaba59551fe1a83a97431b6c28846770e
+  data.tar.gz: 947ba58ff5eeda3fd87ad0b33b08bded49bcaacb21ac1ad9c027bd76a48b5c1d
+SHA512:
+  metadata.gz: 1d22bfb7e46602d1ed7de1d078476171eca7a3ac087048afb099c643eeb8cd8a05028d8440c479c2cb3ad6be7060c63b71c1455d16da735a82fdfd42d2b0013b
+  data.tar.gz: 8e4713b6e68e97ad343e5aed8027c60be383bea467ad752e64023458cb6714b21e2866ce1b7418a989933c6c4881fbc1272b052e6280965e858eedae1bd50854

data/.gitignore

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

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 0.1.0 - 2019-10-25
+### Added
+- Initial product.

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pure_iterator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Adrian Albin-Clark
+
+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,53 @@
+# Pure Iterator
+
+A flexible way to process records in the Pure Research Information System.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pure_iterator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pure_iterator
+
+## Usage
+```ruby
+class Foo < PureIterator::Base
+  def act(response)
+    # do something
+  end
+
+  def post_endpoint
+    'persons'
+  end
+end
+```
+
+```ruby
+def config
+  {
+    host: 'pure.example.com',
+    username: 'YOUR_PURE_USERNAME',
+    password: 'YOUR_PURE_PASSWORD',
+    api_key:  'YOUR_PURE_API_KEY',
+    api_version: 514
+  }
+end
+
+iterator = Foo.new config
+iterator.accept :json # default is :xml
+params = {size: 20} # for pagination, use size and offset
+iterator.iterate params
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/pure_iterator/base.rb

@@ -0,0 +1,86 @@
+require 'http'
+require 'nokogiri'
+
+module PureIterator
+  class Base
+    # @param config [Hash]
+    # @option config [String] :host Pure host
+    # @option config [String] :username Username of the Pure host account
+    # @option config [String] :password Password of the Pure host account
+    # @option config [String] :api_key API key of the Pure host account
+    # @option config [Integer] :api_version Pure API version
+    def initialize(config)
+      http_client = HTTP::Client.new
+      http_client = http_client.headers({ 'api-key' => config[:api_key] })
+      http_client = http_client.basic_auth({user: config[:username], pass: config[:password]})
+      @http_client = http_client
+      @host = config[:host]
+      @api_version = config[:api_version]
+      accept :xml
+    end
+
+    # Set the response Accept type
+    # @param accept [Symbol]
+    def accept(accept)
+      supported_accept = [:xml, :json]
+      raise "Supported Accept values #{supported_accept}" unless supported_accept.include? accept
+      @accept = accept
+    end
+
+    # Traverse a collection, doing something with each response (which may contain multiple records if size parameter used)
+    # @param params [Hash] Pure POST parameters (except page and pageSize)
+    # @return [String] 'done' when collection has been traversed
+    def iterate(params = {})
+      query_record_count = count(params)
+      @http_client = @http_client.headers({ 'Accept' => "application/#{@accept}" })
+      default_query_params = {size: 1, offset: 0}
+      query_options = params.dup
+      query_options.delete :page
+      query_options.delete :pageSize
+      query_params = default_query_params.merge(query_options)
+      while query_params[:offset] < query_record_count
+        response = @http_client.post url, json: query_params
+        act response
+        query_params[:offset] += query_params[:size]
+      end
+      'done'
+    end
+
+    def count(params = {})
+      @http_client = @http_client.headers({ 'Accept' => "application/xml" })
+      default_count_params = {size: 0}
+      count_options = params.dup
+      count_options.delete :size
+      count_options.delete :page
+      count_options.delete :pageSize
+      response = @http_client.post url, json: default_count_params.merge(count_options)
+      if response.code === 200
+        count_from_xml response
+      else
+        raise response
+      end
+    end
+
+    private
+
+    def url
+      File.join 'https://', @host, 'ws', 'api', @api_version.to_s, post_endpoint
+    end
+
+    def count_from_xml(xml)
+      doc = Nokogiri::XML xml
+      doc.remove_namespaces!
+      doc.xpath('/result/count').text.to_i
+    end
+
+    # @return [String] Pure POST endpoint
+    def post_endpoint
+      raise "#{self.class.name}##{__method__} not implemented"
+    end
+
+    # @param response [HTTP::Response]
+    def act(response)
+      raise "#{self.class.name}##{__method__} not implemented"
+    end
+  end
+end

data/lib/pure_iterator/version.rb

@@ -0,0 +1,3 @@
+module PureIterator
+  VERSION = "0.1.0"
+end

data/lib/pure_iterator.rb

@@ -0,0 +1,7 @@
+require "pure_iterator/version"
+require_relative 'pure_iterator/base'
+
+module PureIterator
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/pure_iterator.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pure_iterator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pure_iterator"
+  spec.version       = PureIterator::VERSION
+  spec.authors       = ["Adrian Albin-Clark"]
+  spec.email         = ["a.albin-clark@lancaster.ac.uk"]
+  spec.summary       = %q{A flexible way to process records in the Pure Research Information System.}
+  spec.metadata = {
+    'source_code_uri' => "https://github.com/lulibrary/#{spec.name}",
+    "documentation_uri" => "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}",
+  }
+  spec.license       = "MIT"
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'minitest-reporters', '~> 1.1'
+
+  spec.add_dependency 'http', '~> 3.0'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: pure_iterator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Albin-Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- a.albin-clark@lancaster.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/pure_iterator.rb
+- lib/pure_iterator/base.rb
+- lib/pure_iterator/version.rb
+- pure_iterator.gemspec
+homepage: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/lulibrary/pure_iterator
+  documentation_uri: https://www.rubydoc.info/gems/pure_iterator/0.1.0
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A flexible way to process records in the Pure Research Information System.
+test_files: []