annotot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 73ff37edcbe6076b7c13b627f604e810444a3ef2
+  data.tar.gz: 48dc1b3a6e082c65ad30059de75efef4795dd69e
+SHA512:
+  metadata.gz: 3b9cd548ed28a8d7bea2fbff4012fcf5cc0325dd798c4af622479100b645a3d8b614187bb4b2e5177c9c1ca1726d80a2b0aba7661eb78772fae49f60ac295a36
+  data.tar.gz: 7b60a2cb545fcb9aae0a58a243f298bebc762fc39a50bd89ac0c567b878907f68cc0325d0a138d80138d6950dcbe42c10fc482f19277050a3e6605e64783eb9a

data/LICENSE

@@ -0,0 +1,13 @@
+© 2018 The Board of Trustees of the Leland Stanford Junior University.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,55 @@
+# Annotot
+[![Build Status](https://travis-ci.org/mejackreed/annotot.svg?branch=master)](https://travis-ci.org/mejackreed/annotot)
+
+Need to persist annotations quick and easily? Annotot, the original mini annotation API is for you. Don't annotate, annotot instead.
+
+![](annotot.png)
+
+This logo, "Annotot", is a derivative of "[Sweet Potato Tator Tots](https://www.flickr.com/photos/flyfarther79/6270223411/)" by [Lisa Brettschneider](https://www.flickr.com/photos/flyfarther79/) used under [CC BY-NC 2.0](https://creativecommons.org/licenses/by-nc/2.0/). "Annotot" is also licensed under [CC BY-NC 2.0](https://creativecommons.org/licenses/by-nc/2.0/).
+
+## Usage
+
+Annotot provides a simple RESTful endpoint for persisting annotations. Just configure your client to work with its endpoint.
+
+For Mirador integration, you can use the provided `AnnototEndpoint`:
+
+```javascript
+// Within Mirador creation options
+...
+annotationEndpoint: {
+  name: 'Annotot',
+  module: 'AnnototEndpoint',
+  options: {
+    endpoint: 'https://www.annotot.biz/annotot/annotations'
+  }
+},
+...
+```
+
+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).
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'annotot'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Install the gem:
+```bash
+$ rails g annotot:install
+```
+
+If you are serving both Mirador and Annotot in the same application, the integration will be easier. You can just require the `annotot_endpoint.js` file.
+
+```javascript
+//= require annotot/annotot_endpoint
+```
+
+## License
+The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/Apache-2.0).

data/Rakefile

@@ -0,0 +1,17 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+Bundler::GemHelper.install_tasks
+
+require 'engine_cart/rake_task'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task ci: ['engine_cart:generate'] do
+  ENV['environment'] = 'test'
+  Rake::Task['spec'].invoke
+end
+
+task default: [:ci]

data/app/assets/config/annotot_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/annotot .js
+//= link_directory ../stylesheets/annotot .css

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

@@ -0,0 +1,188 @@
+/*
+ * annotationsList - current list of OA Annotations
+ * dfd - Deferred Object
+ * init()
+ * search(options, successCallback, errorCallback)
+ * create(oaAnnotation, successCallback, errorCallback)
+ * update(oaAnnotation, successCallback, errorCallback)
+ * deleteAnnotation(annotationID, successCallback, errorCallback)
+ *
+ * getAnnotationInOA(endpointAnnotation)
+ * getAnnotationInEndpoint(oaAnnotation)
+ */
+(function($){
+
+  $.AnnototEndpoint = function(options) {
+
+    jQuery.extend(this, {
+      dfd:             null,
+      annotationsList: [],  // OA list for Mirador use
+      windowID:        null,
+      eventEmitter:    null
+    }, options);
+
+    this.init();
+  };
+
+  $.AnnototEndpoint.prototype = {
+    init: function() {},
+
+    // Search endpoint for all annotations with a given URI in options
+    search: function(options, successCallback, errorCallback) {
+      var _this = this;
+      _this.annotationsList = [];
+      options.format = 'json'
+
+      jQuery.ajax({
+        url: _this.endpoint,
+        type: 'GET',
+        dataType: 'json',
+        headers: { },
+        data: options,  // options.uri contains the Canvas URI
+        contentType: "application/json; charset=utf-8",
+        success: function(data) {
+          if (typeof successCallback === "function") {
+            successCallback(data);
+          } else {
+            jQuery.each(data, function(index, value) {
+              value.endpoint = _this;
+              _this.annotationsList.push(_this.getAnnotationInOA(value));
+            });
+            _this.dfd.resolve(true);
+          }
+        },
+        error: function(data) {
+          if (typeof errorCallback === "function") {
+            errorCallback(data);
+          } else {
+            console.log("The request for annotations has caused an error for endpoint: " + options.uri);
+          }
+        }
+      });
+    },
+
+    // Delete an annotation by endpoint identifier
+    deleteAnnotation: function(annotationID, successCallback, errorCallback) {
+      var _this = this;
+      jQuery.ajax({
+        url: _this.endpoint + '/' + annotationID,
+        type: 'DELETE',
+        dataType: 'json',
+        headers: {
+          // 'X-CSRF-Token': _this.csrfToken()
+        },
+        contentType: "application/json; charset=utf-8",
+        success: function(data) {
+          if (typeof successCallback === "function") {
+            successCallback();
+          }
+        },
+        error: function(a, b) {
+          if (typeof errorCallback === "function") {
+            errorCallback();
+          }
+        }
+      });
+    },
+
+    // Update an annotation given the OA version
+    update: function(oaAnnotation, successCallback, errorCallback) {
+      var _this = this;
+      var annotation = _this.getAnnotationInEndpoint(oaAnnotation);
+      
+      var annotationID = annotation.annotation['uuid'];
+
+      jQuery.ajax({
+        url: _this.endpoint + '/' + annotationID,
+        type: 'PATCH',
+        dataType: 'json',
+        headers: {
+          'X-CSRF-Token': _this.csrfToken()
+        },
+        data: JSON.stringify(annotation),
+        contentType: "application/json; charset=utf-8",
+        success: function(data) {
+          if (typeof successCallback === "function") {
+            data.endpoint = _this;
+            successCallback(data);
+          }
+        },
+        error: function(a, b, c) {
+          if (typeof errorCallback === "function") {
+            errorCallback();
+          }
+        }
+      });
+    },
+
+    // Takes OA Annotation, gets Endpoint Annotation, and saves
+    // if successful, MUST return the OA rendering of the annotation
+    create: function(oaAnnotation, successCallback, errorCallback) {
+      var _this = this;
+      var annotation = _this.getAnnotationInEndpoint(oaAnnotation);
+      jQuery.ajax({
+        url: _this.endpoint,
+        type: 'POST',
+        headers: {
+          // 'X-CSRF-Token': _this.csrfToken()
+        },
+        data: JSON.stringify(annotation),
+        contentType: "application/json; charset=utf-8",
+        success: function(data) {
+          data.endpoint = _this;
+          if (typeof successCallback === "function") {
+            successCallback(_this.getAnnotationInOA(data));
+          }
+        },
+        error: function() {
+          if (typeof errorCallback === "function") {
+            errorCallback();
+          }
+        }
+      });
+    },
+
+    set: function(prop, value, options) {
+      if (options) {
+        this[options.parent][prop] = value;
+      } else {
+        this[prop] = value;
+      }
+    },
+
+    //Convert Endpoint annotation to OA
+    getAnnotationInOA: function(annotation) {
+      return annotation;
+    },
+
+    // Converts OA Annotation to endpoint format
+    getAnnotationInEndpoint: function(oaAnnotation) {
+      // Generate a new uuid if one is not present
+      if (oaAnnotation['@id'] == null) {
+        oaAnnotation["@id"] = Mirador.genUUID();
+      }
+      
+      canvas = oaAnnotation.on[0].full;
+      var newAnno = jQuery.extend({}, oaAnnotation);
+      delete newAnno.endpoint
+      return {
+        annotation: {
+          uuid: oaAnnotation["@id"],
+          data: JSON.stringify(newAnno),
+          canvas: canvas
+        }
+      };
+    },
+
+    userAuthorize: function(action, annotation) {
+      return true;  // allow all
+    },
+
+    csrfToken: function() {
+      // We need to monkey patch this since $ !== jQuery in Mirador context
+      return jQuery('meta[name=csrf-token]').attr('content');
+    },
+
+  };
+
+}(Mirador));

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

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/controllers/annotot/annotations_controller.rb

@@ -0,0 +1,60 @@
+require_dependency "annotot/application_controller"
+
+module Annotot
+  class AnnotationsController < ApplicationController
+    before_action :set_annotation, only: %i[update destroy]
+
+    # GET /annotations
+    def index
+      @annotations = Annotation.where(canvas: annotation_search_params)
+    end
+
+    # POST /annotations
+    def create
+      @annotation = Annotation.new(annotation_params)
+
+      if @annotation.save
+        render json: @annotation.data
+      else
+        render status: :bad_request, json: {
+          message: 'An annotation could not be created'
+        }
+      end
+    end
+
+    # PATCH/PUT /annotations/1
+    def update
+      if @annotation.update(annotation_params)
+        render status: :ok, json: @annotation.data
+      else
+        render status: :bad_request, json: {
+          message: 'Annotation could not be updated.',
+          status: :bad_request
+        }
+      end
+    end
+
+    # DELETE /annotations/1
+    def destroy
+      @annotation.destroy
+      render status: :ok, json: {
+        message: 'Annotation was successfully destroyed.'
+      }
+    end
+
+    private
+
+    def set_annotation
+      @annotation = Annotation.find_by(id: params[:id]) || Annotation.find_by(uuid: params[:id])
+      raise ActiveRecord::RecordNotFound unless @annotation.present?
+    end
+
+    def annotation_params
+      params.require(:annotation).permit(:uuid, :data, :canvas)
+    end
+
+    def annotation_search_params
+      params.require(:uri)
+    end
+  end
+end

data/app/controllers/annotot/application_controller.rb

@@ -0,0 +1,5 @@
+module Annotot
+  class ApplicationController < ActionController::Base
+    protect_from_forgery
+  end
+end

data/app/helpers/annotot/annotations_helper.rb

@@ -0,0 +1,4 @@
+module Annotot
+  module AnnotationsHelper
+  end
+end

data/app/helpers/annotot/application_helper.rb

@@ -0,0 +1,4 @@
+module Annotot
+  module ApplicationHelper
+  end
+end

data/app/jobs/annotot/application_job.rb

@@ -0,0 +1,4 @@
+module Annotot
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/annotot/application_mailer.rb

@@ -0,0 +1,6 @@
+module Annotot
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/annotot/annotation.rb

@@ -0,0 +1,8 @@
+module Annotot
+  class Annotation < ApplicationRecord
+    validates :uuid, presence: true, uniqueness: true
+    validates :canvas, presence: true
+
+    serialize :data, JSON
+  end
+end

data/app/models/annotot/application_record.rb

@@ -0,0 +1,5 @@
+module Annotot
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

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

@@ -0,0 +1 @@
+<%= @annotations.map{ |a| JSON.parse(a.data )}.to_json.html_safe %>

data/app/views/layouts/annotot/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Annotot</title>
+  <%= stylesheet_link_tag    "annotot/application", media: "all" %>
+  <%= javascript_include_tag "annotot/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+Annotot::Engine.routes.draw do
+  resources :annotations, except: %i[new edit show], defaults: { format: :json }
+end

data/db/migrate/20180215183225_create_annotot_annotations.rb

@@ -0,0 +1,11 @@
+class CreateAnnototAnnotations < ActiveRecord::Migration[5.1]
+  def change
+    create_table :annotot_annotations do |t|
+      t.string :uuid, index: true
+      t.string :canvas, index: true
+      t.binary :data
+
+      t.timestamps
+    end
+  end
+end

data/lib/annotot.rb

@@ -0,0 +1,5 @@
+require "annotot/engine"
+
+module Annotot
+  # Your code goes here...
+end

data/lib/annotot/engine.rb

@@ -0,0 +1,5 @@
+module Annotot
+  class Engine < ::Rails::Engine
+    isolate_namespace Annotot
+  end
+end

data/lib/annotot/version.rb

@@ -0,0 +1,3 @@
+module Annotot
+  VERSION = '0.1.0'
+end

data/lib/generators/annotot/install_generator.rb

@@ -0,0 +1,9 @@
+module Annotot
+  ##
+  # Install generator
+  class Install < Rails::Generators::Base
+    def add_routes
+      route "mount Annotot::Engine => '/'"
+    end
+  end
+end

data/lib/tasks/annotot_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :annotot do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: annotot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jack Reed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: engine_cart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-controller-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Annotot. Open annotations in Rails.
+email:
+- phillipjreed@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/config/annotot_manifest.js
+- app/assets/javascripts/annotot/annotot_endpoint.js
+- app/assets/javascripts/annotot/application.js
+- app/controllers/annotot/annotations_controller.rb
+- app/controllers/annotot/application_controller.rb
+- app/helpers/annotot/annotations_helper.rb
+- app/helpers/annotot/application_helper.rb
+- app/jobs/annotot/application_job.rb
+- app/mailers/annotot/application_mailer.rb
+- app/models/annotot/annotation.rb
+- app/models/annotot/application_record.rb
+- app/views/annotot/annotations/index.json.erb
+- app/views/layouts/annotot/application.html.erb
+- config/routes.rb
+- db/migrate/20180215183225_create_annotot_annotations.rb
+- lib/annotot.rb
+- lib/annotot/engine.rb
+- lib/annotot/version.rb
+- lib/generators/annotot/install_generator.rb
+- lib/tasks/annotot_tasks.rake
+homepage: https://github.com/mejackreed/annotot
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Annotot. Open annotations in Rails.
+test_files: []