iiif-presentation 0.0.4

data/spec/unit/iiif/presentation/sequence_spec.rb

@@ -0,0 +1,110 @@
+describe IIIF::Presentation::Sequence do
+
+  let(:subclass_subject) do
+    Class.new(IIIF::Presentation::Sequence) do
+      def initialize(hsh={})
+        hsh = { '@type' => 'a:SubClass' }
+        super(hsh)
+      end
+    end
+  end
+
+  let(:fixed_values) do
+    {
+      '@type' => 'sc:Sequence',
+      '@id' => 'http://example.com/prefix/sequence/456',
+      '@context' => IIIF::Presentation::CONTEXT,
+      'label' => 'Book 1',
+      'description' => 'A longer description of this example book. It should give some real information.',
+      'thumbnail' => {
+        '@id' => 'http://www.example.org/images/book1-page1/full/80,100/0/default.jpg',
+        'service'=> {
+          '@context' => 'http://iiif.io/api/image/2/context.json',
+          '@id' => 'http://www.example.org/images/book1-page1',
+          'profile' => 'http://iiif.io/api/image/2/level1.json'
+        }
+      },
+      'attribution' => 'Provided by Example Organization',
+      'license' => 'http://www.example.org/license.html',
+      'logo' => 'http://www.example.org/logos/institution1.jpg',
+      'see_also' => 'http://www.example.org/library/catalog/book1.xml',
+      'service' => {
+        '@context' => 'http://example.org/ns/jsonld/context.json',
+        '@id' =>  'http://example.org/service/example',
+        'profile' => 'http://example.org/docs/example-service.html'
+      },
+      'related' => {
+        '@id' => 'http://www.example.org/videos/video-book1.mpg',
+        'format' => 'video/mpeg'
+      },
+      'within' => 'http://www.example.org/collections/books/',
+      # Sequence
+      'metadata' => [{'label'=>'Author', 'value'=>'Anne Author'}],
+      'canvases' => [{
+        '@id' => 'http://www.example.org/iiif/book1/canvas/p1',
+        '@type' => 'sc:Canvas',
+        'label' => 'p. 1',
+        'height' => 1000,
+        'width' => 750,
+        'images'=>  []
+      }],
+      'viewing_hint' => 'paged',
+      'start_canvas' => 'http://www.example.org/iiif/book1/canvas/p2',
+      'viewing_direction' => 'right-to-left',
+    }
+  end
+
+  describe '#initialize' do
+    it 'sets @type to sc:Sequence by default' do
+      expect(subject['@type']).to eq 'sc:Sequence'
+    end
+    it 'allows subclasses to override @type' do
+      sub = subclass_subject.new
+      expect(sub['@type']).to eq 'a:SubClass'
+    end
+  end
+
+  describe '#required_keys' do
+    it 'accumulates from the superclass' do
+      expect(subject.required_keys).to eq %w{ @type }
+    end
+  end
+
+  describe '#string_only_keys' do
+    it 'accumulates from the superclass' do
+      expect(subject.string_only_keys).to eq %w{ viewing_hint start_canvas viewing_direction }
+    end
+  end
+
+  describe '#array_only_keys' do
+    it 'accumulates from the superclass' do
+      expect(subject.array_only_keys).to eq %w{ metadata canvases }
+    end
+  end
+
+  describe "#{described_class}.define_methods_for_array_only_keys" do
+    it_behaves_like 'it has the appropriate methods for array-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_string_only_keys" do
+    it_behaves_like 'it has the appropriate methods for string-only keys'
+  end
+
+  describe "#{described_class}.define_methods_for_any_type_keys" do
+    it_behaves_like 'it has the appropriate methods for any-type keys'
+  end
+
+  describe '#validate' do
+    it 'raises an error if viewing_hint isn\'t an allowable value' do
+      subject['viewing_hint'] = 'foo'
+      expect { subject.validate }.to raise_error IIIF::Presentation::IllegalValueError
+    end
+    it 'raises an error if viewing_directon isn\'t an allowable value' do
+      subject['viewing_direction'] = 'foo-to-bar'
+      expect { subject.validate }.to raise_error IIIF::Presentation::IllegalValueError
+    end
+  end
+
+
+end
+

data/spec/unit/iiif/presentation/shared_examples/abstract_resource_only_keys.rb

@@ -0,0 +1,43 @@
+require 'set'
+
+shared_examples 'it has the appropriate methods for abstract_resource_only_keys' do
+
+  described_class.new.abstract_resource_only_keys.each do |entry|
+
+    describe "#{entry[:key]}=" do
+      it "sets #{entry[:key]}" do
+        @ex = entry[:type].new
+        subject.send("#{entry[:key]}=", @ex)
+        expect(subject[entry[:key]]).to eq @ex
+      end
+      if entry[:key].camelize(:lower) != entry[:key]
+        it "is aliased as ##{entry[:key].camelize(:lower)}=" do
+          @ex = entry[:type].new
+          subject.send("#{entry[:key].camelize(:lower)}=", @ex)
+          expect(subject[entry[:key]]).to eq @ex
+        end
+      end
+      it "raises an exception when attempting to set it to something other than an #{entry[:type]}" do
+        e = IIIF::Presentation::IllegalValueError
+        expect { subject.send("#{entry[:key]}=", 'Foo') }.to raise_error e
+      end
+    end
+
+    describe "#{entry[:key]}" do
+      it "gets #{entry[:key]}" do
+        @ex = entry[:type].new
+        subject[entry[:key]] = @ex
+        expect(subject.send(entry[:key])).to eq @ex
+      end
+      if entry[:key].camelize(:lower) != entry[:key]
+        it "is aliased as ##{entry[:key].camelize(:lower)}" do
+          @ex = entry[:type].new
+          subject[entry[:key]] = @ex
+          expect(subject.send("#{entry[:key].camelize(:lower)}")).to eq @ex
+        end
+      end
+    end
+
+  end
+
+end

data/spec/unit/iiif/presentation/shared_examples/any_type_keys.rb

@@ -0,0 +1,33 @@
+require 'set'
+
+shared_examples 'it has the appropriate methods for any-type keys' do
+
+  described_class.new.any_type_keys.each do |prop|
+    describe "##{prop}=" do
+      it "sets self['#{prop}']" do
+        subject.send("#{prop}=", fixed_values[prop])
+        expect(subject[prop]).to eq fixed_values[prop]
+      end
+      if prop.camelize(:lower) != prop
+        it "is aliased as ##{prop.camelize(:lower)}=" do
+          subject.send("#{prop.camelize(:lower)}=", fixed_values[prop])
+          expect(subject[prop]).to eq fixed_values[prop]
+        end
+      end
+    end
+
+    describe "##{prop}" do
+      it "gets self[#{prop}]" do
+        subject.send("[]=", prop, fixed_values[prop])
+        expect(subject.send("#{prop}")).to eq fixed_values[prop]
+      end
+      if prop.camelize(:lower) != prop
+        it "is aliased as ##{prop.camelize(:lower)}" do
+          subject.send("[]=", prop, fixed_values[prop])
+          expect(subject.send("#{prop.camelize(:lower)}")).to eq fixed_values[prop]
+        end
+      end
+    end
+  end
+
+end

data/spec/unit/iiif/presentation/shared_examples/array_only_keys.rb

@@ -0,0 +1,44 @@
+require 'set'
+
+shared_examples 'it has the appropriate methods for array-only keys' do
+
+  described_class.new.array_only_keys.each do |prop|
+
+    describe "#{prop}=" do
+      it "sets #{prop}" do
+        ex = [{'label' => 'XYZ'}]
+        subject.send("#{prop}=", ex)
+        expect(subject[prop]).to eq ex
+      end
+      if prop.camelize(:lower) != prop
+        it "is aliased as ##{prop.camelize(:lower)}=" do
+          ex = [{'label' => 'XYZ'}]
+          subject.send("#{prop.camelize(:lower)}=", ex)
+          expect(subject[prop]).to eq ex
+        end
+      end
+      it 'raises an exception when attempting to set it to something other than an Array' do
+        expect { subject.send("#{prop}=", 'Foo') }.to raise_error IIIF::Presentation::IllegalValueError
+      end
+    end
+
+    describe "#{prop}" do
+      it "gets #{prop}" do
+        ex = [{'label' => 'XYZ'}]
+        subject[prop] = ex
+        expect(subject.send(prop)).to eq ex
+      end
+      if prop.camelize(:lower) != prop
+        it "is aliased as ##{prop.camelize(:lower)}" do
+          ex = [{'label' => 'XYZ'}]
+          subject[prop] = ex
+          expect(subject.send("#{prop.camelize(:lower)}")).to eq ex
+        end
+      end
+    end
+
+  end
+
+end
+
+

data/spec/unit/iiif/presentation/shared_examples/int_only_keys.rb

@@ -0,0 +1,49 @@
+require 'set'
+
+shared_examples 'it has the appropriate methods for integer-only keys' do
+
+  described_class.new.int_only_keys.each do |prop|
+
+    describe "#{prop}=" do
+      before(:all) do
+        @ex = 7200
+      end
+      it "sets #{prop}" do
+        subject.send("#{prop}=", @ex)
+        expect(subject[prop]).to eq @ex
+      end
+      if prop.camelize(:lower) != prop
+        it "is aliased as ##{prop.camelize(:lower)}=" do
+          subject.send("#{prop.camelize(:lower)}=", @ex)
+          expect(subject[prop]).to eq @ex
+        end
+      end
+      it 'raises an exception when attempting to set it to something other than an Integer' do
+        expect { subject.send("#{prop}=", 'Foo') }.to raise_error IIIF::Presentation::IllegalValueError
+      end
+      it 'raises an exception when attempting to set it to a negative number' do
+        expect { subject.send("#{prop}=", -1) }.to raise_error IIIF::Presentation::IllegalValueError
+      end
+    end
+
+    describe "#{prop}" do
+      before(:all) do
+        @ex = 7200
+      end
+      it "gets #{prop}" do
+        subject[prop] = @ex
+        expect(subject.send(prop)).to eq @ex
+      end
+      if prop.camelize(:lower) != prop
+        it "is aliased as ##{prop.camelize(:lower)}" do
+          subject[prop] = @ex
+          expect(subject.send("#{prop.camelize(:lower)}")).to eq @ex
+        end
+      end
+    end
+
+  end
+
+end
+
+

data/spec/unit/iiif/presentation/shared_examples/string_only_keys.rb

@@ -0,0 +1,29 @@
+require 'set'
+
+shared_examples 'it has the appropriate methods for string-only keys' do
+
+  described_class.new.string_only_keys.each do |prop|
+
+    describe "#{prop}=" do
+      it "sets #{prop}" do
+        ex = 'foo'
+        subject.send("#{prop}=", ex)
+        expect(subject[prop]).to eq ex
+      end
+      it 'raises an exception when attempting to set it to something other than a String' do
+        expect { subject.send("#{prop}=", ['Foo']) }.to raise_error IIIF::Presentation::IllegalValueError
+      end
+    end
+
+    describe "#{prop}" do
+      it "gets #{prop}" do
+        ex = 'bar'
+        subject[prop] = ex
+        expect(subject.send(prop)).to eq ex
+      end
+    end
+
+  end
+
+end
+

data/spec/unit/iiif/service_spec.rb

@@ -0,0 +1,10 @@
+describe IIIF::Service do
+
+  describe 'self#get_descendant_class_by_jld_type' do
+    it 'gets the right class' do
+      klass = described_class.get_descendant_class_by_jld_type('sc:Canvas')
+      expect(klass).to be IIIF::Presentation::Canvas
+    end
+  end
+
+end

metadata

@@ -0,0 +1,262 @@
+--- !ruby/object:Gem::Specification
+name: iiif-presentation
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Jon Stroop
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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
+  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: coveralls
+  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: webmock
+  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: multi_json
+  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: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.3
+- !ruby/object:Gem::Dependency
+  name: json
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.18
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: API for working with IIIF Presentation manifests.
+email:
+- jpstroop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- gemfiles/rails3.gemfile
+- gemfiles/rails4.gemfile
+- iiif-presentation.gemspec
+- lib/active_support/ordered_hash.rb
+- lib/iiif/hash_behaviours.rb
+- lib/iiif/presentation.rb
+- lib/iiif/presentation/abstract_resource.rb
+- lib/iiif/presentation/annotation.rb
+- lib/iiif/presentation/annotation_list.rb
+- lib/iiif/presentation/canvas.rb
+- lib/iiif/presentation/collection.rb
+- lib/iiif/presentation/image_resource.rb
+- lib/iiif/presentation/layer.rb
+- lib/iiif/presentation/manifest.rb
+- lib/iiif/presentation/range.rb
+- lib/iiif/presentation/resource.rb
+- lib/iiif/presentation/sequence.rb
+- lib/iiif/service.rb
+- spec/fixtures/manifests/complete_from_spec.json
+- spec/fixtures/manifests/minimal.json
+- spec/fixtures/manifests/service_only.json
+- spec/fixtures/vcr_cassettes/pul_loris_cassette.json
+- spec/integration/iiif/presentation/image_resource_spec.rb
+- spec/integration/iiif/service_spec.rb
+- spec/spec_helper.rb
+- spec/unit/active_support/ordered_hash_spec.rb
+- spec/unit/iiif/hash_behaviours_spec.rb
+- spec/unit/iiif/presentation/abstract_resource_spec.rb
+- spec/unit/iiif/presentation/annotation_list_spec.rb
+- spec/unit/iiif/presentation/annotation_spec.rb
+- spec/unit/iiif/presentation/canvas_spec.rb
+- spec/unit/iiif/presentation/collection_spec.rb
+- spec/unit/iiif/presentation/image_resource_spec.rb
+- spec/unit/iiif/presentation/layer_spec.rb
+- spec/unit/iiif/presentation/manifest_spec.rb
+- spec/unit/iiif/presentation/range_spec.rb
+- spec/unit/iiif/presentation/resource_spec.rb
+- spec/unit/iiif/presentation/sequence_spec.rb
+- spec/unit/iiif/presentation/shared_examples/abstract_resource_only_keys.rb
+- spec/unit/iiif/presentation/shared_examples/any_type_keys.rb
+- spec/unit/iiif/presentation/shared_examples/array_only_keys.rb
+- spec/unit/iiif/presentation/shared_examples/int_only_keys.rb
+- spec/unit/iiif/presentation/shared_examples/string_only_keys.rb
+- spec/unit/iiif/service_spec.rb
+homepage: https://github.com/iiif/osullivan
+licenses:
+- Simplified BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: API for working with IIIF Presentation manifests.
+test_files:
+- spec/fixtures/manifests/complete_from_spec.json
+- spec/fixtures/manifests/minimal.json
+- spec/fixtures/manifests/service_only.json
+- spec/fixtures/vcr_cassettes/pul_loris_cassette.json
+- spec/integration/iiif/presentation/image_resource_spec.rb
+- spec/integration/iiif/service_spec.rb
+- spec/spec_helper.rb
+- spec/unit/active_support/ordered_hash_spec.rb
+- spec/unit/iiif/hash_behaviours_spec.rb
+- spec/unit/iiif/presentation/abstract_resource_spec.rb
+- spec/unit/iiif/presentation/annotation_list_spec.rb
+- spec/unit/iiif/presentation/annotation_spec.rb
+- spec/unit/iiif/presentation/canvas_spec.rb
+- spec/unit/iiif/presentation/collection_spec.rb
+- spec/unit/iiif/presentation/image_resource_spec.rb
+- spec/unit/iiif/presentation/layer_spec.rb
+- spec/unit/iiif/presentation/manifest_spec.rb
+- spec/unit/iiif/presentation/range_spec.rb
+- spec/unit/iiif/presentation/resource_spec.rb
+- spec/unit/iiif/presentation/sequence_spec.rb
+- spec/unit/iiif/presentation/shared_examples/abstract_resource_only_keys.rb
+- spec/unit/iiif/presentation/shared_examples/any_type_keys.rb
+- spec/unit/iiif/presentation/shared_examples/array_only_keys.rb
+- spec/unit/iiif/presentation/shared_examples/int_only_keys.rb
+- spec/unit/iiif/presentation/shared_examples/string_only_keys.rb
+- spec/unit/iiif/service_spec.rb