ezproxy 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README

@@ -0,0 +1,30 @@
+# EZproxy
+
+This is a general purpose gem for working with OCLC's EZproxy
+
+## Supported File Formats
+
+The following formats are currently supported:
+
+* %h
+* %l
+* %u
+* %t
+* %r
+* %s
+* %b
+* %U
+* %{ezproxy-session}i
+
+## Examples
+
+    require 'ezproxy'
+
+    @log = EZproxy::Log.new(:format => '%h %{ezproxy-session}i %u %t "%r" %s %b')
+    @log.parse_file('ezp201104.log') do |line|
+      puts line.inspect
+    end
+
+Will output something like the following for each line
+
+    {"remote_host"=>"127.0.0.1", "ezproxy_session"=>"-", "username"=>"-", "happened_at"=>"19/Apr/2011:13:31:38 -0500", "http_request"=>"GET https://localhost:443/favicon.ico HTTP/1.1", "http_status"=>"404", "http_bytes"=>"0"}

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/ezproxy.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ezproxy/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ezproxy"
+  s.version     = EZproxy::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brice Stacey"]
+  s.email       = ["bricestacey@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{General use library for OCLC's EZproxy}
+  s.description = %q{General use library for OCLC's EZproxy}
+
+  s.rubyforge_project = "ezproxy"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency('rspec')
+end

data/lib/ezproxy.rb

@@ -0,0 +1,6 @@
+require 'ezproxy/log'
+require 'ezproxy/log/format'
+
+module EZproxy
+  # Your code goes here...
+end

data/lib/ezproxy/log.rb

@@ -0,0 +1,32 @@
+module EZproxy
+  class Log
+    attr_accessor :format
+
+    def initialize(attributes)
+      @format = EZproxy::Log::Format.new(attributes[:format])
+    end
+
+    # Load and parse `filename`
+    def parse_file(filename)
+      matcher = @format.to_regex
+      defined_attributes = @format.defined_attributes
+
+      File.open(filename) do |file|
+        file.each_line do |line|
+          m = line.match(matcher).to_a
+
+          r = {}
+          m[1..m.count].zip(defined_attributes).each do |match, attr|
+            r[attr[:label]] = match
+          end
+
+          if block_given?
+            yield r
+          else
+            r
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ezproxy/log/format.rb

@@ -0,0 +1,63 @@
+module EZproxy
+  class Log
+    class Format
+      attr_accessor :format
+
+      # Array containing each log format
+      # An attribute must contain a :token, :regexp, and :label.
+      # Optional keys include :post
+      ATTRIBUTES = [
+        {:token => '%h',
+         :regexp => /([0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3})/,
+         :label => 'remote_host'},
+        {:token => '%l',
+         :regexp => /(-)/,
+         :label  => nil},
+        {:token => '%u',
+         :regexp => /(.*)/,
+         :label  => 'username'},
+        {:token => '%t',
+         :regexp => /\[(.*)\]/,
+         :post   => Proc.new {|x| x[11] = ' '},
+         :label  => 'happened_at'},
+        {:token => '%r',
+         :regexp => /(.*)/,
+         :label  => 'http_request'},
+        {:token => '%s',
+         :regexp => /(\d+)/,
+         :label  => 'http_status'},
+        {:token => '%b',
+         :regexp => /(\d+)/,
+         :label  => 'http_bytes'},
+        {:token => '%U',
+         :regexp => /([^ ]+)/,
+         :label  => 'http_url'},
+        {:token => '%{ezproxy-session}i',
+         :regexp => /(.*)/,
+         :label  => 'ezproxy_session'}
+      ]
+
+      def initialize(s)
+        @format = s
+      end
+
+      def to_regex
+        regex = @format.clone
+        ATTRIBUTES.each do |regexp|
+          regex.gsub!(regexp[:token], regexp[:regexp].source)
+        end
+
+        Regexp.compile(regex)
+      end
+
+      def defined_attributes
+        l = []
+        ATTRIBUTES.each do |attr|
+          l[@format.index(attr[:token])] = attr if @format.include? attr[:token]
+        end
+
+        l.compact
+      end
+    end
+  end
+end

data/lib/ezproxy/version.rb

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

data/spec/ezproxy/log/format_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe EZproxy::Log::Format do 
+  it "should have a format accessor" do
+    @format = EZproxy::Log::Format.new('%h %{ezproxy-session}i %u %t "%r" %s %b')
+    @format.format.should == '%h %{ezproxy-session}i %u %t "%r" %s %b'
+
+    @format.format = '%h %u %t "%r" %s %b'
+    @format.format.should == '%h %u %t "%r" %s %b'
+  end
+
+  it "should convert to a regular expression" do
+    @format = EZproxy::Log::Format.new('%h %{ezproxy-session}i %u %t "%r" %s %b')
+    @format.to_regex.class.should == Regexp
+  end
+
+  it "should properly identify which match is which attribute" do
+    @format = EZproxy::Log::Format.new('%h %{ezproxy-session}i %u %t "%r" %s %b')
+    defined_attributes = @format.defined_attributes
+
+    defined_attributes[0][:label].should == 'remote_host'
+    defined_attributes[1][:label].should == 'ezproxy_session'
+    defined_attributes[2][:label].should == 'username'
+    defined_attributes[3][:label].should == 'happened_at'
+    defined_attributes[4][:label].should == 'http_request'
+    defined_attributes[5][:label].should == 'http_status'
+    defined_attributes[6][:label].should == 'http_bytes'
+  end
+end

data/spec/ezproxy/log_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe EZproxy::Log do
+  it "should load a log from a file" do
+    @log = EZproxy::Log.new(:format => '%h %{ezproxy-session}i %u %t "%r" %s %b')
+
+    @log.parse_file('spec/ezproxy/test.log') do |line|
+      line['remote_host'].should == '127.0.0.1'
+      line['ezproxy_session'].should == 'itiFqehv7PMNRYl'
+      line['username'].should == 'brice'
+      line['happened_at'].should == '18/May/2009:12:55:27 -0500'
+      line['http_request'].should == 'GET http://localhost:80/connect?session=sitiFqehv7PMNRYl&url=http://localhost/admin HTTP/1.1'
+      line['http_status'].should == "302"
+      line['http_bytes'].should == "0"
+    end
+  end
+end

data/spec/ezproxy/test.log

@@ -0,0 +1 @@
+127.0.0.1 itiFqehv7PMNRYl brice [18/May/2009:12:55:27 -0500] "GET http://localhost:80/connect?session=sitiFqehv7PMNRYl&url=http://localhost/admin HTTP/1.1" 302 0

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'ezproxy'
+require 'rspec'
+
+Rspec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: ezproxy
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brice Stacey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-19 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: General use library for OCLC's EZproxy
+email: 
+- bricestacey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- ezproxy.gemspec
+- lib/ezproxy.rb
+- lib/ezproxy/log.rb
+- lib/ezproxy/log/format.rb
+- lib/ezproxy/version.rb
+- spec/ezproxy/log/format_spec.rb
+- spec/ezproxy/log_spec.rb
+- spec/ezproxy/test.log
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: ezproxy
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: General use library for OCLC's EZproxy
+test_files: 
+- spec/ezproxy/log/format_spec.rb
+- spec/ezproxy/log_spec.rb
+- spec/ezproxy/test.log
+- spec/spec_helper.rb