annotator_store 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6ddd11b4ff25f3477a7c2ef180080c135f192ba
+  data.tar.gz: 40c0857fbb2adc58ec90f65622f91ca463016d9d
+SHA512:
+  metadata.gz: 9dde1c468bcdeb6c3a6bd7069b9bb1176e479036b3e1b4b3b4bff26b756368d4fde382ffd863596fd5dd11ed04cd6995565bb8e5191b1d23080dd5212d5b067c
+  data.tar.gz: 39a4e0020f14898a1d0e3b730fa4adba062baa338fdf317c10214935b357f7235637d109a067319e0c87068d4ed78b603683c4ae0a4f732d6ca6ae54d17e9470

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+CHANGELOG
+=========
+
+v1.0.0.pre
+----------
+
+* Rename gem from `annotator-store` to `annotator_store`
+* Fix issue with explicit require needed in main application
+
+
+v0.4.0
+------
+
+* Add support for MySQL
+
+
+v0.3.0
+------
+
+* Change create endpoint to respond with `201 CREATED`
+* Test support for Ruby `>= 1.9.3`.
+* Test support for Rails `>= 4.0`.
+
+
+v0.2.0
+------
+
+* Add required files to gemspec
+* Add CRUD (create, read, update and delete) endpoints
+* Add search endpoint with filter support for uri
+* Included tests for routes, requests, models and controllers
+
+
+v0.1.0
+------
+
+* Create index page with description of API.
+* Add annotation functionality & create necessary endpoints
+
+
+v0.0.1
+------
+
+Initial release, to lock the gem name ... by v1.0.0 we should have a version
+ready for deployment in production environment.
+
+* Initialise the project
+* Create structure

data/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+CONTRIBUTING
+============
+
+Submitting a Pull Request
+-------------------------
+
+1. [Fork the repository][fork].
+2. [Create a topic branch][branch] (`git checkout -b BRANCH_NAME`).
+3. [Install bundler][bundler].
+4. Check that tests pass with `rspec spec`.
+5. Write a failing test to capture existing bug or lack of feature.
+6. Run `rspec spec` to verify that test fails.
+7. Implement your feature or bug fix.
+8. Ensure tests pass.
+9. If it's a new feature or a bug fix, please add an entry to the CHANGELOG file.
+10. Check code style violations using [Rubocop][rubocop].
+11. Add a commit (`git commit -am 'AWESOME COMMIT MESSAGE'`).
+12. Push your changes to the branch (`git push origin BRANCH_NAME`).
+13. [Submit a pull request.][pr]
+14. You will get some feedback and may need to push additional commits
+    with more fixes to the same branch; this will update your pull request
+    automatically.
+
+[branch]: http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches
+[bundler]: http://bundler.io
+[fork]: https://help.github.com/articles/fork-a-repo/
+[pr]: https://help.github.com/articles/using-pull-requests
+[rubocop]: https://github.com/bbatsov/rubocop

data/LICENSE.md

@@ -0,0 +1,23 @@
+License
+=======
+
+Copyright (c) 2014 Job King'ori Maina
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sub-license, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,414 @@
+Annotator Store
+===============
+
+[![Gem Version](https://badge.fury.io/rb/annotator_store.svg)][5]
+[![Build Status](https://travis-ci.org/itsmrwave/annotator_store-gem.svg?branch=master)][13]
+
+Rails engine to implement a [Ruby on Rails][18] backend store implementation for
+[Annotator][annotator].
+
+> Annotator an open-source JavaScript library to easily add annotation
+> functionality to any webpage. Annotations can have comments, tags, links,
+> users, and more. Annotator is designed for [easy extensibility][1] so its a
+> cinch to add a new feature or behaviour. Annotator also fosters an active
+> developer community with contributors from four continents, building 3rd party
+> plugins allowing the annotation of PDFs, EPUBs, videos, images, sound, and
+> more.
+
+The gem should be up on [rubygems.org][5], the [CHANGELOG here][7] and [all the
+releases listed here][8].
+
+
+Contents
+--------
+
+1. Dependencies & Versions
+2. Installation
+3. Annotation Format
+4. API Endpoints
+5. Development
+6. Testing & Appraisals
+7. Versioning
+8. Contributing
+9. License
+
+
+Dependencies & Versions
+----------------------
+
+This engine requires Rails `>= 4.0` and Ruby `>= 1.9.3` and supports more than
+one database.
+
+Supported Ruby versions:
+
+* [X] 1.9.3
+* [X] 2.0.0
+* [X] 2.1.0
+* [X] 2.1.1
+* [X] 2.1.2
+
+Supported Rails versions:
+
+* [X] 4.0.x
+* [X] 4.1.x
+* [X] 4.2.x
+
+Supported databases:
+
+* [X] MySQL
+* [X] PostgreSQL
+
+_'Supported'_ means that the test suite is designed to cover these versions
+only. If your version isn't supported [raise a ticket][19]; make sure you
+include the versions.
+
+Sometimes when the build is failing, it's probably a few of these
+configurations. Have a [look at the builds here][13] and see section on testing
+& appraisals for more information.
+
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+    gem 'annotator_store'
+
+And then from the `APP_ROOT` execute:
+
+    $ bundle install
+
+Configure your database credentials in `config/database.yml` and then run the
+migrations to create the tables to store the annotations. Depending on the
+database of choice you'll need to set the `DB` environment variable when running
+the migrations. There are slight variations in the structure of the DB when
+using MySQL and PostgreSQL. The default setting is PostgreSQL if not set.
+
+    # Copy migrations over from the engine
+    $ rake annotator_store:install:migrations
+
+    # To run the copied migration when using MySQL
+    $ DB=mysql rake db:migrate
+
+    # To run the copied migration when using PostgreSQL
+    $ DB=postgres rake db:migrate
+
+    # To run the copied migration without specifying type (defaults to postgres)
+    $ rake db:migrate
+
+Then mount it in `config/routes.rb`:
+
+    # Configures store endpoint in your app
+    mount AnnotatorStore::Engine, at: '/annotator_store'
+
+Now it should be ready for use. All the endpoints will be available at
+`http://0.0.0.0:3000/annotator_store` in your app.
+
+
+Annotation Format
+-----------------
+
+An annotation is a JSON document that contains a number of fields describing the
+position and content of an annotation within a specified document:
+
+    {
+      "id": "39fc339cf058bd22176771b3e3187329",  # unique id (added by backend)
+      "annotator_schema_version": "v1.0",        # schema version: default v1.0
+      "created": "2011-05-24T18:52:08.036814",   # created datetime in iso8601 format (added by backend)
+      "updated": "2011-05-26T12:17:05.012544",   # updated datetime in iso8601 format (added by backend)
+      "text": "A note I wrote",                  # content of annotation
+      "quote": "the text that was annotated",    # the annotated text (added by frontend)
+      "uri": "http://example.com",               # URI of annotated document (added by frontend)
+      "ranges": [                                # list of ranges covered by annotation (usually only one entry)
+        {
+          "start": "/p[69]/span/span",           # (relative) XPath to start element
+          "end": "/p[70]/span/span",             # (relative) XPath to end element
+          "startOffset": 0,                      # character offset within start element
+          "endOffset": 120                       # character offset within end element
+        }
+      ]
+    }
+
+For PostgreSQL the primary key of the annotation will be a UUID while for MySQL it
+will be a normal integer id.
+
+
+API Endpoints
+-------------
+
+### Root
+
+| Method | Path | Returns                                                                  |
+| ------ | ---- | ------------------------------------------------------------------------ |
+| GET    | /    | `200 OK` with an object containing store metadata, including API version |
+
+Returns (example):
+
+    $ curl http://example.com/annotator_store
+    {
+      "name": "Annotator Store API",
+      "version": "2.0.0",
+      "links": {
+        "annotation": {
+          "create": {
+            "url": "http://example.com/annotator_store/annotations",
+            "method": "POST",
+            "description": "Create or add new annotations."
+          },
+          "read": {
+            "url": "http://example.com/annotator_store/annotations/:id",
+            "method": "GET",
+            "description": "Read, retrieve or view existing annotation."
+          },
+          "update": {
+            "url": "http://example.com/annotator_store/annotations/:id",
+            "method": "PUT/PATCH",
+            "description": "Update or edit existing annotation."
+          },
+          "delete": {
+            "url": "http://example.com/annotator_store/annotations/:id",
+            "method": "DELETE",
+            "description": "Delete or deactivate existing annotation."
+          }
+      },
+      "search": {
+          "url": "http://example.com/annotator_store/search",
+          "method": "GET",
+          "description": "Search for annotations"
+        }
+      }
+    }
+
+
+### Create
+
+| Method  | Path         | Returns                                                                    |
+| ------- | ------------ | -------------------------------------------------------------------------- |
+| POST    | /annotations | `201 CREATED` with location in header set to the appropriate read endpoint |
+
+Receives an annotation object in the proper annotation format, sent with `Content-Type: application/json`.
+
+Returns (example):
+
+    $ curl http://example.com/annotator_store/annotations
+    {
+      "id": "d41d8cd98f00b204e9800998ecf8427e",
+      "text": "Annotation text",
+      ...
+    }
+
+
+### Read
+
+| Method | Path             | Returns                            |
+| ------ | ---------------- | ---------------------------------- |
+| GET    | /annotations/:id | `200 OK` with an annotation object |
+
+Returns (example):
+
+    $ curl http://example.com/annotator_store/annotations/d41d8cd98f00b204e9800998ecf8427e
+    {
+      "id": "d41d8cd98f00b204e9800998ecf8427e",
+      "text": "Annotation text",
+      ...
+    }
+
+
+### Update
+
+| Method     | Path             | Returns                                                               |
+| ---------- | ---------------- | --------------------------------------------------------------------- |
+| PUT/PATCH  | /annotations/:id | `200 OK` with location in header set to the appropriate read endpoint |
+
+Receives attributes in the proper annotation format, sent with `Content-Type: application/json`.
+
+Returns (example):
+
+    $ curl http://example.com/annotator_store/annotations/d41d8cd98f00b204e9800998ecf8427e
+    {
+      "id": "d41d8cd98f00b204e9800998ecf8427e",
+      "text": "Annotation text",
+      ...
+    }
+
+
+### Delete
+
+| Method     | Path             | Returns                                    |
+| ---------- | ---------------- | ------------------------------------------ |
+| DELETE     | /annotations/:id | `204 NO CONTENT` and obviously, no content |
+
+
+### Search
+
+| Method | Path     | Returns                                                 |
+| ------ | -------- | ------------------------------------------------------- |
+| GET    | /search  | An object with total and rows fields                    |
+
+_Total_ is an integer denoting the total number of annotations matched by the
+search, while _rows_ is a list containing what might be a subset of these
+annotations.
+
+If implemented, this endpoint should also support the `limit` and `offset` query
+parameters for paging through results.
+
+_Ps: Pagination with limit and offset not yet implemented. See [issue #1][15]._
+
+Returns (example):
+
+    $ curl http://example.com/annotator_store/search?text=annotation
+    {
+      "total": 43127,
+      "rows": [
+        {
+          "id": "d41d8cd98f00b204e9800998ecf8427e",
+          "text": "Updated annotation text",
+          ...
+        },
+        ...
+      ]
+    }
+
+
+Development
+-----------
+
+There's a dummy Rails application in the `spec/dummy` folder. This application
+is used as a mounting point for the engine, to make testing the engine on a
+Rails app extremely simple. This directory should be treated like a typical
+Rails testing environment, allowing for unit, functional and integration tests.
+
+The current dummy app was generated using Rails 4.1.6 and with PostgreSQL as the
+default store. The app depends on the `DB` environment variable to know which
+settings to use for the database. See `config/database.yml` for details.
+
+Set the `DB` environment variable to either `mysql` or `postgres` to choose
+between the two.
+
+    # To use MySQL
+    $ DB=mysql [commands to run]
+
+    # To use PostgreSQL
+    $ DB=postgres [commands to run]
+
+You can start up the dummy app to give it a spin by running `rails server` in
+`spec/dummy` and then browse to `http://0.0.0.0:3000/`. There's a README in
+there with a few details on setup, make sure you check it out.
+
+
+Testing & Appraisals
+--------------------
+
+You may extend the dummy application by generating controllers, models or views
+from within the directory (`spec/dummy`), and then use those to test our engine
+(I've done this already but feel free to add). Then use the rspec command to run
+your specs.
+
+  	#=> Run all specs
+  	$ bundle exec rspec
+
+  	#=> Run only model specs example ...
+  	$ bundle exec rspec spec/models
+
+  	#=> Run only specs for AnnotatorStore::AnnotationsController ...
+  	$ bundle exec rspec spec/controllers/annotations_controller_spec.rb
+
+These will run the tests as per your local default configuration.
+
+The [appraisal gem][16] is used to integrate with bundler and rake to test the
+engine against different versions of dependencies in repeatable scenarios called
+_'appraisals'_. This makes it easy to check for regressions in the library
+without interfering with day-to-day development using Bundler.
+
+As a result, a separate test run is created for each Ruby version and every
+Rails version (see `travis.yml` file for specifics).
+
+Locally you can test for different Rails versions. For example:
+
+  	# Run specs against rails 4.0.12
+  	$ appraisal rails-4.0.12 rspec spec
+
+  	# Run specs against rails 4.1.8
+  	$ appraisal rails-4.1.8 rspec spec
+
+  	# Run specs against rails 4.2.0
+  	$ appraisal rails-4.2.0 rspec spec
+
+Check the Appraisal file at the root for the different rails configurations.
+[Learn more about appraisals here][17].
+
+PostgreSQL is configured to be the default database configuration. Set the `DB`
+environment variable to either `mysql` or `postgres` to choose between the two.
+
+    # To use MySQL
+    $ DB=mysql [commands to run your tests]
+
+    # To use PostgreSQL
+    $ DB=postgres [commands to run your tests]
+
+Automated tests are configured and set up to [run on Travis-CI][13]. Any push or
+pull request will be built. The `DB` environment variable should be set to
+either `mysql` or `postgres` to create a build matrix with good coverage.
+
+
+Versioning
+----------
+
+Major version zero (0.y.z) is for initial development. Anything may change at
+any time. The public API should not be considered stable (implicitly mean, not
+production ready ... yet).
+
+Version 1.0.0 defines the public API (implying that it is production ready). The
+way in which the version number is incremented after this release is dependent
+on this public API and how it changes as per [Semantic Versioning
+2.0.0][semver].
+
+All the releases, with their respective changes are [listed here][8].
+
+
+Contributing
+------------
+
+Want to contribute to the code? First, have a look at the guide in the
+[CONTRIBUTING.md][9] file for the workflow.
+
+Then, here's some Annotator documentation to help you get up to speed:
+
+* [Annotator Storage][10] API specifications.
+* [Annotator Store Plugin][11] documentation.
+
+In summary, this gem helps implement a store for the plugin to interact with.
+
+Any code contributors should be [listed here][12].
+
+
+License
+-------
+
+[King'ori J. Maina][2] © 2014. The MIT License bundled therein is a permissive
+license that is short and to the point. It lets people do anything they want as
+long as they provide attribution and waive liability.
+
+
+[annotator]: http://annotatorjs.org/
+[semver]: http://semver.org
+
+[1]: http://docs.annotatorjs.org/en/latest/hacking/plugin-development.html
+[2]: http://kingori.co/
+[3]: http://bundler.io/gemfile.html
+[4]: http://bundler.io
+[5]: https://rubygems.org/gems/annotator_store
+[6]: http://rubydoc.info/gems/annotator_store/frames/
+[7]: https://github.com/itsmrwave/annotator_store-gem/blob/master/CHANGELOG.md
+[9]: https://github.com/itsmrwave/annotator_store-gem/blob/master/CONTRIBUTING.md
+[8]: https://github.com/itsmrwave/annotator_store-gem/releases
+[10]: http://docs.annotatorjs.org/en/v1.2.x/storage.html
+[11]: http://docs.annotatorjs.org/en/v1.2.x/plugins/store.html
+[12]: https://github.com/itsmrwave/annotator_store-gem/graphs/contributors
+[13]: https://travis-ci.org/itsmrwave/annotator_store-gem
+[14]: https://github.com/itsmrwave/annotator-store-demo
+[15]: https://github.com/itsmrwave/annotator_store-gem/issues/1
+[16]: http://rubygems.org/gems/appraisal
+[17]: http://www.rubydoc.info/gems/appraisal
+[18]: http://rubyonrails.org
+[19]: https://github.com/itsmrwave/annotator_store-gem/issues/new

data/Rakefile

@@ -0,0 +1,10 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/app/assets/javascripts/annotator_store/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 vendor/assets/javascripts of plugins, if any, 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/annotator_store/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/annotator_store/annotations_controller.rb

@@ -0,0 +1,97 @@
+require_dependency 'annotator_store/application_controller'
+
+module AnnotatorStore
+  class AnnotationsController < ApplicationController
+    before_action :set_annotation, only: [:show, :update, :destroy]
+
+    # POST /annotations
+    def create
+      format_client_input_to_rails_convention_for_create
+      @annotation = Annotation.new(annotation_params)
+      respond_to do |format|
+        if @annotation.save
+          format.json { render :show, status: :created, location: annotation_url(@annotation) }
+        else
+          format.json { render json: @annotation.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # GET /annotations/1
+    def show
+    end
+
+    # PATCH/PUT /annotations/1
+    def update
+      format_client_input_to_rails_convention_for_update
+      respond_to do |format|
+        if @annotation.update(annotation_params)
+          format.json { render :show, status: :ok, location: annotation_url(@annotation) }
+        else
+          format.json { render json: @annotation.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    # DELETE /annotations/1
+    def destroy
+      @annotation.destroy
+      respond_to do |format|
+        format.json { head :no_content, status: :no_content }
+      end
+    end
+
+    # OPTIONS /annotations
+    def options
+      respond_to do |format|
+        format.json { render :options }
+      end
+    end
+
+    private
+
+    # Use callbacks to share common setup or constraints between actions.
+    def set_annotation
+      @annotation = Annotation.find(params[:id])
+    end
+
+    # Convert the data sent by AnnotatorJS to the format that Rails expects so
+    # that we are able to create a proper params object
+    def format_client_input_to_rails_convention_for_create
+      params[:annotation] = {}
+      params[:annotation][:version] = params[:annotator_schema_version] unless params[:annotator_schema_version].blank?
+      params[:annotation][:text] = params[:text] unless params[:text].blank?
+      params[:annotation][:quote] = params[:quote] unless params[:quote].blank?
+      params[:annotation][:uri] = params[:uri] unless params[:uri].blank?
+      params[:annotation][:ranges_attributes] = params[:ranges].map do |r|
+        range = {}
+        range[:start]        = r[:start]
+        range[:end]          = r[:end]
+        range[:start_offset] = r[:startOffset]
+        range[:end_offset]   = r[:endOffset]
+        range
+      end unless params[:ranges].blank?
+    end
+
+    # Convert the data sent by AnnotatorJS to the format that Rails expects so
+    # that we are able to create a proper params object
+    def format_client_input_to_rails_convention_for_update
+      params[:annotation] = {}
+      params[:annotation][:version] = params[:annotator_schema_version] unless params[:annotator_schema_version].blank?
+      params[:annotation][:text] = params[:text] unless params[:text].blank?
+      params[:annotation][:quote] = params[:quote] unless params[:quote].blank?
+      params[:annotation][:uri] = params[:uri] unless params[:uri].blank?
+    end
+
+    # Only allow a trusted parameter 'white list' through.
+    def annotation_params
+      params.require(:annotation).permit(
+       :text,
+       :quote,
+       :uri,
+       :version,
+       ranges_attributes: [:start, :end, :start_offset, :end_offset]
+      )
+    end
+  end
+end

data/app/controllers/annotator_store/application_controller.rb

@@ -0,0 +1,15 @@
+module AnnotatorStore
+  class ApplicationController < ActionController::Base
+    before_action :set_headers
+
+    private
+
+    def set_headers
+      headers['Access-Control-Allow-Origin'] = '*'
+      headers['Access-Control-Expose-Headers'] = 'ETag'
+      headers['Access-Control-Allow-Methods'] = 'GET, POST, PATCH, PUT, DELETE, OPTIONS, HEAD'
+      headers['Access-Control-Allow-Headers'] = '*,x-requested-with,Content-Type,If-Modified-Since,If-None-Match'
+      headers['Access-Control-Max-Age'] = '86400'
+    end
+  end
+end

data/app/controllers/annotator_store/pages_controller.rb

@@ -0,0 +1,24 @@
+module AnnotatorStore
+  class PagesController < ApplicationController
+    before_action :format_input, only: [:search]
+
+    def index
+    end
+
+    def search
+      @annotations = AnnotatorStore::Annotation.where(search_params)
+      @total = @annotations.size
+    end
+
+    private
+
+    def format_input
+      params[:search] = {}
+      params[:search][:uri] = params[:uri]
+    end
+
+    def search_params
+      params.require(:search).permit(:uri)
+    end
+  end
+end

data/app/helpers/annotator_store/annotations_helper.rb

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

data/app/helpers/annotator_store/application_helper.rb

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

data/app/models/annotator_store/annotation.rb

@@ -0,0 +1,16 @@
+module AnnotatorStore
+  class Annotation < ActiveRecord::Base
+    # Associations
+    has_many :ranges, dependent: :destroy, autosave: true
+
+    # Allow saving of attributes on associated records through the parent,
+    # :autosave option is automatically enabled on every association
+    accepts_nested_attributes_for :ranges
+
+    # Validations
+    validates :version, presence: true
+    validates :text, presence: true
+    validates :quote, presence: true
+    validates :uri, presence: true
+  end
+end

data/app/models/annotator_store/range.rb

@@ -0,0 +1,12 @@
+module AnnotatorStore
+  class Range < ActiveRecord::Base
+    # Associations
+    belongs_to :annotation
+
+    # Validations
+    validates :start, presence: true
+    validates :end, presence: true
+    validates :start_offset, presence: true
+    validates :end_offset, presence: true
+  end
+end

data/app/views/annotator_store/annotations/_annotation.json.jbuilder

@@ -0,0 +1,23 @@
+json.id annotation.id
+
+# Version
+json.annotator_schema_version annotation.version
+
+# Meta
+json.uri annotation.uri
+
+# Content
+json.text annotation.text
+json.quote annotation.quote
+json.ranges do
+  json.array! annotation.ranges do |range|
+    json.start range.start
+    json.end range.end
+    json.startOffset range.start_offset
+    json.endOffset range.end_offset
+  end
+end
+
+# Timestamps
+json.created annotation.created_at
+json.updated annotation.updated_at

data/app/views/annotator_store/annotations/options.json.jbuilder

@@ -0,0 +1 @@
+json.approved true

data/app/views/annotator_store/annotations/show.json.jbuilder

@@ -0,0 +1 @@
+json.partial! 'annotator_store/annotations/annotation', annotation: @annotation, as: :annotation

data/app/views/annotator_store/pages/index.json.jbuilder

@@ -0,0 +1,31 @@
+json.name 'Annotator Store API'
+json.version '2.0.0'
+json.links do
+  json.annotation do
+    json.create do
+      json.url annotator_store.annotations_url
+      json.method 'POST'
+      json.description 'Create or add new annotations.'
+    end
+    json.read do
+      json.url annotator_store.annotation_url(':id')
+      json.method 'GET'
+      json.description 'Read, retrieve or view existing annotation.'
+    end
+    json.update do
+      json.url annotator_store.annotation_url(':id')
+      json.method 'PUT/PATCH'
+      json.description 'Update or edit existing annotation.'
+    end
+    json.delete do
+      json.url annotator_store.annotation_url(':id')
+      json.method 'DELETE'
+      json.description 'Delete or deactivate existing annotation.'
+    end
+  end
+  json.search do
+    json.url annotator_store.search_url
+    json.method 'GET'
+    json.description 'Search for annotations'
+  end
+end

data/app/views/annotator_store/pages/search.json.jbuilder

@@ -0,0 +1,4 @@
+json.total @total
+json.rows do
+  json.array! @annotations, partial: 'annotator_store/annotations/annotation', as: :annotation
+end

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

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

data/config/routes.rb

@@ -0,0 +1,15 @@
+AnnotatorStore::Engine.routes.draw do
+
+  # Root path
+  root 'pages#index', defaults: { format: :json }
+
+  # Search
+  match 'search', to: 'pages#search', via: [:get], defaults: { format: :json }, constraints: { format: :json }
+  match 'search', to: 'annotations#options', via: [:options], defaults: { format: :json }, constraints: { format: :json }
+
+  # Annotations Endpoint
+  resources :annotations, only: [:create, :show, :update, :destroy], defaults: { format: :json }, constraints: { format: :json } do
+    match '/', to: 'annotations#options', via: [:options], on: :collection
+    match '/', to: 'annotations#options', via: [:options], on: :member
+  end
+end

data/db/migrate/20141013113654_create_annotator_store.rb

@@ -0,0 +1,48 @@
+# This migration executes differently depending on the database set via the DB
+# environment variable. For PostgreSQL we use UUIDs ... for MySQL we use normal
+# primary keys.
+class CreateAnnotatorStore < ActiveRecord::Migration
+  def self.up
+    # If using PostgreSQL database these are extensions are necessary
+    database_type = ENV['DB'] || 'postgres'
+    if database_type == 'postgres'
+      enable_extension 'plpgsql'   unless extension_enabled?('plpgsql')
+      enable_extension 'uuid-ossp' unless extension_enabled?('uuid-ossp')
+      options = { id: :uuid, default: 'uuid_generate_v4()' }
+    else
+      options = {}
+    end
+
+    # Table to store annotations
+    create_table :annotator_store_annotations, options do |t|
+      t.string :version   # Schema version
+      t.text :text        # Content of annotation
+      t.text :quote       # The annotated text
+      t.string :uri       # URI of annotated document
+      t.timestamps        # Time created_at and updated_at
+    end
+
+    # Table to store ranges covered by an annotation since each annotation could
+    # have many ranges ... at least by design in annotator.js but not yet
+    # implemented. Since the associated annotation's primary could be a UUID, at
+    # least in the case of PostgreSQL, we'll have to apply some logic to cater
+    # for the different scenarios.
+    create_table :annotator_store_ranges do |t|
+      if database_type == 'postgres'
+        t.uuid :annotation_id, index: true # Associated annotation's UUID
+      else
+        t.references :annotation, index: true     # Associated annotation's normal id
+      end
+      t.string :start                             # Relative XPath to start element
+      t.string :end                               # Relative XPath to end element
+      t.integer :start_offset                     # Character offset within start element
+      t.integer :end_offset                       # Character offset within end element
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :annotator_store_annotations
+    drop_table :annotator_store_ranges
+  end
+end

data/lib/annotator_store.rb

@@ -0,0 +1,5 @@
+require 'annotator_store/engine'
+require 'jbuilder'
+
+module AnnotatorStore
+end

data/lib/annotator_store/engine.rb

@@ -0,0 +1,11 @@
+module AnnotatorStore
+  class Engine < ::Rails::Engine
+    isolate_namespace AnnotatorStore
+
+    config.generators do |g|
+      g.integration_tool :rspec
+      g.test_framework :rspec, fixture: false
+      g.fixture_replacement :factory_girl, dir: 'spec/factories'
+    end
+  end
+end

data/lib/annotator_store/version.rb

@@ -0,0 +1,3 @@
+module AnnotatorStore
+  VERSION = '1.0.0.pre'
+end

data/lib/tasks/annotator_store_tasks.rake

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

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: annotator_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0.pre
+platform: ruby
+authors:
+- Job King'ori Maina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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: pg
+  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: appraisal
+  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: database_cleaner
+  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_girl_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: faker
+  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: json-schema
+  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: jbuilder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Rails engine to implement a Ruby backend store implementation for Annotator,
+  an open-source JavaScript library to easily add annotation functionality to any
+  webpage.
+email:
+- j@kingori.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- Rakefile
+- app/assets/javascripts/annotator_store/application.js
+- app/assets/stylesheets/annotator_store/application.css
+- app/controllers/annotator_store/annotations_controller.rb
+- app/controllers/annotator_store/application_controller.rb
+- app/controllers/annotator_store/pages_controller.rb
+- app/helpers/annotator_store/annotations_helper.rb
+- app/helpers/annotator_store/application_helper.rb
+- app/models/annotator_store/annotation.rb
+- app/models/annotator_store/range.rb
+- app/views/annotator_store/annotations/_annotation.json.jbuilder
+- app/views/annotator_store/annotations/options.json.jbuilder
+- app/views/annotator_store/annotations/show.json.jbuilder
+- app/views/annotator_store/pages/index.json.jbuilder
+- app/views/annotator_store/pages/search.json.jbuilder
+- app/views/layouts/annotator_store/application.html.erb
+- config/routes.rb
+- db/migrate/20141013113654_create_annotator_store.rb
+- lib/annotator_store.rb
+- lib/annotator_store/engine.rb
+- lib/annotator_store/version.rb
+- lib/tasks/annotator_store_tasks.rake
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rails engine to implement a Ruby backend store implementation for Annotator.
+test_files: []