iiif-presentation 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 595091b364990a3c3c5119ad55629ad137b9f59ad2b59b5fd0ae763b12afc340
-  data.tar.gz: ad8be940ec5dd37006b619456d23eb0d410f201a36587a6045917739ba69c94f
+  metadata.gz: a766530b4d9f912c49a41e9c6d5982282671c4188a26b27e5a4fb99176fae90c
+  data.tar.gz: bbb25e477c3563ab2a65ec0de5bfc634acffa93c00e7504992dfe539f0e89ad2
 SHA512:
-  metadata.gz: 23600bbc87868cc9b7d0455228d0c7f8a1dca235a4e732b343e9dc0987f485f0dd4e59f64ae6434afec341ba8ae36add4ab48b91a0bc4d2be9e94596879b247e
-  data.tar.gz: ddd645e0cb9fd3464547826504b4078798e02cb06d766c6b9e10fb28d7b4999e0a643414f7ddb737bf91d2469e6693e7cbdbb556bd73d191d50063442c3dae18
+  metadata.gz: ac981b561c8e99f41891f2e5246bf46e6de9766abde2269e5eb46e35baeabb4a74404366b8e83ff2eef4e8656ddcb3e8946cd07bfcf14a96c40ba10b29f2fab7
+  data.tar.gz: 126391967ebc6b1e3db349daed94e3aad1ba43f8083729c49b0c976131f5e3c85f8f507713d0f04721f98c494b0193b761a714f1129b9b044d0dcf181e21e112

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,4 +1,5 @@
 coverage/
 pkg/
 Gemfile.lock
+.pry_history
 

data/Gemfile

@@ -8,3 +8,5 @@ end
 if ENV['FARADAY_VERSION']
   gem 'faraday', ENV['FARADAY_VERSION']
 end
+
+gem 'debug'

data/README.md

@@ -1,7 +1,7 @@
 # O'Sullivan: A Ruby API for working with IIIF Presentation manifests
 
-[![Build Status](https://travis-ci.org/iiif-prezi/osullivan.svg?branch=development)](https://travis-ci.org/iiif-prezi/osullivan)
 [![Coverage Status](https://coveralls.io/repos/github/iiif-prezi/osullivan/badge.svg?branch=development)](https://coveralls.io/github/iiif-prezi/osullivan?branch=development)
+[![Gem Version](https://badge.fury.io/rb/iiif-presentation.svg)](https://badge.fury.io/rb/iiif-presentation)
 
 
 ## Installation
@@ -25,6 +25,11 @@ seed = {
 # Any options you add are added to the object
 manifest = IIIF::Presentation::Manifest.new(seed)
 
+# sequences array is generated for you, but let's add a sequence object
+sequence = IIIF::Presentation::Sequence.new()
+sequence['@id'] = "http://example.com/manifest/seq/"
+manifest.sequences << sequence
+
 canvas = IIIF::Presentation::Canvas.new()
 # All classes act like `ActiveSupport::OrderedHash`es, for the most part.
 # Use `[]=` to set JSON-LD properties...
@@ -35,10 +40,25 @@ canvas.width = 10
 canvas.height = 20
 canvas.label = 'My Canvas'
 
+# Add images 
+service = IIIF::Presentation::Resource.new('@context' => 'http://iiif.io/api/image/2/context.json', 'profile' => 'http://iiif.io/api/image/2/level2.json', '@id' => "http://images.exampl.com/loris2/my-image")
+
+image = IIIF::Presentation::ImageResource.new()
+i['@id'] = "http://images.exampl.com/loris2/my-image/full/#{canvas.width},#{canvas.height}/0/default.jpg"
+i.format = "image/jpeg"
+i.width = canvas.width
+i.height = canvas.height
+i.service = service
+
+images = IIIF::Presentation::Resource.new('@type' => 'oa:Annotation', 'motivation' => 'sc:painting', '@id' => "#{canvas['@id']}/images", 'resource' => i)
+
+canvas.images << images
+
+# Add other content resources
 oc = IIIF::Presentation::Resource.new('@id' => 'http://example.com/content')
 canvas.other_content << oc
 
-manifest.sequences << canvas
+manifest.sequences.first.canvases << canvas
 
 puts manifest.to_json(pretty: true)
 ```

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.2.0

data/iiif-presentation.gemspec

@@ -24,5 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'json'
   spec.add_dependency 'activesupport', '>= 3.2.18'
-  spec.add_dependency 'faraday', '>= 0.9'
+  spec.add_dependency 'faraday', '~> 2.7'
 end

data/lib/iiif/hash_behaviours.rb

@@ -8,7 +8,7 @@ module IIIF
     #  * reject
     #  * replace
 
-    def_delegators :@data, :[], :[]=, :camelize_keys, :delete, :empty?,
+    def_delegators :@data, :[], :[]=, :camelize_keys, :delete, :dig, :empty?,
     :fetch, :has_key?, :has_value?, :include?, :insert, :insert_after,
     :insert_before, :key, :key?, :keys, :length, :member?, :shift, :size,
     :snakeize_keys, :store, :unshift, :value?, :values

data/lib/iiif/presentation/canvas.rb

@@ -25,6 +25,10 @@ module IIIF
         super + %w{ width height }
       end
 
+      def numeric_only_keys
+        super + %w{ duration }
+      end
+
       def legal_viewing_hint_values
         super + %w{ non-paged }
       end

data/lib/iiif/presentation/service.rb

@@ -0,0 +1,12 @@
+require File.join(File.dirname(__FILE__), 'abstract_resource')
+
+module IIIF
+  module Presentation
+    class Service < AbstractResource
+      def required_keys
+        []
+      end
+    end
+  end
+end
+

data/lib/iiif/presentation.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), 'service')
 %w{
-abstract_resource
+  abstract_resource
   annotation
   annotation_list
   canvas
@@ -8,9 +8,10 @@ abstract_resource
   layer
   manifest
   resource
-    image_resource 
-  sequence 
-    range
+  image_resource 
+  sequence
+  service
+  range
 }.each do |f|
   require File.join(File.dirname(__FILE__), 'presentation', f)
 end

data/lib/iiif/service.rb

@@ -17,6 +17,7 @@ module IIIF
     def abstract_resource_only_keys; %w{ }; end
     def hash_only_keys; %w{ }; end
     def int_only_keys; %w{ }; end
+    def numeric_only_keys; %w{ }; end
 
     def initialize(hsh={})
       @data = IIIF::OrderedHash[hsh]
@@ -24,6 +25,7 @@ module IIIF
       self.define_methods_for_array_only_keys
       self.define_methods_for_string_only_keys
       self.define_methods_for_int_only_keys
+      self.define_methods_for_numeric_only_keys
       self.define_methods_for_abstract_resource_only_keys
       self.snakeize_keys
     end
@@ -33,9 +35,9 @@ module IIIF
       # Parse from a file path, string, or existing hash
       def parse(s)
         ordered_hash = nil
-        if s.kind_of?(String) && File.exists?(s)
+        if s.kind_of?(String) && File.exist?(s)
           ordered_hash = IIIF::OrderedHash[JSON.parse(IO.read(s))]
-        elsif s.kind_of?(String) && !File.exists?(s)
+        elsif s.kind_of?(String) && !File.exist?(s)
           ordered_hash = IIIF::OrderedHash[JSON.parse(s)]
         elsif s.kind_of?(Hash)
           ordered_hash = IIIF::OrderedHash[s]
@@ -210,7 +212,7 @@ module IIIF
           new_object[new_key] = []
           hsh[key].each do |member|
             if new_key == 'service'
-              new_object[new_key] << IIIF::Service.from_ordered_hash(member, IIIF::Service)
+              new_object[new_key] << IIIF::Service.from_ordered_hash(member, IIIF::Presentation::Service)
             elsif new_key == 'resource'
               new_object[new_key] << IIIF::Service.from_ordered_hash(hsh[key], IIIF::Presentation::Resource)
             elsif member.kind_of?(Hash)
@@ -221,7 +223,7 @@ module IIIF
             end
           end
         elsif new_key == 'service'
-          new_object[new_key] = IIIF::Service.from_ordered_hash(hsh[key], IIIF::Service)
+          new_object[new_key] = IIIF::Service.from_ordered_hash(hsh[key], IIIF::Presentation::Service)
         elsif new_key == 'resource'
           new_object[new_key] = IIIF::Service.from_ordered_hash(hsh[key], IIIF::Presentation::Resource)
         elsif hsh[key].kind_of?(Hash)
@@ -255,56 +257,22 @@ module IIIF
     end
 
     def define_methods_for_any_type_keys
+      define_accessor_methods(*any_type_keys)
+
+      # override the getter defined by define_accessor_methods to avoid returning
+      # an array for empty values.
       any_type_keys.each do |key|
-        # Setters
-        define_singleton_method("#{key}=") do |arg|
-          self.send('[]=', key, arg)
-        end
-        if key.camelize(:lower) != key
-          define_singleton_method("#{key.camelize(:lower)}=") do |arg|
-            self.send('[]=', key, arg)
-          end
-        end
-        # Getters
         define_singleton_method(key) do
           self.send('[]', key)
         end
-        if key.camelize(:lower) != key
-          define_singleton_method(key.camelize(:lower)) do
-            self.send('[]', key)
-          end
-        end
       end
     end
 
     def define_methods_for_array_only_keys
-      array_only_keys.each do |key|
-        # Setters
-        define_singleton_method("#{key}=") do |arg|
-          unless arg.kind_of?(Array)
-            m = "#{key} must be an Array."
-            raise IIIF::Presentation::IllegalValueError, m
-          end
-          self.send('[]=', key, arg)
-        end
-        if key.camelize(:lower) != key
-          define_singleton_method("#{key.camelize(:lower)}=") do |arg|
-            unless arg.kind_of?(Array)
-              m = "#{key} must be an Array."
-              raise IIIF::Presentation::IllegalValueError, m
-            end
-            self.send('[]=', key, arg)
-          end
-        end
-        # Getters
-        define_singleton_method(key) do
-          self[key] ||= []
-          self[key]
-        end
-        if key.camelize(:lower) != key
-          define_singleton_method(key.camelize(:lower)) do
-            self.send('[]', key)
-          end
+      define_accessor_methods(*array_only_keys) do |key, arg|
+        unless arg.kind_of?(Array)
+          m = "#{key} must be an Array."
+          raise IIIF::Presentation::IllegalValueError, m
         end
       end
     end
@@ -314,85 +282,53 @@ module IIIF
       abstract_resource_only_keys.each do |hsh|
         key = hsh[:key]
         type = hsh[:type]
-        # Setters
-        define_singleton_method("#{key}=") do |arg|
+
+        define_accessor_methods(key) do |key, arg|
           unless arg.kind_of?(type)
             m = "#{key} must be an #{type}."
             raise IIIF::Presentation::IllegalValueError, m
           end
-          self.send('[]=', key, arg)
-        end
-        if key.camelize(:lower) != key
-          define_singleton_method("#{key.camelize(:lower)}=") do |arg|
-            unless arg.kind_of?(type)
-              m = "#{key} must be an #{type}."
-              raise IIIF::Presentation::IllegalValueError, m
-            end
-            self.send('[]=', key, arg)
-          end
-        end
-        # Getters
-        define_singleton_method(key) do
-          self[key] ||= []
-          self[key]
-        end
-        if key.camelize(:lower) != key
-          define_singleton_method(key.camelize(:lower)) do
-            self.send('[]', key)
-          end
         end
       end
     end
 
-
     def define_methods_for_string_only_keys
-      string_only_keys.each do |key|
-        # Setter
-        define_singleton_method("#{key}=") do |arg|
-          unless arg.kind_of?(String)
-            m = "#{key} must be an String."
-            raise IIIF::Presentation::IllegalValueError, m
-          end
-          self.send('[]=', key, arg)
-        end
-        if key.camelize(:lower) != key
-          define_singleton_method("#{key.camelize(:lower)}=") do |arg|
-            unless arg.kind_of?(String)
-              m = "#{key} must be an String."
-              raise IIIF::Presentation::IllegalValueError, m
-            end
-            self.send('[]=', key, arg)
-          end
+      define_accessor_methods(*string_only_keys) do |key, arg|
+        unless arg.kind_of?(String)
+          m = "#{key} must be an String."
+          raise IIIF::Presentation::IllegalValueError, m
         end
-        # Getter
-        define_singleton_method(key) do
-          self[key] ||= []
-          self[key]
+      end
+    end
+
+    def define_methods_for_int_only_keys
+      define_accessor_methods(*int_only_keys) do |key, arg|
+        unless arg.kind_of?(Integer) && arg > 0
+          m = "#{key} must be a positive Integer."
+          raise IIIF::Presentation::IllegalValueError, m
         end
-        if key.camelize(:lower) != key
-          define_singleton_method(key.camelize(:lower)) do
-            self.send('[]', key)
-          end
+      end
+    end
+
+    def define_methods_for_numeric_only_keys
+      define_accessor_methods(*numeric_only_keys) do |key, arg|
+        unless arg.kind_of?(Numeric) && arg > 0
+          m = "#{key} must be a positive Integer or Float."
+          raise IIIF::Presentation::IllegalValueError, m
         end
       end
     end
 
-    def define_methods_for_int_only_keys
-      int_only_keys.each do |key|
+    def define_accessor_methods(*keys, &validation)
+      keys.each do |key|
         # Setter
         define_singleton_method("#{key}=") do |arg|
-          unless arg.kind_of?(Integer) && arg > 0
-            m = "#{key} must be a positive Integer."
-            raise IIIF::Presentation::IllegalValueError, m
-          end
+          validation.call(key, arg) if block_given?
           self.send('[]=', key, arg)
         end
         if key.camelize(:lower) != key
           define_singleton_method("#{key.camelize(:lower)}=") do |arg|
-            unless arg.kind_of?(Integer) && arg > 0
-              m = "#{key} must be a positive Integer."
-              raise IIIF::Presentation::IllegalValueError, m
-            end
+            validation.call(key, arg) if block_given?
             self.send('[]=', key, arg)
           end
         end
@@ -408,6 +344,5 @@ module IIIF
         end
       end
     end
-
   end
 end