annotator_store 1.0.0.pre → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6ddd11b4ff25f3477a7c2ef180080c135f192ba
-  data.tar.gz: 40c0857fbb2adc58ec90f65622f91ca463016d9d
+  metadata.gz: 43b816e26d213ee0689e56a6b43c70faac7e4b89
+  data.tar.gz: 33b50d049831ea7d930d46696a62fa22883967d6
 SHA512:
-  metadata.gz: 9dde1c468bcdeb6c3a6bd7069b9bb1176e479036b3e1b4b3b4bff26b756368d4fde382ffd863596fd5dd11ed04cd6995565bb8e5191b1d23080dd5212d5b067c
-  data.tar.gz: 39a4e0020f14898a1d0e3b730fa4adba062baa338fdf317c10214935b357f7235637d109a067319e0c87068d4ed78b603683c4ae0a4f732d6ca6ae54d17e9470
+  metadata.gz: 61825fac6af6a847c1fda2f5607e52a4a99af8c9095bb4eb5eeaf4f4f638e11da0a9c03990ab0e4ce1cea7c4435be3233029f8a0c24eaf3ac817336763941958
+  data.tar.gz: 2499df60e7292ffafd03175e1acd8172b62e6c00fe5a92891355f65f665921252892402043c325cad831d1276813bb0c6ef94f4b34cc037cfe50e86c6eea68e5

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+v1.0.0
+------
+
+* Drop complexity brought in by UUIDs
+
+
 v1.0.0.pre
 ----------
 

data/README.md

@@ -78,22 +78,13 @@ 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.
+Configure your database credentials in your `config/database.yml` file and then run the
+migrations to create the tables to store the annotations.
 
     # 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)
+    # To run the copied migration
     $ rake db:migrate
 
 Then mount it in `config/routes.rb`:
@@ -112,7 +103,7 @@ 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)
+      "id": 1,                                   # 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)
@@ -129,9 +120,6 @@ position and content of an annotation within a specified document:
       ]
     }
 
-For PostgreSQL the primary key of the annotation will be a UUID while for MySQL it
-will be a normal integer id.
-
 
 API Endpoints
 -------------
@@ -192,7 +180,7 @@ Returns (example):
 
     $ curl http://example.com/annotator_store/annotations
     {
-      "id": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": 1,
       "text": "Annotation text",
       ...
     }
@@ -208,7 +196,7 @@ Returns (example):
 
     $ curl http://example.com/annotator_store/annotations/d41d8cd98f00b204e9800998ecf8427e
     {
-      "id": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": 1,
       "text": "Annotation text",
       ...
     }
@@ -226,7 +214,7 @@ Returns (example):
 
     $ curl http://example.com/annotator_store/annotations/d41d8cd98f00b204e9800998ecf8427e
     {
-      "id": "d41d8cd98f00b204e9800998ecf8427e",
+      "id": 1,
       "text": "Annotation text",
       ...
     }
@@ -261,7 +249,7 @@ Returns (example):
       "total": 43127,
       "rows": [
         {
-          "id": "d41d8cd98f00b204e9800998ecf8427e",
+          "id": 1,
           "text": "Updated annotation text",
           ...
         },

data/config/routes.rb

@@ -1,5 +1,4 @@
 AnnotatorStore::Engine.routes.draw do
-
   # Root path
   root 'pages#index', defaults: { format: :json }
 

data/db/migrate/20141013113654_create_annotator_store.rb

@@ -1,43 +1,20 @@
-# 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|
+    create_table :annotator_store_annotations 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
+      t.timestamps        # Time created_at and updated_at for annotation
     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
+      t.references :annotation, index: true # Associated annotation's id
+      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                          # Time created_at and updated_at for range
     end
   end
 

data/lib/annotator_store/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: annotator_store
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre
+  version: 1.0.0
 platform: ruby
 authors:
 - Job King'ori Maina
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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
@@ -200,12 +214,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Rails engine to implement a Ruby backend store implementation for Annotator.