versionone_sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b929a84fe8986422cdc95404986d18e2a0eec9e5
-  data.tar.gz: fa773d457e79500251f754a7a317e7c26bf03c9e
+  metadata.gz: 1daac7c4e87ce3126bb13a34fb2f4a592f70d6de
+  data.tar.gz: 85d4ff86d26a6c8d4bdff3d9174ac51ead75ec7e
 SHA512:
-  metadata.gz: 762acd0b035a50e2e1b8b080c91d00ebcf2d6033e6d7c6bdc9198a3f37b7772adebcf2ea01d65a79efebd0e4ad9257ed56fc064796f9e5463c8e09beb677dbfc
-  data.tar.gz: e419b27a5ef24b59672482fd1197ddb15f9ab307ffac0dab98298a00f64ee4eed71ad8bf61e544ca6c40bdaeebb52f7d62c245f839af3cbebce34892786d7416
+  metadata.gz: 88a38a47a9ed0f1258ace70aa5d6da504e93fe86d22c3c8e5d912ae7de8067716dbe3c13c789515a4b06e03d9690ef3500d9cfe79cb5c48701ade8d711d917f5
+  data.tar.gz: 65cdf7a3fd33460abb4d62e055afd240739c19a4a49393ba94f10e76afd54827dde9c05cb79b6c52db0c9b179924a5694d1f11c69db7bc88a08d87a37600bff7

data/CHANGELOG.md

@@ -1,4 +1,6 @@
 CHANGELOG
 ---------
+- **2014-03-17**: 0.0.2
+  - Add VersiononeSdk::Asset object to support value inflation, starting with AssetState.Name
 - **2014-03-16**: 0.0.1
   - Initial release

data/README.md

@@ -33,9 +33,9 @@ Download and install versionone_sdk with the following:
     
     v1client = VersiononeSdk::Client.new(dParams)
     
-    # Retrieve an array of JsonDoc::Document objects
+    # Retrieve an array of VersiononeSdk::Asset objects
 
-    assets   = oClient.getAssets('Scope')
+    assets   = v1client.getAssets('Scope')
 
     assets.each do |asset|
       assetHash = asset.asHash
@@ -52,17 +52,27 @@ This gem is 100% documented with YARD, an exceptional documentation library. To
 Notes
 -----
 
-1. Nil/Null Values and Empty Strings
+1. Integer Values
+
+  Integer values for Order and AssetState are converted from strings to integers.
+
+2. Nil/Null Values and Empty Strings
 
   The VersionOne JavaScript API provides empty strings when no value is present. This SDK uses Ruby nil values and JSON null values for empty strings. The primary reason for this is to support easy indexing using Elasticsearch.
 
-2. Tracking Properties
+3. Inflation
+
+  Some values are inflated. Currently, AssetState is used to derive AssetState.Name as defined here: https://community.versionone.com/Developers/Developer-Library/Concepts/Asset_State
+
+4. Tracking Properties
 
   In addition to the standard VersionOne properties, this modules adds the following generic properties for tracking: :__id__sObjectDomain, :__id__sObjectType, :__id__iObjectId, :__id__sObjectUrl. The object domain is set to 'Versionone', while object type and object id correspond to VersionOne Asset types and ids. The URL is the full URL for the resource including protocol, host and port.
 
 #Change Log
 -----------
 
+- **2014-03-17**: 0.0.2
+  - Add VersiononeSdk::Asset object to support value inflation, starting with AssetState.Name
 - **2014-03-16**: 0.0.1
   - Initial release
 

data/Rakefile

@@ -16,4 +16,4 @@ task :gendoc do
   #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
     system "yardoc"
     system "yard stats --list-undoc"
-end
+end

data/lib/versionone_sdk.rb

@@ -1,4 +1,5 @@
 module VersiononeSdk
+  autoload :Asset, 'versionone_sdk/asset'
   autoload :Client, 'versionone_sdk/client'
   autoload :ParserXmlAssets, 'versionone_sdk/parser_xml_assets'
 end

data/lib/versionone_sdk/asset.rb

@@ -0,0 +1,61 @@
+require 'jsondoc'
+
+module VersiononeSdk
+
+  # VersiononeSdk::Asset class is a JsonDoc::Document subclass that includes
+  # the #inflateNames method to add AssetState.Name based on the VersionOne
+  # classifications avaiable at: https://community.versionone.com/Developers/Developer-Library/Concepts/Asset_State
+
+  class Asset < JsonDoc::Document
+    attr_accessor :dSchema
+    def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=false)
+      @dSchema        = dSchema || self.getDefaultSchema()
+      @bDefaultifyDoc = bDefaultifyDoc ? true : false
+      @bIsStrict      = bIsStrict      ? true : false
+      @dDocument      = self.getDefaultDocument()
+      self.loadInitialValues(dValues)
+    end
+
+    def getDefaultSchema()
+      dSchema =  {}
+      return dSchema
+    end
+
+    def inflate()
+      self.inflateNames
+      self.convertIntegers
+    end
+
+    def convertIntegers()
+      [:Order,:AssetState].each do |yKey|
+        xxVal = self.getProp(yKey)
+        if xxVal.is_a?(String) && xxVal =~ /^-?[0-9]+$/
+          xxVal = xxVal.to_i
+          self.setProp(yKey,xxVal)
+        end
+      end
+    end
+
+    def inflateNames()
+      dAssetState = {
+        0   => 'Future',
+        64  => 'Active',
+        128 => 'Closed',
+        200 => 'Template (Dead)',
+        208 => 'Broken Down (Dead)',
+        255 => 'Deleted (Dead)'
+      }
+      if @dDocument.has_key?(:AssetState)
+        sAssetState = @dDocument[:AssetState]
+        if sAssetState.is_a?(String) && sAssetState =~ /^[0-9]+$/
+          iAssetState = sAssetState.to_i
+          if dAssetState.has_key?(iAssetState)
+            sAssetStateName = dAssetState[iAssetState]
+            self.setProp(:'AssetState.Name',sAssetStateName)
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/versionone_sdk/parser_xml_assets.rb

@@ -1,5 +1,6 @@
 require 'jsondoc'
 require 'nokogiri'
+require 'versionone_sdk/asset'
 
 module VersiononeSdk
   class ParserXmlAssets
@@ -28,7 +29,7 @@ module VersiononeSdk
       if oNodeAsset.nil?
         raise RuntimeError, 'E_NIL_NODE'
       end
-      oJsondoc = JsonDoc::Document.new
+      oJsondoc = VersiononeSdk::Asset.new
       oJsondoc.bIsStrict = false
       if oNodeAsset.attribute('id')
         sId = oNodeAsset.attribute('id').value
@@ -73,6 +74,7 @@ module VersiononeSdk
           raise RuntimeError, "E_UNKNOWN_ASSET_NODE_NAME #{oNodeChild.name}"
         end
       end
+      oJsondoc.inflate
       return oJsondoc
     end
   end

data/test/test_setup.rb

@@ -4,8 +4,13 @@ require 'versionone_sdk'
 class VersiononeSdkTest < Test::Unit::TestCase
   def testSetup
 
+    oAsset  = VersiononeSdk::Asset.new
     oClient = VersiononeSdk::Client.new
     oParser = VersiononeSdk::ParserXmlAssets.new
 
+    assert_equal 'VersiononeSdk::Asset', oAsset.class.name
+    assert_equal 'VersiononeSdk::Client', oClient.class.name
+    assert_equal 'VersiononeSdk::ParserXmlAssets', oParser.class.name
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versionone_sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - John Wang
@@ -56,20 +56,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.0
 description: A Ruby SDK for the VersionOne REST API
 email: john@johnwang.com
 executables: []
@@ -82,6 +82,7 @@ files:
 - Rakefile
 - VERSION
 - lib/versionone_sdk.rb
+- lib/versionone_sdk/asset.rb
 - lib/versionone_sdk/client.rb
 - lib/versionone_sdk/parser_xml_assets.rb
 - test/test_setup.rb