active_fedora-noid 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83ec9c5f0edbe298c0b6fa8371eef1ec7af1651a
-  data.tar.gz: ef4f8031eaf4e0bab414882c4e46e49e67dd7841
+  metadata.gz: 8ccbc2239b7c60748fb0fde64de2810dae5bc1ec
+  data.tar.gz: c76dd79fe28f8d2304f7d9e2e167b286a3a9a07d
 SHA512:
-  metadata.gz: 38f935884a4bb63bc70d10d54fc5ff56c7fde95740954c69af86d717887439427565243518ce2918b65999315ddd0d873ff0db0f325a593398fa79f04d6c4e39
-  data.tar.gz: 03fc4dcfc8c764a650e1f5d03e4769fa88e4fd2ffaa177d3f781bd9d89ab10d3b9fe0e5668a8db2a5ed6bd8b43690494f7d9e689b3ebcbde4e1cb158f8ef625e
+  metadata.gz: d87e041f9caacf82a0ec9c69bb7860b08925deedbfec266352b64436038c0a11645deca8652ed1b31f1963c6d10f4c449041bcdeb8f8d2b8df2e6467f25d19ed
+  data.tar.gz: 4da0a6a9178291ab0bd1aa947f280bea8841cd578a5b9e990afeb2c3833165bd6150fe4b8d4679f8b3f59993fa11e4215b933d3d94313e0288169fb15829b00b

data/.travis.yml

@@ -15,7 +15,6 @@ notifications:
     on_failure: "always"
   irc:
     channels:
-      - "irc.freenode.org#scholarsphere"
       - "irc.freenode.org#projecthydra"
     template:
       - "%{repository}//%{branch}@%{commit} by %{author}: %{message} - %{build_url}"

data/README.md

@@ -4,7 +4,7 @@
 [![API Docs](http://img.shields.io/badge/API-docs-blue.svg)](http://rubydoc.info/gems/active_fedora-noid)
 [![Build Status](https://travis-ci.org/projecthydra-labs/active_fedora-noid.png?branch=master)](https://travis-ci.org/projecthydra-labs/active_fedora-noid)
 [![Dependency Status](https://gemnasium.com/projecthydra-labs/active_fedora-noid.png)](https://gemnasium.com/projecthydra-labs/active_fedora-noid)
-[![Coverage Status](https://img.shields.io/coveralls/projecthydra-labs/active_fedora-noid.svg)](https://coveralls.io/r/projecthydra-labs/active_fedora-noid?branch=master)
+[![Coverage Status](https://coveralls.io/repos/projecthydra-labs/active_fedora-noid/badge.svg)](https://coveralls.io/r/projecthydra-labs/active_fedora-noid)
 
 # ActiveFedora::Noid
 
@@ -12,6 +12,20 @@ Override your ActiveFedora-based applications with opaque [Noid](https://wiki.uc
 
 **This gem depends only upon ActiveFedora, not on Hydra or HydraHead**
 
+# Table of Contents
+
+  * [Installation](#installation)
+  * [Usage](#usage)
+    * [Minting and validating identifiers](#minting-and-validating-identifiers)
+    * [ActiveFedora integration](#activefedora-integration)
+      * [Identifier/URI translation](#identifieruri-translation)
+    * [Overriding default behavior](#overriding-default-behavior)
+      * [Minter state (for replayability)](#minter-state-for-replayability)
+      * [Identifier template](#identifier-template)
+      * [Custom minters](#custom-minters)
+  * [Help](#help)
+  * [Acknowledgments](#acknowledgments)
+
 # Installation
 
 Add this line to your application's Gemfile:
@@ -37,7 +51,7 @@ noid_service = ActiveFedora::Noid::Service.new
 noid = noid_service.mint
 ```
 
-This creates a Noid with the default identifier template, which you can override (see below).  Now that you have a service object with a template, you can also use it to validate identifier to see if they conform to the template:
+This creates a Noid with the default identifier template, which you can override (see below).  Now that you have a service object with a template, you can also use it to validate identifiers to see if they conform to the template:
 
 ```ruby
 noid_service.valid? 'xyz123foobar'
@@ -69,9 +83,22 @@ class MyObject < ActiveFedora::Base
 end
 ```
 
+### Identifier/URI translation
+
+As ActiveFedora::Noid overrides the default identifier minting strategy in ActiveFedora, you will need to let ActiveFedora know how to translate identifiers into URIs and vice versa so that identifiers are laid out in a sustainable way in Fedora.  Add the following to e.g. `config/initializers/active_fedora.rb`:
+
+```ruby
+ActiveFedora::Base.translate_uri_to_id = ActiveFedora::Noid.config.translate_uri_to_id
+ActiveFedora::Base.translate_id_to_uri = ActiveFedora::Noid.config.translate_id_to_uri
+```
+
+This will make sure your objects have Noid-like identifiers (e.g. `bb22bb22b`) that map to URIs in Fedora (e.g. `bb/22/bb/22/bb22bb22b`).
+
 ## Overriding default behavior
 
-The default minter creates a Noid and dumps it to a statefile in the /tmp directory. You can override the location or name of this statefile as follows:
+### Minter state (for replayability)
+
+The default minter creates a Noid and dumps it to a statefile in the /tmp directory. You can override the location or name of this statefile as follows in e.g. `config/initializers/active_fedora-noid.rb`:
 
 ```ruby
 require 'active_fedora/noid'
@@ -81,6 +108,8 @@ ActiveFedora::Noid.configure do |config|
 end
 ```
 
+### Identifier template
+
 To override the default identifier pattern -- a nine-character string consisting of two alphanumeric digits, two numeric digits, two alphanumeric digits, two numeric digits, and a check digit -- put the following code in e.g. `config/initializers/active_fedora-noid.rb`:
 
 ```ruby
@@ -93,6 +122,8 @@ end
 
 For more information about the format of Noid patterns, see pages 8-10 of the [Noid documentation](https://wiki.ucop.edu/download/attachments/16744482/noid.pdf).
 
+### Custom minters
+
 If you don't want your minter's state to be persisted, you may also pass in your own minter.  First write up a minter class that looks like the following:
 
 ```ruby

data/lib/active_fedora/noid/config.rb

@@ -12,7 +12,7 @@ module ActiveFedora
       end
 
       def translate_uri_to_id
-        lambda { |uri| uri.to_s.split('/')[-1] }
+        lambda { |uri| URI(uri).path.split('/', 9).last }
       end
 
       def translate_id_to_uri

data/lib/active_fedora/noid/version.rb

@@ -1,5 +1,5 @@
 module ActiveFedora
   module Noid
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'coveralls'
 Coveralls.wear!
 
+require 'active_fedora/noid'
+
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

data/spec/unit/config_spec.rb

@@ -1,4 +1,4 @@
-require 'active_fedora/noid/config'
+require 'spec_helper'
 
 describe ActiveFedora::Noid::Config do
   it { is_expected.to respond_to(:template) }
@@ -23,4 +23,12 @@ describe ActiveFedora::Noid::Config do
       end
     end
   end
+
+  describe '#translate_uri_to_id' do
+    let(:translator) { described_class.new.translate_uri_to_id }
+    let(:uri) { "http://localhost:8983/fedora/rest/test/hh/63/vz/22/hh63vz22q/members" }
+    subject { translator.call(uri) }
+
+    it { is_expected.to eq 'hh63vz22q/members' }
+  end
 end

data/spec/unit/noid_spec.rb

@@ -1,4 +1,4 @@
-require 'active_fedora/noid'
+require 'spec_helper'
 
 describe ActiveFedora::Noid do
   describe '#configure' do

data/spec/unit/service_spec.rb

@@ -1,5 +1,4 @@
-require 'active_fedora/noid/service'
-require 'active_fedora/noid/synchronized_minter'
+require 'spec_helper'
 
 describe ActiveFedora::Noid::Service do
   describe 'public API' do

data/spec/unit/synchronized_minter_spec.rb

@@ -1,6 +1,5 @@
+require 'spec_helper'
 require 'active_fedora'
-require 'active_fedora/noid'
-require 'active_fedora/noid/synchronized_minter'
 
 describe ActiveFedora::Noid::SynchronizedMinter do
   it { is_expected.to respond_to(:mint) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_fedora-noid
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael J. Giarlo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-31 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active-fedora
@@ -125,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Noid identifier services for ActiveFedora-based applications
@@ -135,3 +135,4 @@ test_files:
 - spec/unit/noid_spec.rb
 - spec/unit/service_spec.rb
 - spec/unit/synchronized_minter_spec.rb
+has_rdoc: