romniture 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+test/config.yml
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_STORE

data/Gemfile

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

data/README

@@ -0,0 +1,9 @@
+TODO: Write an actual read me file...for now check out the stuff in test
+
+To run unit tests properly, add a config.yml in /test with this structure:
+
+omniture:
+  username:
+  shared_secret:
+  report_suite_id:
+  environment:

data/ROmniture.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "romniture/version"
+
+Gem::Specification.new do |s|
+  s.name              = "romniture"
+  s.version           = ROmniture::VERSION
+  s.authors           = ["Mike Sukmanowsky"]
+  s.email             = ["mike.sukmanowsky@gmail.com"]
+  s.homepage          = "http://github.com/msukmanowsky/ROmniture"
+  s.summary           = "Use Omniture's REST API with ease."
+  s.description       = "A library that allows access to Omniture's REST API libraries (developer.omniture.com)"
+
+  s.rubyforge_project = s.name
+
+  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_runtime_dependency("httpi")
+  s.add_runtime_dependency("json")  
+ 
+end

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+namespace :test do 
+  desc "Run all tests in /test"
+  task :all do
+    Dir["test/**/*_test.rb"].each do |test_path|
+      system "ruby #{test_path}"
+    end
+  end
+end

data/lib/romniture/client.rb

@@ -0,0 +1,137 @@
+module ROmniture
+  
+  class Client
+
+    DEFAULT_REPORT_WAIT_TIME = 5
+    
+    ENVIRONMENTS = {
+      :san_jose       => "https://api.omniture.com/admin/1.2/rest/",
+      :dallas         => "https://api2.omniture.com/admin/1.2/rest/",
+      :london         => "https://api3.omniture.com/admin/1.2/rest/",
+      :san_jose_beta  => "https://beta-api.omniture.com/admin/1.2/rest/",
+      :dallas_beta    => "https://beta-api2.omniture.com/admin/1.2/rest/",
+      :sandbox        => "https://api-sbx1.omniture.com/admin/1.2/rest/"
+    }    
+    
+    def initialize(options={})
+      @username       = options[:username]
+      @shared_secret  = options[:shared_secret]
+      @base_uri       = options[:environment].is_a?(Symbol) ? ENVIRONMENTS[options[:environment]] : options[:environment].to_s
+      HTTPI.log       = false
+    end
+        
+    def request(method, parameters = {})
+      response = send_request(method, parameters)
+      
+      JSON.parse(response.body)
+    end
+    
+    def get_report(method, report_description)      
+      response = send_request(method, report_description)
+      
+      json = JSON.parse response.body
+      if json["status"] == "queued"
+        log(Logger::INFO, "Report with ID (" + json["reportID"].to_s + ") queued.  Now fetching report...")
+        return get_queued_report json["reportID"]
+      else
+        log(Logger::ERROR, "Could not queue report.  Omniture returned with error:\n#{response.body}")
+        raise "Could not queue report.  Omniture returned with error:\n#{response.body}"
+      end
+    end
+    
+    attr_writer :log
+    
+    def log?
+      @log != false
+    end
+    
+    def logger
+      @logger ||= ::Logger.new(STDOUT)
+    end
+    
+    def log_level
+      @log_level ||= ::Logger::INFO
+    end
+    
+    def log(*args)
+      level = args.first.is_a?(Numeric) || args.first.is_a?(Symbol) ? args.shift : log_level
+      logger.log(level, args.join(" ")) if log?
+    end
+        
+    private
+    
+    def send_request(method, data)
+      log(Logger::INFO, "Requesting #{method}...")
+      generate_nonce
+      
+      log(Logger::INFO, "Created new nonce: #{@password}")
+      
+      request = HTTPI::Request.new
+      request.url = @base_uri + "?method=#{method}"
+      request.headers = request_headers
+      request.body = data.to_json
+
+      response = HTTPI.post(request)
+      
+      if response.code >= 400
+        log(:error, "Request failed and returned with response code: #{response.code}\n\n#{response.body}")
+        raise "Request failed and returned with response code: #{response.code}\n\n#{response.body}" 
+      end
+      
+      log(Logger::INFO, "Server responded with response code #{response.code}.")
+      
+      response
+    end
+    
+    def generate_nonce
+      @nonce          = Digest::MD5.new.hexdigest(rand().to_s)
+      @created        = Time.now.strftime("%Y-%m-%dT%H:%M:%SZ")
+      combined_string = @nonce + @created + @shared_secret
+      sha1_string     = Digest::SHA1.new.hexdigest(combined_string)
+      @password       = Base64.encode64(sha1_string).to_s.chomp("\n")
+    end    
+
+    def request_headers 
+      {
+        "X-WSSE" => "UsernameToken Username=\"#{@username}\", PasswordDigest=\"#{@password}\", Nonce=\"#{@nonce}\", Created=\"#{@created}\""
+      }
+    end
+    
+    def get_queued_report(report_id)
+      done = false
+      error = false
+      status = nil
+      start_time = Time.now
+      end_time = nil
+
+      begin
+        response = send_request("Report.GetStatus", {"reportID" => "#{report_id}"})
+        log(Logger::INFO, "Checking on status of report #{report_id}...")
+        
+        json = JSON.parse(response.body)
+        status = json["status"]
+        
+        if status == "done"
+          done = true
+        elsif status == "failed"
+          error = true
+        end
+        
+        sleep DEFAULT_REPORT_WAIT_TIME if !done && !error
+      end while !done && !error
+      
+      if error
+        log(:error, "Unable to get data for report #{report_id}.  Omniture returned a status of #{status}.")
+        raise "Unable to get data for report #{report_id}.  Omniture returned a status of #{status}."
+      end
+            
+      response = send_request("Report.GetReport", {"reportID" => "#{report_id}"})
+
+      end_time = Time.now
+      log(Logger::INFO, "Report with ID #{report_id} has finished processing in #{((end_time - start_time)*1000).to_i} ms")
+      
+      JSON.parse(response.body)
+    end
+  end
+
+end

data/lib/romniture/version.rb

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

data/lib/romniture.rb

@@ -0,0 +1,15 @@
+require "romniture/version"
+require "romniture/client"
+
+require "rubygems"
+
+require "logger"
+require "httpi"
+require "digest/md5"
+require "digest/sha1"
+require "base64"
+require "json"
+
+module ROmniture
+  
+end

data/test/client_test.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'test/unit'
+require 'yaml'
+
+require 'romniture'
+
+class ClientTest < Test::Unit::TestCase
+  
+  def setup
+    config = YAML::load(File.open("test/config.yml"))
+    @config = config["omniture"]
+    
+    @client = ROmniture::Client.new({
+      :username => "#{@config["username"]}",
+      :shared_secret => "#{@config["shared_secret"]}",
+      :environment => "#{@config["environment"]}"
+    })
+  end
+  
+  def test_simple_request
+    response = @client.request('Company.GetReportSuites')
+    
+    assert_instance_of Hash, response, "Returned object is not a hash."
+    assert(response.has_key?("report_suites"), "Returned hash does not contain any report suites.")
+  end
+  
+  def test_report_request
+    response = @client.get_report "Report.QueueOvertime", {
+      "reportDescription" => {
+        "reportSuiteID" => "#{@config["report_suite_id"]}",
+        "dateFrom" => "2011-01-01",
+        "dateTo" => "2011-01-10",
+        "metrics" => [{"id" => "pageviews"}]
+        }
+      }
+    
+    assert_instance_of Hash, response, "Returned object is not a hash."
+    assert(response["report"].has_key?("data"), "Returned hash has no data!")
+  end
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: romniture
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mike Sukmanowsky
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httpi
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A library that allows access to Omniture's REST API libraries (developer.omniture.com)
+email: 
+- mike.sukmanowsky@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- ROmniture.gemspec
+- Rakefile
+- lib/romniture.rb
+- lib/romniture/client.rb
+- lib/romniture/version.rb
+- test/client_test.rb
+homepage: http://github.com/msukmanowsky/ROmniture
+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: romniture
+rubygems_version: 1.8.4
+signing_key: 
+specification_version: 3
+summary: Use Omniture's REST API with ease.
+test_files: 
+- test/client_test.rb