handle-system-rest 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 80560da22c69f15df93fe8e75c12627751d4a67d2737d872677d7e6acca7eb3c
+  data.tar.gz: fc09852264bb245a026acfa8efe66fed8c6e85d71140064e120bda81a54326b8
+SHA512:
+  metadata.gz: 518f266900d680dcc2b826042187109fc7addd8f73a5395500e854be76619ec04d6e0c987737b322b0f4dd083ecc029cc7ce438141f0ae011d1d39cf1842884f
+  data.tar.gz: f29c169459e00f9374b8172f82337b9d1f5a6b220a4238ae1d384be2d72b1bf3c6e1d7097502adab74989ce82c84a9e15cc83bf88fa4c443521aa192a909b0ed

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+Gemfile.lock
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in handle_system.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,205 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2012 Penn State University
+   Copyright 2013 University of Notre Dame, Northwestern University, and Data Curation Experts
+   Copyright 2014 Data Curation Experts
+   Additional copyright may be held by others, as reflected in the commit log
+
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,102 @@
+# HandleSystem
+
+A Ruby library for interfacing with the [Handle System](http://handle.net/) JSON REST API.
+
+## Handle server requirements
+
+This library works with Handle System version 8 or higher.  For older versions of the Handle System, which didn't have a JSON API, consider using mbklien's [Handle](https://github.com/mbklein/handle) library.
+
+### Private key conversion
+
+Before you start using the library, you need to convert your Handle server's private key into PEM format.  The Handle Server distribution directory (e.g., `/hs/handle-9.2.0`) has a utility, `hdl-convert-key`, for doing this.  Your private key (`admpriv.bin`) is in the server directory (e.g., `/hs/svr_1`).
+
+On the Handle server, Run this command to convert the file:
+
+```
+/hs/handle-9.2.0/bin/hdl-convert-key /hs/svr_1/admpriv.bin -o /hs/svr_1/admpriv.pem
+```
+
+Download that `admpriv.pem` file for use with this library.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'handle-system-rest'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install handle-system-rest
+
+## Usage
+
+```ruby
+require 'handle_system'
+
+server = '216.58.217.206:8000'        # server in the form of ip-address:port
+hs_admin = '300:0.NA/20.123.4567'     # the handle server admin
+private_key = '/path/to/admpriv.pem'  # path to private key we downloaded above
+
+# connect to the handle server
+handle_client = HandleSystem::Client.new(server, hs_admin, private_key)
+
+# the url we want to register with the handle system
+hyrax_url = 'https://hyrax.example.edu/concern/theses/6h440t294'
+
+# we need to create a unique handle identifier in the form of 'prefix/suffix'
+
+prefix = '20.123.45678'         # your handle.net registered prefix
+suffix = '2'                    # this can be any unique identifier
+handle = prefix + '/' + suffix
+
+# register our url and get back a new persistent url
+handle_url = handle_client.create(handle, hyrax_url)
+
+puts handle_url  #=> "http://hdl.handle.net/20.123.45678/2"
+
+# get back our original url if we supply the handle
+hyrax_url = handle_client.get(handle).url
+
+puts hyrax_url  #=> "https://hyrax.example.edu/concern/theses/6h440t294"
+
+# we can also delete our handle entry
+result = handle_client.delete(handle)
+
+puts result.to_s  #=> true
+
+# client will throw an AuthenticationError if something went wrong while
+# authenticating with the handle server
+
+begin
+  HandleSystem::Client.new(server, 'bad-admin', private_key)
+rescue HandleSystem::AuthenticationError => e
+  puts 'AuthenticationError'
+  puts '  message: ' + e.message
+end
+
+# client will throw an Error if something went wrong while creating, updating,
+# or deleting a handle
+
+begin
+  handle_client.create('bad-handle', hyrax_url)
+rescue HandleSystem::Error => e
+  puts 'Error for bad handle id'
+  puts '  code: ' + e.response_code.to_s
+  puts '  handle: ' + e.handle
+  puts '  message: ' + e.message
+end
+
+begin
+  handle_client.delete('bad-handle')
+rescue HandleSystem::Error => e
+  puts 'Error when trying to delete a non-existant handle'
+  puts '  code: ' + e.response_code.to_s
+  puts '  handle: ' + e.handle
+  puts '  message: ' + e.message
+end
+
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "handle_system"
+
+# 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(__FILE__)

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/handle_system.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/handle_system/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'handle-system-rest'
+  spec.version       = HandleSystem::VERSION
+  spec.authors       = ['David Walker']
+  spec.email         = ['dwalker@calstate.edu']
+
+  spec.summary       = 'A library for interfacing with the Handle System JSON REST API.'
+  spec.description   =  spec.summary + ' This gem works with Handle System ' +
+                        'version 8 or higher. For older versions of the ' +
+                        "Handle System, which didn't have a JSON API, " +
+                        'consider using the handle-system gem'
+  spec.homepage      = 'https://github.com/csuscholarworks/handle-system'
+  spec.license       = 'APACHE'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/csuscholarworks/handle-system/README.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty', '~> 0.18'
+  spec.add_development_dependency 'solargraph'
+end

data/lib/handle_system/client.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module HandleSystem
+  #
+  # Handle System client
+  #
+  # @author David Walker
+  #
+  class Client
+    #
+    # New Handle System client
+    #
+    # @param [String] server         ip_address:port, e.g., 123.456.78.9:8000
+    # @param [String] hs_admin       handle administrator
+    # @param [String] priv_key_path  file path to private key
+    #
+    def initialize(server, hs_admin, priv_key_path)
+      @http_client = HttpClient.new(server, hs_admin, priv_key_path)
+      @handle_base = 'http://hdl.handle.net/'
+    end
+
+    #
+    # Create a new handle
+    #
+    # @param [String] handle    e.g., 20.500.12345/876
+    # @param [String] url       the url we want to register
+    # @param [String] email     [optional] email address to add to record
+    # @param [String] hs_admin  [optional] handle administrator to add to record
+    #
+    # @return [string] the new handle url at hdl.handle.net
+    #
+    def create(handle, url, email = nil, hs_admin = nil)
+      body = Record.new.from_values(handle, url, email, hs_admin).json
+      json = @http_client.put_it('/handles/' + handle, body)
+      @handle_base + json['handle']
+    end
+
+    # creating and updating handle records is the same thing
+    alias update create
+
+    #
+    # Return the full record for a handle
+    #
+    # @param [String] handle  handle identifier
+    #
+    # @return [<JSON>] the handle record
+    #
+    def get(handle)
+      json = @http_client.get_it('/handles/' + handle)
+      Record.new.from_json(json)
+    end
+
+    #
+    # Delete a handle
+    #
+    # @param [String] handle  handle identifier
+    #
+    # @return [Boolean] true if we deleted the record
+    #
+    def delete(handle)
+      json = @http_client.delete_it('/handles/' + handle)
+      return true if json['responseCode'] == 1
+    end
+  end
+end

data/lib/handle_system/exceptions.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module HandleSystem
+  #
+  # A basic Exception class to wrap the handle server errors
+  #
+  # @author David Walker
+  #
+  class Error < StandardError
+    # @return [Intenger] handle protocol response code for the message
+    attr_reader :response_code
+
+    # @return [String] the handle specified in the request
+    attr_reader :handle
+
+    #
+    # New Handle server Error
+    #
+    # @param [Integer] code    handle protocol response code for the message
+    # @param [String] handle   the handle specified in the request
+    # @param [String] message  error message
+    #
+    def initialize(code, handle, message)
+      @response_code = code.to_int unless code.nil?
+      @handle = handle
+      super(message)
+    end
+  end
+
+  #
+  # Handle server authentication error
+  #
+  # @author David Walker
+  #
+  class AuthenticationError < StandardError; end
+end

data/lib/handle_system/http_client.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+
+require 'base64'
+require 'httparty'
+require 'securerandom'
+
+module HandleSystem
+  #
+  # HTTP utility class for Handle client
+  #
+  # Provides some convenience methods so we don't have to set headers and
+  # options with each request, checks for and throws errors reported by
+  # the handle server, and does the work of acquiring a session
+  #
+  # @author David Walker
+  #
+  class HttpClient
+    include HTTParty
+
+    #
+    # New Handle HTTP client
+    #
+    # @param [String] server         ip_address:port, e.g., 123.456.78.9:8000
+    # @param [String] hs_admin       handle administrator
+    # @param [String] priv_key_path  file path to private key
+    #
+    def initialize(server, hs_admin, priv_key_path)
+      @hs_admin = hs_admin
+      @private_key_path = priv_key_path
+      @base_url = 'https://' + server + '/api'
+      @session_id = initialize_session
+    end
+
+    #
+    # Send a get request
+    #
+    # @param [String] path  relative path from /api end-point
+    #
+    # @raise HandleSystem::Error  if we got an error from the server
+    # @return [JSON]      parsed json response from handle server
+    #
+    def get_it(path)
+      url = @base_url + path
+      json = self.class.get(url, options).parsed_response
+      check_errors(json)
+      json
+    end
+
+    #
+    # Send a put request
+    #
+    # @param [String] path  relative path from /api end-point
+    # @param [String] body  json data object
+    #
+    # @raise HandleSystem::Error  if we got an error from the server
+    # @return [JSON]      parsed json response from handle server
+    #
+    def put_it(path, body)
+      url = @base_url + path
+      json = self.class.put(url, body: body, **options).parsed_response
+      check_errors(json)
+      json
+    end
+
+    #
+    # Send a delete request
+    #
+    # @param [String] path  relative path from /api end-point
+    #
+    # @raise HandleSystem::Error  if we got an error from the server
+    # @return [JSON]      parsed json response from handle server
+    #
+    def delete_it(path)
+      url = @base_url + path
+      json = self.class.delete(url, options).parsed_response
+      check_errors(json)
+      json
+    end
+
+    private
+
+    #
+    # Header and connection options
+    #
+    # @raise HandleSystem::Error
+    # @return [Hash]
+    #
+    def options
+      {
+        headers: {
+          'Content-Type': 'application/json;charset=UTF-8',
+          'Authorization': 'Handle sessionId="' + @session_id + '"'
+        },
+        verify: false
+      }
+    end
+
+    #
+    # If we got an error message from the handle server, convert it into
+    # an actual exception and throw it here
+    #
+    # @param [JSON] json  handle server json response
+    # @raise HandleSystem::Error
+    #
+    def check_errors(json)
+      return unless json['message']
+
+      raise Error.new(json['responseCode'], json['handle'], json['message'])
+    end
+
+    #
+    # Initialize a new session with the handle server using its
+    # challenge-response framework
+    #
+    # @raise AuthenticationError if identity not verified
+    #
+    # @return [String] the authenticated session id
+    #
+    def initialize_session
+      # get initial challenge from handle server
+      url = @base_url + '/sessions/'
+      json = self.class.post(url, verify: false).parsed_response
+      nounce = Base64.decode64(json['nonce'])
+      session_id = json['sessionId']
+
+      # create authorization header
+      headers = {
+        'Content-Type': 'application/json;charset=UTF-8',
+        'Authorization': create_auth_header(nounce, session_id)
+      }
+
+      # send it back to handle server to get authenticated session id
+      opts = { headers: headers, verify: false }
+      json = self.class.put(url + 'this', opts).parsed_response
+      raise AuthenticationError, json['error'] unless json['authenticated']
+
+      json['sessionId']
+    end
+
+    #
+    # Create authentication header
+    #
+    # @param [String] server_nonce  nonce from handle server
+    # @param [String] session_id    session identifier from handle server
+    #
+    # @return [String] handle authorization header
+    #
+    def create_auth_header(server_nonce, session_id)
+      # challenge response is combination of server's nonce and
+      # client nonce that we will create ourselves
+      client_nonce = SecureRandom.random_bytes(16)
+      combined_nonce = server_nonce + client_nonce
+
+      # create combined nonce digest and sign with private key
+      private_key = OpenSSL::PKey::RSA.new(File.read(@private_key_path))
+      signature = private_key.sign(OpenSSL::Digest::SHA256.new, combined_nonce)
+
+      # build the authorization header
+      header = 'Handle sessionId="' + session_id + '", ' \
+              'id="' + CGI.escape(@hs_admin) + '", ' \
+              'type="HS_PUBKEY", ' \
+              'cnonce="' + Base64.encode64(client_nonce) + '", ' \
+              'alg="SHA256", ' \
+              'signature="' + Base64.encode64(signature) + '"'
+      header.gsub("\n", '')
+    end
+  end
+end

data/lib/handle_system/record.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module HandleSystem
+  #
+  # Handle Record entry
+  #
+  # @author David Walker
+  #
+  class Record
+    # @return [Hash] the internal hash data
+    attr_reader :data
+
+    # @return [String] handle identifier
+    attr_reader :handle
+
+    # @return [String] the url we registered
+    attr_reader :url
+
+    # @return [String] email address added to record
+    attr_reader :email
+
+    # @return [String] handle administrator
+    attr_reader :hs_admin
+
+    #
+    # Populate Record from values
+    #
+    # @param [String] handle    e.g., 20.500.12345/876
+    # @param [String] url       the url we want to register
+    # @param [String] email     [optional] email address to add to record
+    # @param [String] hs_admin  [optional] handle administrator to add to record
+    #
+    def from_values(handle, url, email = nil, hs_admin = nil)
+      @handle = handle
+      @url = url
+      @email = email
+      @hs_admin = hs_admin
+
+      values = [build_url_field(url)]
+      values.push(build_email_field(email)) unless email.nil?
+      values.push(build_admin_field(hs_admin)) unless hs_admin.nil?
+      @data = {
+        'values': values,
+        'handle': handle,
+        'responseCode': 1
+      }
+      self
+    end
+
+    #
+    # Populate Record from JSON
+    #
+    # @param [JSON] data  the handle server record as json
+    #
+    def from_json(json)
+      @data = json
+      @handle = json['handle']
+      json['values'].each do |part|
+        value = part['data']['value']
+        @url = value if part['type'] == 'URL'
+        @has_admin = value if part['type'] == 'EMAIL'
+        @email = value if part['type'] == 'HS_ADMIN'
+      end
+      self
+    end
+
+    #
+    # @return [<String>] JSON string
+    #
+    def json
+      @data.to_json
+    end
+
+    private
+
+    #
+    # Current date-time
+    #
+    # @return [String]
+    #
+    def timestamp
+      DateTime.now.strftime('%Y-%m-%dT%H:%M:%SZ')
+    end
+
+    #
+    # Create a new URL field
+    #
+    # @param [String] url  the url we want to register
+    #
+    # @return [Hash]
+    #
+    def build_url_field(url)
+      {
+        'index': 1,
+        'ttl': 86_400,
+        'type': 'URL',
+        'timestamp': timestamp,
+        'data': {
+          'value': url,
+          'format': 'string'
+        }
+      }
+    end
+
+    #
+    # Create a new EMAIL field
+    #
+    # @param [String] email  email address
+    #
+    # @return [Hash]
+    #
+    def build_email_field(email)
+      {
+        'index': 2,
+        'ttl': 86_400,
+        'type': 'EMAIL',
+        'timestamp': timestamp,
+        'data': {
+          'value': email,
+          'format': 'string'
+        }
+      }
+    end
+
+    #
+    # Create a new HS_ADMIN field
+    #
+    # @param [String] hs_admin  handle administrator
+    #
+    # @return [Hash]
+    #
+    def build_admin_field(hs_admin)
+      {
+        'index': 100,
+        'ttl': 86_400,
+        'type': 'HS_ADMIN',
+        'timestamp': timestamp,
+        'data': {
+          'value': {
+            'index': 200,
+            'handle': hs_admin,
+            'permissions': '011111110011'
+          },
+          'format': 'admin'
+        }
+      }
+    end
+  end
+end

data/lib/handle_system/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HandleSystem
+  VERSION = '0.1.1'
+end

data/lib/handle_system.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'handle_system/client'
+require 'handle_system/exceptions'
+require 'handle_system/http_client'
+require 'handle_system/record'

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: handle-system-rest
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- David Walker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: solargraph
+  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: '0'
+description: A library for interfacing with the Handle System JSON REST API. This
+  gem works with Handle System version 8 or higher. For older versions of the Handle
+  System, which didn't have a JSON API, consider using the handle-system gem
+email:
+- dwalker@calstate.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- handle_system.gemspec
+- lib/handle_system.rb
+- lib/handle_system/client.rb
+- lib/handle_system/exceptions.rb
+- lib/handle_system/http_client.rb
+- lib/handle_system/record.rb
+- lib/handle_system/version.rb
+homepage: https://github.com/csuscholarworks/handle-system
+licenses:
+- APACHE
+metadata:
+  homepage_uri: https://github.com/csuscholarworks/handle-system
+  source_code_uri: https://github.com/csuscholarworks/handle-system
+  changelog_uri: https://github.com/csuscholarworks/handle-system/README.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A library for interfacing with the Handle System JSON REST API.
+test_files: []