annotot 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be4df7aa9f2057db9fca11f7d9d502aca19f0e5f
-  data.tar.gz: f61ed7cc230a9baa013a802d28a0a303cafcc565
+  metadata.gz: 8ef48cc5249aff0db0503072365d000d5d8eae6d
+  data.tar.gz: b902d44435a13a32aafaadfdc2fcf135e684a06e
 SHA512:
-  metadata.gz: a8d2afb622d7478d7572a5d51c7da7812a33d2ce53218b33c975f9ca535a6e8d1e1144a87e35a64cf0ec5c7540675f5485506e95f3fcae54802952e18cfedc0b
-  data.tar.gz: c394334b580a956cada38ca7848a51f14b6780eaa566e5d09b5b3b0c81be948121986bd0aff73c96c6c62081df5141e0e52bfb445768b0bf5a64f70dd1f9dde3
+  metadata.gz: 916eec33063d224db4c79bd581df0057237d92f0f5de20c0cdd4c73dc19371ded452af0e303e939ff81a814980f59772b69219c92b1423c4c737e80a4f194857
+  data.tar.gz: 855ec55e830d8d5483f6871577be98a2b5fa442a759106e8a8e40fddaefd9bf7b56677f9c3c1869eccb3a35dc44651597d4142a90ef348c2d6f8c1630b2f8f49

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

@@ -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: {
@@ -93,7 +93,7 @@
       var annotationID = annotation.annotation['uuid'];
 
       jQuery.ajax({
-        url: _this.endpoint + '/' + annotationID,
+        url: _this.endpoint + '/' + encodeURIComponent(annotationID),
         type: 'PATCH',
         dataType: 'json',
         headers: {

data/app/controllers/annotot/annotations_controller.rb

@@ -50,7 +50,7 @@ module Annotot
     private
 
     def set_annotation
-      @annotation = Annotation.find_by(id: params[:id]) || Annotation.find_by(uuid: params[:id])
+      @annotation = Annotation.find_by(id: CGI.unescape(params[:id])) || Annotation.find_by(uuid: CGI.unescape(params[:id]))
       raise ActiveRecord::RecordNotFound unless @annotation.present?
     end
 
@@ -59,7 +59,7 @@ module Annotot
     end
 
     def annotation_search_params
-      params.require(:uri)
+      CGI.unescape(params.require(:uri))
     end
   end
 end

data/lib/annotot/version.rb

@@ -1,3 +1,3 @@
 module Annotot
-  VERSION = '0.2.1'
+  VERSION = '0.3.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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotot
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jack Reed