omniture_rails3 0.0.1

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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.textile

@@ -0,0 +1,3 @@
+h1. Omniture Rails 3
+
+This engine is meant to help app developers easily set Omniture sprops. It uses "Higml":https://github.com/flyingmachine/higml to configure custom variables based on controller, action, and whatever other params are present. It also allows you to provide a mapping between your custom variable names and their omniture name - i.e. you can refer to "prop34" as "search\_origin" in your code and in your configuration.

data/Rakefile

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OmnitureRails3'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/helpers/omniture_rails3/controller_helper.rb

@@ -0,0 +1,7 @@
+module OmnitureRails3
+  module ControllerHelper
+    def omniture_input
+      
+    end
+  end
+end

data/app/helpers/omniture_rails3/view_helper.rb

@@ -0,0 +1,55 @@
+module OmnitureRails3
+  module ViewHelper
+    def omniture_html
+      <<-EOS
+      <!-- SiteCatalyst code version: H.1. Copyright 1997-2005 Omniture, Inc. More info available at http://www.omniture.com -->
+      <script language="JavaScript"><!--
+        #{omniture_javascript}
+        //--></script>
+        <script language="JavaScript"><!--
+        if(navigator.appVersion.indexOf('MSIE')>=0)document.write(unescape('%3C')+'\!-'+'-')
+        //--></script><noscript><img
+        src="#{OmnitureRails3.config.noscript_img_src}"
+        height="1" width="1" border="0" alt="" /></noscript><!--/DO NOT REMOVE/-->
+        <!-- End SiteCatalyst code version: H.1. -->
+      EOS
+    end
+  
+    def omniture_javascript
+      <<-EOS
+      var s_account="#{OmnitureRails3.config.tracking_account}";
+      var s=s_gi(s_account);
+
+      $.extend(s, #{sprops_json})
+
+      /* WARNING: Changing the visitor namespace will cause drastic changes
+      to how your visitor data is collected.  Changes should only be made
+      when instructed to do so by your account manager.*/
+      s.visitorNamespace="#{OmnitureRails3.config.visitor_namespace}"
+
+      /************* DO NOT ALTER ANYTHING BELOW THIS LINE ! **************/
+      var s_code=s.t();if(s_code)document.write(s_code)
+      EOS
+    end
+  
+    def sprops_json
+      sprops = Higml.
+        values_for(omniture_input, OmnitureRails3::TREES[controller_name.to_sym], self, omniture_priority_map || {}).
+        delete_if{|k,v| !v}
+      
+      transform_sprops(sprops)
+      
+      sprops.inject({}){|return_value, value| return_value[value[0]] = h(value[1]); return_value }. #html escape
+        to_json.
+        gsub(/,\s*"/,",\n\"") #put each variable on a separate line
+    end
+    
+    def transform_sprops(sprops)
+      OmnitureRails3.config.prop_map.each do |internal_name, omniture_name|
+        sprops[omniture_name] = sprops[internal_name]
+        sprops.delete(internal_name)
+      end
+      sprops
+    end
+  end
+end

data/lib/omniture_rails3/action_controller_extension.rb

@@ -0,0 +1,20 @@
+module OmnitureRails3
+  module ActionControllerExtension
+    extend ActiveSupport::Concern
+    included do
+      attr_accessor :omniture_input, :omniture_priority_map
+      helper_attr :omniture_input, :omniture_priority_map
+      
+      before_filter :set_omniture_input
+    end
+    
+    module ClassMethods
+    end
+    
+    module InstanceMethods
+      def set_omniture_input
+        self.omniture_input = params
+      end
+    end
+  end
+end

data/lib/omniture_rails3/config.rb

@@ -0,0 +1,59 @@
+module OmnitureRails3
+  class Config
+    include Singleton
+    OPTIONS = %w{higml_directory prop_map tracking_account visitor_namespace noscript_img_src}
+    attr_accessor *OPTIONS.collect{|o|o.to_sym}
+    
+    def higml_directory
+      @higml_directory ||= File.join(Rails.root, "app", "omniture")
+    end
+    
+    def set(config)
+      case config
+      when Hash: set_with_hash(config)
+      when IO: set_with_io(config)
+      when String: set_with_string(config)
+      end
+      
+      Higml.config.set({
+        "global_pairs" => {
+          :visitor_namespace => visitor_namespace,
+          :tracking_account  => tracking_account,
+          :noscript_img_src  => noscript_img_src
+        },
+        "higml_directory" => self.higml_directory
+      })
+    end
+    
+    def set_with_hash(config)
+      OPTIONS.each do |option|
+        self.send("#{option}=", config[option]) if config[option]
+      end
+    end
+    
+    # String should be either a filename or YAML
+    def set_with_string(config)
+      if File.exists?(config)
+        set_with_yaml(File.read(config))
+      else
+        set_with_yaml(config)
+      end
+    end
+    
+    def set_with_io(config)
+      set_with_yaml(config)
+      config.close
+    end
+    
+    def set_with_yaml(config)
+      set_with_hash(YAML.load(config)[Rails.env])
+    end
+    
+    def to_hash
+      OPTIONS.inject({}){ |hash, option|
+        hash[option] = self.send(option)
+        hash
+      }
+    end
+  end
+end

data/lib/omniture_rails3/engine.rb

@@ -0,0 +1,18 @@
+module OmnitureRails3
+  class Engine < Rails::Engine
+    initializer 'omniture_rails_3.helper' do |app|
+      ActionView::Base.send :include, OmnitureRails3::ViewHelper
+      ActionController::Base.send :include, OmnitureRails3::ActionControllerExtension
+      
+      OmnitureRails3.config.set(File.join(Rails.root, "config", "omniture.yml"))
+      # Parse Higml trees and store them so we don't have to do this every request
+      
+      OmnitureRails3::TREES = Dir[File.join(OmnitureRails3.config.higml_directory, '*.higml')].inject({}) do |hash, filename|
+        puts filename
+        hash[File.basename(filename, ".higml").to_sym] = Higml::Parser.new(File.read(filename)).to_tree
+        hash
+      end
+      
+    end
+  end
+end

data/lib/omniture_rails3.rb

@@ -0,0 +1,12 @@
+require "higml"
+require "omniture_rails3/action_controller_extension"
+require "omniture_rails3/config"
+require "omniture_rails3/engine"
+
+module OmnitureRails3
+  class << self
+    def config
+      @config ||= OmnitureRails3::Config.instance
+    end
+  end
+end

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: omniture_rails3
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Daniel Higginbotham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: higml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+description: Insert OmnitureRails3 description.
+email: daniel@flyingmachinestudios.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- app/helpers/omniture_rails3/controller_helper.rb
+- app/helpers/omniture_rails3/view_helper.rb
+- lib/omniture_rails3/action_controller_extension.rb
+- lib/omniture_rails3/config.rb
+- lib/omniture_rails3/engine.rb
+- lib/omniture_rails3.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.textile
+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 
+      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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Insert OmnitureRails3 summary.
+test_files: []
+