url_job 0.0.1

data/.gitignore

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

data/Gemfile

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

data/NOTES

@@ -0,0 +1,3 @@
+0.1.0
+  - Ability to create jobs
+  - Url redirects / render (text)

data/README.rdoc

@@ -0,0 +1,83 @@
+= UrlJob
+
+Rails gem that provides an engine which allows for creating urls that execute jobs
+
+== Install
+
+  gem install url_job
+
+== Usage
+
+Lets assume you have an class like the following:
+
+  class Redirector < Struct.new(:redirect_to)
+    def initialize(redirect)
+      self.redirect_to = redirect
+    end
+
+    def perform(args={})
+      self    
+    end
+  end
+
+By creating a UrlJob using the following:
+  uj = UrlJob::Job.from_object(Redirector.new("http://frison.ca"))
+
+And visiting:
+  http://localhost:3000/uj/#{uj.token}
+
+The result will be deserializing the Redirector job, and calling it's perform method.
+The perform method should return an object that responds to either: 'redirect_to' or 'render', and the corresponding action will occur. The perform method will be passed in a dictionary with the following keys:
+  :ip_address => The ip address of the url visitor
+  :user_agent => The user agent of the url visitor
+  :referrer   => The referrer of the url visitor
+  :token      => The token used to visit the url.
+
+A more interesting example might be an object like:
+
+  class Tracker
+    def initialize
+    end
+
+    def perform(params={})
+      @url_job = UrlJob::Job.find_by_token(params[:token])
+      UrlTrack.create(:url_job => @url_job,
+                      :referrer => params[:referrer],
+                      :ip_address => params[:ip_address],
+                      :user_agent => params[:user_agent])
+
+      OpenStruct.new({:render => " "})
+    end
+  end
+
+This way you could do something like:
+  uj = UrlJob::Job.from_object(Tracker.new)
+
+And embed a image tag like:
+  <img src="http://localhost:3000/uj/#{uj.token}" height="1px" width="1px">
+
+Inside some emails to track some email opens
+
+== Licence
+
+Copyright (c) 2011 Timothy Frison
+ 
+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/Rakefile

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

data/app/controllers/url_job/url_job_controller.rb

@@ -0,0 +1,44 @@
+module UrlJob
+  class UrlJobController < ApplicationController
+    before_filter :set_token
+
+    def perform
+      method_parameters = {:token      => @token,
+                           :user_agent => request.env['HTTP_USER_AGENT'],
+                           :referrer   => request.referrer,
+                           :ip_address => request.env['REMOTE_ADDR']
+      }
+
+      delegator = UrlJob::Job.find_by_token(@token)
+
+      if delegator.nil? || delegator.limit_reached?
+        render_not_found
+        return
+      end
+
+
+      ac = delegator.payload_object.try(:perform, method_parameters)
+
+      if ac.respond_to?(:redirect_to) and ac.redirect_to
+        redirect_to ac.redirect_to
+        return
+      elsif ac.respond_to?(:render) and ac.render
+        render :text => ac.render
+        return
+      end
+
+      render_not_found
+    end
+
+
+    protected
+    def set_token
+      @token = params[:token]
+      render_not_found if !@token
+    end
+
+    def render_not_found
+      render :text => '404 Not Found', :status => :not_found
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do |map|
+   match '/uj/:token', :action => 'perform', :controller => "UrlJob/UrlJob"
+end

data/lib/url_job.rb

@@ -0,0 +1,6 @@
+module UrlJob
+  require 'url_job/engine' if defined?(Rails)
+
+  autoload :DeserializationError, 'url_job/deserialization_error'
+  autoload :Job, 'url_job/job'
+end

data/lib/url_job/deserialization_error.rb

@@ -0,0 +1,3 @@
+module UrlJob
+  class DeserializationError < StandardError; end
+end

data/lib/url_job/engine.rb

@@ -0,0 +1,7 @@
+require 'url_job'
+require 'rails'
+
+module UrlJob
+  class Engine < Rails::Engine
+  end
+end

data/lib/url_job/job.rb

@@ -0,0 +1,56 @@
+module UrlJob
+  require 'uniquify'
+
+  class Job < ActiveRecord::Base
+    set_table_name :url_jobs
+
+    uniquify :token do
+      SecureRandom.hex(40)
+    end
+
+
+
+    validates :handler, :presence => true
+
+    class << self
+      def from_object(object, &block)
+        unless object.respond_to?(:perform)
+          raise ArgumentError, 'Cannot create a UrlJob from an object that does not respond to perform'
+        end
+
+        create(:payload_object => object)
+      end
+    end
+
+    def limit_reached?
+      return false if no_limit?
+      action_count >= action_limit
+    end
+
+    def no_limit?
+      0 == action_limit
+    end
+
+    ParseObjectFromYaml = /\!ruby\/\w+\:([^\s]+)/
+    def name
+      @name ||= payload_object.respond_to?(:display_name) ?
+          payload_object.display_name :
+          payload_object.class.name
+    rescue DeserializationError
+      ParseObjectFromYaml.match(handler)[1]
+    end
+
+    def payload_object=(object)
+      @payload_object = object
+      self.handler = object.to_yaml
+    end
+
+    def payload_object
+      @payload_object ||= YAML.load(self.handler)
+    rescue TypeError, LoadError, NameError, ArgumentError => e
+      raise DeserializationError,
+            "UrlJob failed to load: #{e.message}. Handler: #{handler.inspect}"
+    end
+
+  end
+end

data/lib/url_job/version.rb

@@ -0,0 +1,3 @@
+module UrlJob
+  VERSION = "0.0.1".freeze
+end

data/url_job.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "url_job/version"
+
+Gem::Specification.new do |s|
+  s.name        = "url_job"
+  s.version     = UrlJob::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Timothy Frison"]
+  s.email       = ["tim@frison.ca"]
+  s.homepage    = "http://frison.ca/"
+  s.summary     = %q{A rails engine for creating urls that run jobs}
+  s.description = <<-EOF
+  Need to track if an email was opened? If a link was clicked? If a page was viewed?
+  Too lazy to setup cron (or is it impossible?)?
+
+  Easy -- Just create a url_job that when visited does things (like the above) for you.
+  EOF
+
+  s.rubyforge_project = "url_job"
+
+  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_dependency('uniquify', '>= 0.1.0')
+  s.add_dependency('rails', '>= 3.0.0')
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: url_job
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Timothy Frison
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uniquify
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+description: "  Need to track if an email was opened? If a link was clicked? If a page was viewed?\n  Too lazy to setup cron (or is it impossible?)?\n\n  Easy -- Just create a url_job that when visited does things (like the above) for you.\n"
+email: 
+- tim@frison.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- NOTES
+- README.rdoc
+- Rakefile
+- app/controllers/url_job/url_job_controller.rb
+- config/routes.rb
+- lib/url_job.rb
+- lib/url_job/deserialization_error.rb
+- lib/url_job/engine.rb
+- lib/url_job/job.rb
+- lib/url_job/version.rb
+- url_job.gemspec
+has_rdoc: true
+homepage: http://frison.ca/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: url_job
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: A rails engine for creating urls that run jobs
+test_files: []
+