aspace_client 0.0.1

data/lib/aspace_client/schemas/boolean_query.rb

@@ -0,0 +1,13 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "op" => {"type" => "string", "enum" => ["AND", "OR", "NOT"], "ifmissing" => "error"},
+      "subqueries" => {"type" => ["JSONModel(:boolean_query) object", "JSONModel(:field_query) object", "JSONModel(:boolean_field_query) object", "JSONModel(:date_field_query) object"], "ifmissing" => "error", "minItems" => 1},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/classification.rb

@@ -0,0 +1,10 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_classification",
+    "uri" => "/repositories/:repo_id/classifications",
+    "properties" => {},
+  },
+}

data/lib/aspace_client/schemas/classification_term.rb

@@ -0,0 +1,38 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_classification",
+    "uri" => "/repositories/:repo_id/classification_terms",
+    "properties" => {
+
+      "position" => {"type" => "integer", "required" => false},
+
+      "parent" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {"type" => "JSONModel(:classification_term) uri"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        },
+      },
+
+      "classification" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "ifmissing" => "error",
+        "properties" => {
+          "ref" => {"type" => "JSONModel(:classification) uri"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          },
+        }
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/classification_tree.rb

@@ -0,0 +1,17 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/classifications/:classification_id/tree",
+    "parent" => "record_tree",
+    "properties" => {
+      "identifier" => {"type" => "string", "maxLength" => 255},
+      "children" => {
+        "type" => "array",
+        "additionalItems" => false,
+        "items" => { "type" => "JSONModel(:classification_tree) object" }
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/collection_management.rb

@@ -0,0 +1,27 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/collection_management",
+    "properties" => {
+      "uri" => {"type" => "string", "required" => false},
+
+      "external_ids" => {"type" => "array", "items" => {"type" => "JSONModel(:external_id) object"}},
+
+      "cataloged_note" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "processing_hours_per_foot_estimate" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "processing_total_extent" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "processing_total_extent_type" => {"type" => "string", "required" => false, "dynamic_enum" => "extent_extent_type"},
+      "processing_hours_total" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "processing_plan" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "processing_priority" => {"type" => "string", "required" => false, "dynamic_enum" => "collection_management_processing_priority"},
+      "processing_started_date" => {"type" => "date", "minLength" => 1, "required" => false},
+      "processing_status" => {"type" => "string", "required" => false, "dynamic_enum" => "collection_management_processing_status"},
+      "processing_funding_source" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "processors" => {"type" => "string", "maxLength" => 65000, "required" => false},
+      "rights_determined" => {"type" => "boolean", "default" => false},
+
+    },
+  }
+}

data/lib/aspace_client/schemas/container.rb

@@ -0,0 +1,29 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "type_1" => {"type" => "string", "dynamic_enum" => "container_type", "required" => false},
+      "indicator_1" => {"type" => "string", "maxLength" => 255, "minLength" => 1, "required" => false },
+      "barcode_1" => {"type" => "string", "maxLength" => 255, "minLength" => 1},
+
+      "type_2" => {"type" => "string", "dynamic_enum" => "container_type"},
+      "indicator_2" => {"type" => "string", "maxLength" => 255},
+
+      "type_3" => {"type" => "string", "dynamic_enum" => "container_type"},
+      "indicator_3" => {"type" => "string", "maxLength" => 255},
+
+      "container_extent" => {"type" => "string", "maxLength" => 255, "required" => false},
+      "container_extent_type" => {"type" => "string", "required" => false, "dynamic_enum" => "extent_extent_type"},
+
+      "container_locations" => {
+        "type" => "array",
+        "items" => {
+          "type" => "JSONModel(:container_location) object",
+        }
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/container_location.rb

@@ -0,0 +1,19 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "subtype" => "ref",
+    "properties" => {
+      "status" => {"type" => "string", "minLength" => 1, "ifmissing" => "error", "dynamic_enum" => "container_location_status"},
+      "start_date" => {"type" => "date", "minLength" => 1, "ifmissing" => "error"},
+      "end_date" => {"type" => "date"},
+      "note" => {"type" => "string"},
+      "ref" => {"type" => "JSONModel(:location) uri", "ifmissing" => "error"},
+      "_resolved" => {
+        "type" => "object",
+        "readonly" => "true"
+      }
+    },
+  },
+}

data/lib/aspace_client/schemas/date.rb

@@ -0,0 +1,19 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+
+    "properties" => {
+      "date_type" => {"type" => "string", "dynamic_enum" => "date_type", "ifmissing" => "error"},
+      "label" => {"type" => "string", "dynamic_enum" => "date_label", "ifmissing" => "error"},
+
+      "certainty" => {"type" => "string", "dynamic_enum" => "date_certainty"},
+      "expression" => {"type" => "string", "maxLength" => 255},
+      "begin" => {"type" => "string", "maxLength" => 255},
+      "end" => {"type" => "string", "maxLength" => 255},
+      "era" => {"type" => "string", "dynamic_enum" => "date_era"},
+      "calendar" => {"type" => "string", "dynamic_enum" => "date_calendar"},
+    },
+  },
+}

data/lib/aspace_client/schemas/date_field_query.rb

@@ -0,0 +1,14 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "comparator" => {"type" => "string", "enum" => ["greater_than", "lesser_than", "equal"]},
+      "field" => {"type" => "string", "ifmissing" => "error"},
+      "value" => {"type" => "date", "ifmissing" => "error"},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/deaccession.rb

@@ -0,0 +1,20 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "scope" => {"type" => "string", "dynamic_enum" => "deaccession_scope", "ifmissing" => "error"},
+      "description" => {"type" => "string", "maxLength" => 65000, "minLength" => 1, "ifmissing" => "error"},
+
+      "reason" => {"type" => "string", "maxLength" => 65000},
+      "disposition" => {"type" => "string", "maxLength" => 65000},
+      "notification" => {"type" => "boolean", "default" => false},
+
+      "date" => {"type" => "JSONModel(:date) object", "ifmissing" => "error"},
+
+      "extents" => {"type" => "array", "items" => {"type" => "JSONModel(:extent) object"}},
+    },
+  },
+}

data/lib/aspace_client/schemas/defaults.rb

@@ -0,0 +1,104 @@
+accession_browse_column_enum = [
+                      "identifier", "accession_date", "acquisition_type", "resource_type",
+                      "restrictions_apply", "access_restrictions", "use_restrictions",
+                      "publish", 'no_value'
+                     ]
+resource_browse_column_enum = [
+                      "identifier", "resource_type", "level", "language", "restrictions",
+                      "ead_id", "finding_aid_status", "publish", 'no_value'
+                     ]
+digital_object_browse_column_enum = [
+                      "digital_object_id", "digital_object_type", "level", "restrictions",
+                      "publish", 'no_value'
+                     ]
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "properties" => {
+
+      "show_suppressed" =>  {"type" => "boolean", "required" => false},
+      "publish" =>  {"type" => "boolean", "required" => false},
+
+      "accession_browse_column_1" => {
+        "type" => "string",
+        "enum" => accession_browse_column_enum,
+        "required" => false
+      },
+      "accession_browse_column_2" => {
+        "type" => "string",
+        "enum" => accession_browse_column_enum,
+        "required" => false
+      },
+      "accession_browse_column_3" => {
+        "type" => "string",
+        "enum" => accession_browse_column_enum,
+        "required" => false
+      },
+      "accession_browse_column_4" => {
+        "type" => "string",
+        "enum" => accession_browse_column_enum,
+        "required" => false
+      },
+      "accession_browse_column_5" => {
+        "type" => "string",
+        "enum" => accession_browse_column_enum,
+        "required" => false
+      },
+
+      "resource_browse_column_1" => {
+        "type" => "string",
+        "enum" => resource_browse_column_enum,
+        "required" => false
+      },
+      "resource_browse_column_2" => {
+        "type" => "string",
+        "enum" => resource_browse_column_enum,
+        "required" => false
+      },
+      "resource_browse_column_3" => {
+        "type" => "string",
+        "enum" => resource_browse_column_enum,
+        "required" => false
+      },
+      "resource_browse_column_4" => {
+        "type" => "string",
+        "enum" => resource_browse_column_enum,
+        "required" => false
+      },
+      "resource_browse_column_5" => {
+        "type" => "string",
+        "enum" => resource_browse_column_enum,
+        "required" => false
+      },
+
+      "digital_object_browse_column_1" => {
+        "type" => "string",
+        "enum" => digital_object_browse_column_enum,
+        "required" => false
+      },
+      "digital_object_browse_column_2" => {
+        "type" => "string",
+        "enum" => digital_object_browse_column_enum,
+        "required" => false
+      },
+      "digital_object_browse_column_3" => {
+        "type" => "string",
+        "enum" => digital_object_browse_column_enum,
+        "required" => false
+      },
+      "digital_object_browse_column_4" => {
+        "type" => "string",
+        "enum" => digital_object_browse_column_enum,
+        "required" => false
+      },
+      "digital_object_browse_column_5" => {
+        "type" => "string",
+        "enum" => digital_object_browse_column_enum,
+        "required" => false
+      },
+
+    },
+  },
+}

data/lib/aspace_client/schemas/digital_object.rb

@@ -0,0 +1,64 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_archival_object",
+    "uri" => "/repositories/:repo_id/digital_objects",
+    "properties" => {
+
+      "digital_object_id" => {"type" => "string", "maxLength" => 255, "ifmissing" => "error"},
+      "level" => {"type" => "string", "dynamic_enum" => "digital_object_level"},
+      "digital_object_type" => {
+        "type" => "string",
+        "dynamic_enum" => "digital_object_digital_object_type"
+      },
+
+      "file_versions" => {"type" => "array", "items" => {"type" => "JSONModel(:file_version) object"}},
+
+      "restrictions" => {"type" => "boolean", "default" => false},
+      "tree" => {
+          "type" => "object", 
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => "JSONModel(:digital_object_tree) uri",
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+      },
+
+
+      "notes" => {
+            "type" => "array",
+            "items" => {"type" => [{"type" => "JSONModel(:note_bibliography) object"},
+                                   {"type" => "JSONModel(:note_digital_object) object"}]},
+          },
+      "collection_management" => {"type" => "JSONModel(:collection_management) object"},
+      "user_defined" => {"type" => "JSONModel(:user_defined) object"},
+
+      "linked_instances" => {
+        "type" => "array",
+        "readonly" => "true",
+        "items" => {
+          "type" => "object",
+          "subtype" => "ref",
+          "properties" => {
+            "ref" => {
+              "type" => ["JSONModel(:resource) uri", "JSONModel(:archival_object) object"],
+              "ifmissing" => "error"
+            },
+            "_resolved" => {
+              "type" => "object",
+              "readonly" => "true"
+            }
+          }
+        },
+      },
+    },
+  },
+}

data/lib/aspace_client/schemas/digital_object_component.rb

@@ -0,0 +1,53 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "parent" => "abstract_archival_object",
+    "uri" => "/repositories/:repo_id/digital_object_components",
+    "properties" => {
+
+      "component_id" => {"type" => "string", "maxLength" => 255},
+      "label" => {"type" => "string", "maxLength" => 255},
+      "title" => {"type" => "string", "maxLength" => 16384, "ifmissing" => nil},
+      "display_string" => {"type" => "string", "maxLength" => 8192, "readonly" => true},
+
+      "file_versions" => {"type" => "array", "items" => {"type" => "JSONModel(:file_version) object"}},
+
+      "parent" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {"type" => "JSONModel(:digital_object_component) uri"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+
+      "digital_object" => {
+        "type" => "object",
+        "subtype" => "ref",
+        "properties" => {
+          "ref" => {"type" => "JSONModel(:digital_object) uri"},
+          "_resolved" => {
+            "type" => "object",
+            "readonly" => "true"
+          }
+        }
+      },
+
+      "position" => {"type" => "integer", "required" => false},
+
+      "notes" => {
+            "type" => "array",
+            "items" => {"type" => [{"type" => "JSONModel(:note_bibliography) object"},
+                                   {"type" => "JSONModel(:note_digital_object) object"}]},
+          },
+
+      "has_unpublished_ancestor" => {"type" => "boolean", "readonly" => "true"},
+
+    },
+  },
+}

data/lib/aspace_client/schemas/digital_object_tree.rb

@@ -0,0 +1,19 @@
+{
+  :schema => {
+    "$schema" => "http://www.archivesspace.org/archivesspace.json",
+    "version" => 1,
+    "type" => "object",
+    "uri" => "/repositories/:repo_id/digital_objects/:digital_object_id/tree",
+    "parent" => "record_tree",
+    "properties" => {
+      "level" => {"type" => "string", "maxLength" => 255},
+      "digital_object_type" => {"type" => "string", "maxLength" => 255},
+      "file_versions" => {"type" => "array", "items" => {"type" => "object"}},
+      "children" => {
+        "type" => "array",
+        "additionalItems" => false,
+        "items" => { "type" => "JSONModel(:digital_object_tree) object" }
+      }
+    },
+  },
+}