grokify / versionone-sdk-ruby

lib/versionone_sdk/client.rb

require 'faraday'
require 'versionone_sdk/update'
require 'versionone_sdk/parser_xml_assets'

module VersiononeSdk
  class Client
    DEFAULT_PROTOCOL = 'https'
    DEFAULT_HOSTNAME = 'localhost'
    DEFAULT_PORT = 443

    attr_accessor :oFaraday
    attr_accessor :sInstance
    attr_accessor :dTypePrefix

    def initialize(opts = {})
      @sProtocol   = opts[:protocol] || DEFAULT_PROTOCOL
      @sHostname   = opts[:hostname] || DEFAULT_HOSTNAME
      @iPort       = opts.key?(:port) && opts[:port] \
                   ? opts[:port].to_i : DEFAULT_PORT
      sUsername    = opts[:username] || ''
      sPassword    = opts[:password] || ''
      # VersionOne provides a mechanism for generating an access token
      sAccessToken = opts[:access_token] || ''
      @sInstance   = opts[:instance] || ''
      @dTypePrefix = opts[:type_prefixes] || {'B' => 'Story', 'E' => 'Epic', 'D' => 'Defect'}
      @sUrl        = buildUrl(@sProtocol, @sHostname, @iPort)
      @oFaraday    = Faraday::Connection.new url: @sUrl
      @oFaraday.ssl.verify = opts[:ssl_verify].to_s.match(/false/i) \
                   ? false : true
      if sAccessToken.empty?
        @oFaraday.basic_auth(sUsername, sPassword)
      else
        # could also patch Faraday to have a method similar to basic_auth
        @oFaraday.headers['Authorization']  = "Bearer #{sAccessToken}"
      end
      @oUpdate     = VersiononeSdk::Update.new self
    end

    def getAsset(xAssetId1, xAssetId2 = nil)
      xAssetId1.strip!

      if xAssetId1 =~ /^([^:]+):([0-9]+)$/
        sAssetType = $1
        sAssetOid = $2.to_i
        return self.getAssetForTypeAndOid(sAssetType, sAssetOid)

      elsif xAssetId1 =~ /^([a-zA-Z])-[0-9]+$/
        sAssetTypeAbbr = $1.upcase
        sAssetType = @dTypePrefix.key?(sAssetTypeAbbr) \
          ? @dTypePrefix[ sAssetTypeAbbr ] : ''
        xAssetId1.upcase!
        return self.getAssetForTypeAndNumber(sAssetType, xAssetId1)

      elsif !xAssetId2.nil?
        if xAssetId2.is_a?(String) && xAssetId2 =~ /^[0-9]+$/
          xAssetId2 = xAssetId2.to_i
        end

        if xAssetId2.is_a?(Integer)

          if xAssetId1 =~ /^[a-zA-Z]$/
            xAssetId1.upcase!
            sAssetTypeAbbr = xAssetId1
            sAssetType = @dTypePrefix.key?(sAssetTypeAbbr) \
              ? @dTypePrefix[ sAssetTypeAbbr ] : ''
            sAssetNumber = xAssetId1 + '-' + xAssetId2.to_s
            sAssetNumber.upcase!
            return self.getAssetForTypeAndNumber(sAssetType, sAssetNumber)
          elsif xAssetId1 =~ /^[a-zA-Z].+$/
            return self.getAssetForTypeAndOid(xAssetId1, xAssetId2)
          end
        end
      end

      raise RuntimeError, "E_UNKNOWN_ASSET_ID [#{xAssetId1}][#{xAssetId2.to_s}]"
    end

This code seems to be duplicated in your project.

    def getAssetForTypeAndOid(sAssetType = nil, sAssetOid = nil)
      sUrl = self.getUrlForAssets( sAssetType, sAssetOid )
      oRes = @oFaraday.get sUrl
      oParser = VersiononeSdk::ParserXmlAssets.new({url: @sUrl})
      return oParser.getDocForAssetXml( oRes.body )
    end

This code seems to be duplicated in your project.

    def getAssetForTypeAndNumber(sAssetType = nil, sAssetNumber = nil)
      sUrl = self.getUrlForAssetTypeAndNumber( sAssetType, sAssetNumber )
      oRes = @oFaraday.get sUrl
      oParser = VersiononeSdk::ParserXmlAssets.new({url: @sUrl})
      aDocs = oParser.getDocsForAssetsXml( oRes.body )
      return aDocs[0]
    end

    def getAssets(sAssetType = nil, xIds = nil)
      oRes = self.getAssetsXml(sAssetType,xIds)
      oParser = VersiononeSdk::ParserXmlAssets.new({url: @sUrl})
      return oParser.getDocsForAssetsXml( oRes.body )
    end

This code seems to be duplicated in your project.

    def getAssetsXml(sAssetType = nil, xIds = nil)
      sUrl = self.getUrlForAssets(sAssetType)
      return @oFaraday.get sUrl
    end

    def getUrlForAssetTypeAndNumber(sAssetType = nil, sAssetNumber = nil)
      aUrl = [ @sUrl, @sInstance, 'rest-1.v1/Data',sAssetType + %Q!?where=Number="#{sAssetNumber}"!]
      return aUrl.join('/')
    end

    def getUrlForAssets(sAssetType = nil, sAssetOid = nil)
      aUrl = [@sUrl, @sInstance, 'rest-1.v1/Data',sAssetType]
      if sAssetOid.is_a?(Integer)
        aUrl.push sAssetOid
      elsif sAssetOid.kind_of?(String) && sAssetOid =~ /^[0-9]+$/
        aUrl.push sAssetOid
      end
      return aUrl.join('/')
    end

    def updateAsset(sAssetType=nil,sAssetOid=nil,sName=nil,xxValues=nil,yTagType=nil)
      return @oUpdate.updateAsset(sAssetType, sAssetOid, sName, xxValues, yTagType)
    end

    private

    def buildUrl(sProtocol = DEFAULT_PROTOCOL, sHostname = DEFAULT_HOSTNAME, iPort = DEFAULT_PORT)
      if sHostname.nil?
        sHostname = 'localhost'
      elsif sHostname.is_a?(String)

This code seems to be duplicated in your project.

        sHostname.strip!
        if sHostname.length < 1
          sHostname = 'localhost'

This code seems to be duplicated in your project.

        end
      else
        raise ArgumentError, 'E_HOSTNAME_IS_NOT_A_STRING'
      end
      if iPort.nil?
        iPort = 80
      elsif iPort.is_a?(String) && iPort =~ /^[0-9]+$/
        iPort = iPort.to_i
      elsif ! iPort.kind_of?(Integer)

This code seems to be duplicated in your project.

        raise ArgumentError, 'E_PORT_IS_NOT_AN_INTEGER'
      end
      sBaseUrl = "#{sProtocol}://#{sHostname}"
      sBaseUrl.sub!(/\/+\s*$/,'')
      sBaseUrl += ':' + iPort.to_s if iPort != 80
      return sBaseUrl
    end
  end
end