lentil 0.0.1.pre

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTg5YTU4MDUzOWFiZGE5OTVkYThiNGVmYTIwNDZlNWM2N2NiNWVmMg==
+  data.tar.gz: !binary |-
+    ZTM2OTk5ODI2Yzc0YzYyMWQxMjMxOTZhMTI1NGI0NmMxZTllZjc2Mw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZGFkMmQ0MGRhZGQ2NjNlNDg1ZjZlNWFhNTM1ZDM5YTIzYjZhYzg2OGQ3NGE1
+    ZDAwMDRkMjk1NzMzYjlmMDMwOWE1ODJlNDNlZmRhMzY3MGY2ZTg3Yjc2YjIy
+    NGU2MjQxMWVlNDAxMzZjNTYzODhmMGQ3MTRhMDFmNjVkMGI2OWY=
+  data.tar.gz: !binary |-
+    YzU2ZDFiMTYxMWYxNGNlZjRmNDlhZGQ1YWRhM2M0MmE4MDg2ZDBjZDBkYTYy
+    NjU3NjE2OGM4ZTVjYWUxNzdkY2E5NWUyMjA3MWRiNWU0ZTQ1YTc0NjVkZTdi
+    ZjYyMGVjNTQzMjhjZTRmZGFiNDgxYTk5MmU1ZDgyMTkyMzY0Nzc=

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 North Carolina State University
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,199 @@
+# Lentil
+
+lentil is a Ruby on Rails Engine that supports the harvesting of images from Instagram and provides several browsing views, mechanisms for sharing, tools for users to select their favorite images, an administrative interface for moderating images, and a system for harvesting images and submitting donor agreements in preparation of ingest into external repositories. Built according to the principles of “responsive design,” lentil is designed for use on mobile devices, tablets, desktops, and larger screens.
+
+## History
+
+lentil is extracted from the [My #HuntLibrary project](http://www.lib.ncsu.edu/dli/projects/MHL) at [NCSU Libraries](http://www.lib.ncsu.edu/). My #HuntLibrary was created as a platform to foster student and community engagement with the new building via social media imagery and to preserve and archive these images as part of the record of the [Hunt Library](http://www.lib.ncsu.edu/huntlibrary) launch. Images from this crowdsourced documentation effort will be selected to become part of our permanent digital collections, allowing the NCSU community to contribute to the historical record of the Hunt Library through image submissions as well as the use of voting tools.
+
+## Project Maturity
+
+Although a version of this code is being used in production, **this gem should be considered a pre-release**. We are still in the process of moving over to using this gem.
+
+## Installation
+
+> **Note:** lentil has not been tested with Ruby 2.x.
+
+### Add lentil and therubyracer (or another ExecJS runtime) to your Gemfile and `bundle`
+
+```ruby
+gem 'lentil'
+gem 'therubyracer'
+```
+
+> If you would like to work directly from the master branch, use `gem 'git://github.com/NCSU-Libraries/lentil.git'` instead.
+
+### Run the generator
+
+```sh
+bundle exec rails generate lentil:install
+```
+
+### Start the server
+
+```sh
+bundle exec rails server
+```
+
+Visit <http://localhost:3000>
+
+## Harvest Images
+
+- You will need to define your `instagram_client_id` and `instagram_client_secret` in `config/lentil_config.yml`. You can generate these strings by creating an [Instagram API](http://instagram.com/developer) client for your application.
+
+- If you haven't already, add an administrative user in development.
+
+```sh
+bundle exec rake lentil:dummy_admin_user
+```
+
+You will then have an administrative user with the following credentials:
+- Username: admin@example.com
+- Password: password
+
+- Login to the administrative console. Go to <http://localhost:3000/admin>
+
+- Go to <http://localhost:3000/admin/lentil_tags/> and create a new tag.
+- Go to <http://localhost:3000/admin/lentil_tagsets> and create a new tagset, selecting the tag you just created. Make sure to mark this tagset as `harvestable`.
+
+- Harvest some images by opening up another terminal and running:
+
+```sh
+bundle exec rake lentil:image_services:instagram:fetch_by_tag
+```
+
+You ought to see a message like: "15 new images added"
+
+> **Note:** The harvesting task currently does not utilize Instagram's result paging. It is important at this point to harvest images frequently in order to avoid missed content.
+
+- Go to <http://localhost:3000/admin/lentil_images> and click on "Moderate New." Approve or reject some images. Once you've approved some, go to <http://localhost:3000> to see your approved images.
+- Congratulations! You're now up and running!
+
+## Scheduling tasks
+
+There are several rake tasks that you should schedule to run on a recurring basis:
+
+- `rake lentil:image_services:instagram:fetch_by_tag` harvests image metadata for all tags within "harvestable" tagsets.
+- `rake lentil:image_services:test_image_files[number_of_images,image_service]` checks that the image content for approved images is still available. After 3 failures, Lentil will stop displaying the images. After 10 failures, Lentil will stop checking. Defaults to checking 10 Instagram images. Images will not be checked more than once per day.
+- `rake lentil:popularity:update_score` recalculates the popularity score based on "likes" and "battles."
+
+Additionally, there are two optional rake tasks that support image file harvesting for longer-term retention:
+
+- `rake lentil:image_services:save_image_files[number_of_images,image_service,base_directory]` Lentil normally only stores image metadata, but this task will save the image file to a specified directory. This file will still not be used by Lentil, but the file retrieval will be noted in the Image model. Defaults to 50 Instagram images, saving to the path specified by the `base_image_file_dir` option from `config/lentil_config.yml`.
+- `rake lentil:image_services:submit_donor_agreements[number_of_images,image_service]` will submit a donor agreement (using the `donor_agreement_text` option from `config/lentil_config.yml`) as a comment on approved Instagram images that have been in the system for at least a week. Currently defaults to one image.
+
+> In order to submit comments, you will need to generate an access token for the user that will submit the comments. See the [Instagram documentation](http://instagram.com/developer/authentication/) and a [discussion of access token expiration](https://groups.google.com/forum/?fromgroups=#!searchin/instagram-api-developers/access$20token%7Csort:date/instagram-api-developers/OBOTwIh3FSw/9hTccUX1Jq4J).
+
+An example of a background task schedule using the [whenever](https://github.com/javan/whenever) gem:
+
+```ruby
+case @environment
+when 'production'
+  every 5.minutes do
+    rake "image_services:instagram:fetch_by_tag", :output => {:standard => nil}
+  end
+
+  every 30.minutes do
+    rake "image_services:test_image_files", :output => {:standard => nil}
+  end
+end
+
+# All environments
+every :hour do
+  rake "popularity:update_score", :output => {:standard => nil}
+end
+```
+
+## Customization
+
+- A simple first customization to do is to override the about page by putting your own about page at app/views/lentil/pages/about.html.erb.
+- If you haven't already you'll have update your `config/lentil_config.yml` file with your application name.
+- You can change the look of your site by including some variables in your application.css.scss before importing the lentil CSS:
+
+```sass
+$gray_text: #34282C;
+$lentil_yellow: #DAB416;
+$lentil_blue: #08C;
+@import "lentil";
+```
+
+- In order to set image backgrounds in [My #HuntLibrary](http://d.lib.ncsu.edu/myhuntlibrary), the following CSS is included in a file that is imported after `lentil`:
+
+```css
+body {
+    background: image-url("background/fins3.jpg") fixed;
+}
+
+.navbar-inner {
+    background: #121212 image-url("nav/top_background.png") repeat-x;
+}
+
+div.header {
+    background: #0C1021 image-url("nav/example_08.jpg");
+}
+```
+
+## Testing
+
+- Install all of the dependencies:
+
+```sh
+bundle install
+```
+
+- Prepare the test database
+
+```sh
+RAILS_ENV=test bundle exec rake app:db:migrate
+RAILS_ENV=test bundle exec rake app:db:test:prepare
+```
+
+- Run the tests
+
+```sh
+bundle exec rake test
+```
+
+## Running the Test/Dummy Instance
+
+Sometimes you just might want to see what the dummy instance actually looks like. You can do the following:
+
+```sh
+bundle exec rake app:db:schema:load
+cd test/dummy
+bundle exec rake db:fixtures:load FIXTURES_PATH=../fixtures
+bundle exec rails s
+```
+
+Once you load the fixtures you'll be able to harvest anything that has the tag "#hunttesting"
+
+```sh
+cd test/dummy
+```
+
+Edit `config/lentil_config.yml` and set `instagram_client_id` to the client ID associated with your Instagram API client.
+
+```sh
+bundle exec rake image_services:instagram:fetch_by_tag
+```
+
+## License
+
+See MIT-LICENSE
+
+## Contact
+
+Submit a GitHub issue or contact lentil@lists.ncsu.edu.
+
+## Authors (in alphabetical order)
+
+* Jason Casden
+* Bret Davidson
+* Cory Lown
+* Jason Ronallo
+
+## Additional project team members
+
+* Brian Dietz
+* Jennifer Garrett
+* Mike Nutt (Product Lead for My #HuntLibrary project)

data/Rakefile

@@ -0,0 +1,43 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Lentil'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test
+
+require 'single_test'
+SingleTest.load_tasks

data/app/assets/javascripts/active_admin.js

@@ -0,0 +1,7 @@
+//= require active_admin/base
+//= require chosen-jquery
+//= require expanding/expanding
+
+$(document).ready(function() {
+    $(".chzn-select").chosen();
+});

data/app/assets/javascripts/lentil.js

@@ -0,0 +1,3 @@
+//= require lentil/images
+//= require lentil/thisorthat
+//= require lentil/event_tracking

data/app/assets/javascripts/lentil/addanimatedimages.js

@@ -0,0 +1,44 @@
+//= require animatedimages/js/modernizr.custom.26633.js
+//= require animatedimages/js/jquery.gridrotator.js
+function addanimatedimages() {
+
+    $(function() {
+        $( '#ri-grid' ).gridrotator( {
+            rows : 3,
+            columns : 8,
+            maxStep : 2,
+            interval : 4500,
+            animType : 'rotateRight',
+            animSpeed: 1000,
+            w2000 : {
+            rows : 3,
+            columns: 6
+            },
+            w1750 : {
+            rows : 4,
+            columns : 6
+            },
+            w1024 : {
+            rows : 6,
+            columns : 3
+            },
+            w768 : {
+            rows : 5,
+            columns : 3
+            },
+            w480 : {
+            rows : 8,
+            columns : 4
+            },
+            w320 : {
+            rows : 4,
+            columns : 3
+            },
+            w240 : {
+            rows : 4,
+            columns : 3
+            }
+        });
+
+    });
+}

data/app/assets/javascripts/lentil/addfancybox.js

@@ -0,0 +1,152 @@
+var FancyBoxCloseFunctionState = {
+
+    // object literal for tracking important
+    // state information so we know
+    // how to change the url in response
+    // to user actions such as
+    // dismissing fancybox from clicking or using back button
+    popcalled: false,
+    fancyboxvisible: false,
+    pathname: window.location.pathname.replace(/\/?$/, '/')
+};
+
+// listen for popstate (back/forward, etc.)
+function listenforpopstate() {
+    window.onpopstate = function(){
+        if ($('body').is(".lentil-images_show")) {
+            // if we're on the images page
+            // and this doesn't look like an image url
+            // switch to page that matches the url
+            if (!/images\/[0-9]/.test(window.location.pathname)) {
+              window.location.href = window.location.pathname;
+            }
+        } else {
+
+            // if we're on any other page (not an image)
+            // but the url looks like an image url
+            // switch to the image page that matches the url
+            if (/images\/[0-9]/.test(window.location.pathname)) {
+              window.location.href = window.location.pathname;
+            }
+        }
+    };
+}
+
+function pushimageurl() {
+
+    // extract application root url
+    var approot = FancyBoxCloseFunctionState.pathname.replace(/(photographers\/\d+|images|thisorthat\/battle|thisorthat\/battle_leaders)\/\D*\/?/, "");
+
+    // construct an image show url with the right image id
+    replacementUrl =  approot + "images/" + imageId.replace("image_","");
+
+    // get rid of any double slashes (TO DO: remove this?)
+    if (/\/\//.test(replacementUrl)) {
+        replacementUrl = replacementUrl.replace("//","/");
+    }
+
+    // push the url for the displayed image to the browser
+    window.history.pushState(null, null, replacementUrl);
+
+    if (typeof _gaq !== "undefined") {
+        _gaq.push(['_trackPageview', replacementUrl]);
+    }
+
+    // listen for popstate (back/forward button)
+    window.onpopstate = function(){
+        if (/images\/[0-9]/.test(window.location.pathname)) {
+            // if this url looks like an image show url then switch
+            // the browser to the displayed url
+            window.location.href = window.location.pathname;
+        } else {
+            // otherwise switch the popcalled state to true
+            // and close the fancybox
+            FancyBoxCloseFunctionState.popcalled = true;
+            $.fancybox.close();
+            // switch the popcalled flag to false
+            // and the fancybox visible flag to false
+            FancyBoxCloseFunctionState.popcalled = false;
+            FancyBoxCloseFunctionState.fancyboxvisible = false;
+        }
+    };
+}
+
+function addfancybox() {
+
+    $(".fancybox").fancybox({
+        openEffect  : 'none',
+        closeEffect : 'none',
+        nextEffect  : 'none',
+        prevEffect  : 'none',
+        loop : false,
+        minWidth : '250px',
+        helpers     : {
+            title   : { type : 'inside' }
+        },
+        afterLoad: function(current, previous) {
+
+          // pushing base url so that back/close returns to image gallery
+          // instead of image show
+          window.history.pushState(null,null,FancyBoxCloseFunctionState.pathname);
+        },
+        beforeShow  : function() {
+            this.title = $(this.element).next(".text-overlay").html();
+            imageId = $(this.element).parents("div").attr("id");
+            $(".fancybox-overlay, .fancybox-mobile").attr('id', imageId);
+            pushimageurl(imageId);
+        },
+        afterShow : function() {
+
+            // checks whether browser understands touch events
+            // if so the next/prev buttons are disabled
+            // and swipe down/right is added to advance slides
+            if ('ontouchstart' in document.documentElement){
+                $('.fancybox-nav').css('display','none');
+                $('.fancybox-wrap').swipe({
+                    swipe : function(event, direction) {
+                        if (direction === 'right' || direction === 'down') {
+                            $.fancybox.prev( direction );
+                        } else {
+                            $.fancybox.next( direction );
+                        }
+                    }
+                });
+            }
+
+            // adds button handling script to displayed fancybox buttons
+            buttonhandler();
+
+            // this is to check that the fancybox is really visible
+            // afterClose is fired off on fancybox open -- a bug
+            FancyBoxCloseFunctionState.fancyboxvisible = true;
+            imageId = $(this.element).parents("div").attr("id");
+
+            // check whether we're on the last image in the gallery
+            // and whether there's more than one page of images
+            // if so, launch the spinner, fetch the next set of images
+            // and scroll to the current image
+            // (callback on addininfintescroll() does the work of reloading fancybox)
+            if (this.index == this.group.length - 1 && $("div#paging a").length > 0) {
+                $('#spinner-overlay').show();
+                $('#spinner-overlay').css("z-index", 10000000);
+                target = document.getElementById('spinner-overlay');
+                FANCYBOX_SPINNER = new Spinner(opts).spin(target);
+                //$("body").animate({scrollTop: $("div#" + imageId).offset().top }, 1500);
+                $('div.images').infinitescroll('retrieve');
+            }
+        },
+        afterClose : function() {
+            if (FancyBoxCloseFunctionState.popcalled === false && FancyBoxCloseFunctionState.fancyboxvisible === true) {
+
+              // if after closing the fancybox there is no pop event
+              // and the fancybox is visible
+              // (this afterClose event also fires when fancybox opens
+              // -- a bug we're getting around with this hack)
+              // switch the flags and point the url at the previous page
+              // should be an image tile view (recent, popular, staff picks, etc.)
+              FancyBoxCloseFunctionState.fancyboxvisible = false;
+              window.history.back();
+            }
+        }
+    });
+}