versionone_sdk 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02fbf3cf28e3b313d11b05f641eb49e06beb8871
-  data.tar.gz: c8e6e63230e3fed52fb9c8f5d98dc15d928ff17e
+  metadata.gz: 593a1ecf5b4ea7e8c39f51451b592c5fa543a39e
+  data.tar.gz: d378134bbee3c8a49d8be66a85f3eca28799c53e
 SHA512:
-  metadata.gz: d3de9a4765a94782805327f4ebd5cd59a0163b653dee79d8bf645dbdc043115177aa522ef75451594939e86da3f3eff9b6ba1b637245422b875e6354dffa4ddc
-  data.tar.gz: 241f2a0644bcd85daac4e5390dc317fd6d8d561064e6b80edaab7077bfd9ab3971eb5703fa6613fc16120124a29c9da8c1f6e026f74e80819c68fe7ab40ed1e0
+  metadata.gz: 526a552e0dc3d7be35b2f81192b63391d2570d065b45b8c091add1a35409d9c6fc2e38b59093cce0f6ae232e146c4e76560602c5b16790605c5934bfce8949d0
+  data.tar.gz: d45d34cebf4da109cc92f5baff983b1984f157b14525af9dd3c12518510535e52da9528554a28bfc24f18e16a0f80351892695e6713ecedaddcc39891b032073

data/README.md

@@ -70,6 +70,13 @@ params = {
 }
 v1client = VersiononeSdk::Client.new params
 
+# Different asset types can be defined and passed in during instantiation
+params = {
+  ...
+  type_prefixes: { 'R' => 'Request', 'D' => 'Defect', 'B' => 'Story', 'E' => 'Epic' }
+}
+v1client = VersiononeSdk::Client.new params
+
 # Retrieve an array of VersiononeSdk::Asset objects
 assets   = v1client.getAssets('Scope')
 

data/lib/versionone_sdk.rb

@@ -1,6 +1,5 @@
-require 'versionone_sdk/version.rb'
-
 module VersiononeSdk
+  VERSION = '0.2.2'
   autoload :Asset,  'versionone_sdk/asset'
   autoload :Client, 'versionone_sdk/client'
   autoload :ParserXmlAssets, 'versionone_sdk/parser_xml_assets'

data/lib/versionone_sdk/client.rb

@@ -10,6 +10,7 @@ module VersiononeSdk
 
     attr_accessor :oFaraday
     attr_accessor :sInstance
+    attr_accessor :dTypePrefix
 
     def initialize(opts = {})
       @sProtocol   = opts[:protocol] || DEFAULT_PROTOCOL
@@ -21,7 +22,7 @@ module VersiononeSdk
       # VersionOne provides a mechanism for generating an access token
       sAccessToken = opts[:access_token] || ''
       @sInstance   = opts[:instance] || ''
-      @dTypePrefix = {'B' => 'Story', 'E' => 'Epic'}
+      @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) \
@@ -77,35 +78,32 @@ module VersiononeSdk
     def getAssetForTypeAndOid(sAssetType = nil, sAssetOid = nil)
       sUrl = self.getUrlForAssets( sAssetType, sAssetOid )
       oRes = @oFaraday.get sUrl
-      oParser = VersiononeSdk::ParserXmlAssets.new({:url => @sUrl})
-      aDoc = oParser.getDocForAssetXml( oRes.body )
+      oParser = VersiononeSdk::ParserXmlAssets.new({url: @sUrl})
+      return oParser.getDocForAssetXml( oRes.body )
     end
 
     def getAssetForTypeAndNumber(sAssetType = nil, sAssetNumber = nil)
       sUrl = self.getUrlForAssetTypeAndNumber( sAssetType, sAssetNumber )
       oRes = @oFaraday.get sUrl
-      oParser = VersiononeSdk::ParserXmlAssets.new({:url => @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})
-      aDocs = oParser.getDocsForAssetsXml( oRes.body )
-      return aDocs
+      oParser = VersiononeSdk::ParserXmlAssets.new({url: @sUrl})
+      return oParser.getDocsForAssetsXml( oRes.body )
     end
 
     def getAssetsXml(sAssetType = nil, xIds = nil)
       sUrl = self.getUrlForAssets(sAssetType)
-      oRes = @oFaraday.get sUrl
-      return oRes
+      return @oFaraday.get sUrl
     end
 
     def getUrlForAssetTypeAndNumber(sAssetType = nil, sAssetNumber = nil)
       aUrl = [ @sUrl, @sInstance, 'rest-1.v1/Data',sAssetType + %Q!?where=Number="#{sAssetNumber}"!]
-      sUrl = aUrl.join('/')
-      return sUrl
+      return aUrl.join('/')
     end
 
     def getUrlForAssets(sAssetType = nil, sAssetOid = nil)
@@ -115,8 +113,7 @@ module VersiononeSdk
       elsif sAssetOid.kind_of?(String) && sAssetOid =~ /^[0-9]+$/
         aUrl.push sAssetOid
       end
-      sUrl = aUrl.join('/')
-      return sUrl
+      return aUrl.join('/')
     end
 
     def updateAsset(sAssetType=nil,sAssetOid=nil,sName=nil,xxValues=nil,yTagType=nil)

data/lib/versionone_sdk/parser_xml_assets.rb

@@ -62,10 +62,9 @@ module VersiononeSdk
             xxPropVal = getAssetNodeChildPropVal( oNodeChild )
             oAsset.setProp(yPropKey,xxPropVal)
           end
+        elsif oNodeChild.name == 'Message' && oNodeChild.text == 'Not Found'
+          raise RuntimeError, "E_ASSET_NOT_FOUND #{oNodeAsset.attribute('href').value}"
         else
-          if oNodeChild.name == 'Message' && oNodeChild.text == 'Not Found'
-            raise RuntimeError, "E_ASSET_NOT_FOUND #{oNodeAsset.attribute('href').value}"
-          end
           raise RuntimeError, "E_UNKNOWN_ASSET_NODE_NAME #{oNodeChild.name}"
         end
       end

data/test/test_setup.rb

@@ -33,11 +33,17 @@ class VersiononeSdkTest < Test::Unit::TestCase
     oClient = VersiononeSdk::Client.new(protocol: 'http', user: 'user',
                 password: 'pass', port: 80, access_token: '', instance: 'Test')
     assert_equal 'http://localhost/Test/rest-1.v1/Data/', oClient.getUrlForAssets
-    assert_match /\ABasic /, oClient.oFaraday.headers['Authorization']
+    assert_match(/\ABasic /, oClient.oFaraday.headers['Authorization'])
 
     sAccessToken = 'some_string_generated_from_version_one'
     oClient = VersiononeSdk::Client.new(protocol: 'https', port: 443,
                 access_token: sAccessToken, instance: Test)
     assert_equal "Bearer #{sAccessToken}", oClient.oFaraday.headers['Authorization']
+
+    oClient = VersiononeSdk::Client.new(instance: 'Test')
+    assert_equal({'B' => 'Story', 'E' => 'Epic', 'D' => 'Defect'}, oClient.dTypePrefix)
+
+    oClient = VersiononeSdk::Client.new(instance: 'Test', type_prefixes: { 'T' => 'Test' })
+    assert_equal({ 'T' => 'Test'}, oClient.dTypePrefix)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: versionone_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2016-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -142,7 +142,6 @@ files:
 - lib/versionone_sdk/client.rb
 - lib/versionone_sdk/parser_xml_assets.rb
 - lib/versionone_sdk/update.rb
-- lib/versionone_sdk/version.rb
 - test/test_base.rb
 - test/test_parser_xml_assets.rb
 - test/test_setup.rb

data/lib/versionone_sdk/version.rb

@@ -1,3 +0,0 @@
-module VersiononeSdk
-  VERSION = '0.2.1'
-end