aspace_client 0.0.1

data/lib/aspace_client/memoryleak.rb

@@ -0,0 +1,59 @@
+require 'atomic'
+require 'thread'
+
+module MemoryLeak
+
+  class Resources
+
+    @@refresh_mutex = Mutex.new
+
+    @@resources = {}
+    @@refresh_fns = {}
+    @@expiration_seconds = {}
+
+
+    def self.define(resource, refresh_fn, ttl, opts = {})
+      @@resources[resource] = Atomic.new(nil)
+      @@refresh_fns[resource] = refresh_fn
+      @@expiration_seconds[resource] = ttl if ttl
+
+      self.set(resource, opts[:init], 0)
+    end
+
+
+    def self.get(resource)
+      stale = (@@resources[resource].value.nil? ||
+               (@@expiration_seconds[resource] &&
+                (Time.now.to_i - @@resources[resource].value[:system_mtime]) > @@expiration_seconds[resource]))
+
+      self.refresh(resource) if stale
+
+      @@resources[resource].value[:value]
+    end
+
+
+    def self.refresh(resource)
+      # Two concurrent users might trigger some resource to be refreshed at
+      # around the same time (e.g. when two people create a new repository at
+      # once).  We want both refreshes to run in sequence, so use a mutex to
+      # serialize them.
+      @@refresh_mutex.synchronize do
+        self.set(resource, @@refresh_fns[resource].call)
+      end
+    end
+
+
+    def self.set(resource, value, time = nil)
+      @@resources[resource].swap({:value => value, :system_mtime => (time || Time.now.to_i)})
+    end
+
+
+    def self.invalidate_all!
+      @@resources.values.each do |atom|
+        atom.update {|val| val.merge(:system_mtime => 0) if val}
+      end
+    end
+
+  end
+
+end

data/lib/aspace_client/schemas/abstract_agent.rb

@@ -0,0 +1,51 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "title" => {
+        "type" => "string",
+        "readonly" => true
+      },
+
+      "is_linked_to_published_record" => {"type" => "boolean", "readonly" => true},
+
+      "agent_type" => {
+        "type" => "string",
+        "required" => false,
+        "enum" => ["agent_person", "agent_corporate_entity", "agent_software", "agent_family", "user"]
+      },
+
+      "agent_contacts" => {
+        "type" => "array",
+        "items" => {"type" => "JSONModel(:agent_contact) object"}
+      },
+
+      "linked_agent_roles" => {
+        "type" => "array",
+        "items" => {"type" => "string"},
+        "readonly" => true
+      },
+
+      "external_documents" => {"type" => "array", "items" => {"type" => "JSONModel(:external_document) object"}},
+
+      "system_generated" => {
+        "readonly" => true,
+        "type" => "boolean"
+      },
+
+      "notes" => {
+        "type" => "array",
+        "items" => {"type" => [{"type" => "JSONModel(:note_bioghist) object"}]},
+      },
+      
+      "dates_of_existence" => {"type" => "array", "items" => {"type" => "JSONModel(:date) object"}},
+
+      "publish" => {"type" => "boolean"},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/abstract_agent_relationship.rb

@@ -0,0 +1,12 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "subtype" => "ref",
+    "properties" => {
+      "description" => {"type" => "string", "maxLength" => 65000},
+      "dates" => {"type" => "JSONModel(:date) object"}
+    }
+  }
+}

data/lib/aspace_client/schemas/abstract_archival_object.rb

@@ -0,0 +1,96 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
+
+      "title" => {"type" => "string", "minLength" => 1, "maxLength" => 16384, "ifmissing" => "error"},
+      "language" => {"type" => "string", "dynamic_enum" => "language_iso639_2"},
+
+      "publish" => {"type" => "boolean"},
+
+      "subjects" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => "JSONModel(:subject) uri",
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "linked_events" => {
+        "type" => "array",
+        "readonly" => "true",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => "JSONModel(:event) uri",
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+
+      "extents" => {"type" => "array", "items" => {"type" => "JSONModel(:extent) object"}},
+      "dates" => {"type" => "array", "items" => {"type" => "JSONModel(:date) object"}},
+      "external_documents" => {"type" => "array", "items" => {"type" => "JSONModel(:external_document) object"}},
+      "rights_statements" => {"type" => "array", "items" => {"type" => "JSONModel(:rights_statement) object"}},
+      "linked_agents" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "role" => {
+              "type" => "string",
+              "dynamic_enum" => "linked_agent_role",
+              "ifmissing" => "error",
+            },
+
+            "terms" => {"type" => "array", "items" => {"type" => "JSONModel(:term) uri_or_object"}},
+
+            "relator" => {
+              "type" => "string",
+              "dynamic_enum" => "linked_agent_archival_record_relators",
+            },
+
+            "title" => {"type" => "string"},
+
+            "ref" => {"type" => [{"type" => "JSONModel(:agent_corporate_entity) uri"},
+                                 {"type" => "JSONModel(:agent_family) uri"},
+                                 {"type" => "JSONModel(:agent_person) uri"},
+                                 {"type" => "JSONModel(:agent_software) uri"}],
+              "ifmissing" => "error"},
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "suppressed" => {"type" => "boolean", "readonly" => "true"},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/abstract_classification.rb

@@ -0,0 +1,44 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "identifier" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+      "title" => {"type" => "string", "minLength" => 1, "maxLength" => 16384, "ifmissing" => "error"},
+      "description" => {"type" => "string", "maxLength" => 65000},
+
+      "publish" => {"type" => "boolean", "default" => true, "readonly" => true},
+
+      "path_from_root" => {
+        "type" => "array",
+        "readonly" => true,
+        "items" => {
+          "type" => "object",
+          "properties" => {
+            "identifier" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+            "title" => {"type" => "string", "minLength" => 1, "maxLength" => 16384, "ifmissing" => "error"},
+          }
+        }
+      },
+
+      "creator" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {"type" => [{"type" => "JSONModel(:agent_corporate_entity) uri"},
+                               {"type" => "JSONModel(:agent_family) uri"},
+                               {"type" => "JSONModel(:agent_person) uri"},
+                               {"type" => "JSONModel(:agent_software) uri"}],
+            "ifmissing" => "error"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+    },
+  },
+}

data/lib/aspace_client/schemas/abstract_name.rb

@@ -0,0 +1,23 @@
+# Note: This schema isn't used directly: it's here for inheritance purposes
+# only.
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "authority_id" => {"type" => "string", "maxLength" => 255},
+      "dates" => {"type" => "string", "maxLength" => 255},
+      "use_dates" => {"type" => "array", "items" => {"type" => "JSONModel(:date) object"}},
+      "qualifier" => {"type" => "string", "maxLength" => 255},
+      "source" => {"type" => "string", "dynamic_enum" => "name_source"},
+      "rules" => {"type" => "string", "dynamic_enum" => "name_rule"},
+
+      "authorized" => {"type" => "boolean", "default" => false},
+      "is_display_name" => {"type" => "boolean", "default" => false},
+
+      "sort_name" => {"type" => "string", "maxLength" => 255},
+      "sort_name_auto_generate" => {"type" => "boolean", "default" => true},
+    },
+  },
+}

data/lib/aspace_client/schemas/abstract_note.rb

@@ -0,0 +1,13 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+      "label" => {"type" => "string", "maxLength" => 65000},
+      "publish" => {"type" => "boolean"},
+      "persistent_id" => {"type" => "string", "maxLength" => 255},
+      "ingest_problem" => {"type" => "string", "maxLength" => 65000},
+    },
+  },
+}

data/lib/aspace_client/schemas/accession.rb

@@ -0,0 +1,174 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/accessions",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
+
+      "title" => {"type" => "string", "maxLength" => 8192, "ifmissing" => nil},
+      "display_string" => {"type" => "string", "maxLength" => 8192, "readonly" => true},
+
+      "id_0" => {"type" => "string", "ifmissing" => "error", "maxLength" => 255},
+      "id_1" => {"type" => "string", "maxLength" => 255},
+      "id_2" => {"type" => "string", "maxLength" => 255},
+      "id_3" => {"type" => "string", "maxLength" => 255},
+
+      "content_description" => {"type" => "string", "maxLength" => 65000},
+      "condition_description" => {"type" => "string", "maxLength" => 65000},
+
+      "disposition" => {"type" => "string", "maxLength" => 65000},
+      "inventory" => {"type" => "string", "maxLength" => 65000},
+
+      "provenance" => {"type" => "string", "maxLength" => 65000},
+
+      "related_accessions" => {
+        "type" => "array",
+        "items" => {"type" => [{"type" => "JSONModel(:accession_parts_relationship) object"},
+                               {"type" => "JSONModel(:accession_sibling_relationship) object"}]},
+      },
+
+
+      "accession_date" => {"type" => "date", "minLength" => 1, "ifmissing" => "error"},
+
+      "publish" => {"type" => "boolean"},
+
+      "classification" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {
+            "type" => [{"type" => "JSONModel(:classification) uri"},
+                       {"type" => "JSONModel(:classification_term) uri"}],
+            "ifmissing" => "error"
+          },
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+
+      "subjects" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => "JSONModel(:subject) uri",
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "linked_events" => {
+        "type" => "array",
+        "readonly" => "true",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => "JSONModel(:event) uri",
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "extents" => {"type" => "array", "items" => {"type" => "JSONModel(:extent) object"}},
+      "dates" => {"type" => "array", "items" => {"type" => "JSONModel(:date) object"}},
+      "external_documents" => {"type" => "array", "items" => {"type" => "JSONModel(:external_document) object"}},
+      "rights_statements" => {"type" => "array", "items" => {"type" => "JSONModel(:rights_statement) object"}},
+      "deaccessions" => {"type" => "array", "items" => {"type" => "JSONModel(:deaccession) object"}},
+      "collection_management" => {"type" => "JSONModel(:collection_management) object"},
+      "user_defined" => {"type" => "JSONModel(:user_defined) object"},
+
+      "related_resources" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => [{"type" => "JSONModel(:resource) uri"}],
+                      "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "suppressed" => {"type" => "boolean", "readonly" => "true"},
+
+      "acquisition_type" => {"type" => "string", "dynamic_enum" => "accession_acquisition_type"},
+      
+      "resource_type" => {"type" => "string", "dynamic_enum" => "accession_resource_type"},
+      
+      "restrictions_apply" => {"type" => "boolean", "default" => false},
+
+      "retention_rule" => {"type" => "string", "maxLength" => 65000},
+      
+      "general_note" => {"type" => "string", "maxLength" => 65000},
+      
+      "access_restrictions" => {"type" => "boolean", "default" => false},
+      "access_restrictions_note" => {"type" => "string", "maxLength" => 65000},
+      
+      "use_restrictions" => {"type" => "boolean", "default" => false},
+      "use_restrictions_note" => {"type" => "string", "maxLength" => 65000},
+
+      "linked_agents" => {
+        "type" => "array",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "role" => {
+              "type" => "string",
+              "dynamic_enum" => "linked_agent_role",
+              "ifmissing" => "error"
+            },
+
+            "terms" => {"type" => "array", "items" => {"type" => "JSONModel(:term) uri_or_object"}},
+
+            "title" => {"type" => "string"},
+
+            "relator" => {
+              "type" => "string",
+              "dynamic_enum" => "linked_agent_archival_record_relators",
+            },
+
+            "ref" => {"type" => [{"type" => "JSONModel(:agent_corporate_entity) uri"},
+                                 {"type" => "JSONModel(:agent_family) uri"},
+                                 {"type" => "JSONModel(:agent_person) uri"},
+                                 {"type" => "JSONModel(:agent_software) uri"}],
+              "ifmissing" => "error"},
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        }
+      },
+
+      "instances" => {"type" => "array", "items" => {"type" => "JSONModel(:instance) object"}},
+
+    },
+  },
+}