versionone_sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b929a84fe8986422cdc95404986d18e2a0eec9e5
+  data.tar.gz: fa773d457e79500251f754a7a317e7c26bf03c9e
+SHA512:
+  metadata.gz: 762acd0b035a50e2e1b8b080c91d00ebcf2d6033e6d7c6bdc9198a3f37b7772adebcf2ea01d65a79efebd0e4ad9257ed56fc064796f9e5463c8e09beb677dbfc
+  data.tar.gz: e419b27a5ef24b59672482fd1197ddb15f9ab307ffac0dab98298a00f64ee4eed71ad8bf61e544ca6c40bdaeebb52f7d62c245f839af3cbebce34892786d7416

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+CHANGELOG
+---------
+- **2014-03-16**: 0.0.1
+  - Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 John Wang
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+VersionOne SDK - A Ruby SDK for the VersionOne REST API
+=======================================================
+
+Synopsis
+--------
+
+This is a VersionOne SDK for Ruby that accesses the VersionOne REST API.
+
+VersionOne currently provides official SDKs for Java, .NET, Python and JavaScript, but not for Ruby and other languages. VersionOne describes the use case for SDKs as the following: "All access to VersionOne is provided by the API endpoints. The most common use is to manipulate data in VersionOne. Doing so with the rest-1.v1/Data endpoint requires manipulation of XML, which can be tedious. Therefore, there are a number of API wrappers that abstract the details of HTTP and VersionOne's XML serialization: SDK.Java, SDK.NET, SDK.Python, SDK.JavaScript."
+
+A primary goal of this project is to convert VersionOne REST API XML responses to JSON.
+
+Installing
+----------
+
+Download and install versionone_sdk with the following:
+
+    gem install versionone_sdk
+
+#Examples
+---------
+
+    require 'versionone_sdk'
+
+    dParams     =  {
+      :hostname => 'www1.v1host.com',
+      :instance => 'myinstance',
+      :username => 'myusername',
+      :password => 'mypassword',
+      :port     => 443,
+      :protocol => 'https'
+    }
+    
+    v1client = VersiononeSdk::Client.new(dParams)
+    
+    # Retrieve an array of JsonDoc::Document objects
+
+    assets   = oClient.getAssets('Scope')
+
+    assets.each do |asset|
+      assetHash = asset.asHash
+    end
+
+#Documentation
+--------------
+
+This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use:
+
+    $ gem install yard
+    $ yard server -g
+
+Notes
+-----
+
+1. 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
+
+  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-16**: 0.0.1
+  - Initial release
+
+#Links
+------
+
+VersionOne API Documentation
+
+http://community.versionone.com/Developers/Developer-Library/Documentation/API
+
+#Copyright and License
+----------------------
+
+Elastirad © 2014 by [John Wang](mailto:johncwang@gmail.com).
+
+Elastirad is licensed under the MIT license. Please see the LICENSE document for more information.
+
+Warranty
+--------
+
+This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rake'
+require 'rake/testtask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the library.'
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = false
+end
+
+desc 'Generate YARD documentation.'
+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

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/versionone_sdk/client.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+require 'versionone_sdk/parser_xml_assets'
+
+module VersiononeSdk
+  class Client
+    def initialize(dOptions={})
+      iPort      = iPort.to_i if iPort.is_a?(String)
+      @sProtocol = dOptions.has_key?(:protocol) && dOptions[:protocol] \
+                 ? dOptions[:protocol]    : 'https'
+      @sHostname = dOptions.has_key?(:hostname) && dOptions[:hostname] \
+                 ? dOptions[:hostname]    : 'localhost'
+      @iPort     = dOptions.has_key?(:port) && dOptions[:port] \
+                 ? dOptions[:port].to_i   : 443
+      sUsername  = dOptions.has_key?(:username) ? dOptions[:username] : ''
+      sPassword  = dOptions.has_key?(:password) ? dOptions[:password] : ''
+      @sInstance = dOptions.has_key?(:instance) ? dOptions[:instance] : ''
+      @sUrl      = buildUrl(@sProtocol,@sHostname,@iPort)
+      @oFaraday  = Faraday::Connection.new url: @sUrl
+      @oFaraday.basic_auth(sUsername, sPassword)
+    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
+    end
+
+    def getAssetsXml(sAssetType=nil,xIds=nil)
+      sUrl = self.getUrlForAssets(sAssetType)
+      oRes = @oFaraday.get sUrl
+      return oRes
+    end
+
+    def getUrlForAssets(sAssetType=nil)
+      aUrl = [ @sUrl, @sInstance, 'rest-1.v1/Data',sAssetType]
+      sUrl = aUrl.join('/')
+      return sUrl
+    end
+
+    private
+
+    def buildUrl(sProtocol='http',sHostname='localhost',iPort=80)
+      if sHostname.nil?
+        sHostname = 'localhost'
+      elsif sHostname.is_a?(String)
+        sHostname.strip!
+        if sHostname.length < 1
+          sHostname = 'localhost'
+        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)
+        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

data/lib/versionone_sdk/parser_xml_assets.rb

@@ -0,0 +1,79 @@
+require 'jsondoc'
+require 'nokogiri'
+
+module VersiononeSdk
+  class ParserXmlAssets
+    def initialize(dOptions={})
+      @sUrl = dOptions.has_key?(:url) ? dOptions[:url] : ''
+    end
+    def getDocsForAssetsXmlPath(sPath=nil)
+      if File.exists?(sPath)
+        return self.getDocsForAssetsXml(IO.read(sPath))
+      end
+      return []
+    end
+    def getDocsForAssetsXml(xAssets=nil)
+      oXml   = Nokogiri::XML::Document.parse(xAssets)
+      oBlock = oXml.xpath("//Assets/Asset")
+      aDocs  = []
+      oBlock.map do |oNodeAsset|
+        oJsondoc = self.getJsondocForXmlAssetNode( oNodeAsset )
+        unless oJsondoc.nil?
+          aDocs.push(oJsondoc)
+        end
+      end
+      return aDocs
+    end
+    def getJsondocForXmlAssetNode(oNodeAsset=nil)
+      if oNodeAsset.nil?
+        raise RuntimeError, 'E_NIL_NODE'
+      end
+      oJsondoc = JsonDoc::Document.new
+      oJsondoc.bIsStrict = false
+      if oNodeAsset.attribute('id')
+        sId = oNodeAsset.attribute('id').value
+        if sId =~ /^(.+):([0-9]+)$/
+          sObjectType = $1
+          iObjectId   = $2.to_i
+          oJsondoc.setProp(:__id__sObjectDomain,'Versionone')
+          oJsondoc.setProp(:__id__sObjectType,sObjectType)
+          oJsondoc.setProp(:__id__iObjectId,  iObjectId)
+        end
+      end
+      if oNodeAsset.attribute('href').value
+        sUrl = @sUrl \
+          ? @sUrl + oNodeAsset.attribute('href').value
+          : oNodeAsset.attribute('href').value
+        oJsondoc.setProp(:__id__sObjectUrl,sUrl)
+      end
+      oNodeAsset.children.each do |oNodeChild|
+        if oNodeChild.name == 'Attribute'
+          if oNodeChild.attribute('name')
+            yPropKey = oNodeChild.attribute('name').to_s.to_sym
+            sPropVal = oNodeChild.text
+            sPropVal = nil if sPropVal == ''
+            oJsondoc.setProp(yPropKey,sPropVal)
+          end
+        elsif oNodeChild.name == 'Relation'
+          yPropKey      = oNodeChild.attribute('name').to_s.to_sym
+          oNodeRelation = oNodeChild
+          oNodeRelation.children.each do |oNodeRelationChild|
+            if oNodeRelationChild.name == 'Asset'
+              if oNodeRelationChild.attribute('idref').value
+                oJsondoc.pushProp(yPropKey,oNodeRelationChild.attribute('idref').value)
+              end
+            else
+              raise RuntimeError, "E_UNKNOWN_RELATION_CHILD_NAME #{oNodeRelationChild.name}"
+            end
+          end
+          if oNodeRelation.children.count == 0
+            oJsondoc.setProp(yPropKey,[])
+          end
+        else
+          raise RuntimeError, "E_UNKNOWN_ASSET_NODE_NAME #{oNodeChild.name}"
+        end
+      end
+      return oJsondoc
+    end
+  end
+end

data/lib/versionone_sdk.rb

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

data/test/test_setup.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'versionone_sdk'
+
+class VersiononeSdkTest < Test::Unit::TestCase
+  def testSetup
+
+    oClient = VersiononeSdk::Client.new
+    oParser = VersiononeSdk::ParserXmlAssets.new
+
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: versionone_sdk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jsondoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby SDK for the VersionOne REST API
+email: john@johnwang.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/versionone_sdk.rb
+- lib/versionone_sdk/client.rb
+- lib/versionone_sdk/parser_xml_assets.rb
+- test/test_setup.rb
+homepage: http://johnwang.com/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: VersionOne SDK - A Ruby SDK for the VersionOne REST API
+test_files: []