irus_analytics 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    M2VkNzliNDBkYWRlZmVmNmMzZDc3ZTUzZDc0YTk1ZWE2YmUyZTUyZQ==
+  data.tar.gz: !binary |-
+    OTgwYjQyOWVjN2Y5NWMzZjQ0MGViMjA2NGU0M2FlNTE4YWVkMTk0OQ==
+SHA512:
+  metadata.gz: !binary |-
+    OTVkZTBjMWY3ZWUxMTFmMDhhMzk5MDQ3NjliODhkMTljZTRkNTFkMjg3OTZm
+    YWUzMTY3NDE0YWE2ZjVjMWEyNzVjMzkyMGNhYzQ2NzE1NmYyOTExYTM2Y2I0
+    ODUxMGQ2NGQ4OTdjODNhMTM3NDc4OWVjZGNkNWZhZjZmYmU4NGQ=
+  data.tar.gz: !binary |-
+    NDVjMGM0YTY5NGI4MmUxZjI0NzUxOWU0NDZkN2QwNzE4NDVlYjY0NjkwZjQ1
+    ZWQ2YmZhZmNlMjczM2I4ZTcyZjU1ZmZmYjIwNzYzMWQ3ZjQ1OTU5ZmNkMzA3
+    NjJmNzc1N2I0Mjc2NTEwOTdjYWM2YzEwYTU4ZGIwMzlhMzUyYmU=

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-gemset

@@ -0,0 +1 @@
+irus_analytics

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p545

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in irus_analytics.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,15 @@
+Copyright 2014 The University of Hull
+ 
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+ 
+http://www.apache.org/licenses/LICENSE-2.0
+ 
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+ 
+Additional copyright may be held by others, as reflected in the commit history. 

data/README.md

@@ -0,0 +1,92 @@
+# IrusAnalytics
+
+IrusAnalytics is a gem that provides a simple way to send analytics to the IRUS-UK repository agggregation service.  
+
+More information about IRUS-UK can be found at [http://www.irus.mimas.ac.uk/](http://www.irus.mimas.ac.uk/).  In summary the IRUS-UK service is designed to provide article-level usage statistics for Institutional Repositories.  To sign up and use IRUS-UK, please see the above link. 
+
+This gem was developed for use with a Hydra repository [http://projecthydra.org/](http://projecthydra.org/), but it can be used with any other Rails based web application. 
+
+# Build Status
+![Build Status](https://api.travis-ci.org/uohull/irus_analytics.png?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'irus_analytics'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install irus_analytics
+
+## Usage
+
+Once you have the gem, run the following generator:
+
+    $ rails g irus_analytics
+
+This will generate a configuration file that exists within config/initializers/irus_analytics.rb
+
+**IrusAnalytics.configuration.source\_repository** is used to configure the name of the source respository url (i.e. what the url for your repository)
+**IrusAnalytics.configuration.irus\_server\_address** is used to define the IRUS-UK server endpoint, this can be configured for the test version of the service.  
+
+The Irus analytics code is designed to be called after a download event has happened in your rails application.  The following code needs adding to the Rails controller handles the content download.
+
+A simple example...
+
+    class YourDownloadController < ApplicationController
+      # You need to include the IrusAnalytics behaviour module
+      include IrusAnalytics::Controller::AnalyticsBehaviour 
+
+      after_filter :send_analytics, only: [:show]
+
+      def show
+        @id = params[:id] 
+        # Your code
+      end
+
+      protected 
+    
+      #  You need to define this method for IrusAnalytics to use as the identifier (typically a OAI valid identifier)
+      def item_identifier 
+        @id
+      end
+    end
+
+Therefore in summary...
+
+    include IrusAnalytics::Controller::AnalyticsBehaviour  
+  
+    after_filter :send_analytics, only: [:show]
+
+    def item_identifier
+    end
+
+... needs adding to the relevant controller.  
+
+To be compliant with the IRUS-UK client requirements/recommendations this Gem makes use of the Resque  [https://github.com/resque/resque](https://github.com/resque/resque).  Resque provides a simple way to create background jobs within your Ruby application, and is specifically used within this gem to push the analytics posts onto a queue.  This means the download functionality within your application is unaffected by the send analytics call, and it provides a means of queuing analytics if the IRUS-UK server is down. 
+
+Note: Resque requires Redis to be installed  
+
+By installing this gem, your application should have access to the Resque rake tasks.  These can be seen by running "rake -T",  the list should include:-
+
+    rake resque:failures:sort 
+    rake resque:work
+    rake resque:workers
+
+To start the resque background job for this gem use
+
+    QUEUE=irus_analytics rake environment resque:work
+
+
+## Contributing
+
+1. Fork it ( https://github.com/uohull/irus_analytics/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "resque/tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec
+

data/config/counter_robot_list.txt

@@ -0,0 +1,241 @@
+[^a]fish
+[+:,\.\;\/\\-]bot
+^$
+^IDA$
+^ruby$
+^voyager\/
+acme\.spider
+alexa
+Alexandria(\s|\+)prototype(\s|\+)project
+AllenTrack
+almaden
+appie
+Arachmo
+architext
+archive\.org_bot
+arks
+asterias
+atomz
+autoemailspider
+awbot
+baiduspider
+bbot
+BDFetch
+biadu
+biglotron
+bjaaland
+blaiz\-bee
+bloglines
+blogpulse
+boitho\.com\-dc
+bookmark\-manager
+bot
+Brutus\/AET
+bspider
+bwh3_user_agent
+celestial
+cfnetwork|checkbot
+checkprivacy
+China\sLocal\sBrowse\s2\.6
+cloakDetect
+Code\sSample\sWeb\sClient
+combine
+commons\-httpclient
+contentmatch
+ContentSmartz
+core
+CoverScout
+crawl
+crawler 
+cursor
+custo
+DataCha0s\/2\.0
+daumoa
+Demo\sBot
+docomo
+Download\+Master
+DSurf
+dtSearchSpider
+dumbot
+easydl
+EmailSiphon
+EmailWolf
+exabot
+fast-webcrawler
+favorg
+FDM(\s|\+)1
+feedburner
+FeedFetcher
+feedfetcher\-google
+ferret
+Fetch(\s|\+)API(\s|\+)Request
+findlinks
+Fulltext
+Funnelback
+gaisbot
+GetRight
+geturl
+gigabot
+girafabot
+gnodspider
+Goldfire(\s|\+)Server
+google
+grub
+gulliver
+harvest
+heritrix
+hl_ftien_spider
+holmes
+htdig
+htmlparser
+HttpComponents\/1.1
+HTTPFetcher
+httpget\?5\.2\.2
+httpget\-5\.2\.2
+httrack
+ia_archiver
+ichiro
+iktomi
+ilse
+internetseer
+intute
+iSiloX
+Jakarta\+Commons\-HttpClient
+java
+jeeves
+jobo
+kyluka
+larbin
+libcurl
+libwww
+libwww\-perl
+lilina
+linkbot
+linkcheck
+linkchecker
+LinkLint-checkonly
+linkscan
+linkwalker
+livejournal\.com
+lmspider
+LOCKSS
+lwp
+LWP\:\:Simple
+lwp\-request
+lwp\-tivial
+lwp\-trivial
+lwp-request
+lycos[_+]
+mail.ru
+MarcEdit.5.2.Web.Client
+mediapartners\-google
+Mediapartners-Google
+megite
+Microsoft(\s|\+)URL(\s|\+)Control
+milbot
+mimas
+mj12bot
+mnogosearch
+moget
+mojeekbot
+momspider
+motor
+msiecrawler
+msnbot
+MuscatFerre
+myweb
+NABOT
+nagios
+NaverBot
+netcraft
+netluchs
+ng\/2\.
+Ning
+no_user_agent
+nomad
+nutch
+ocelli
+Offline(\s|\+)Navigator
+onetszukaj
+OurBrowser
+parsijoo
+pear.php.net
+perman
+PHP\/
+pioneer
+playmusic\.com
+playstarmusic\.com
+powermarks
+psbot
+PycURL
+python
+qihoobot
+rambler
+Readpaper
+redalert|robozilla
+RePEc.link.checker
+robot
+robots
+RPT\-HTTPClient\/0.3-3E
+rss
+scan4mail
+scientificcommons
+scirus
+scooter
+seekbot
+seznambot
+shoutcast
+slurp
+sogou
+speedy
+spider
+spiderman
+spiderview
+Strider
+sunrise
+superbot
+surveybot
+T\-H\-U\-N\-D\-E\-R\-S\-T\-O\-N\-E
+tailrank
+technoratibot
+Teleport(\s|\+)Pro
+Teoma
+titan
+turnitinbot
+twiceler
+ucsd
+ultraseek
+URL2File
+urlaliasbuilder
+urllib
+validator
+virus[_+]detector
+voila
+w3c\-checklink
+Wanadoo
+Web(\s|\+)Downloader
+WebCloner
+webcollage
+WebCopier
+Webinator
+weblayers
+Webmetrics
+webmirror
+webreaper
+WebStripper
+WebZIP
+Wget
+wordpress
+worm
+www.gnip.com 
+WWW\-Mechanize
+xenu
+Xenu(\s|\+)Link(\s|\+)Sleuth
+y!j
+yacy
+yahoo
+yandex
+yodaobot
+zealbot
+zeus
+zyborg

data/irus_analytics.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'irus_analytics/version'
+
+Gem::Specification.new do |spec|
+  spec.name           = "irus_analytics"
+  spec.version        = IrusAnalytics::VERSION
+  spec.authors        = ["Simon Lamb"]
+  spec.email           = ["s.lamb@hull.ac.uk"]
+  spec.summary      = %q{IrusAnalytics is a gem that provides a simple way to send analytics to the IRUS-UK repository agggregation service. }
+  spec.description   = %q{More information about IRUS-UK can be found at [http://www.irus.mimas.ac.uk/](http://www.irus.mimas.ac.uk/).  In summary the IRUS-UK service is designed to provide article-level usage statistics for Institutional Repositories. This gem was developed for use with a Hydra repository [http://projecthydra.org/(http://projecthydra.org/)], but it can be used with any other Rails based web application. }
+  spec.homepage    = "https://github.com/uohull/irus_analytics"
+  spec.license         = "APACHE2"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "openurl", "~> 0.5"
+  spec.add_dependency "resque", "~> 1.25"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/generators/irus_analytics_generator.rb

@@ -0,0 +1,31 @@
+class IrusAnalyticsGenerator < Rails::Generators::Base
+  
+  desc "Irus Analytics Generator"
+  def create_irus_analytics_initializer
+      initializer "irus_analytics.rb" do
+<<EOF
+  # Configuration of IrusAnalytics
+  env = Rails.env.to_s
+
+  IrusAnalytics.configuration.source_repository = case env
+  when "development"
+    "your-repository.org"
+  when "test"
+    "your-repository.org"
+  else
+    "your-repository.org"
+  end
+
+  IrusAnalytics.configuration.irus_server_address = case env
+  when "development"
+    nil
+  when "test"
+    nil
+  else
+    "irus_server_address"
+  end
+EOF
+
+      end
+  end
+end

data/lib/irus_analytics/controller/analytics_behaviour.rb

@@ -0,0 +1,89 @@
+require 'logger'
+require 'resque'
+
+module IrusAnalytics
+  module Controller
+    module AnalyticsBehaviour 
+      def send_analytics
+        logger = Logger.new(STDOUT) if logger.nil? 
+        # Retrieve required params from the request
+        if request.nil?
+           logger.warn("IrusAnalytics::Controller::AnalyticsBehaviour.send_analytics exited: Request object is nil.")
+        else
+          # Should we filter this request...
+          unless filter_request?(request)
+            # Get Request data
+            client_ip = request.remote_ip if request.respond_to?(:remote_ip)
+            user_agent = request.user_agent if request.respond_to?(:user_agent)
+            file_url = request.url if request.respond_to?(:url)
+            referer = request.referer if request.respond_to?(:referer)
+
+             # Defined locally
+            datetime = datetime_stamp
+            source_repository = source_repository_name
+
+            # These following should defined in the controller class including this module
+            identifier = self.item_identifier if self.respond_to?(:item_identifier)
+
+            analytics_params = { date_stamp: datetime, client_ip_address: client_ip, user_agent: user_agent, item_oai_identifier: identifier, file_url: file_url, 
+                                             http_referer: referer,  source_repository: source_repository }
+
+            if irus_server_address.nil? 
+              # In development and test Rails environment without irus_server_address we log in debug  
+              if rails_environment == "development" || rails_environment == "test"
+                logger.debug("IrusAnalytics::ControllerBehaviour.send_irus_analytics params extracted #{analytics_params}")
+              else
+                logger.error("IrusAnalytics::Controller::AnalyticsBehaviour.send_analytics exited: Irus Server address is not set.")
+              end
+
+            else
+              begin
+                Resque.enqueue(IrusClient, irus_server_address, analytics_params)
+              rescue Exception => e
+                logger.error("IrusAnalytics::Controller::AnalyticsBehaviour.send_analytics error: Problem enquing the analytics with Resque. Error: #{e}")
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+
+      # Returns UTC iso8601 version of Datetime
+      def datetime_stamp
+        Time.now.utc.iso8601
+      end
+
+      def source_repository_name
+        IrusAnalytics.configuration.source_repository
+      end
+
+      def irus_server_address
+        IrusAnalytics.configuration.irus_server_address
+      end
+
+      def filter_request?(request)
+        filter_request = false 
+        # If we can't determine the request.user_agent we should filter it...
+        if request.respond_to?(:user_agent)
+          filter_request = !request.headers['HTTP_RANGE'].nil?  || robot_user_agent?(request.user_agent) 
+        else
+          filter_request = true
+        end
+        filter_request
+      end
+
+      def robot_user_agent?(user_agent)
+        IrusAnalytics::UserAgentFilter.instance.filter_user_agent?(user_agent)
+      end
+
+      def rails_environment
+        unless Rails.nil?
+          return Rails.env.to_s 
+        end
+      end
+
+    end
+  end
+end

data/lib/irus_analytics/irus_analytics_service.rb

@@ -0,0 +1,54 @@
+require 'openurl'
+
+module IrusAnalytics
+  class IrusAnalyticsService
+     attr_accessor :irus_server_address
+
+     def initialize(irus_server_address)
+      @irus_server_address = irus_server_address
+      @missing_params = []
+    end
+
+     def send_analytics(params = {})
+      if @irus_server_address.to_s.empty? 
+        raise ArgumentError, "Cannot send analytics: Missing Irus server address"
+      end
+
+      default_params = {date_stamp: "", client_ip_address: "",  user_agent: "", item_oai_identifier: "", file_url: "", http_referer: "", source_repository: ""}
+      params = default_params.merge(params)
+
+      if missing_mandatory_params?(params)
+        raise ArgumentError, "Missing the following required params: #{@missing_params}"
+      end
+
+     tracker_context_object_builder = IrusAnalytics::TrackerContextObjectBuilder.new
+
+      tracker_context_object_builder.set_event_datestamp(params[:date_stamp])
+      tracker_context_object_builder.set_client_ip_address(params[:client_ip_address])
+      tracker_context_object_builder.set_user_agent(params[:user_agent])
+      tracker_context_object_builder.set_oai_identifier(params[:item_oai_identifier])
+      tracker_context_object_builder.set_file_url(params[:file_url])
+      tracker_context_object_builder.set_http_referer(params[:http_referer])
+      tracker_context_object_builder.set_source_repository(params[:source_repository])
+
+      transport = openurl_link_resolver(tracker_context_object_builder.context_object)
+      transport.get 
+
+      if transport.code != "200"
+        raise "Unexpected response from IRUS server"
+      end
+
+     end
+
+     # At present, all the params, are mandatory...
+     def missing_mandatory_params?(params)
+       params.each_pair { |key,value| @missing_fields << key if value.to_s.empty?  }
+       return !@missing_params.empty? 
+     end
+
+     def  openurl_link_resolver(context_object)
+       OpenURL::Transport.new(@irus_server_address, context_object)
+     end
+
+  end 
+end

data/lib/irus_analytics/irus_client.rb

@@ -0,0 +1,22 @@
+module IrusAnalytics
+  class IrusClient
+    @queue = :irus_analytics
+
+    def self.perform(irus_server_address, analytics_params)
+      service = IrusAnalytics::IrusAnalyticsService.new(irus_server_address)
+      service.send_analytics(symbolize_keys(analytics_params))     
+    end
+
+    def self.symbolize_keys(hash)
+      new={}
+      hash.map do |key,value|
+          if value.is_a?(Hash)
+            value = symbolize_keys(value) 
+          end
+          new[key.to_sym]=value
+      end        
+      return new
+    end 
+
+  end
+end

data/lib/irus_analytics/rail_tie.rb

@@ -0,0 +1,13 @@
+require "rails"
+
+# Used to push rake tasks up to app using gem
+module IrusAnalytics
+  class Railtie < Rails::Railtie
+    railtie_name :irus_analytics
+
+    rake_tasks do
+      load "tasks/resque.rake"
+    end
+
+  end
+end

data/lib/irus_analytics/tracker_context_object_builder.rb

@@ -0,0 +1,39 @@
+require "openurl"
+
+module IrusAnalytics
+  class TrackerContextObjectBuilder
+    attr_accessor :context_object
+    def initialize
+      @context_object = OpenURL::ContextObject.new
+    end
+
+    def set_event_datestamp(datetime)
+      @context_object.admin.merge!("url_tim"=>{"label"=>"Usage event datestamp", "value"=>datetime})
+    end
+    
+    def set_client_ip_address(ip_address)
+      @context_object.admin.merge!("req_id"=>{"label"=>"Client IP address", "value"=>"urn:ip:#{ip_address}"})
+    end
+
+    def set_user_agent(user_agent)
+      @context_object.admin.merge!("req_dat"=>{"label"=>"UserAgent", "value"=>user_agent})
+    end
+
+    def set_oai_identifier(identifier)
+       @context_object.referent.set_metadata("artnum", identifier)
+    end
+
+    def set_file_url(url)
+      @context_object.admin.merge!("svc_dat"=>{"label"=>"FileURL", "value"=>url})
+    end
+
+    def set_http_referer(referer)
+      @context_object.admin.merge!("rfr_dat"=>{"label"=>"HTTP referer", "value"=>referer})
+    end
+
+    def set_source_repository(source_repository)
+      @context_object.admin.merge!("rfr_id"=>{"label"=>"Source repository", "value"=>source_repository})
+    end
+
+  end
+end

data/lib/irus_analytics/user_agent_filter.rb

@@ -0,0 +1,36 @@
+require 'irus_analytics'
+require 'singleton'
+
+module IrusAnalytics
+  class UserAgentFilter
+    include Singleton
+
+    # Singleton module defines us a instance class method and makes this private...
+    def initialize
+      set_robot_agents
+    end
+
+    def filter_user_agent?(user_agent)
+      @robot_agents.each do |robot_regexp|
+        return true unless user_agent.match(robot_regexp).nil? 
+      end
+      return false
+    end
+
+    def set_robot_agents
+      @robot_agents = get_robots_from_config
+    end
+  
+    private
+
+    def get_robots_from_config
+      begin 
+        agent_list = File.open("#{IrusAnalytics.config}/counter_robot_list.txt", "r") { |config| config.readlines.collect{|line| line.chomp }}
+      rescue Exception => ex
+          # Deal with configuration read error
+          agent_list = []
+      end
+    end
+
+  end
+end

data/lib/irus_analytics/version.rb

@@ -0,0 +1,3 @@
+module IrusAnalytics
+  VERSION = "0.0.1"
+end

data/lib/irus_analytics.rb

@@ -0,0 +1,46 @@
+require "irus_analytics/version"
+require "irus_analytics/controller/analytics_behaviour"
+require "irus_analytics/irus_analytics_service"
+require "irus_analytics/tracker_context_object_builder"
+require "irus_analytics/user_agent_filter"
+require "irus_analytics/irus_client"
+require "irus_analytics/rail_tie" if defined?(Rails)
+require "resque/server"
+
+
+module IrusAnalytics
+  class << self
+    attr_writer :configuration 
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yeild(configuration)
+  end
+
+  def self.root
+    @root ||= File.expand_path(File.dirname(File.dirname(__FILE__)))
+  end
+
+  def self.config
+    File.join root, "config" 
+  end
+
+  class Configuration
+    attr_accessor :source_repository, :irus_server_address
+
+    def initialize
+      @source_repository = "locahost:3000"
+      @irus_server_address = "localhost:3000/irus"
+    end
+  end
+
+end
+

data/lib/tasks/resque.rake

@@ -0,0 +1,3 @@
+require 'resque/tasks'
+
+task 'resque:setup' => :environment

data/spec/lib/irus_analytics/controller/analytics_behaviour_spec.rb

@@ -0,0 +1,74 @@
+	require 'spec_helper'
+
+class TestClass
+  include IrusAnalytics::Controller::AnalyticsBehaviour
+  attr_accessor :request, :item_identifier
+end
+
+describe IrusAnalytics::Controller::AnalyticsBehaviour do
+
+  describe ".send_analytics" do
+    before(:each) do
+       @test_class = TestClass.new
+       @test_class.request  = double("request", :remote_ip => "127.0.0.1", :user_agent => "Test user agent",  url: "http://localhost:3000/test", referer: "http://localhost:3000", headers: { "HTTP_RANGE" => nil })
+       @test_class.item_identifier = "test:123"
+    end
+
+    it "will call the send_irus_analytics method with the correct params..." do
+       # We set the datetime stamp to ensure sync
+       date_time = "2014-06-09T16:56:48Z"
+       allow(@test_class).to receive(:datetime_stamp) .and_return(date_time)
+       allow(@test_class).to receive(:source_repository_name) .and_return("hydra.hull.ac.uk")
+       allow(@test_class).to receive(:irus_server_address) .and_return("irus-server-address.org")
+       allow(@test_class).to receive(:rails_environment) .and_return("production")
+       params = { date_stamp: date_time, client_ip_address: "127.0.0.1", user_agent: "Test user agent",item_oai_identifier: "test:123", 
+                  file_url: "http://localhost:3000/test", http_referer: "http://localhost:3000",  source_repository: "hydra.hull.ac.uk" }
+
+       allow(Resque).to receive(:enqueue) .and_return(nil)
+       # Should NOT filter this request
+       expect(@test_class).to receive(:filter_request?).and_return(false)
+       expect(Resque).to receive(:enqueue).with(IrusAnalytics::IrusClient, "irus-server-address.org", params )
+
+       @test_class.send_analytics       
+    end
+
+    it "will not call the send_irus_analytics method when there is a filter user-agent.." do
+       # Add a well known robot... 
+       @test_class.request  = double("request", :remote_ip => "127.0.0.1", :user_agent => "Microsoft URL Control - 6.00.8862",  url: "http://localhost:3000/test", referer: "http://localhost:3000", headers: { "HTTP_RANGE" => nil })
+       # We set the datetime stamp to ensure sync
+       date_time = "2014-06-09T16:56:48Z"
+       allow(@test_class).to receive(:datetime_stamp) .and_return(date_time)
+       allow(@test_class).to receive(:source_repository_name) .and_return("hydra.hull.ac.uk")
+       allow(@test_class).to receive(:irus_server_address) .and_return("irus-server-address.org")
+       allow(@test_class).to receive(:rails_environment) .and_return("production")
+       params = { date_stamp: date_time, client_ip_address: "127.0.0.1", user_agent: "Microsoft URL Control - 6.00.8862" ,item_oai_identifier: "test:123", 
+                  file_url: "http://localhost:3000/test", http_referer: "http://localhost:3000",  source_repository: "hydra.hull.ac.uk" }
+
+       allow(Resque).to receive(:enqueue) .and_return(nil)
+       # Should filter this request
+       expect(Resque).to_not receive(:enqueue).with(IrusAnalytics::IrusClient, "irus-server-address.org", params )
+       @test_class.send_analytics       
+    end
+
+
+    it "will not call the send_irus_analytics method when the request is expecting a chunk of data (HTTP_RANGE downloading data)." do
+       # Add a well known robot... 
+       @test_class.request  = double("request", :remote_ip => "127.0.0.1", :user_agent =>"Test user agent",  url: "http://localhost:3000/test", referer: "http://localhost:3000", headers: { "HTTP_RANGE" => "bytes=0-65535"})
+       # We set the datetime stamp to ensure sync
+       date_time = "2014-06-09T16:56:48Z"
+       allow(@test_class).to receive(:datetime_stamp) .and_return(date_time)
+       allow(@test_class).to receive(:source_repository_name) .and_return("hydra.hull.ac.uk")
+       allow(@test_class).to receive(:irus_server_address) .and_return("irus-server-address.org")
+       allow(@test_class).to receive(:rails_environment) .and_return("production")
+       params = { date_stamp: date_time, client_ip_address: "127.0.0.1", user_agent: "Microsoft URL Control - 6.00.8862" ,item_oai_identifier: "test:123", 
+                  file_url: "http://localhost:3000/test", http_referer: "http://localhost:3000",  source_repository: "hydra.hull.ac.uk" }
+
+       allow(Resque).to receive(:enqueue) .and_return(nil)
+       # Should filter this request
+       expect(Resque).to_not receive(:enqueue).with(IrusAnalytics::IrusClient, "irus-server-address.org", params )
+       @test_class.send_analytics       
+    end
+
+
+  end  
+end

data/spec/lib/irus_analytics/irus_analytics_service_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe IrusAnalytics::IrusAnalyticsService do 
+  let (:irus_analytics_service) { IrusAnalytics::IrusAnalyticsService.new("") }
+  let(:test_params) { { date_stamp: "2010-10-17T03:04:42Z", client_ip_address: "127.0.0.1", user_agent: "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405",
+                     item_oai_identifier: "hull:123", file_url: "https://hydra.hull.ac.uk/assets/hull:123/content", http_referer: "https://www.google.co.uk/search?q=hydra+hull%3A123&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a&channel=sb&gfe_rd=cr",
+                      source_repository: "hydra.hull.ac.uk"  } }
+
+  describe ".send_analytics" do
+
+    before (:each) do
+       # Create a double for the transport object that will return 200 OK status
+       transport = double("transport", :get => "", :code => "200")
+       allow(irus_analytics_service).to receive(:openurl_link_resolver) .and_return(transport)
+    end
+
+    it "will throw an exception if the irus_server_address object variable is not set" do
+      expect { irus_analytics_service.send_analytics(test_params) }.to raise_error
+    end
+
+    it "enables the required parameters to be set within a hash" do
+       irus_analytics_service.irus_server_address = "irus_address"
+       irus_analytics_service.send_analytics(test_params)
+    end
+
+    it "will throw an exception if any of the mandatory IRUS data is missing" do
+      expect { irus_analytics_service.send_analytics({}) }.to raise_error
+    end
+
+  end
+end

data/spec/lib/irus_analytics/irus_client_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+
+describe IrusAnalytics::IrusClient do
+  let(:test_params) { { date_stamp: "2010-10-17T03:04:42Z", client_ip_address: "127.0.0.1", user_agent: "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405",
+                   item_oai_identifier: "hull:123", file_url: "https://hydra.hull.ac.uk/assets/hull:123/content", http_referer: "https://www.google.co.uk/search?q=hydra+hull%3A123&ie=utf-8&oe=utf-8&aq=t&rls=org.mozilla:en-US:official&client=firefox-a&channel=sb&gfe_rd=cr",
+                    source_repository: "hydra.hull.ac.uk"  } }
+  describe ".perform" do
+    it "takes the irus_server_address and analytics_params and calls IrusAnalyticsService.send_irus_analytics method" do
+    # subject.class.perform("irus-server", test_params)
+    end
+  end
+  
+  # Required due to Resque returning stringyfield hash keys
+  describe ".symbolize_keys" do
+     it "takes a hash that uses string keys, and returns the hash with symbol keys" do
+       test_hash = { "key_1" => "Value 1", "key_2" => "Value 2", "key_3" => "Value 3"  }
+       new_hash = IrusAnalytics::IrusClient.symbolize_keys(test_hash)
+       expect(new_hash).to include(key_1: "Value 1", key_2: "Value 2", key_3: "Value 3")
+     end
+  end
+
+end

data/spec/lib/irus_analytics/tracker_context_object_builder_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe IrusAnalytics::TrackerContextObjectBuilder do
+  describe ".initialize" do
+    it "will initialize an empty OpenURL::ContextObject instance" do
+      expect(IrusAnalytics::TrackerContextObjectBuilder.new.context_object).to be_an_instance_of OpenURL::ContextObject
+    end
+  end
+
+  context "set methods" do
+    let(:builder) { IrusAnalytics::TrackerContextObjectBuilder.new }
+
+     describe "OpenURL version" do
+       it "will be defaulted to required version for IRUS" do
+        expect(builder.context_object.kev).to include("url_ver=Z39.88-2004")        
+       end
+     end
+
+    describe "set_event_datestamp" do
+      it "will set event datestamp as per IRUS specification" do
+        date_time = "2010-10-17T03:04:42Z"
+        builder.set_event_datestamp(date_time)
+        expect(builder.context_object.kev).to include("url_tim=2010-10-17T03%3A04%3A42Z")        # Html_encoded version of the string
+      end
+    end
+
+    describe "set_client_ip_address" do
+       it "will set client ip address as per IRUS specification" do
+         ip_address = "127.0.0.1"
+         builder.set_client_ip_address(ip_address)
+         expect(builder.context_object.kev).to include("req_id=urn%3Aip%3A127.0.0.1") 
+       end
+    end
+
+    describe "set_user_agent" do
+      it "will set the request UserAgent as per IRUS specification" do
+        agent = "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405"
+        builder.set_user_agent(agent)
+        expect(builder.context_object.kev).to include("req_dat=Mozilla%2F5.0+%28iPad%3B+U%3B+CPU+OS+3_2_1+like+Mac+OS+X%3B+en-us%29+AppleWebKit%2F531.21.10+%28KHTML%2C+like+Gecko%29+Mobile%2F7B405")
+      end
+    end
+
+    describe "set_oai_identifier" do
+      it "will set the item oai identifier as per IRUS specification" do
+        identifier = "oai:hull.ac.uk:hull:123"
+        builder.set_oai_identifier(identifier)
+        expect(builder.context_object.kev).to include("rft.artnum=oai%3Ahull.ac.uk%3Ahull%3A123")
+      end
+    end
+
+    describe "set_file_url" do
+      it "will set FileURL as per IRUS specification" do
+        url = "https://hydra.hull.ac.uk/assets/hull:123/content"
+        builder.set_file_url(url)
+        expect(builder.context_object.kev).to include("svc_dat=https%3A%2F%2Fhydra.hull.ac.uk%2Fassets%2Fhull%3A123%2Fcontent")
+      end
+    end
+
+    describe "set_http_referer" do
+      it "will set the HTTP referer as per IRUS specification" do
+        referer = "http://www.google.co.uk/url?sa=t&rct=j&q=http%20referer&source=web&cd=4&sqi=2&ved=0CEoQFjAD&url=http%3A%2F%2Fwww.whatismyreferer.com%2F&ei=zIBCU6fbEoOqhQf67YCwBg&usg=AFQjCNFt-KMqneTZfEb6OxjPZlD4ogiJcQ&sig2=wZJYkoWgNScNjgxRbRs29w&bvm=bv.64125504,d.ZWU"
+        builder.set_http_referer(referer)
+        expect(builder.context_object.kev).to include("rfr_dat=http%3A%2F%2Fwww.google.co.uk%2Furl%3Fsa%3Dt%26rct%3Dj%26q%3Dhttp%2520referer%26source%3Dweb%26cd%3D4%26sqi%3D2%26ved%3D0CEoQFjAD%26url%3Dhttp%253A%252F%252Fwww.whatismyreferer.com%252F%26ei%3DzIBCU6fbEoOqhQf67YCwBg%26usg%3DAFQjCNFt-KMqneTZfEb6OxjPZlD4ogiJcQ%26sig2%3DwZJYkoWgNScNjgxRbRs29w%26bvm%3Dbv.64125504%2Cd.ZWU")
+      end
+    end
+
+    describe "set_source_repository" do
+      it "will set the Source repository as per IRUS specification" do
+        src_repo = "hydra.hull.ac.uk"
+        builder.set_source_repository(src_repo)
+        expect(builder.context_object.kev).to include("rfr_id=hydra.hull.ac.uk")
+      end
+    end
+
+
+  end
+
+end

data/spec/lib/irus_analytics/user_agent_filter_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe IrusAnalytics::UserAgentFilter do
+
+  context "singleton" do
+    describe ".instance" do
+      it "should return the singleton instance of the RobotsFilter" do
+        expect(IrusAnalytics::UserAgentFilter.instance).to be_instance_of IrusAnalytics::UserAgentFilter
+      end
+    end
+
+    describe ".filter_user_agent" do
+       it "will return true when a user agent should be filtered" do
+         expect(IrusAnalytics::UserAgentFilter.instance.filter_user_agent?("appie")).to be true
+       end
+
+       it "will return false when a user agent is valid and should not be filtered" do
+        expect(IrusAnalytics::UserAgentFilter.instance.filter_user_agent?("Firefox 3.0")).to be false
+       end
+    end
+ 
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+require 'irus_analytics'
+
+# RSpec.configure do |c|
+#   c.mock_with :rspec
+# end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: irus_analytics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Simon Lamb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: openurl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.25'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+description: ! 'More information about IRUS-UK can be found at [http://www.irus.mimas.ac.uk/](http://www.irus.mimas.ac.uk/).  In
+  summary the IRUS-UK service is designed to provide article-level usage statistics
+  for Institutional Repositories. This gem was developed for use with a Hydra repository
+  [http://projecthydra.org/(http://projecthydra.org/)], but it can be used with any
+  other Rails based web application. '
+email:
+- s.lamb@hull.ac.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/counter_robot_list.txt
+- irus_analytics.gemspec
+- lib/generators/irus_analytics_generator.rb
+- lib/irus_analytics.rb
+- lib/irus_analytics/controller/analytics_behaviour.rb
+- lib/irus_analytics/irus_analytics_service.rb
+- lib/irus_analytics/irus_client.rb
+- lib/irus_analytics/rail_tie.rb
+- lib/irus_analytics/tracker_context_object_builder.rb
+- lib/irus_analytics/user_agent_filter.rb
+- lib/irus_analytics/version.rb
+- lib/tasks/resque.rake
+- spec/lib/irus_analytics/controller/analytics_behaviour_spec.rb
+- spec/lib/irus_analytics/irus_analytics_service_spec.rb
+- spec/lib/irus_analytics/irus_client_spec.rb
+- spec/lib/irus_analytics/tracker_context_object_builder_spec.rb
+- spec/lib/irus_analytics/user_agent_filter_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/uohull/irus_analytics
+licenses:
+- APACHE2
+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.2.2
+signing_key: 
+specification_version: 4
+summary: IrusAnalytics is a gem that provides a simple way to send analytics to the
+  IRUS-UK repository agggregation service.
+test_files:
+- spec/lib/irus_analytics/controller/analytics_behaviour_spec.rb
+- spec/lib/irus_analytics/irus_analytics_service_spec.rb
+- spec/lib/irus_analytics/irus_client_spec.rb
+- spec/lib/irus_analytics/tracker_context_object_builder_spec.rb
+- spec/lib/irus_analytics/user_agent_filter_spec.rb
+- spec/spec_helper.rb