osullivan 0.0.2

data/osullivan.gemspec

@@ -0,0 +1,27 @@
+version = File.read(File.expand_path('../VERSION', __FILE__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name          = 'osullivan'
+  spec.version       = version
+  spec.authors       = ['Jon Stroop']
+  spec.email         = ['jpstroop@gmail.com']
+  spec.description   = 'API for working with IIIF Presentation manifests.'
+  spec.summary       = 'API for working with IIIF Presentation manifests.'
+  spec.license       = 'Simplified BSD'
+  spec.homepage      = 'https://github.com/jpstroop/osullivan'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^spec/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr', '~> 2.9.3'
+
+  spec.add_dependency 'json'
+  spec.add_dependency 'activesupport', '~> 3.2'
+  spec.add_dependency 'faraday', '~> 0.9.0'
+end

data/spec/fixtures/manifests/complete_from_spec.json

@@ -0,0 +1,171 @@
+{
+  "@context": "http://iiif.io/api/presentation/2/context.json",
+  "@id": "http://www.example.org/iiif/book1/manifest",
+  "@type": "sc:Manifest",
+  "label": "Book 1",
+  "metadata": [
+    {
+      "label": "Author",
+      "value": "Anne Author"
+    },
+    {
+      "label": "Published",
+      "value": [
+        {
+          "@value": "Paris, circa 1400",
+          "@language": "en"
+        },
+        {
+          "@value": "Paris, environ 14eme siecle",
+          "@language": "fr"
+        }
+      ]
+    }
+  ],
+  "description": "A longer description of this example book. It should give some real information.",
+  "license": "http://www.example.org/license.html",
+  "attribution": "Provided by Example Organization",
+  "service": {
+    "@context": "http://example.org/ns/jsonld/context.json",
+    "@id": "http://example.org/service/example",
+    "profile": "http://example.org/docs/example-service.html"
+  },
+  "seeAlso": {
+    "@id": "http://www.example.org/library/catalog/book1.marc",
+    "format": "application/marc"
+  },
+  "within": "http://www.example.org/collections/books/",
+  "sequences": [
+    {
+      "@id": "http://www.example.org/iiif/book1/sequence/normal",
+      "@type": "sc:Sequence",
+      "label": "Current Page Order",
+      "viewingDirection": "left-to-right",
+      "viewingHint": "paged",
+      "canvases": [
+        {
+          "@id": "http://www.example.org/iiif/book1/canvas/p1",
+          "@type": "sc:Canvas",
+          "label": "p. 1",
+          "height": 1000,
+          "width": 750,
+          "images": [
+            {
+              "@type": "oa:Annotation",
+              "motivation": "sc:painting",
+              "resource": {
+                "@id": "http://www.example.org/iiif/book1/res/page1.jpg",
+                "@type": "dctypes:Image",
+                "format": "image/jpeg",
+                "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"
+                },
+                "height": 2000,
+                "width": 1500
+              },
+              "on": "http://www.example.org/iiif/book1/canvas/p1"
+            }
+          ],
+          "otherContent": [
+            {
+              "@id": "http://www.example.org/iiif/book1/list/p1",
+              "@type": "sc:AnnotationList"
+            }
+          ]
+        },
+        {
+          "@id": "http://www.example.org/iiif/book1/canvas/p2",
+          "@type": "sc:Canvas",
+          "label": "p. 2",
+          "height": 1000,
+          "width": 750,
+          "images": [
+            {
+              "@type": "oa:Annotation",
+              "motivation": "sc:painting",
+              "resource": {
+                "@id": "http://www.example.org/images/book1-page2/full/1500,2000/0/default.jpg",
+                "@type": "dctypes:Image",
+                "format": "image/jpeg",
+                "height": 2000,
+                "width": 1500,
+                "service": {
+                  "@context": "http://iiif.io/api/image/2/context.json",
+                  "@id": "http://www.example.org/images/book1-page2",
+                  "profile": "http://iiif.io/api/image/2/level1.json",
+                  "height": 8000,
+                  "width": 6000,
+                  "tiles": [
+                    {
+                      "width": 512,
+                      "scaleFactors": [
+                        1,
+                        2,
+                        4,
+                        8,
+                        16
+                      ]
+                    }
+                  ]
+                }
+              },
+              "on": "http://www.example.org/iiif/book1/canvas/p2"
+            }
+          ],
+          "otherContent": [
+            {
+              "@id": "http://www.example.org/iiif/book1/list/p2",
+              "@type": "sc:AnnotationList"
+            }
+          ]
+        },
+        {
+          "@id": "http://www.example.org/iiif/book1/canvas/p3",
+          "@type": "sc:Canvas",
+          "label": "p. 3",
+          "height": 1000,
+          "width": 750,
+          "images": [
+            {
+              "@type": "oa:Annotation",
+              "motivation": "sc:painting",
+              "resource": {
+                "@id": "http://www.example.org/iiif/book1/res/page3.jpg",
+                "@type": "dctypes:Image",
+                "format": "image/jpeg",
+                "service": {
+                  "@context": "http://iiif.io/api/image/2/context.json",
+                  "@id": "http://www.example.org/images/book1-page3",
+                  "profile": "http://iiif.io/api/image/2/level1.json"
+                },
+                "height": 2000,
+                "width": 1500
+              },
+              "on": "http://www.example.org/iiif/book1/canvas/p3"
+            }
+          ],
+          "otherContent": [
+            {
+              "@id": "http://www.example.org/iiif/book1/list/p3",
+              "@type": "sc:AnnotationList"
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "structures": [
+    {
+      "@id": "http://www.example.org/iiif/book1/range/r1",
+      "@type": "sc:Range",
+      "label": "Introduction",
+      "canvases": [
+        "http://www.example.org/iiif/book1/canvas/p1",
+        "http://www.example.org/iiif/book1/canvas/p2",
+        "http://www.example.org/iiif/book1/canvas/p3#xywh=0,0,750,300"
+      ]
+    }
+  ]
+}

data/spec/fixtures/manifests/minimal.json

@@ -0,0 +1,40 @@
+{
+  "@context": "http://iiif.io/api/presentation/2/context.json",
+  "@type": "sc:Manifest",
+  "@id": "http://www.example.org/iiif/book1/manifest",
+  "label": "Book 1",
+  "sequences": [
+    {
+      "@id": "http://www.example.org/iiif/book1/sequence/normal",
+      "label": "Current Page Order",
+      "canvases": [
+        {
+          "@id": "http://www.example.org/iiif/book1/canvas/p1",
+          "@type": "sc:Canvas",
+          "label": "p. 1",
+          "height": 1000,
+          "width": 750,
+          "images": [
+            {
+              "@type": "oa:Annotation",
+              "motivation": "sc:painting",
+              "on": "http://www.example.org/iiif/book1/canvas/p1",
+              "resource": {
+                "@id": "http://www.example.org/iiif/book1/res/page1.jpg",
+                "@type": "dctypes:Image",
+                "format": "image/jpeg",
+                "height": 2000,
+                "width": 1500,
+                "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"
+                }
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

data/spec/fixtures/manifests/service_only.json

@@ -0,0 +1,11 @@
+{
+  "@context": "http://iiif.io/api/presentation/2/context.json",
+  "@type": "sc:Manifest",
+  "@id": "http://www.example.org/iiif/book1/manifest",
+  "label": "Book 1",
+  "service": {
+    "@context": "http://example.org/ns/jsonld/context.json",
+    "@id": "http://example.org/service/example",
+    "profile": "http://example.org/docs/example-service.html"
+  }
+}

data/spec/fixtures/vcr_cassettes/pul_loris_cassette.json

@@ -0,0 +1,159 @@
+{
+  "http_interactions": [
+    {
+      "request": {
+        "method": "get",
+        "uri": "http://libimages.princeton.edu/loris2/pudl0001%2F4612422%2F00000001.jp2/info.json",
+        "body": {
+          "encoding": "US-ASCII",
+          "string": ""
+        },
+        "headers": {
+          "User-Agent": [
+            "Faraday v0.9.0"
+          ],
+          "Accept-Encoding": [
+            "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
+          ],
+          "Accept": [
+            "*/*"
+          ]
+        }
+      },
+      "response": {
+        "status": {
+          "code": 200,
+          "message": "OK"
+        },
+        "headers": {
+          "Server": [
+            "Apache/2.2.22 (Ubuntu)"
+          ],
+          "Link": [
+            "<http://iiif.io/api/image/2/level2.json>;rel=\"profile\",<http://iiif.io/api/image/2/context.json>;rel=\"http://www.w3.org/ns/json-ld#context\";type=\"application/ld+json\""
+          ],
+          "Access-Control-Allow-Origin": [
+            "*"
+          ],
+          "Last-Modified": [
+            "Wed, 26 Nov 2014 21:16:14 GMT"
+          ],
+          "Cache-Control": [
+            "max-age=5184000"
+          ],
+          "Expires": [
+            "Sun, 25 Jan 2015 21:16:14 GMT"
+          ],
+          "Content-Type": [
+            "application/json"
+          ],
+          "Content-Length": [
+            "737"
+          ],
+          "Accept-Ranges": [
+            "bytes"
+          ],
+          "Date": [
+            "Thu, 27 Nov 2014 00:55:14 GMT"
+          ],
+          "X-Varnish": [
+            "1471998866 1471996229"
+          ],
+          "Age": [
+            "13140"
+          ],
+          "Via": [
+            "1.1 varnish"
+          ],
+          "Connection": [
+            "keep-alive"
+          ]
+        },
+        "body": {
+          "encoding": "UTF-8",
+          "string": "{\"profile\": [\"http://iiif.io/api/image/2/level2.json\", {\"supports\": [\"canonicalLinkHeader\", \"profileLinkHeader\", \"mirroring\", \"rotationArbitrary\", \"sizeAboveFull\"], \"qualities\": [\"default\", \"bitonal\", \"gray\", \"color\"], \"formats\": [\"jpg\", \"png\", \"gif\", \"webp\"]}], \"tiles\": [{\"width\": 1024, \"scaleFactors\": [1, 2, 4, 8, 16, 32]}], \"protocol\": \"http://iiif.io/api/image\", \"sizes\": [{\"width\": 96, \"height\": 225}, {\"width\": 191, \"height\": 450}, {\"width\": 381, \"height\": 900}, {\"width\": 762, \"height\": 1800}, {\"width\": 1524, \"height\": 3600}, {\"width\": 3047, \"height\": 7200}], \"height\": 7200, \"width\": 3047, \"@context\": \"http://iiif.io/api/image/2/context.json\", \"@id\": \"http://libimages.princeton.edu/loris2/pudl0001%2F4612422%2F00000001.jp2\"}"
+        },
+        "http_version": null
+      },
+      "recorded_at": "Thu, 27 Nov 2014 01:00:58 GMT"
+    },
+    {
+      "request": {
+        "method": "get",
+        "uri": "http://libimages.princeton.edu/loris2/xxxx%2F4612422%2F00000001.jp2/info.json",
+        "body": {
+          "encoding": "US-ASCII",
+          "string": ""
+        },
+        "headers": {
+          "User-Agent": [
+            "Faraday v0.9.0"
+          ],
+          "Accept-Encoding": [
+            "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
+          ],
+          "Accept": [
+            "*/*"
+          ]
+        }
+      },
+      "response": {
+        "status": {
+          "code": 404,
+          "message": "NOT FOUND"
+        },
+        "headers": {
+          "Server": [
+            "Apache/2.2.22 (Ubuntu)"
+          ],
+          "Link": [
+            "<http://iiif.io/api/image/2/level2.json>;rel=\"profile\""
+          ],
+          "Access-Control-Allow-Origin": [
+            "*"
+          ],
+          "Cache-Control": [
+            "max-age=5184000"
+          ],
+          "Expires": [
+            "Mon, 26 Jan 2015 10:20:46 GMT"
+          ],
+          "Vary": [
+            "Accept-Encoding"
+          ],
+          "Content-Type": [
+            "text/plain"
+          ],
+          "Content-Length": [
+            "88"
+          ],
+          "Accept-Ranges": [
+            "bytes"
+          ],
+          "Date": [
+            "Thu, 27 Nov 2014 10:20:46 GMT"
+          ],
+          "X-Varnish": [
+            "1472002765"
+          ],
+          "Age": [
+            "0"
+          ],
+          "Via": [
+            "1.1 varnish"
+          ],
+          "Connection": [
+            "keep-alive"
+          ]
+        },
+        "body": {
+          "encoding": "UTF-8",
+          "string": "Not Found: could not resolve identifier: xxxx%2F4612422%2F00000001.jp2  (404)"
+        },
+        "http_version": null
+      },
+      "recorded_at": "Thu, 27 Nov 2014 10:26:31 GMT"
+    }
+  ],
+  "recorded_with": "VCR 2.9.3"
+}

data/spec/integration/iiif/presentation/image_resource_spec.rb

@@ -0,0 +1,123 @@
+describe IIIF::Presentation::ImageResource do
+  vcr_options = {
+    cassette_name: 'pul_loris_cassette',
+    record: :new_episodes,
+    serialize_with: :json
+  }
+
+  describe 'self#create_image_api_image_resource', vcr: vcr_options do
+
+    let(:image_server) { 'http://libimages.princeton.edu/loris2' }
+
+    let(:valid_service_id) {
+      id = 'pudl0001%2F4612422%2F00000001.jp2'
+      "#{image_server}/#{id}"
+    }
+
+    let(:invalid_service_id) {
+      id = 'xxxx%2F4612422%2F00000001.jp2'
+      "#{image_server}/#{id}"
+    }
+
+    it 'returns an ImageResource' do
+      instance = described_class.create_image_api_image_resource(service_id: valid_service_id)
+      expect(instance.class).to be described_class
+    end
+
+
+    describe 'has expected values from our fixture' do
+      it 'when copy_info is false' do
+        opts = { service_id: valid_service_id }
+        resource = described_class.create_image_api_image_resource(opts)
+        # expect(resource['@context']).to eq 'http://iiif.io/api/presentation/2/context.json'
+        # @context is only added when we call to_json...
+        expect(resource['@id']).to eq 'http://libimages.princeton.edu/loris2/pudl0001%2F4612422%2F00000001.jp2/full/!200,200/0/default.jpg'
+        expect(resource['@type']).to eq 'dcterms:Image'
+        expect(resource.format).to eq "image/jpeg"
+        expect(resource.width).to eq 3047
+        expect(resource.height).to eq 7200
+        expect(resource.service['@context']).to eq 'http://iiif.io/api/image/2/context.json'
+        expect(resource.service['@id']).to eq 'http://libimages.princeton.edu/loris2/pudl0001%2F4612422%2F00000001.jp2'
+        expect(resource.service['profile']).to eq 'http://iiif.io/api/image/2/level2.json'
+      end
+      it 'copies over all teh infos (when copy_info is true)' do
+        opts = { service_id: valid_service_id, copy_info: true }
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource['@id']).to eq 'http://libimages.princeton.edu/loris2/pudl0001%2F4612422%2F00000001.jp2/full/!200,200/0/default.jpg'
+        expect(resource['@type']).to eq 'dcterms:Image'
+        expect(resource.format).to eq "image/jpeg"
+        expect(resource.width).to eq 3047
+        expect(resource.height).to eq 7200
+        expect(resource.service['@context']).to eq 'http://iiif.io/api/image/2/context.json'
+        expect(resource.service['@id']).to eq 'http://libimages.princeton.edu/loris2/pudl0001%2F4612422%2F00000001.jp2'
+        expect(resource.service['profile']).to eq [
+          'http://iiif.io/api/image/2/level2.json',
+          {
+            'supports' => [
+              'canonicalLinkHeader', 'profileLinkHeader', 'mirroring',
+              'rotationArbitrary', 'sizeAboveFull'
+            ],
+            'qualities' => ['default', 'bitonal', 'gray', 'color'],
+            'formats'=>['jpg', 'png', 'gif', 'webp']
+          }
+        ]
+        expect(resource.service['tiles']).to eq [ {
+          'width' =>  1024,
+          'scaleFactors' =>  [ 1, 2, 4, 8, 16, 32 ] 
+        } ]
+        expect(resource.service['sizes']).to eq [
+          {'width' => 96, 'height' =>  225 },
+          {'width' => 191, 'height' =>  450 },
+          {'width' => 381, 'height' =>  900 },
+          {'width' => 762, 'height' => 1800 },
+          {'width' => 1524, 'height' => 3600 },
+          {'width' => 3047, 'height' =>  7200 }
+        ]
+      end
+    end
+
+    describe 'respects the params we supply' do
+      it ':resource_id' do
+        r_id = 'http://example.edu/images/some.jpg'
+        opts = { service_id: valid_service_id, resource_id: r_id}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource['@id']).to eq r_id
+      end
+      it ':width' do
+        width = 42
+        opts = { service_id: valid_service_id, width: width}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource.width).to eq width
+      end
+      it ':height' do
+        height = 42
+        opts = { service_id: valid_service_id, height: height}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource.height).to eq height
+      end
+      it ':profile (service[\'profile\'])' do
+        profile = 'http://iiif.io/api/image/2/level1.json'
+        opts = { service_id: valid_service_id, profile: profile}
+        resource = described_class.create_image_api_image_resource(opts)
+        expect(resource.service['profile']).to eq profile
+      end
+    end
+
+    describe 'errors' do
+      it 'raises if :service_id is not included' do
+        expect {
+          described_class.create_image_api_image_resource
+        }.to raise_error
+      end
+      it 'raises if the info can\'t be pulled in' do
+        expect {
+          described_class.create_image_api_image_resource(service_id: invalid_service_id)
+        }.to raise_error
+      end
+    end
+
+
+  end
+end
+
+