active_annotations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 355f86d0f2d32d10bcfedc91df427f21870de457
+  data.tar.gz: e63e3874afdd33b7c85e5d20011cf8ec7cad5d97
+SHA512:
+  metadata.gz: 8378e0252e6b6431f3871c8a8a949a289ec64580f81d5beb391ad446a3d07c3f36fea9d0d4a52a28cea2b0782e7d072e0c1d0c23ba11ecc5dff084d932b50c89
+  data.tar.gz: 079841e779a5ae75c668c0cf004a02e31830960d2652e16724695db19e32f9113dafe5f1c488c025ed2b2c1e6b19452cb673eaa7ba331826bf7a53e5f6349c87

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: W7waugqQH8STNmsf9kX0CldGQPeB0A4wM

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.internal_test_app

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+sudo: false
+rvm:
+  - 2.1
+  - 2.2
+env:
+  global:
+    - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+  matrix:
+    - RAILS_VERSION='~>4.1.10' RDF_GEM_VERSION='~>1.1.0'
+    - RAILS_VERSION='~>4.1.10' RDF_GEM_VERSION='~>2.0.0'
+    - RAILS_VERSION='~>4.2.5' RDF_GEM_VERSION='~>1.1.0'
+    - RAILS_VERSION='~>4.2.5' RDF_GEM_VERSION='~>2.0.0'
+
+before_install:
+  - gem install bundler
+  
+notifications:
+  irc: "irc.freenode.org#projectvov"

data/Gemfile

@@ -0,0 +1,44 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in active_annotations.gemspec
+gemspec
+
+if ENV["RDF_GEM_VERSION"]
+  gem 'rdf', ENV["RDF_GEM_VERSION"]
+else
+  gem 'rdf'
+end
+
+# BEGIN ENGINE_CART BLOCK
+# engine_cart: 0.8.2
+# engine_cart stanza: 0.8.0
+# the below comes from engine_cart, a gem used to test this Rails engine gem in the context of a Rails app.
+file = File.expand_path("Gemfile", ENV['ENGINE_CART_DESTINATION'] || ENV['RAILS_ROOT'] || File.expand_path(".internal_test_app", File.dirname(__FILE__)))
+if File.exist?(file)
+  begin
+    eval_gemfile file
+  rescue Bundler::GemfileError => e
+    Bundler.ui.warn '[EngineCart] Skipping Rails application dependencies:'
+    Bundler.ui.warn e.message
+  end
+else
+  Bundler.ui.warn "[EngineCart] Unable to find test application dependencies in #{file}, using placeholder dependencies"
+
+  if ENV['RAILS_VERSION']
+    if ENV['RAILS_VERSION'] == 'edge'
+      gem 'rails', github: 'rails/rails'
+      ENV['ENGINE_CART_RAILS_OPTIONS']= "--edge --skip-turbolinks"
+    else
+      gem 'rails', ENV['RAILS_VERSION']
+    end
+  end
+
+  if ENV['RAILS_VERSION'].nil? || ENV['RAILS_VERSION'] =~ /^4.2/
+    gem 'responders', "~> 2.0"
+    gem 'sass-rails', ">= 5.0"
+  elsif ENV['RAILS_VERSION'] =~ /^5.0/ || ENV['RAILS_VERSION'] == 'edge'
+    # nop
+  else
+    gem 'sass-rails', "< 5.0"
+  end
+end
+# END ENGINE_CART BLOCK

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,92 @@
+# ActiveAnnotations
+
+[![Gem Version](https://badge.fury.io/rb/active_annotations.png)](http://badge.fury.io/rb/active_annotations)
+[![Build Status](https://travis-ci.org/avalonmediasystem/active_annotations.svg?branch=master)](https://travis-ci.org/avalonmediasystem/active_annotations)
+[![Coverage Status](https://coveralls.io/repos/avalonmediasystem/active_annotations/badge.svg?branch=master&service=github)](https://coveralls.io/github/avalonmediasystem/active_annotations?branch=master)
+
+ActiveAnnotations is a gem for modeling simple [OpenAnnotation](http://www.openannotation.org/)-compatible annotations to Rails. It is ActiveRecord compatible, but is backed by an RDF graph that serializes (by default) to [JSON-LD](http://json-ld.org/).
+
+* The `source_uri` and the serialized annotation are stored in ActiveRecord; other methods access the underlying graph.
+* All attributes are optional.
+* Target selectors are currently limited to time-based media fragments, but will be generalized in future iterations.
+* If using v1.x of the `rdf` gem, all DateTime values _must_ be in UTC to ensure proper serialization. This restriction does not apply to `rdf >= 2.0`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_annotations'
+```
+
+And then execute:
+
+    $ bundle install
+
+Run the install generator which will copy over the required migrations and run them:
+
+    $ rails generate active_annotations:install
+    
+## Usage
+
+```ruby
+note = ActiveAnnotations::Annotation.create
+note.label = 'This is the annotation label'
+note.annotated_by = 'https://github.com/mbklein/'
+note.annotated_at = DateTime.now
+note.content = 'The five boxing wizards jump quickly.'
+note.source = thing # thing is expected to respond to :rdf_uri and :rdf_type
+note.start_time = 3.5
+note.end_time = 10.75
+note.save
+
+puts note.pretty_annotation
+```
+Output:
+```json
+{
+  "@context": "http://www.w3.org/ns/oa.jsonld",
+  "@id": "urn:uuid:cac68351-a920-47d5-8c7c-9820e2f4d3bd",
+  "@type": "oa:Annotation",
+  "annotatedBy": {
+    "@id": "https://github.com/mbklein/",
+    "@type": "foaf:Person"
+  },
+  "hasBody": {
+    "@id": "urn:uuid:55cb5e7e-19bf-406c-9e4c-cc0ff9fd0689",
+    "@type": [
+      "dctypes:Text",
+      "cnt:ContentAsText"
+    ],
+    "chars": "The five boxing wizards jump quickly."
+  },
+  "hasTarget": {
+    "@id": "urn:uuid:7a5adf37-7bf2-45d4-ab0d-5a6b9aa2c6ad",
+    "@type": "oa:SpecificResource",
+    "hasSelector": {
+      "@id": "urn:uuid:21331f24-e065-4c06-8c7f-b42a95c53721",
+      "@type": "oa:FragmentSelector",
+      "conformsTo": "http://www.w3.org/TR/media-frags/",
+      "value": "t=3.5,10.75"
+    },
+    "hasSource": {
+      "@id": "http://www.example.edu/thing/being/annotated",
+      "@type": "dctypes:MovingImage"
+    }
+  },
+  "label": "This is the annotation label",
+  "oa:annotatedAt": {
+    "@value": "2016-04-22T12:59:31Z",
+    "@type": "xsd:dateTime"
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/avalonmediasystem/active_annotations.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache License](http://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rails'
+
+Bundler::GemHelper.install_tasks
+
+load "tasks/active_annotations.rake"
+
+task :default => :ci

data/active_annotations.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_annotations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_annotations"
+  spec.version       = ActiveAnnotations::VERSION
+  spec.authors       = ["Michael B. Klein"]
+  spec.email         = ["mbklein@gmail.com"]
+
+  spec.summary       = %q{OpenAnnontations + JSON-LD + ActiveRecord}
+  spec.description   = %q{See http://www.openannotation.org/spec/core/}
+  spec.homepage      = "http://github.com/avalonmediasystem/active_annotations"
+  spec.license       = "Apache"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json-ld"
+  spec.add_dependency "rdf-vocab"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "engine_cart"
+  spec.add_development_dependency "faker"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "simplecov"
+end

data/app/models/active_annotations/annotation.rb

@@ -0,0 +1,72 @@
+module ActiveAnnotations
+  class Annotation < ActiveRecord::Base
+    attr :internal
+
+    delegate :start_time, :end_time, 
+      :content, :annotated_by, 
+      :annotated_at, :source, :label,
+      to: :internal
+    
+    [:start_time=,:end_time=,:content=,:annotated_by=,:annotated_at=,:source=,:label=].each do |setter|
+      define_method(setter) do |*args|
+        internal.send(setter, *args)
+        @internal_changed = true
+        self.sync_attributes!
+      end
+    end
+    
+    [:source_uri=,:annotation=,:uuid=].each do |invalid_setter|
+      define_method(invalid_setter) do |*args|
+        raise NoMethodError, "undefined method `#{invalid_setter}' for #{self.to_s}"
+      end
+    end
+  
+    before_save :sync_attributes!
+    before_save :sync_annotation!
+  
+    def inspect
+      internal_attrs = [:annotated_by, :annotated_at, :start_time, :end_time, :source, :content].collect { |attr|
+        "#{attr}: #{internal.send(attr).inspect}"
+      }
+      inspection = (["uuid: #{uuid.inspect}"] + internal_attrs).compact.join(", ")
+      hex_id = '%#016x' % (self.object_id << 1)
+      "#<#{self.class}:#{hex_id} #{inspection}>"
+    end
+    
+    def sync_attributes!
+      self[:uuid] = internal.annotation_id.value
+      self[:source_uri] = internal.source
+      true
+    end
+    
+    def sync_annotation!
+      if @internal_changed
+        self[:annotation] = internal.to_jsonld
+        @internal_changed = false
+      end
+      true
+    end
+
+    def internal
+      if @internal.nil?
+        if self.annotation.nil?
+          @internal = RDFAnnotation.new
+          self[:annotation] = @internal.to_jsonld
+        else
+          @internal = RDFAnnotation.from_jsonld(self.annotation)
+        end
+      end
+      @internal
+    end
+    
+    def annotation
+      sync_annotation!
+      self[:annotation]
+    end
+    
+    def pretty_annotation
+      sync_annotation!
+      internal.to_jsonld(pretty_json: true)
+    end
+  end
+end

data/db/migrate/20160422052041_create_annotations.rb

@@ -0,0 +1,9 @@
+class CreateAnnotations < ActiveRecord::Migration
+  def change
+    create_table :annotations do |t|
+      t.string :uuid
+      t.string :source_uri
+      t.text   :annotation
+    end
+  end
+end

data/lib/active_annotations/document_loader.rb

@@ -0,0 +1,20 @@
+module ActiveAnnotations
+  module DocumentLoader
+    class << self
+      def local_document_loader(url, options={}, &block)
+        if RDF::URI(url) == RDF::URI(RDFAnnotation::CONTEXT_URI)
+          remote_document = JSON::LD::API::RemoteDocument.new(url, File.read(File.expand_path('../oa.jsonld',__FILE__)))
+          block_given? ? yield(remote_document) : remote_document
+        else
+          # :nocov:
+          JSON::LD::API.documentLoader(url, options, &block)
+          # :nocov:
+        end
+      end
+      
+      def document_loader
+        ENV['NO_RDF_CACHE'] == '1' ? JSON::LD::API.method(:documentLoader) : self.method(:local_document_loader)
+      end
+    end
+  end
+end

data/lib/active_annotations/engine.rb

@@ -0,0 +1,9 @@
+if defined?(Rails)
+  module ActiveAnnotations  
+    class Engine < Rails::Engine
+      config.autoload_paths += Dir["#{config.root}/app/models/**/"]
+
+      engine_name 'active_annotations'
+    end
+  end
+end

data/lib/active_annotations/frame.yml

@@ -0,0 +1,9 @@
+---
+"@context": http://www.w3.org/ns/oa.jsonld
+"@type": oa:Annotation
+label: 
+hasBody: {}
+hasTarget:
+  "@type": oa:SpecificResource
+  hasSelector: {}
+  hasSource: {}