Project

bookreader

0.0
No commit activity in last 3 years
No release in over 3 years
Archive BookReader Gem for Rails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 1.17
~> 5.0
~> 10.0
 Project Readme

Bookreader

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/bookreader. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'bookreader'

And then execute:

$ bundle

Or install it yourself as:

$ gem install bookreader

Usage

add follow code to application.css:

 *= require bookreader/BookReader
 *= require bookreader/BookReaderDemo

and add follow code to application.js:

//= require bookreader/jquery-1.10.1
//= require bookreader/jquery-ui-1.12.0.min
//= require bookreader/jquery.browser.min
//= require bookreader/dragscrollable-br
//= require bookreader/jquery.colorbox-min
//= require bookreader/jquery.bt.min
//= require bookreader/BookReader

then, add follow javascript code to demo page in body:

<div id="BookReader">
    Internet Archive BookReader Demo<br/>
    <noscript>
    <p>
        The BookReader requires JavaScript to be enabled. Please check that your browser supports JavaScript and that it is enabled in the browser settings.  You can also try one of the <a href="https://archive.org/details/goodytwoshoes00newyiala"> other formats of the book</a>.
    </p>
    </noscript>
</div>

<script>
// Bind to the BookReader object providing facilities to set the necessary
// BookReader functions from a IIIF endpoint URL.
// author: @aeschylus

// TODO enable passing in manifest and sequence id directly
// TODO convert this to be a v3 plugin. Use simplified options.data

(function(BR){

    BR.prototype.IIIF = function (config) {
        // config should have the url of a sequence
        // within a passed-in manifest.
        var brInstance = this;
        brInstance.IIIFsequence = {
            title: null,
            imagesList: [],
            numPages: null,
            bookUrl: null
        };
        oldInit = brInstance.init;
        oldMode = brInstance.mode;
        brInstance.init = function() {
            load(config);
        };
        brInstance.mode = 2;

        function bindBRMethods(){
            brInstance.getPageNum = function(index) {
                return index+1;
            };

            brInstance.getSpreadIndices = function(pindex) {
                var spreadIndices = [null, null];
                if ('rl' == brInstance.pageProgression) {
                    // Right to Left
                    if (brInstance.getPageSide(pindex) == 'R') {
                        spreadIndices[1] = pindex;
                        spreadIndices[0] = pindex + 1;
                    } else {
                        // Given index was LHS
                        spreadIndices[0] = pindex;
                        spreadIndices[1] = pindex - 1;
                    }
                } else {
                    // Left to right
                    if (brInstance.getPageSide(pindex) == 'L') {
                        spreadIndices[0] = pindex;
                        spreadIndices[1] = pindex + 1;
                    } else {
                        // Given index was RHS
                        spreadIndices[1] = pindex;
                        spreadIndices[0] = pindex - 1;
                    }
                }

                return spreadIndices;
            };

            brInstance.getPageSide = function(index) {
                if (0 == (index & 0x1)) {
                    return 'R';
                } else {
                    return 'L';
                }
            };

            brInstance.getPageHeight = function(index) {
                // console.log(index);
                var fullWidth = brInstance.IIIFsequence.imagesList[index].width,
                fullHeight = brInstance.IIIFsequence.imagesList[index].height,
                scaleRatio = config.maxWidth/fullWidth;

                return fullHeight*scaleRatio;
            };

            brInstance.getPageWidth = function(index) {
                var fullWidth = brInstance.IIIFsequence.imagesList[index].width,
                scaleRatio = config.maxWidth/fullWidth;

                return fullWidth*scaleRatio;
            };

            brInstance.getPageURI = function(index) {
                // Finds the image info.json url
                // from the loaded sequence and returns the
                // IIIF-formatted url for the page image
                // based on the provided configuration object
                // (adjusting for width, etc.).
                var infoJsonUrl = brInstance.IIIFsequence.imagesList[index].imageUrl;
                var url = infoJsonUrl + "/full/" + config.maxWidth + ",/0/native.jpg";
                return url;
            };

        }

        function load(config) {

            endpointUrl = config.url,
            sequenceId = config.sequenceId;

            jQuery.ajax({
                url: endpointUrl.replace(/^\s+|\s+$/g, ''),
                dataType: 'json',
                async: true,

                success: function(jsonLd) {
                    brInstance.jsonLd = jsonLd;
                    brInstance.bookTitle = jsonLd.label;
                    brInstance.bookUrl = '#';
                    brInstance.thumbnail = jsonLd.thumbnail['@id'];
                    brInstance.metadata = jsonLd.metadata;
                    parseSequence(sequenceId);
                    bindBRMethods();

                    // Call the old initialisation after
                    // the urls are finished. A better implementation
                    // would be to employ promises (Likely by including
                    // the Q Promises/A+ implementation. See issue #1 at
                    // github.
                    oldInit.call(brInstance);

                    if (config.initCallback) {
                      config.initCallback.apply();
                    }

                    // // The following is an attrocious hack and must not
                    // // be allowed to persist. See issue #2 at github.com
                    // setTimeout(function() { jQuery(window).trigger('resize'); console.log("resize event fired")}, 2500);
                },

                error: function() {
                    console.log('Failed loading ' + brInstance.uri);
                }

            });

        }

        function parseSequence(sequenceId) {

            jQuery.each(brInstance.jsonLd.sequences, function(index, sequence) {
                if (sequence['@id'] === sequenceId) {
                    brInstance.IIIFsequence.title = "here's a sequence";
                    brInstance.IIIFsequence.bookUrl = "http://iiif.io";
                    brInstance.IIIFsequence.imagesList = getImagesList(sequence);
                    brInstance.numLeafs = brInstance.IIIFsequence.imagesList.length;
                }
            });

            delete brInstance.jsonLd;

        }

        function getImagesList(sequence) {
            var imagesList = [];

            jQuery.each(sequence.canvases, function(index, canvas) {
                var imageObj;

                if (canvas['@type'] === 'sc:Canvas') {
                    var images = canvas.resources || canvas.images;

                    jQuery.each(images, function(index, image) {
                        if (image['@type'] === 'oa:Annotation') {
                            imageObj = getImageObject(image);
                            imageObj.canvasWidth = canvas.width;
                            imageObj.canvasHeight = canvas.height;

                            if (!(/#xywh/).test(image.on)) {
                                imagesList.push(imageObj);
                            }
                        }
                    });

                }
            });

            return imagesList;
        }

        function getImageObject (image) {
            var resource = image.resource;

            if (resource.hasOwnProperty('@type') && resource['@type'] === 'oa:Choice') {
                var imageObj = getImageProperties(resource.default);
            } else {
                imageObj = getImageProperties(resource);
            }

            return(imageObj);
        }

        function getImageProperties(image) {
            var imageObj = {
                height:       image.height || 0,
                width:        image.width || 0,
                imageUrl:     image.service['@id'].replace(/\/$/, ''),
            };

            imageObj.aspectRatio  = (imageObj.width / imageObj.height) || 1;

            return imageObj;
        }

    };

})(BookReader);
</script>
<script>

// This demo uses a slightly modified version of
// https://github.com/aeschylus/IIIFBookReader
//
// It is intended as a rapid proof of concept.
// More development could be done.

var br = new BookReader({
    // Book title and the URL used for the book title link
    bookTitle: 'Open Library BookReader Presentation',
    bookUrl: 'http://openlibrary.org',

    // Override the path used to find UI images
    imagesBaseURL: '/assets/',
    enableMobileNav: false,
});

br.IIIF({
    url: 'https://iiif.archivelab.org/iiif/platowithenglish04platuoft/manifest.json',
    sequenceId : 'https://iiif.archivelab.org/iiif/platowithenglish04platuoft/canvas/default',
    maxWidth: 800,
    initCallback: function() {
    }
});

// Let's go!
br.init();
</script>

then, you can visit it. enjoy!

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/bookreader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Bookreader project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.