rally_rest_api 0.7.4 → 0.7.5

data/Manifest.txt

@@ -11,6 +11,7 @@ lib/rally_rest_api/rest_object.rb
 lib/rally_rest_api/typedef.rb
 lib/rally_rest_api/ruport.rb
 lib/rally_rest_api/version.rb
+lib/rally_rest_api/custom_http_header.rb
 Manifest.txt
 Rakefile
 README.txt

data/Rakefile

@@ -22,7 +22,7 @@ RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
 
 NAME = "rally_rest_api"
 REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (RallyRestVersion::VERSION::STRING + (REV ? ".#{REV}" : ""))
+VERS = ENV['VERSION'] || (RallyRestVersion::LIBRARY_VERSION::STRING + (REV ? ".#{REV}" : ""))
 CLEAN.include ['**/.*.sw?', '*.gem', '.config']
 RDOC_OPTS = ['--quiet', '--title', "rally_rest_api documentation",
     "--opname", "index.html",

data/lib/rally_rest_api/custom_http_header.rb

@@ -0,0 +1,22 @@
+class CustomHttpHeader
+  attr_accessor :name, :version, :vendor
+  attr_reader :library, :os, :platform
+
+  HTTP_HEADER_FIELDS = [:name, :vendor, :version, :library, :platform, :os]
+  HTTP_HEADER_PREFIX = 'X-RallyIntegration'
+
+  def initialize
+    @os = RUBY_PLATFORM
+    @platform = "Ruby #{RUBY_VERSION}"
+    @library = "RallyRestAPI version #{RallyRestVersion::LIBRARY_VERSION::STRING}"
+  end
+
+  def add_headers(req)
+    headers = {}
+    HTTP_HEADER_FIELDS.each do |field|
+      value = self.send(field)
+      next if value.nil?
+      req.add_field("#{HTTP_HEADER_PREFIX}#{field.to_s.capitalize}", value)
+    end
+  end
+end

data/lib/rally_rest_api/rally_rest.rb

@@ -18,15 +18,16 @@ class RallyRestAPI
   # new - Create an instance of RallyRestAPI. Each instance corresponds to one named user.
   #
   # options (as a Hash):
-  # * username  - The Rally username
-  # * password  - The password for the named user
-  # * base_url  - The base url of the system. Defaults to https://rally1.rallydev.com/slm
-  # * version   - The RallyWebservices Version. Defaults to 'current', which will always be the most
+  # * username     - The Rally username
+  # * password     - The password for the named user
+  # * base_url     - The base url of the system. Defaults to https://rally1.rallydev.com/slm
+  # * version      - The RallyWebservices Version. Defaults to 'current', which will always be the most
   #               recent version of the api. Pass the value as a String, "1.0", "1.01" for example.
-  # * logger    - a Logger to log to.
+  # * logger       - a Logger to log to.
+  # * http_headers - an instace of CustomHttpHeader that will send application information with the request
   #
   def initialize(options = {})
-    parse_options options
+    parse_options(options)
   end
 
   def parse_options(options)
@@ -35,12 +36,13 @@ class RallyRestAPI
     @base_url = options[:base_url] || "https://rally1.rallydev.com/slm"
     @version = options[:version] || "current"
     @logger = options[:logger]
+    @http_headers = options[:http_headers] || CustomHttpHeader.new
     @parse_collections_as_hash = options[:parse_collections_as_hash] || false
 
     if options[:builder]
       builder = options[:builder]
     else
-      builder = RestBuilder.new(@base_url, @username, @password, @version)
+      builder = RestBuilder.new(@base_url, @username, @password, @version, @http_headers)
     end
     builder.logger = @logger if @logger
     @builder = builder

data/lib/rally_rest_api/rest_builder.rb

@@ -6,11 +6,11 @@ require 'builder'
 
 class RestBuilder # :nodoc:
 
-  attr_reader :base_url, :username, :password
+  attr_reader :base_url, :username, :password, :http_headers
   attr_accessor :logger
 
-  def initialize(base_url, username, password, version = "current")
-    @base_url, @username, @password, @version = base_url, username, password, version
+  def initialize(base_url, username, password, version = "current", http_headers = CustomHttpHeader.new)
+    @base_url, @username, @password, @version, @http_headers = base_url, username, password, version, http_headers
   end
 
   def marshal_dump
@@ -79,6 +79,7 @@ class RestBuilder # :nodoc:
   end
 
   def send_request(url, req, username, password)
+    @http_headers.add_headers(req)
     req.basic_auth username, password
     req.content_type = 'text/xml'
     proxy = ENV['http_proxy'] ? URI.parse(ENV['http_proxy']) : OpenStruct.new

data/lib/rally_rest_api/version.rb

@@ -1,8 +1,8 @@
 module RallyRestVersion #:nodoc:
-  module VERSION #:nodoc:
+  module LIBRARY_VERSION #:nodoc:
     MAJOR = 0
     MINOR = 7
-    TINY  = 4
+    TINY  = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/custom_http_header_spec.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+describe "A CustomHttpHeader" do
+
+  before(:each) do
+    @custom_http_header = CustomHttpHeader.new
+    @sample_values = {
+      :library  => RallyRestVersion::LIBRARY_VERSION::STRING,
+      :platform => RUBY_VERSION,
+      :os       => RUBY_PLATFORM,
+      :name     => 'Guacamole',
+      :vendor   => "The Big Enchilda's Burrito Company",
+      :version  => '0.3.2'
+    }
+  end
+  
+  it "should set library, platform, and os automatically" do
+    @custom_http_header.library.should == @sample_values[:library]
+    @custom_http_header.platform.should == @sample_values[:platform]
+    @custom_http_header.os.should == @sample_values[:os]
+  end
+
+  it 'should allow name, version, and vendor to be set' do
+    [:name, :vendor, :version].each do |field, value|
+      @custom_http_header.send("#{field}=".to_sym, value)
+      @custom_http_header.send(field).should == value
+    end
+  end
+
+  it 'should set the HTTP headers appropriately' do
+    req = mock("HTTP Request")
+    [:name, :vendor, :version].each do |field|
+      @custom_http_header.send("#{field}=", @sample_values[field])
+    end
+
+    @sample_values.each do |header, value|
+      hdr = "#{CustomHttpHeader::HTTP_HEADER_PREFIX}#{header.to_s.capitalize}"
+      req.should_receive(:add_field).with(hdr, value)
+    end
+    @custom_http_header.add_headers(req)
+  end
+
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: rally_rest_api
 version: !ruby/object:Gem::Version 
-  version: 0.7.4
-date: 2007-10-17 00:00:00 -06:00
+  version: 0.7.5
+date: 2007-10-29 00:00:00 -06:00
 summary: A ruby-ized interface to Rally's REST webservices API
 require_paths: 
 - lib
@@ -42,6 +42,7 @@ files:
 - lib/rally_rest_api/typedef.rb
 - lib/rally_rest_api/ruport.rb
 - lib/rally_rest_api/version.rb
+- lib/rally_rest_api/custom_http_header.rb
 - Manifest.txt
 - Rakefile
 - README.txt
@@ -57,6 +58,7 @@ files:
 - test/rest_builder_spec.rb
 test_files: 
 - test/attribute_definition_spec.rb
+- test/custom_http_header_spec.rb
 - test/query_result_spec.rb
 - test/rest_builder_spec.rb
 - test/rest_object_spec.rb