geo_concerns 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34af069d1dd402d1592d5e24933df3362ad4bd4d
-  data.tar.gz: c04fb982ce925417ebeddaedbcc5052eb5ea064d
+  metadata.gz: 7859ed88c8abf63d62c3f01656c86bef9100759a
+  data.tar.gz: 9d9b2132b6e5497633bc66604656917fe6cf801b
 SHA512:
-  metadata.gz: 0dc13d96992a96f8d02ba4da85d00884c30e10e4d5c1f81fe507d235219f0d9d5556732212bfea956cc68696c412d9a17e0ca841bf14cc00e2ffab95b9591591
-  data.tar.gz: a33e2ed33523ebb633749a2bfe2056f9bbb8225b3d26c69580c3789044d2cacf332e693ee27a454b386fcbf7ab66c8a218fdfb75d24182803dce8b5fccddb497
+  metadata.gz: 9396b438f6ee45eef45ecd87b180e54f66e4a23bc83297c27dad047f4065eede959f5870c84ae94adff9529c3a13d6242067be951cbc1ccef497921618d83efb
+  data.tar.gz: a21f787e7a4762b5aeab53a76386975a6f92170a2b55dec1e2537438cb5466df028e9ddbf4856dc3eff3da6c51b5eafa7186910d9528bce9a9a60e8c218ec468

data/.travis.yml

@@ -18,6 +18,7 @@ before_install:
  - sudo apt-add-repository --yes ppa:mapnik/nightly-${MAPNIK_VERSION}
  - sudo apt-get update -y
  - sudo apt-get -y install libmapnik=${MAPNIK_VERSION}* mapnik-utils=${MAPNIK_VERSION}* libmapnik-dev=${MAPNIK_VERSION}* mapnik-input-plugin*=${MAPNIK_VERSION}*
+ - gem install bundler -v 1.13.1 # hopefully temporary
 install: bundle install --jobs=3 --retry=3
 before_script:
   - gdalinfo --version

data/README.md

@@ -21,6 +21,7 @@ Rails application for developing Hydra Geo models. Built around Curation Concern
 1. [GDAL](http://www.gdal.org/)
     * You can install it on Mac OSX with `brew install gdal`.
     * On Ubuntu, use `sudo apt-get install gdal-bin`.
+1. [GeoServer](http://geoserver.org/) (Optional)
 
 ## Mapnik
 
@@ -73,3 +74,43 @@ Then, in another terminal window:
 ```
 $ rake spec
 ```
+
+## Running GeoServer for Development with Docker
+
+### MacOS
+
+1. Make sure you have docker engine, docker-machine, and docker-compose installed.
+   - Docker Toolbox: [https://www.docker.com/products/docker-toolbox](https://www.docker.com/products/docker-toolbox)
+
+1. Execute the following command in the geo_concerns directory:
+   
+   ```
+   $ source ./run-docker.sh
+   ```
+
+### Linux
+
+1. Make sure you have docker engine and docker-compose installed.
+   - [https://docs.docker.com/engine/installation/linux/](https://docs.docker.com/engine/installation/linux/)
+   - [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
+
+1. Execute the following commands in the geo_concerns directory:
+
+	```
+	$ docker-compose up -d
+	$ export GEOSERVER_URL="http://localhost:8181/geoserver/rest"
+	```
+
+## Running GeoServer for Development with Vagrant
+
+1. Make sure you have VirtualBox and Vagrant installed.
+	- [https://www.virtualbox.org/wiki/Downloads](https://www.virtualbox.org/wiki/Downloads)
+	- [https://www.vagrantup.com/docs/installation/](https://www.vagrantup.com/docs/installation/)
+1. Execute the following commands:
+	
+	```
+	$ git clone https://github.com/geoconcerns/geoserver-vagrant.git
+	$ cd geoserver-vagrant/
+	$ vagrant up
+	
+	```

data/app/jobs/delivery_job.rb

@@ -13,6 +13,6 @@ class DeliveryJob < ActiveJob::Base
   def perform(file_set, content_url)
     uri = URI.parse(content_url)
     raise NotImplementedError, 'Only supports file URLs' unless uri.scheme == 'file'
-    GeoConcerns::DeliveryService.new.publish(file_set.id, uri.path)
+    GeoConcerns::DeliveryService.new(file_set, uri.path).publish
   end
 end

data/app/services/geo_concerns/delivery/geoserver.rb

@@ -1,25 +1,18 @@
 require 'active_support/core_ext/hash/indifferent_access'
 require 'rgeoserver'
 require 'yaml'
+require 'erb'
 
 module GeoConcerns
   module Delivery
     class Geoserver
-      DEFAULT_CONFIG = {
-        url: 'http://localhost:8181/geoserver/rest',
-        user: 'admin',
-        password: 'geoserver'
-      }.with_indifferent_access.freeze
+      attr_reader :config, :workspace_name, :file_set, :file_path
 
-      attr_reader :config
-
-      def initialize
-        begin
-          data = File.read(Rails.root.join('config', 'geoserver.yml'))
-          @config = YAML.load(data)['geoserver'].with_indifferent_access.freeze
-        rescue Errno::ENOENT
-          @config = DEFAULT_CONFIG
-        end
+      def initialize(file_set, file_path)
+        @file_set = file_set
+        @file_path = file_path
+        @config = fetch_config
+        @workspace_name = @config.delete(:workspace)
         validate!
       end
 
@@ -27,12 +20,12 @@ module GeoConcerns
         @catalog ||= RGeoServer.catalog(config)
       end
 
-      def publish(id, filename, type = :vector)
+      def publish(type = :vector)
         case type
         when :vector
-          publish_vector(id, filename)
+          publish_vector
         when :raster
-          publish_raster(id, filename)
+          publish_raster
         else
           raise ArgumentError, "Unknown file type #{type}"
         end
@@ -40,23 +33,41 @@ module GeoConcerns
 
       private
 
+        def fetch_config
+          raise ArgumentError, "FileSet visibility must be open or authenticated" unless visibility
+
+          data = ERB.new(File.read(Rails.root.join('config', 'geoserver.yml'))).result
+          YAML.load(data)['geoserver'][visibility].with_indifferent_access
+        end
+
+        def visibility
+          return file_set.visibility if file_set.visibility == 'open'
+          return file_set.visibility if file_set.visibility == 'authenticated'
+        end
+
         def validate!
           %w(url user password).map(&:to_sym).each do |k|
             raise ArgumentError, "Missing #{k} in configuration" unless config[k].present?
           end
         end
 
-        def publish_vector(id, filename)
-          raise ArgumentError, "Not ZIPed Shapefile: #{filename}" unless filename =~ /\.zip$/
-
-          workspace = RGeoServer::Workspace.new catalog, name: 'geo'
+        def workspace
+          workspace = RGeoServer::Workspace.new catalog, name: workspace_name
           workspace.save if workspace.new?
-          datastore = RGeoServer::DataStore.new catalog, workspace: workspace, name: id
-          datastore.upload_file filename, publish: true
+          workspace
+        end
+
+        def datastore
+          RGeoServer::DataStore.new catalog, workspace: workspace, name: file_set.id
+        end
+
+        def publish_vector
+          raise ArgumentError, "Not ZIPed Shapefile: #{file_path}" unless file_path =~ /\.zip$/
+          datastore.upload_file file_path, publish: true
         end
 
-        def publish_raster(_id, filename)
-          raise ArgumentError, "Not GeoTIFF: #{filename}" unless filename =~ /\.tif$/
+        def publish_raster
+          raise ArgumentError, "Not GeoTIFF: #{file_path}" unless file_path =~ /\.tif$/
           raise NotImplementedError
         end
     end

data/app/services/geo_concerns/delivery_service.rb

@@ -2,8 +2,8 @@ module GeoConcerns
   class DeliveryService
     attr_reader :geoserver
 
-    def initialize
-      @geoserver = GeoConcerns::Delivery::Geoserver.new
+    def initialize(file_set, file_path)
+      @geoserver = GeoConcerns::Delivery::Geoserver.new(file_set, file_path)
     end
 
     delegate :publish, to: :geoserver

data/docker-compose.yml

@@ -0,0 +1,10 @@
+version: '2'
+services:
+  rabbitmq:
+    image: rabbitmq
+    ports:
+      - "8081:8080"
+  geoserver:
+    image: thinkwhere/geoserver
+    ports:
+      - "8181:8080"

data/geo_concerns.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'json-schema', '>= 2.6.2'
   spec.add_dependency 'rgeoserver', '>= 0.9.1'
 
-  spec.add_dependency 'bundler', '~> 1.12.5' # TODO: 1.13 breaks our builds
 
+  spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'devise', '>= 3.0', '< 5'
   spec.add_development_dependency 'rspec-rails', '>= 3.5.2'

data/lib/generators/geo_concerns/templates/config/geoserver.yml

@@ -1,17 +1,25 @@
 geoserver:
-  # Set to the REST API for the GeoServer
-  url: "http://localhost:8181/geoserver/rest"
-  # Optional user/password, set to false to disable
-  user: "admin"
-  password: "geoserver"
-  # Set to your GWC server, or "builtin" for the one bundled with GeoServer
-  geowebcache_url: "builtin"
 
-  # RestClient:
-  restclient:
-    # Set to false to disable or stdout/stderr or 'filename.out'
-    logfile: stderr
-    # Timeout (in seconds)
-    timeout: 300
-    # Open Timeout (in seconds)
-    open_timeout: 60
+  # GeoServer config options for open and public data
+  open: &open
+    # Set to the REST API for the GeoServer
+    url: <%= ENV['PUBLIC_GEOSERVER_URL'] || "http://localhost:8181/geoserver/rest" %>
+    # Optional user and password, set to false to disable
+    user: <%= ENV['PUBLIC_GEOSERVER_USER'] || "admin" %>
+    password: <%= ENV['PUBLIC_GEOSERVER_PASSWORD'] || "geoserver" %>
+    # Set to your GWC server, or "builtin" for the one bundled with GeoServer
+    geowebcache_url: <%= ENV['PUBLIC_GEOSERVER_GWC_URL'] || "builtin" %>
+    # Name of the workspace to save your data in
+    workspace: <%= ENV['PUBLIC_GEOSERVER_WS'] || "public" %>
+    restclient:
+      # Set to false to disable or stdout, stderr, or filename
+      logfile: stderr
+      # Timeout (in seconds)
+      timeout: 300
+      # Open Timeout (in seconds)
+      open_timeout: 60
+
+  # GeoServer config options for restricted data or data that needs authentication
+  authenticated:
+    <<: *open
+    workspace: <%= ENV['AUTH_GEOSERVER_WS'] || "restricted" %>

data/lib/geo_concerns/version.rb

@@ -1,3 +1,3 @@
 module GeoConcerns
-  VERSION = "0.0.8".freeze
+  VERSION = "0.0.9".freeze
 end

data/run-docker.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+docker-machine start
+docker_ip=$(docker-machine ip)
+eval $(docker-machine env)
+docker-compose up -d
+geoserver_url="http://"$docker_ip":8181/geoserver/rest"
+export GEOSERVER_URL=$geoserver_url

data/spec/jobs/delivery_job_spec.rb

@@ -7,13 +7,14 @@ describe GeoConcerns::DeliveryJob do
   context '#perform' do
     context 'local file' do
       let(:content_url) { 'file:/somewhere-to-display-copy' }
+      let(:service) { instance_double('GeoConcerns::DeliveryService') }
       it 'delegates to DeliveryService' do
-        dbl = double
-        expect(GeoConcerns::DeliveryService).to receive(:new).and_return(dbl)
-        expect(dbl).to receive(:publish).with(file_set.id, URI(content_url).path)
+        expect(GeoConcerns::DeliveryService).to receive(:new).with(file_set, URI(content_url).path).and_return(service)
+        expect(service).to receive(:publish)
         subject.perform(file_set, content_url)
       end
     end
+
     context 'remote file' do
       let(:content_url) { 'http://somewhere/to-display-copy' }
       it 'errors out' do

data/spec/services/geo_concerns/delivery/geoserver_spec.rb

@@ -2,71 +2,96 @@ require 'spec_helper'
 
 describe GeoConcerns::Delivery::Geoserver do
   let(:id) { 'abc123' }
+  let(:file_set) { instance_double("FileSet") }
+  let(:visibility) { 'open' }
+  let(:path) { 'spec/fixtures/files/tufts-cambridgegrid100-04.zip' }
 
-  context '#initialize' do
-    it 'configures correctly with defaults' do
-      expect(File).to receive(:read).and_raise(Errno::ENOENT)
+  subject { described_class.new file_set, path }
+
+  before do
+    allow(file_set).to receive(:visibility).and_return(visibility)
+    allow(file_set).to receive(:id).and_return(id)
+  end
+
+  context 'with an authenticated file set visibility' do
+    let(:visibility) { 'authenticated' }
+    it 'does not raise error' do
       expect { subject }.not_to raise_error
-      expect(subject.config).to include('url' => 'http://localhost:8181/geoserver/rest',
-                                        'user' => 'admin',
-                                        'password' => 'geoserver')
     end
   end
 
-  context '#catalog' do
-    it 'connects to a RGeoServer catalog' do
-      expect(RGeoServer).to receive(:catalog).with(hash_including(:url, :user, :password)).and_return(double).once
-      subject.catalog
-      subject.catalog # should cache result
+  context 'with a private file set visibility' do
+    let(:visibility) { 'private' }
+    it 'raises an error' do
+      expect { subject }.to raise_error(ArgumentError, /FileSet visibility/)
     end
   end
 
-  context '#publish' do
+  describe '#publish' do
     it 'requires a valid type' do
-      expect { subject.publish(id, 'some/file', :unknown) }.to raise_error(ArgumentError, /Unknown file type/)
+      expect { subject.publish(:unknown) }.to raise_error(ArgumentError, /Unknown file type/)
     end
-    context 'vector' do
+
+    context 'when type is vector' do
       let(:type) { :vector }
-      let(:filename) { 'file.zip' }
       it 'routes to publish_vector' do
-        expect(subject).to receive(:publish_vector).with(id, filename)
-        subject.publish(id, filename, type)
+        expect(subject).to receive(:publish_vector)
+        subject.publish(type)
       end
     end
-    context 'raster' do
+
+    context 'when type is raster' do
       let(:type) { :raster }
-      let(:filename) { 'file.tif' }
       it 'routes to publish_raster' do
-        expect(subject).to receive(:publish_raster).with(id, filename)
-        subject.publish(id, filename, type)
+        expect(subject).to receive(:publish_raster)
+        subject.publish(type)
       end
     end
   end
 
-  context '#publish_vector' do
-    let(:filename) { 'spec/fixtures/files/tufts-cambridgegrid100-04.zip' }
-    it 'requires a vector ZIP file' do
-      expect { subject.send(:publish_vector, id, 'not-a-zip') }.to raise_error(ArgumentError, /Not ZIPed Shapefile/)
+  describe '#publish_vector' do
+    context 'when a vector is not a zip file' do
+      let(:path) { 'not-a-zip' }
+      it 'raises an error' do
+        expect { subject.send(:publish_vector) }.to raise_error(ArgumentError, /Not ZIPed Shapefile/)
+      end
     end
-    it 'dispatches to RGeoServer' do
-      ws_dbl = double
-      expect(RGeoServer::Workspace).to receive(:new).with(subject.catalog, hash_including(name: 'geo')).and_return(ws_dbl)
-      expect(ws_dbl).to receive(:'new?').and_return(true)
-      expect(ws_dbl).to receive(:save)
-      ds_dbl = double
-      expect(RGeoServer::DataStore).to receive(:new).with(subject.catalog, hash_including(workspace: ws_dbl, name: id)).and_return(ds_dbl)
-      expect(ds_dbl).to receive(:upload_file).with(filename, hash_including(publish: true))
-      subject.send(:publish_vector, id, filename)
+
+    context 'with a path to a zipped shapefile' do
+      let(:ws) { double }
+      let(:ds) { double }
+
+      it 'dispatches to RGeoServer' do
+        expect(RGeoServer::Workspace).to receive(:new).with(subject.catalog, hash_including(name: 'public')).and_return(ws)
+        expect(ws).to receive(:'new?').and_return(true)
+        expect(ws).to receive(:save)
+        expect(RGeoServer::DataStore).to receive(:new).with(subject.catalog, hash_including(workspace: ws, name: id)).and_return(ds)
+        expect(ds).to receive(:upload_file).with(path, hash_including(publish: true))
+        subject.send(:publish_vector)
+      end
     end
   end
 
-  context '#publish_raster' do
-    let(:filename) { 'spec/fixtures/files/S_566_1914_clip.tif' }
-    it 'requires GeoTIFF' do
-      expect { subject.send(:publish_raster, id, 'not-a-tiff') }.to raise_error(ArgumentError, /Not GeoTIFF/)
-    end
+  describe '#publish_raster' do
+    let(:path) { 'spec/fixtures/files/S_566_1914_clip.tif' }
+
     it 'is not implemented yet' do
-      expect { subject.send(:publish_raster, id, filename) }.to raise_error(NotImplementedError)
+      expect { subject.send(:publish_raster) }.to raise_error(NotImplementedError)
+    end
+
+    context 'when a raster is not a GeoTIFF file' do
+      let(:path) { 'not-a-tiff' }
+      it 'raises an error' do
+        expect { subject.send(:publish_raster) }.to raise_error(ArgumentError, /Not GeoTIFF/)
+      end
+    end
+  end
+
+  describe '#catalog' do
+    it 'connects to a RGeoServer catalog' do
+      expect(RGeoServer).to receive(:catalog).with(hash_including(:url, :user, :password)).and_return(double).once
+      subject.catalog
+      subject.catalog # should cache result
     end
   end
 end

data/spec/services/geo_concerns/delivery_service_spec.rb

@@ -2,14 +2,23 @@ require 'spec_helper'
 
 describe GeoConcerns::DeliveryService do
   let(:id) { 'abc123' }
-  let(:filename) { 'somewhere-to-display-copy' }
+  let(:path) { 'somewhere-to-display-copy' }
+  let(:file_set) { instance_double("FileSet") }
+  let(:visibility) { 'open' }
+  let(:service) { instance_double('GeoConcerns::Delivery::Geoserver') }
+
+  subject { described_class.new file_set, path }
+
+  before do
+    allow(file_set).to receive(:visibility).and_return(visibility)
+    allow(service).to receive(:visibility).and_return(visibility)
+  end
 
   context '#publish' do
     it 'dispatches to Geoserver delivery' do
-      dbl = double
-      expect(subject).to receive(:geoserver).and_return(dbl)
-      expect(dbl).to receive(:publish).with(id, filename)
-      subject.publish(id, filename)
+      expect(subject).to receive(:geoserver).and_return(service)
+      expect(service).to receive(:publish)
+      subject.publish
     end
   end
 end

data/template.rb

@@ -1,5 +1,5 @@
 gem 'curation_concerns', '1.5.0'
-gem 'geo_concerns', '0.0.8'
+gem 'geo_concerns', '0.0.9'
 
 run 'bundle install'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: geo_concerns
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - James Griffin
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-10 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: curation_concerns
@@ -90,14 +90,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.5
-  type: :runtime
+        version: '1.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.5
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -468,6 +468,7 @@ files:
 - app/views/geo_concerns/related/_parent_works.html.erb
 - app/vocabs/geo_concerns/geo_terms.rb
 - config/routes.rb
+- docker-compose.yml
 - geo_concerns.gemspec
 - lib/generators/geo_concerns/install_generator.rb
 - lib/generators/geo_concerns/templates/actors/curation_concerns/actors/image_work_actor.rb
@@ -499,6 +500,7 @@ files:
 - lib/geo_concerns/engine.rb
 - lib/geo_concerns/version.rb
 - lib/tasks/geo_concerns_tasks.rake
+- run-docker.sh
 - solr/config/_rest_managed.json
 - solr/config/admin-extra.html
 - solr/config/elevate.xml