alm-rest-api 0.0.2

data/.gitattributes

@@ -0,0 +1,22 @@
+# Auto detect text files and perform LF normalization
+* text=auto
+
+# Custom for Visual Studio
+*.cs     diff=csharp
+*.sln    merge=union
+*.csproj merge=union
+*.vbproj merge=union
+*.fsproj merge=union
+*.dbproj merge=union
+
+# Standard to msysgit
+*.doc	 diff=astextplain
+*.DOC	 diff=astextplain
+*.docx diff=astextplain
+*.DOCX diff=astextplain
+*.dot  diff=astextplain
+*.DOT  diff=astextplain
+*.pdf  diff=astextplain
+*.PDF	 diff=astextplain
+*.rtf	 diff=astextplain
+*.RTF	 diff=astextplain

data/.gitignore

@@ -0,0 +1,163 @@
+#################
+## Eclipse
+#################
+
+*.pydevproject
+.project
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.classpath
+.settings/
+.loadpath
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# CDT-specific
+.cproject
+
+# PDT-specific
+.buildpath
+
+
+#################
+## Visual Studio
+#################
+
+## Ignore Visual Studio temporary files, build results, and
+## files generated by popular Visual Studio add-ons.
+
+# User-specific files
+*.suo
+*.user
+*.sln.docstates
+
+# Build results
+[Dd]ebug/
+[Rr]elease/
+*_i.c
+*_p.c
+*.ilk
+*.meta
+*.obj
+*.pch
+*.pdb
+*.pgc
+*.pgd
+*.rsp
+*.sbr
+*.tlb
+*.tli
+*.tlh
+*.tmp
+*.vspscc
+.builds
+*.dotCover
+
+## TODO: If you have NuGet Package Restore enabled, uncomment this
+#packages/
+
+# Visual C++ cache files
+ipch/
+*.aps
+*.ncb
+*.opensdf
+*.sdf
+
+# Visual Studio profiler
+*.psess
+*.vsp
+
+# ReSharper is a .NET coding add-in
+_ReSharper*
+
+# Installshield output folder
+[Ee]xpress
+
+# DocProject is a documentation generator add-in
+DocProject/buildhelp/
+DocProject/Help/*.HxT
+DocProject/Help/*.HxC
+DocProject/Help/*.hhc
+DocProject/Help/*.hhk
+DocProject/Help/*.hhp
+DocProject/Help/Html2
+DocProject/Help/html
+
+# Click-Once directory
+publish
+
+# Others
+[Bb]in
+[Oo]bj
+sql
+TestResults
+*.Cache
+ClientBin
+stylecop.*
+~$*
+*.dbmdl
+Generated_Code #added for RIA/Silverlight projects
+
+# Backup & report files from converting an old project file to a newer
+# Visual Studio version. Backup files are not needed, because we have git ;-)
+_UpgradeReport_Files/
+Backup*/
+UpgradeLog*.XML
+
+
+
+############
+## Windows
+############
+
+# Windows image file caches
+Thumbs.db
+
+# Folder config file
+Desktop.ini
+
+
+#############
+## Python
+#############
+
+*.py[co]
+
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage
+.tox
+
+#Translations
+*.mo
+
+#Mr Developer
+.mr.developer.cfg
+
+# Mac crap
+.DS_Store

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/alm-rest-api.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name        = 'alm-rest-api'
+  s.version     = '0.0.2'
+  s.date        = '2012-12-14'
+  s.summary     = "ALM!"
+  s.description = "ALM REST API Integration"
+  s.authors     = ["Simon Zheng"]
+  s.email       = 'xiaomengzheng@gmail.com'
+  s.require_paths = ["lib"]
+  s.files = `git ls-files`.split("\n")
+  #s.files       = ["lib/alm-rest-api.rb"]
+  s.homepage    =
+    'http://rubygems.org/gems/alm-rest-api'
+end

data/lib/alm-rest-api.rb

@@ -0,0 +1,154 @@
+# alm-rest-api.rb
+
+module ALM
+
+  # Logging in to our system is standard http login (basic authentication),
+  # where one must store the returned cookies for further use.
+  def self.login(loginUrl, username, password)
+    response = RestConnector.instance.httpBasicAuth(loginUrl, username, password)
+
+    return response.statusCode == '200'
+  end
+
+  def self.logout()
+    # note the get operation logs us out by setting authentication cookies to:
+    # LWSSO_COOKIE_KEY="" via server response header Set-Cookie
+    logoutUrl = RestConnector.instance.buildUrl("qcbin/authentication-point/logout")
+    response = RestConnector.instance.httpGet(logoutUrl, nil, nil)
+
+    return response.statusCode == '200'
+  end
+
+  def self.isAuthenticated()
+    isAuthenticateUrl = RestConnector.instance.buildUrl("qcbin/rest/is-authenticated") 
+    response = RestConnector.instance.httpGet(isAuthenticateUrl, nil, nil)
+    responseCode = response.statusCode
+
+    # if already authenticated
+    # if not authenticated - get the address where to authenticate
+    # via WWW-Authenticate
+    if responseCode == "200"
+      ret = nil
+    elsif responseCode == "401"
+      authenticationHeader = response.responseHeaders["WWW-Authenticate"]
+      newUrl = authenticationHeader.split("=").at(1)
+      newUrl = newUrl.delete("\"")
+      newUrl = newUrl + "/authenticate"
+      ret = newUrl
+    end
+
+    return ret
+  end
+  
+  # convenience method to do user login
+  def self.isLoggedIn(username, password)
+    authenticationPoint = isAuthenticated();
+    if (authenticationPoint != nil)
+        return login(authenticationPoint, username, password)
+    end
+    return true
+  end
+  
+  # read all defects fields 
+  def self.getDefectFields(required = false)
+    defectFieldsUrl = RestConnector.instance.buildEntityCollectionUrl("customization/entities/defect/field")
+    queryString = nil
+    if required
+      queryString = "required=true"
+    end
+    requestHeaders = Hash.new
+    requestHeaders["Accept"] = "application/xml"
+    response = RestConnector.instance.httpGet(defectFieldsUrl, queryString, requestHeaders)
+    
+    defectFields = nil
+    if response.statusCode == '200'
+      defectFields = DefectFields::Fields.parse(response.toString())
+    end
+
+    return defectFields
+  end
+  
+  # read pre-defined defects fields values
+  def self.getValueLists(defectFields = nil)
+    # ALM 11.0 the url is "customization/list"
+    valueListsUrl = RestConnector.instance.buildEntityCollectionUrl("customization/list")
+    queryString = nil
+    if defectFields
+      defectFields.fields.each do |field|
+        if field.list_id
+          if queryString == nil
+            queryString = "id=" + field.list_id.to_s
+          else
+            queryString = queryString + "," + field.list_id.to_s
+          end
+        end
+      end
+    end
+
+    requestHeaders = Hash.new
+    requestHeaders["Accept"] = "application/xml"
+    response = RestConnector.instance.httpGet(valueListsUrl, queryString, requestHeaders)
+    
+    valueLists = nil
+    if response.statusCode == '200'
+      valueLists = ValueLists::Lists.parse(response.toString())
+    end
+
+    return valueLists
+  end
+  
+  # create new defect
+  def self.createDefect(defect)
+    defectsUrl = RestConnector.instance.buildEntityCollectionUrl("defect")
+    requestHeaders = Hash.new
+    requestHeaders["Content-Type"] = "application/xml"
+    requestHeaders["Accept"] = "application/xml"
+
+    response = RestConnector.instance.httpPost(defectsUrl, defect.to_xml, requestHeaders)
+    
+    defectId = nil
+    if response.statusCode == '201'
+      defectUrl = response.responseHeaders["Location"]
+      defectId = defectUrl.split('/').last
+    end
+
+    return defectId
+  end
+  
+  # delete a defect
+  def self.deleteDefect(defectId)
+    defectUrl = RestConnector.instance.buildDefectUrl(defectId)
+    requestHeaders = Hash.new
+    requestHeaders["Accept"] = "application/xml"
+
+    response = RestConnector.instance.httpDelete(defectUrl, requestHeaders)
+ 
+    return response.statusCode == '200'
+  end
+  
+  # attach a file
+  def self.attachWithMultipart(defectId, filePath)
+    attachmentUrl = RestConnector.instance.buildEntityCollectionUrl("attachment")
+    boundary = "AaB03x"
+    requestHeaders = Hash.new
+    requestHeaders["Content-Type"] = "multipart/form-data, boundary=#{boundary}"
+
+    #post_body = []
+    #post_body < < "--#{boundary}rn"
+    #post_body < < "Content-Disposition: form-data; name="datafile"; filename="#{File.basename(file)}"rn"
+    #post_body < < "Content-Type: text/plainrn"
+    #post_body < < "rn"
+    #post_body < < File.read(file)
+    #post_body < < "rn--#{boundary}--rn"    
+    
+    #Response response = RestConnector.instance.httpPost(attachmentUrl, post_body, requestHeaders)
+  end
+
+end
+
+require 'alm-rest-api/entity'
+require 'alm-rest-api/defect-fields'
+require 'alm-rest-api/value-lists'
+require 'alm-rest-api/constants'
+require 'alm-rest-api/response'
+require 'alm-rest-api/rest-connector'

data/lib/alm-rest-api/constants.rb

@@ -0,0 +1,12 @@
+# These constants are used throughout the code to set the server to work with.
+# To execute this code, change these settings to fit
+# those of your server.
+class ALM::Constants
+  HOST = "localhost"
+  PORT = "8080"
+  USERNAME = "sa"
+  PASSWORD = "C71a04t23"
+  DOMAIN = "DEFAULT"
+  PROJECT = "Simon"
+  VERSIONED = true
+end

data/lib/alm-rest-api/defect-fields.rb

@@ -0,0 +1,33 @@
+require 'happymapper'
+
+module DefectFields
+  
+  class Field
+    include HappyMapper
+  
+    tag 'Field'
+    attribute :physical_name, String, :tag => 'PhysicalName'
+    attribute :name, String, :tag => 'Name'
+    attribute :label, String, :tag => 'Label'
+    element :active, Boolean, :tag => 'Active'
+    element :editable, Boolean, :tag => 'Editable'
+    element :size, Integer, :tag => 'Size'
+    element :filterable, Boolean, :tag => 'Filterable'
+    element :groupable, Boolean, :tag => 'Groupable'
+    element :history, Boolean, :tag => 'History'
+    element :list_id, Integer, :tag => 'List-Id'
+    element :type, String, :tag => 'Type'
+    element :supports_multivalue, Boolean, :tag => 'SupportsMultivalue'
+    element :required, Boolean, :tag => 'Required'
+    element :system, Boolean, :tag => 'System'
+    element :verify, Boolean, :tag => 'Verify'
+    element :virtual, Boolean, :tag => 'Virtual'
+  end
+  
+  class Fields
+    include HappyMapper
+
+    tag 'Fields'    
+    has_many :fields, Field
+  end
+end

data/lib/alm-rest-api/entity.rb

@@ -0,0 +1,30 @@
+require 'happymapper'
+
+class Field
+  include HappyMapper
+
+  tag 'Field'
+  attribute :name, String, :tag => 'Name'
+  element :value, String, :tag => 'Value'
+end
+
+class Fields
+  include HappyMapper
+  
+  tag 'Fields'
+  has_many :fields, Field
+end
+
+class Entity
+  include HappyMapper
+  
+  def initialize(type)
+    @type = type
+    @fields = Fields.new
+    @fields.fields = Array.new  
+  end    
+    
+  tag 'Entity'
+  attribute :type, String, :tag => 'Type'
+  element :fields, Fields
+end

data/lib/alm-rest-api/response.rb

@@ -0,0 +1,11 @@
+class ALM::Response
+  attr_accessor :responseHeaders
+  attr_accessor :responseData
+  attr_accessor :failure
+  attr_accessor :statusCode
+  
+  def toString()
+    return responseData
+  end
+  
+end

data/lib/alm-rest-api/rest-connector.rb

@@ -0,0 +1,147 @@
+# rest-connector.rb
+
+require 'net/http'
+require 'uri'
+require 'stringio'
+require 'singleton'
+
+class ALM::RestConnector
+  include Singleton
+  
+  attr_accessor :cookies
+  attr_accessor :host
+  attr_accessor :port
+  attr_accessor :domain
+  attr_accessor :project
+
+  def init(cookies, host, port, domain, project)
+    @cookies = cookies
+    @host = host
+    @port = port
+    @domain = domain
+    @project = project
+  end
+	
+  def buildEntityCollectionUrl(entityType)
+    return buildUrl('qcbin/rest/domains/' + domain + '/projects/' + project + '/' + entityType + 's')
+  end
+
+  def buildDefectUrl(defectId)
+    return buildUrl('qcbin/rest/domains/' + domain + '/projects/' + project + '/defects/' + defectId)
+  end
+    
+  def buildUrl(path)
+    return "http://#{host}:#{port}/#{path}"
+  end
+    
+  def httpPut(url, data, headers)
+    return doHttp('PUT', url, nil, data, headers, cookies)
+  end
+    
+  def httpPost(url, data, headers)
+    return doHttp('POST', url, nil, data, headers, cookies)
+  end
+    
+  def httpDelete(url, headers)
+    return doHttp('DELETE', url, nil, nil, headers, cookies)
+  end
+    
+  def httpGet(url, queryString, headers)
+    return doHttp('GET', url, queryString, nil, headers, cookies)
+  end
+  
+  def httpBasicAuth(url, username, password)
+    headers = {"username" => username, "password" => password}
+    return doHttp('AUTH', url, nil, nil, headers, cookies)    
+  end
+
+  def getCookieString
+    s = StringIO.new
+    if (!cookies.empty?)
+      cookies.each{|key,value|
+        s << key << '=' << value << ';'
+      }
+    end
+  
+    return s.string
+  end
+      
+  private
+    
+  def doHttp(type, url, queryString, data, headers, cookies)
+    if (queryString != nil && !queryString.empty?)
+    	url.concat('?' + queryString)
+    end
+    	  
+    uri = URI.parse(url)
+    http = Net::HTTP.new(uri.host, uri.port)
+
+    case type
+    when "POST"
+      request = Net::HTTP::Post.new(uri.request_uri)
+    when "GET"
+      request = Net::HTTP::Get.new(uri.request_uri)
+    when "PUT"
+      request = Net::HTTP::Put.new(uri.request_uri)
+    when "DELETE"
+      request = Net::HTTP::Delete.new(uri.request_uri)
+    when "AUTH"
+      request = Net::HTTP::Get.new(uri.request_uri)
+      request.basic_auth(headers["username"], headers["password"])
+    end
+        
+    cookieString = getCookieString()
+    prepareHttpRequest(request, headers, data, cookieString)
+        
+    response = http.request(request)  
+        
+    res = retrieveHtmlResponse(response)
+    updateCookies(res)
+        
+    return res  	
+  end
+    
+  def prepareHttpRequest(request, headers, data, cookieString)
+    contentType = nil
+    if (cookieString != nil && !cookieString.empty?)
+       request["Cookie"] = cookieString
+    end
+        
+    if (headers != nil)
+      contentType = headers.delete("Content-Type")
+      headers.each{|key, value|
+          request[key] = value
+      }
+    end
+    
+    if (data != nil)
+      if (contentType != nil)
+        request["Content-Type"] = contentType
+        request.body = data 
+      end
+    end
+  end
+    
+  def retrieveHtmlResponse(response)
+    res = ALM::Response.new
+    res.statusCode = response.code
+    res.responseHeaders = response
+    res.responseData = response.body
+    
+    return res
+  end
+    
+  def updateCookies(response)
+    newCookies = response.responseHeaders.get_fields('Set-Cookie')
+    if (newCookies != nil)
+      newCookies.each{|cookie|
+        c1 = cookie.split(';')[0]
+        c2 = c1.split('=')
+        key = c2[0]
+        value = c2[1]
+        cookies[key] = value
+      }
+    end
+  end
+    
+end

data/lib/alm-rest-api/value-lists.rb

@@ -0,0 +1,43 @@
+require 'happymapper'
+
+module ValueLists
+  
+  class Item
+    include HappyMapper
+
+    tag 'Item'
+    attribute :value, String, :tag => 'value'
+  end
+  
+  class Items
+    include HappyMapper
+
+    tag 'Items'    
+    has_many :items, Item    
+  end
+  
+  class List
+    include HappyMapper
+    
+    tag 'List'    
+    element :name, String, :tag => 'Name'
+    element :id, Integer, :tag => 'Id'
+    has_one :items, Items
+  end
+  
+  class Lists
+    include HappyMapper
+
+    tag 'Lists'
+    has_many :lists, List    
+  end
+  
+  def self.getValuesById(id, valueLists)
+    valueLists.lists.each do |list|
+      if (list.id == id)
+        return list.items.items
+      end
+    end
+  end
+  
+end

data/test/test_alm_rest_api.rb

@@ -0,0 +1,118 @@
+require 'stringio'
+require 'test/unit'
+require 'alm-rest-api'
+
+class TestALMRestAPI < Test::Unit::TestCase
+
+  def setup
+    ALM::RestConnector.instance.init(Hash.new, 
+      ALM::Constants::HOST, 
+      ALM::Constants::PORT, 
+      ALM::Constants::DOMAIN, 
+      ALM::Constants::PROJECT)
+  end
+  
+  def test_AuthenticateLoginLogout
+    if false # change to true if you want run the test case
+    # Returns nil if authenticated. If not authenticated, returns
+    # a URL indicating where to login.
+    # We are not logged in, so call returns a URL
+    authenticationPoint = ALM.isAuthenticated()
+    assert_not_nil(authenticationPoint, "response from isAuthenticated means we're authenticated. that can't be.")
+    
+    # now we login to previously returned URL.
+    loginResponse = ALM.login(authenticationPoint, ALM::Constants::USERNAME, ALM::Constants::PASSWORD)
+    assert(loginResponse, "failed to login.")
+    assert((ALM::RestConnector.instance.getCookieString.include? "LWSSO_COOKIE_KEY"), "login did not cause creation of Light Weight Single Sign On(LWSSO) cookie.")
+    
+    # proof that we are indeed logged in
+    assert_nil(ALM.isAuthenticated(), "isAuthenticated returned not authenticated after login.")
+    
+    # and now we logout
+    ALM.logout()
+    
+    # And now we can see that we are indeed logged out
+    # because isAuthenticated once again returns a url, and not null.
+    assert_not_nil(ALM.isAuthenticated(), "isAuthenticated returned authenticated after logout.")  
+    end  
+  end
+  
+  def test_GetDefectFields
+    if false # change to true if you want run the test case
+    loginResponse = ALM.isLoggedIn(ALM::Constants::USERNAME, ALM::Constants::PASSWORD)
+    assert(loginResponse, "failed to login.")
+
+    defectFields = ALM.getDefectFields(true)
+    valueLists = ALM.getValueLists(defectFields)
+    if defectFields
+      defectFields.fields.each do |field|
+        puts "Name = #{field.name}"
+        puts "Label = #{field.label}"
+        puts "Size = #{field.size}"
+        puts "Type = #{field.type}"
+        puts "Required = #{field.required}"
+        if (field.list_id && valueLists)
+          items = ValueLists.getValuesById(field.list_id, valueLists)
+          items.each do |item|
+            puts "Value = #{item.value}"
+          end
+        end
+        puts "--------------------------"
+      end
+    
+      puts defectFields.to_xml
+      if valueLists
+        puts valueLists.to_xml 
+      end
+    end  
+    
+    ALM.logout()
+    end
+  end
+  
+  def test_CreateDeleteDefect
+    if true # change to true if you want run the test case
+    loginResponse = ALM.isLoggedIn(ALM::Constants::USERNAME, ALM::Constants::PASSWORD)
+    assert(loginResponse, "failed to login.")
+    
+    defect = Entity.new("defect")
+    
+    defectFields = ALM.getDefectFields(true)
+    valueLists = ALM.getValueLists(defectFields)
+    if defectFields
+      defectFields.fields.each do |field|
+        defectField = Field.new
+        defectField.name = field.name
+        type = field.type
+        case type
+        when "LookupList"
+          if valueLists
+            items = ValueLists.getValuesById(field.list_id, valueLists)
+            defectField.value = items.first.value
+          end
+        when "Date"
+          defectField.value = Time.now.strftime("%Y-%m-%d")
+        when "UsersList"
+          defectField.value = ALM::Constants::USERNAME
+        else
+          defectField.value = "0"
+        end
+        defect.fields.fields<<defectField
+      end    
+      
+      puts defect.to_xml
+      
+      defectId = ALM.createDefect(defect)
+      assert_not_nil(defectId, "fail to create defect.")
+
+      if defectId
+        deleteResponse = ALM.deleteDefect(defectId)
+        assert(deleteResponse, "failed to delete defect.")
+      end
+    end
+    
+    ALM.logout()
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: alm-rest-api
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Simon Zheng
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-12-14 00:00:00 Z
+dependencies: []
+
+description: ALM REST API Integration
+email: xiaomengzheng@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitattributes
+- .gitignore
+- Rakefile
+- alm-rest-api-0.0.1.gem
+- alm-rest-api.gemspec
+- lib/alm-rest-api.rb
+- lib/alm-rest-api/constants.rb
+- lib/alm-rest-api/defect-fields.rb
+- lib/alm-rest-api/entity.rb
+- lib/alm-rest-api/response.rb
+- lib/alm-rest-api/rest-connector.rb
+- lib/alm-rest-api/value-lists.rb
+- test/test_alm_rest_api.rb
+homepage: http://rubygems.org/gems/alm-rest-api
+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.8.10
+signing_key: 
+specification_version: 3
+summary: ALM!
+test_files: []
+