annotot 0.2.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: be4df7aa9f2057db9fca11f7d9d502aca19f0e5f
-  data.tar.gz: f61ed7cc230a9baa013a802d28a0a303cafcc565
+SHA256:
+  metadata.gz: f30142a82474f3723a5d0e041a7b26bce696b1aa975d6b4dc3da81b7cc89ad43
+  data.tar.gz: 1f3d9a4ebb62364cb8ca4a2eea465abc6e4a461b397a61949afe4380c0c2f200
 SHA512:
-  metadata.gz: a8d2afb622d7478d7572a5d51c7da7812a33d2ce53218b33c975f9ca535a6e8d1e1144a87e35a64cf0ec5c7540675f5485506e95f3fcae54802952e18cfedc0b
-  data.tar.gz: c394334b580a956cada38ca7848a51f14b6780eaa566e5d09b5b3b0c81be948121986bd0aff73c96c6c62081df5141e0e52bfb445768b0bf5a64f70dd1f9dde3
+  metadata.gz: bfbefc765005d29ab2ec2810941692a93a2d02111701c86648ba9e08efd4b21ee6f639ebf6ea209a185777e7b8020d013b1244c34dedbaff4a3b48ee5dd39421
+  data.tar.gz: 0a93107a49bf745413b4f515e6ceb072d62159f9c5d47919bf615b7b22eef27e4e1af984cf10ea647a0664491552f5f58dbcd666562a0bd3dccf784bf7442059

data/README.md

@@ -3,7 +3,7 @@
 
 Need to persist annotations quick and easily? Annotot, the original mini annotation API is for you. Don't annotate, annotot instead.
 
-h/t @efahy for the inspiration and name
+h/t [@eefahy](https://github.com/eefahy) for the inspiration and name
 
 ![](annotot.png)
 
@@ -30,6 +30,76 @@ annotationEndpoint: {
 
 If you want to configure Annotot to receive annotations from external sources make sure that you enable CORs in the Rails application. This can be done using [rack-cors](https://github.com/cyu/rack-cors).
 
+## API
+
+Annotot by default mounts itself at `/`. Though [this can be changed](http://guides.rubyonrails.org/engines.html#mounting-the-engine). All API endpoints are relative to its mount location.
+
+| Path / Url | HTTP Verb | Path | Controller#Action |
+| --- | --- | --- | --- |
+| [annotations_path](#annotationspath) | GET | /annotations(.:format) | annotot/annotations#index {:format=>:json} |
+| | POST | /annotations(.:format) | annotot/annotations#create {:format=>:json} |
+| [lists_annotations_path](#listsannotationspath) | GET | /annotations/lists(.:format) | annotot/annotations#lists {:format=>:json} |
+| [annotation_path](#annotationpath) | PATCH | /annotations/:id(.:format) | annotot/annotations#update {:format=>:json} |
+| | PUT | /annotations/:id(.:format) |  annotot/annotations#update {:format=>:json}
+| | DELETE | /annotations/:id(.:format) |  annotot/annotations#destroy {:format=>:json}
+
+---
+
+### annotations_path
+`GET` - Return annotations for a given canvas
+
+Parameters:
+
+| Name | Required? | Description |
+| --- | --- | --- |
+| uri | yes | Canvas uri for which to return annotations
+
+`POST` -  Create a new annotation
+
+Parameters:
+
+| Name | Required? | Description |
+| --- | --- | --- |
+| annotation | yes | object containing creation parameters
+| annotation.uuid | no | uuid for annotation
+| annotation.data | no | annotation body data as string
+| annotation.canvas | no | canvas to place the annotation on
+
+---
+
+### lists_annotations_path
+`GET` - Return an AnnotationList of annotations for a given canvas
+
+Parameters:
+
+| Name | Required? | Description |
+| --- | --- | --- |
+| uri | yes | Canvas uri for which to return annotations
+
+---
+
+### annotation_path
+`PATCH`, `PUT` - Update an annotation
+
+Parameters:
+
+| Name | Required? | Description |
+| --- | --- | --- |
+| id | yes | Canvas uri or Rails ActiveRecord id for annotation to update
+| annotation | yes | object containing creation parameters
+| annotation.uuid | no | uuid for annotation
+| annotation.data | no | annotation body data as string
+| annotation.canvas | no | canvas to place the annotation on
+
+`DELETE` - Delete an annotation
+
+Parameters:
+
+| Name | Required? | Description |
+| --- | --- | --- |
+| id | yes | Canvas uri or Rails ActiveRecord id for annotation to delete
+
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/app/assets/javascripts/annotot/annotot_endpoint.js

@@ -31,7 +31,7 @@
     search: function(options, successCallback, errorCallback) {
       var _this = this;
       _this.annotationsList = [];
-      options.format = 'json'
+      options.format = 'json';
 
       jQuery.ajax({
         url: _this.endpoint,
@@ -65,7 +65,7 @@
     deleteAnnotation: function(annotationID, successCallback, errorCallback) {
       var _this = this;
       jQuery.ajax({
-        url: _this.endpoint + '/' + annotationID,
+        url: _this.endpoint + '/' + encodeURIComponent(annotationID),
         type: 'DELETE',
         dataType: 'json',
         headers: {
@@ -89,11 +89,11 @@
     update: function(oaAnnotation, successCallback, errorCallback) {
       var _this = this;
       var annotation = _this.getAnnotationInEndpoint(oaAnnotation);
-      
-      var annotationID = annotation.annotation['uuid'];
+
+      var annotationID = annotation.annotation.uuid;
 
       jQuery.ajax({
-        url: _this.endpoint + '/' + annotationID,
+        url: _this.endpoint + '/' + encodeURIComponent(annotationID),
         type: 'PATCH',
         dataType: 'json',
         headers: {
@@ -158,13 +158,15 @@
     // Converts OA Annotation to endpoint format
     getAnnotationInEndpoint: function(oaAnnotation) {
       // Generate a new uuid if one is not present
-      if (oaAnnotation['@id'] == null) {
+      // condition needs to be set to check for "falsy" values
+      // !oaAnnotation['@id'] should match null and undefined
+      if (!oaAnnotation['@id']) {
         oaAnnotation["@id"] = Mirador.genUUID();
       }
-      
+
       canvas = oaAnnotation.on[0].full;
       var newAnno = jQuery.extend({}, oaAnnotation);
-      delete newAnno.endpoint
+      delete newAnno.endpoint;
       return {
         annotation: {
           uuid: oaAnnotation["@id"],

data/app/controllers/annotot/annotations_controller.rb

@@ -2,18 +2,26 @@ require_dependency "annotot/application_controller"
 
 module Annotot
   class AnnotationsController < ApplicationController
-    before_action :set_annotation, only: %i[update destroy]
+    before_action :set_annotation, only: %i[update destroy show]
 
     # GET /annotations
     def index
       @annotations = Annotation.where(canvas: annotation_search_params)
     end
 
+    # GET /annotations
+    def show; end
+
     # Get /annotations/lists
     def lists
       @annotations = Annotation.where(canvas: annotation_search_params)
     end
 
+    # Get /annotations/pages
+    def pages
+      @annotations = Annotation.where(canvas: annotation_search_params)
+    end
+
     # POST /annotations
     def create
       @annotation = Annotation.new(annotation_params)
@@ -50,7 +58,9 @@ module Annotot
     private
 
     def set_annotation
-      @annotation = Annotation.find_by(id: params[:id]) || Annotation.find_by(uuid: params[:id])
+      @annotation = Annotot::Annotation.retrieve_by_id_or_uuid(
+        CGI.unescape(params[:id])
+      )
       raise ActiveRecord::RecordNotFound unless @annotation.present?
     end
 
@@ -59,7 +69,7 @@ module Annotot
     end
 
     def annotation_search_params
-      params.require(:uri)
+      CGI.unescape(params.require(:uri))
     end
   end
 end

data/app/controllers/annotot/application_controller.rb

@@ -1,5 +1,5 @@
 module Annotot
   class ApplicationController < ActionController::Base
-    protect_from_forgery
+    protect_from_forgery with: :exception, unless: -> { request.format.json? }
   end
 end

data/app/models/annotot/annotation.rb

@@ -4,5 +4,17 @@ module Annotot
     validates :canvas, presence: true
 
     serialize :data, JSON
+
+    ##
+    # Used to differentiate between a numeric id and a uuid. Rails will trim a
+    # uuid with leading numbers eg '123a'.to_i => 123
+    # @param [String] identifier
+    def self.retrieve_by_id_or_uuid(identifier)
+      if identifier =~ /\A\d+\z/
+        find_by(id: identifier)
+      else
+        find_by(uuid: identifier)
+      end
+    end
   end
 end

data/app/views/annotot/annotations/pages.json.jbuilder

@@ -0,0 +1,4 @@
+json.set! '@context', 'http://iiif.io/api/presentation/3/context.json'
+json.set! 'id', request.original_url
+json.set! 'type', 'AnnotationPage'
+json.items(@annotations.map { |a| JSON.parse(a.data) })

data/app/views/annotot/annotations/show.json.erb

@@ -0,0 +1 @@
+<%= JSON.parse(@annotation.data).to_json.html_safe %>

data/config/routes.rb

@@ -1,7 +1,8 @@
 Annotot::Engine.routes.draw do
-  resources :annotations, except: %i[new edit show], defaults: { format: :json } do
+  resources :annotations, path: '/', except: %i[new edit], defaults: { format: :json } do
     collection do
       get 'lists'
+      get 'pages'
     end
   end
 end

data/lib/annotot/version.rb

@@ -1,3 +1,3 @@
 module Annotot
-  VERSION = '0.2.1'
+  VERSION = '0.7.0'
 end

data/lib/generators/annotot/install_generator.rb

@@ -5,5 +5,10 @@ module Annotot
     def add_routes
       route "mount Annotot::Engine => '/'"
     end
+
+    def run_annotot_migrations
+      rake 'annotot:install:migrations'
+      rake 'db:migrate'
+    end
   end
 end

data/lib/tasks/annotot_tasks.rake

@@ -1,4 +1,59 @@
-# desc "Explaining what the task does"
-# task :annotot do
-#   # Task goes here
-# end
+require 'json'
+require 'pathname'
+
+namespace :annotot do
+  desc 'Import annotation list from path'
+  task :import_file, [:url_path] => :environment do |_t, args|
+    path = Pathname.new(args.url_path)
+    puts "Importing annotations from #{path}"
+    anno_list = JSON.parse(File.read(path))
+    puts "#{anno_list['resources'].length} resources found"
+    touch_count = 0
+    anno_list['resources'].map do |resource|
+      uuid = resource['@id']
+      selector = resource['on'].first['selector']
+      canvas = resource['on'].first['full']
+
+      ##
+      # Annotation appears to be Mirador 2.6.0 compatible
+      if resource['on'].first['@type'] == 'oa:SpecificResource' && selector['@type'] == 'oa:Choice'
+        if selector['default']['@type'] == 'oa:FragmentSelector' && selector['item']['@type'] == 'oa:SvgSelector'
+          touch_count += 1
+        end
+      end
+
+      ##
+      # Annotation needs to be updated to a single fragment selector
+      if resource['on'].first['@type'] == 'oa:SpecificResource' && selector['@type'] == 'oa:FragmentSelector'
+        new_on = "#{canvas}##{selector['value']}"
+        resource['on'] = new_on
+        touch_count += 1
+      end
+
+      ##
+      # Annotation only has an SvgSelector and in an non-compliant format
+      if selector['@type'] == 'oa:SvgSelector'
+        item = selector.deep_dup
+        # Fix missing quotes in SVG
+        item['value'] = item['value'].gsub('xmlns=http://www.w3.org/2000/svg', 'xmlns="http://www.w3.org/2000/svg"')
+        selector['@type'] = 'oa:Choice'
+        selector['default'] = {
+          '@type' => 'oa:FragmentSelector',
+          'value' => 'xywh=0,0,0,0'
+        }
+        selector.delete('value')
+        selector['item'] = item
+        resource['on'].first['selector'] = selector.deep_dup
+        touch_count += 1
+      end
+
+      anno_json = resource.to_json
+      anno = Annotot::Annotation.find_or_create_by(uuid: uuid)
+      anno.update!(
+        canvas: canvas,
+        data: anno_json
+      )
+    end
+    puts "Updated #{touch_count} annotations"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: annotot
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Jack Reed
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.1.4
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: engine_cart
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,8 @@ files:
 - app/models/annotot/application_record.rb
 - app/views/annotot/annotations/index.json.erb
 - app/views/annotot/annotations/lists.json.jbuilder
+- app/views/annotot/annotations/pages.json.jbuilder
+- app/views/annotot/annotations/show.json.erb
 - app/views/layouts/annotot/application.html.erb
 - config/routes.rb
 - db/migrate/20180215183225_create_annotot_annotations.rb
@@ -144,8 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Annotot. Open annotations in Rails.