romniture 0.0.1 → 0.0.3

data/README.markdown

@@ -0,0 +1,58 @@
+# romniture
+To be pronounced...RAWWWRROMNITURE
+
+## what is it
+romniture is a minimal Ruby wrapper to [Omniture's REST API](http://developer.omniture.com).  It follows a design policy similar to that of [sucker](https://rubygems.org/gems/sucker) built for Amazon's API.
+
+Omniture's API is closed, you have to be a paying customer in order to access the data.
+
+## installation
+    [sudo] gem install romniture
+
+## initialization and authentication
+romniture requires you supply the `username`, `shared_secret` and `environment` which you can access within the Company > Web Services section of the Admin Console.  The environment you'll use to connect to Omniture's API depends on which data center they're using to store your traffic data and will be one of:
+
+* 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/)
+
+Here's an example of initializing with a few configuration options.
+
+    client = ROmniture::Client.new(
+      username, 
+      shared_secret, 
+      :san_jose, 
+      :log => false,    # Optionally turn off logging if it ticks you off
+      :wait_time => 1   # Amount of seconds to wait in between pinging 
+                        # Omniture's servers to see if a report is done processing (BEWARE OF TOKENS!)
+      )
+    
+## usage
+There are only two core methods for the client which doesn't try to "over architect a spaghetti API":
+
+* `get_report` - used to...while get reports and
+* `request` - more generic used to make any kind of request
+
+For reference, I'd recommend keeping [Omniture's Developer Portal](http://developer.omniture.com) open as you code .  It's not the easiest to navigate but most of what you need is there.
+
+The response returned by either of these requests Ruby (parsed JSON).
+
+## examples
+    # Find all the company report suites
+    client.request('Company.GetReportSuites')
+    
+    # Get an overtime report
+    client.get_report "Report.QueueOvertime", {
+      "reportDescription" => {
+        "reportSuiteID" => "#{@config["report_suite_id"]}",
+        "dateFrom" => "2011-01-01",
+        "dateTo" => "2011-01-10",
+        "metrics" => [{"id" => "pageviews"}]
+        }
+      }
+
+## see also
+My other client library [comscore_ruby](https://github.com/msukmanowsky/comscore_ruby) for those of you looking to pull data from comscore as well.

data/lib/romniture/client.rb

@@ -13,10 +13,13 @@ module ROmniture
       :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
+    def initialize(username, shared_secret, environment, options={})
+      @username       = username
+      @shared_secret  = shared_secret
+      @environment    = environment.is_a?(Symbol) ? ENVIRONMENTS[environment] : environment.to_s
+
+      @wait_time      = options[:wait_time] ? options[:wait_time] : DEFAULT_REPORT_WAIT_TIME
+      @log            = options[:log] ? options[:log] : false
       HTTPI.log       = false
     end
         
@@ -67,7 +70,7 @@ module ROmniture
       log(Logger::INFO, "Created new nonce: #{@password}")
       
       request = HTTPI::Request.new
-      request.url = @base_uri + "?method=#{method}"
+      request.url = @environment + "?method=#{method}"
       request.headers = request_headers
       request.body = data.to_json
 
@@ -117,7 +120,7 @@ module ROmniture
           error = true
         end
         
-        sleep DEFAULT_REPORT_WAIT_TIME if !done && !error
+        sleep @wait_time if !done && !error
       end while !done && !error
       
       if error

data/lib/romniture/version.rb

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

data/test/client_test.rb

@@ -10,11 +10,12 @@ class ClientTest < Test::Unit::TestCase
     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"]}"
-    })
+    @client = ROmniture::Client.new(
+      @config["username"],
+      @config["shared_secret"],
+      @config["environment"],
+      :wait_time => @config["wait_time"]
+    )
   end
   
   def test_simple_request

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: romniture
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Mike Sukmanowsky
@@ -15,7 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-12 00:00:00 Z
+date: 2011-09-18 00:00:00 -04:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: httpi
@@ -57,13 +58,14 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- README
+- README.markdown
 - ROmniture.gemspec
 - Rakefile
 - lib/romniture.rb
 - lib/romniture/client.rb
 - lib/romniture/version.rb
 - test/client_test.rb
+has_rdoc: true
 homepage: http://github.com/msukmanowsky/ROmniture
 licenses: []
 
@@ -93,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: romniture
-rubygems_version: 1.8.4
+rubygems_version: 1.5.0
 signing_key: 
 specification_version: 3
 summary: Use Omniture's REST API with ease.

data/README

@@ -1,9 +0,0 @@
-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: