Merge pull request #25 from ActiveTriples/repository_from_rdf_rb

Interface Added for Blazegraph and Repository.

Author: jcoyne

.gitignore

@@ -22,6 +22,7 @@
 #Ignore Rubymine and jetty files
 /.idea
 /jetty
+/ldf-jetty
 
 #Ignore yml files
 /*.yml

Gemfile

@@ -35,27 +35,33 @@ gem 'sdoc', '~> 0.4.0', group: :doc
 gem 'responders'
 gem 'rdf'
 gem 'rdf-turtle'
-gem 'json-ld', '1.1.8'
+gem 'json-ld', '~> 1.99'
+#gem 'json-ld'
 gem 'active-triples'
-gem 'rdf-vocab', github: "ruby-rdf/rdf-vocab", branch: "develop"
+#gem 'rdf-vocab', github: "ruby-rdf/rdf-vocab", branch: "develop"
+gem 'rdf-vocab', '0.8.7.1'
 gem 'jettywrapper', '>= 2.0.0'
 gem 'marmotta'
+gem 'ldfwrapper', github: 'boston-library/ldf-wrapper', branch: "master"
+gem 'rdf-blazegraph'
 
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug'
 
-  # Access an IRB console on exception pages or by using <%= console %> in views
-  gem 'web-console', '~> 2.0'
-
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
 
   gem 'rspec-rails'
   gem 'pry-byebug'
-  gem 'vcr'
+end
+
+group :development do
+  # Access an IRB console on exception pages or by using <%= console %> in views
+  gem 'web-console', '~> 2.0'
 end
 
 group :test do
+  gem 'vcr'
   gem 'webmock'
 end

README.md

@@ -10,25 +10,49 @@ Configuration
 YAML
 ----
 
-There is a ldf.yml.sample that you need to configure as ldf.yml. There are default values already entered into the
-file.
+You need a ldf.yml file configured. There are currently two sample files for configurations of two different backend
+caching layers: ldf.yml.sample_marmotta and ldf.yml.sample_repository. 
 
 Marmotta
 --------
 
 If you do not already have a marmotta instance, you can use an instance that runs off of jetty by running the following
-generator:
+rake task:
 
-    rails g linked_data_fragments:marmotta
+    rake ldfwrapper:install
 
 Once that finishes, please copy config/jetty.yml.sample to config/jetty.yml. You can change the defaults.
 
 Once that is all setup, here are some commands that can be run to use the marmotta instance:
 
-    rake jetty:stop
-    rake jetty:config
-    rake jetty:start
+    rake ldfjetty:stop
+    rake ldfjetty:config
+    rake ldfjetty:start
 
+Blazegraph
+-----------
+
+If you do not already have a blazegraph instance, you can use an instance that runs off of jetty by running the following
+rake task:
+
+    rake ldfwrapper:install
+
+Once that finishes, please copy config/ldfjetty.yml.sample to config/ldfjetty.yml. You can change the defaults.
+
+It is recommended that you populate Blazegraph with LoC for terms to work. To do this:
+
+* Download the latest subjects vocab from: [http://id.loc.gov/download/](http://id.loc.gov/download/) (the nt version of “LC Subject Headings (SKOS/RDF only)”)
+
+* Extract the above download into a directory.
+
+* Run the following command from that extraction directory:
+    curl -H 'Content-Type: text/turtle' --upload-file subjects-skos-20140306.nt -X POST "http://localhost:8988/blazegraph/sparql?context-uri=http://id.loc.gov/static/data/authoritiessubjects.nt.skos.zip"
+
+Once that is all setup, here are some commands that can be run to use the blazegraph instance:
+
+    rake ldfjetty:stop
+    rake ldfjetty:config
+    rake ldfjetty:start
 
 Usage
 =====

app/controllers/subject_controller.rb

@@ -9,6 +9,10 @@ def self.assign_cache_service
     case Setting.cache_backend
       when 'marmotta'
         @cache = LinkedDataFragments::Marmotta.new
+      when 'repository'
+        @cache = LinkedDataFragments::Repository.new
+      when 'blazegraph'
+        @cache = LinkedDataFragments::Blazegraph.new
       else
         #FIXME: What type of error should this be? Need to unit test this as well once figured out.
         raise ArgumentError, 'Invalid cache_backend set in the yml config'

app/models/setting.rb

@@ -52,7 +52,7 @@ def cache_backend
     end
 
     def cache_backend_url
-      Setting.config[:cache_backend][:url] || 'http://localhost:8983/marmotta'
+      Setting.config[:cache_backend][:url] || 'http://localhost:8988/marmotta'
     end
 
     def cache_backend_context

circle.yml

@@ -3,5 +3,4 @@ machine:
     version: 2.2.0
 dependencies:
   post:
-    - cp config/ldf.yml.sample config/ldf.yml
-    - cp config/jetty.yml.sample config/jetty.yml
+    - cp config/ldf.yml.sample_repository config/ldf.yml

config/ldf.yml.sample_blazegraph

@@ -0,0 +1,21 @@
+development:
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/#dataset'
+  cache_backend:
+    provider: 'blazegraph'
+    url: 'http://localhost:8988/blazegraph/sparql'
+    context: 'http://localhost:8988/linked_data_fragments_dev'
+test: &TEST_
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/#dataset'
+  cache_backend:
+    provider: 'blazegraph'
+    url: 'http://localhost:8988/blazegraph/sparql'
+    context: 'http://localhost:8988/linked_data_fragments_test'
+production:
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/#dataset'
+  cache_backend:
+    provider: 'blazegraph'
+    url: 'http://localhost:8988/blazegraph/sparql'
+    context: 'http://localhost:8988/linked_data_fragments_production'

config/ldf.yml.sample config/ldf.yml.sample_marmottaconfig/ldf.yml.sample renamed to config/ldf.yml.sample_marmotta

@@ -3,19 +3,19 @@ development:
   uri_root: 'http://localhost:3000/#dataset'
   cache_backend:
     provider: 'marmotta'
-    url: 'http://localhost:8983/marmotta'
-    context: 'linked_data_fragments_dev'
+    url: 'http://localhost:8988/marmotta'
+    context: 'http://localhost:8988/linked_data_fragments_dev'
 test: &TEST_
   uri_endpoint: 'http://localhost:3000/{?subject}'
   uri_root: 'http://localhost:3000/#dataset'
   cache_backend:
     provider: 'marmotta'
-    url: 'http://localhost:8983/marmotta'
-    context: 'linked_data_fragments_test'
+    url: 'http://localhost:8988/marmotta'
+    context: 'http://localhost:8988/linked_data_fragments_test'
 production:
   uri_endpoint: 'http://localhost:3000/{?subject}'
   uri_root: 'http://localhost:3000/#dataset'
   cache_backend:
     provider: 'marmotta'
-    url: 'http://localhost:8983/marmotta'
-    context: 'linked_data_fragments_production'
+    url: 'http://localhost:8988/marmotta'
+    context: 'http://localhost:8988/linked_data_fragments_production'

config/ldf.yml.sample_repository

@@ -0,0 +1,15 @@
+development:
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/#dataset'
+  cache_backend:
+    provider: 'repository'
+test: &TEST_
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/#dataset'
+  cache_backend:
+    provider: 'repository'
+production:
+  uri_endpoint: 'http://localhost:3000/{?subject}'
+  uri_root: 'http://localhost:3000/#dataset'
+  cache_backend:
+    provider: 'repository'