versionone_sdk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84cb9b1e6cd4dae9bdb0677179d384f3aac83442
-  data.tar.gz: 9835fc512d709ab2243ba8b41898bc01a953b042
+  metadata.gz: 0c15907c8f53860b4e6e271b5df502d75482d8c0
+  data.tar.gz: c6a1c6c0e857d6201e1e4c485520c1215be6ae11
 SHA512:
-  metadata.gz: c72b5240ab7cceb342143ceb3dc6550d39b819cf7e51d724cda98cfa04f5bfef58deaeb85de1b098bc8ee103a11711b7d44a8f942559b6044e5f0dc855e6a46a
-  data.tar.gz: e1eee8d4139961462edff92f7fcb3de46ae4b7fb3c6ee8f9fa80d71d48f94a8036544bd0b215ccebfb6befb0293385a501a63f09183688fa1842441cb2b02cb2
+  metadata.gz: 9b326cd59f5114a1a25d68f1398701362c189e1a54ace9e3054ef6e4018c63d12a4f26a7a3c594b9c6f99e10ba7f818aa3d12909f1f7a74c1ef0ad0f678b6bdd
+  data.tar.gz: ec8125c609f378a31e5f8dd74a483507723ab5b42670ea038d4ef64dd9ac9d636c3bb7df74386e966b1c9fc1a6b6ec87731427e9978de98cb3ac7da7fdf0cfb3

data/Gemfile

@@ -0,0 +1,11 @@
+source ENV['GEM_SOURCE'] || "https://rubygems.org"
+
+gem 'coveralls'
+gem 'faraday', '~> 0.9.0'
+gem 'jsondoc', '~> 0.1.2'
+gem 'nokogiri'
+gem 'rake'
+gem 'simplecov'
+gem 'test-unit'
+
+# vim:ft=ruby

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2014-2015 John Wang
+The MIT License (MIT)
+
+Copyright (c) 2014-2016 John Wang
  
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,12 +1,15 @@
 VersionOne SDK - A Ruby SDK for the VersionOne REST API
 =======================================================
 
-[![Gem Version](https://badge.fury.io/rb/versionone_sdk.svg)](http://badge.fury.io/rb/versionone_sdk)
-[![Build Status](https://img.shields.io/travis/grokify/versionone-sdk-ruby/master.svg)](https://travis-ci.org/grokify/versionone-sdk-ruby)
-[![Code Climate](https://codeclimate.com/github/grokify/versionone-sdk-ruby/badges/gpa.svg)](https://codeclimate.com/github/grokify/versionone-sdk-ruby)
-[![Coverage Status](https://coveralls.io/repos/grokify/versionone-sdk-ruby/badge.svg?branch=master)](https://coveralls.io/r/grokify/versionone-sdk-ruby?branch=master)
-[![Docs](https://img.shields.io/badge/docs-rubydoc-blue.svg)](http://www.rubydoc.info/gems/versionone_sdk/)
-[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/grokify/versionone-sdk-ruby/master/LICENSE.txt)
+[![Gem Version][gem-version-svg]][gem-version-link]
+[![Build Status][build-status-svg]][build-status-link]
+[![Coverage Status][coverage-status-svg]][coverage-status-link]
+[![Dependency Status][dependency-status-svg]][dependency-status-link]
+[![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
+[![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
+[![Downloads][downloads-svg]][downloads-link]
+[![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
+[![License][license-svg]][license-link]
 
 ## Synopsis
 
@@ -20,11 +23,20 @@ It currently offers the following capabilities:
 2. Ability to query Assets transparently using Asset OID Tokens (e.g. `Story:1`) or Asset Numbers (e.g. `B-1`).
 3. Ability to update Assets using Ruby without needing to manually create XML.
 
-## Installing
+## Installation
 
-Download and install `versionone_sdk` with the following:
+### Via Bundler
 
-```bash
+Add 'versionone_sdk' to `Gemfile` and then run `bundle`:
+
+```sh
+$ echo "gem 'versionone_sdk'" >> Gemfile
+$ bundle
+```
+
+### Via RubyGems
+
+```sh
 $ gem install versionone_sdk
 ```
 
@@ -35,19 +47,18 @@ This gem uses `nokogiri` which requires Ruby >= 1.9.2.
 ```ruby
 require 'versionone_sdk'
 
-params      =  {
-  :hostname => 'www1.v1host.com',
-  :instance => 'myinstance',
-  :username => 'myusername',
-  :password => 'mypassword',
-  :port     => 443,
-  :protocol => 'https'
+params = {
+  hostname: 'www1.v1host.com',
+  instance: 'myinstance',
+  username: 'myusername',
+  password: 'mypassword',
+  port: 443,
+  protocol: 'https'
 }
 
 v1client = VersiononeSdk::Client.new(params)
     
 # Retrieve an array of VersiononeSdk::Asset objects
-
 assets   = v1client.getAssets('Scope')
 
 assets.each do |asset|
@@ -56,39 +67,33 @@ end
 
 # Retrieve a single asset using an Asset OID Token
 # Returns a VersiononeSdk::Asset object
-
-asset = v1client.getAsset("Story:1")
-asset = v1client.getAsset("Story",1)
+asset = v1client.getAsset('Story:1')
+asset = v1client.getAsset('Story',1)
 
 # Retrieve a single asset using an Asset Number
-
-asset = v1client.getAsset("B-1")
-asset = v1client.getAsset("B",1)
+asset = v1client.getAsset('B-1')
+asset = v1client.getAsset('B',1)
 
 # Updating an asset with a simple attribute
 # Returns a Faraday::Response object
-
-v1client.updateAsset("Member",20,"Phone","555-555-1212")
-v1client.updateAsset("Member",20,"Phone",{:value=>"555-555-1212",:act=>"set"})
-v1client.updateAsset("Member",20,"Phone",{:value=>"555-555-1212",:act=>"set"},\
+v1client.updateAsset('Member',20,'Phone','555-555-1212')
+v1client.updateAsset('Member',20,'Phone',{value: '555-555-1212', act: 'set'})
+v1client.updateAsset('Member',20,'Phone',{value: '555-555-1212', act: 'set'},\
   :simple_attribute
 )
 
 # Updating an asset with a single-value relationship:
-
-v1client.updateAsset("Scope",0,"Owner","Member:20")
-v1client.updateAsset("Scope",0,"Owner",{:value=>"Member:20",:act=>"set"})
-v1client.updateAsset("Scope",0,"Owner",{:value=>"Member:20",:act=>"set"},:single_relationship)
+v1client.updateAsset('Scope',0,'Owner','Member:20')
+v1client.updateAsset('Scope',0,'Owner',{value: 'Member:20', act: 'set'})
+v1client.updateAsset('Scope',0,'Owner',{value: 'Member:20', act: 'set'},:single_relationship)
 
 # Updating an asset with a multi-value relationship: adding members
-
-v1client.updateAsset("Scope",0,"Members",["Member:1000","Member:1001"],:multi_relationship)
+v1client.updateAsset('Scope',0,'Members',['Member:1000','Member:1001'],:multi_relationship)
 
 # Updating an asset with a multi-value relationship: adding and removing members
-
-v1client.updateAsset("Scope",0,"Members",[       \
-  { :value => "Member:1000", :act => "add" },    \
-  { :value => "Member:1001", :act => "remove " } \
+v1client.updateAsset('Scope',0,'Members',[ \
+  { value: 'Member:1000', act: 'add' },    \
+  { value: 'Member:1001', act: 'remove' }  \
 ],:multi_relationship)
 ```
 
@@ -132,10 +137,29 @@ VersionOne API Documentation for Updating an Asset
 
 ## Copyright and License
 
-VersiononeSdk © 2014-2015 by [John Wang](mailto:johncwang@gmail.com).
+VersiononeSdk © 2014-2016 by [John Wang](mailto:johncwang@gmail.com).
 
 VersiononeSdk is licensed under the MIT license. Please see the [LICENSE.txt](LICENSE.txt) 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.
+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.
+
+ [gem-version-svg]: https://badge.fury.io/rb/versionone_sdk.svg
+ [gem-version-link]: http://badge.fury.io/rb/versionone_sdk
+ [build-status-svg]: https://api.travis-ci.org/grokify/versionone-sdk-ruby.svg?branch=master
+ [build-status-link]: https://travis-ci.org/grokify/versionone-sdk-ruby
+ [coverage-status-svg]: https://coveralls.io/repos/grokify/versionone-sdk-ruby/badge.svg?branch=master
+ [coverage-status-link]: https://coveralls.io/r/grokify/versionone-sdk-ruby?branch=master
+ [dependency-status-svg]: https://gemnasium.com/grokify/versionone-sdk-ruby.svg
+ [dependency-status-link]: https://gemnasium.com/grokify/versionone-sdk-ruby
+ [codeclimate-status-svg]: https://codeclimate.com/github/grokify/versionone-sdk-ruby/badges/gpa.svg
+ [codeclimate-status-link]: https://codeclimate.com/github/grokify/versionone-sdk-ruby
+ [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/versionone-sdk-ruby/badges/quality-score.png?b=master
+ [scrutinizer-status-link]: https://scrutinizer-ci.com/g/grokify/versionone-sdk-ruby/?branch=master
+ [downloads-svg]: http://ruby-gem-downloads-badge.herokuapp.com/versionone_sdk
+ [downloads-link]: https://rubygems.org/gems/versionone_sdk
+ [docs-rubydoc-svg]: https://img.shields.io/badge/docs-rubydoc-blue.svg
+ [docs-rubydoc-link]: http://www.rubydoc.info/gems/versionone_sdk/
+ [license-svg]: https://img.shields.io/badge/license-MIT-blue.svg
+ [license-link]: https://github.com/grokify/versionone-sdk-ruby/blob/master/LICENSE.txt

data/lib/versionone_sdk.rb

@@ -5,4 +5,4 @@ module VersiononeSdk
   autoload :Client, 'versionone_sdk/client'
   autoload :ParserXmlAssets, 'versionone_sdk/parser_xml_assets'
   autoload :Update, 'versionone_sdk/update'
-end
+end

data/lib/versionone_sdk/asset.rb

@@ -1,19 +1,15 @@
 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)
+
+    def initialize(dValues=nil,dSchema=nil,bDefaultifyDoc=false,bIsStrict=true,opts={})
+      opts[:bUseDeepKeys] = false
+      super(dValues, dSchema, bDefaultifyDoc, bIsStrict, opts)
     end
 
     def getDefaultSchema()
@@ -45,17 +41,16 @@ module VersiononeSdk
         208 => 'Broken Down (Dead)',
         255 => 'Deleted (Dead)'
       }
-      if @dDocument.has_key?(:AssetState)
+      if @dDocument.key?(:AssetState)
         sAssetState = @dDocument[:AssetState]
         if sAssetState.is_a?(String) && sAssetState =~ /^[0-9]+$/
           iAssetState = sAssetState.to_i
-          if dAssetState.has_key?(iAssetState)
+          if dAssetState.key?(iAssetState)
             sAssetStateName = dAssetState[iAssetState]
             self.setProp(:'AssetState.Name',sAssetStateName)
           end
         end
       end
     end
-
   end
-end
+end

data/lib/versionone_sdk/client.rb

@@ -4,21 +4,20 @@ require 'versionone_sdk/parser_xml_assets'
 
 module VersiononeSdk
   class Client
-
     attr_accessor :oFaraday
     attr_accessor :sInstance
 
     def initialize(dOptions={})
       iPort        = iPort.to_i if iPort.is_a?(String)
-      @sProtocol   = dOptions.has_key?(:protocol) && dOptions[:protocol] \
+      @sProtocol   = dOptions.key?(:protocol) && dOptions[:protocol] \
                    ? dOptions[:protocol]    : 'https'
-      @sHostname   = dOptions.has_key?(:hostname) && dOptions[:hostname] \
+      @sHostname   = dOptions.key?(:hostname) && dOptions[:hostname] \
                    ? dOptions[:hostname]    : 'localhost'
-      @iPort       = dOptions.has_key?(:port) && dOptions[:port] \
+      @iPort       = dOptions.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] : ''
+      sUsername    = dOptions.key?(:username) ? dOptions[:username] : ''
+      sPassword    = dOptions.key?(:password) ? dOptions[:password] : ''
+      @sInstance   = dOptions.key?(:instance) ? dOptions[:instance] : ''
       @dTypePrefix = { 'B' => 'Story', 'E' => 'Epic' }
       @sUrl        = buildUrl(@sProtocol,@sHostname,@iPort)
       @oFaraday    = Faraday::Connection.new url: @sUrl
@@ -37,7 +36,7 @@ module VersiononeSdk
 
         elsif xAssetId1 =~ /^([a-zA-Z])-[0-9]+$/
           sAssetTypeAbbr = $1.upcase
-          sAssetType     = @dTypePrefix.has_key?( sAssetTypeAbbr ) \
+          sAssetType     = @dTypePrefix.key?( sAssetTypeAbbr ) \
             ? @dTypePrefix[ sAssetTypeAbbr ] : ''
           xAssetId1.upcase!
           return self.getAssetForTypeAndNumber( sAssetType, xAssetId1 )
@@ -52,7 +51,7 @@ module VersiononeSdk
             if xAssetId1     =~ /^[a-zA-Z]$/
               xAssetId1.upcase!
               sAssetTypeAbbr = xAssetId1
-              sAssetType     = @dTypePrefix.has_key?( sAssetTypeAbbr ) \
+              sAssetType     = @dTypePrefix.key?( sAssetTypeAbbr ) \
                 ? @dTypePrefix[ sAssetTypeAbbr ] : ''
               sAssetNumber   =  xAssetId1 + '-' + xAssetId2.to_s
               sAssetNumber.upcase!
@@ -145,6 +144,5 @@ module VersiononeSdk
       sBaseUrl  += ':' + iPort.to_s if iPort != 80
       return sBaseUrl
     end
-
   end
-end
+end

data/lib/versionone_sdk/parser_xml_assets.rb

@@ -5,7 +5,7 @@ require 'versionone_sdk/asset'
 module VersiononeSdk
   class ParserXmlAssets
     def initialize(dOptions={})
-      @sUrl = dOptions.has_key?(:url) ? dOptions[:url] : ''
+      @sUrl = dOptions.key?(:url) ? dOptions[:url] : ''
     end
     def getDocsForAssetsXmlPath(sPath=nil)
       if File.exists?(sPath)
@@ -76,7 +76,7 @@ module VersiononeSdk
       if oNodeChild.children.length > 0
         oNodeChild.children.each do |oNodeChildGrand|
           dAttributes = oNodeChildGrand.attributes
-          xxPropVal   = dAttributes.has_key?('idref')    \
+          xxPropVal   = dAttributes.key?('idref')    \
             ? oNodeChildGrand.attribute('idref').value \
             : oNodeChildGrand.text
           xxPropVal = nil if xxPropVal == ''
@@ -95,6 +95,5 @@ module VersiononeSdk
       xxPropVal     = nil if xxPropVal == ''
       return xxPropVal
     end
-
   end
-end
+end

data/lib/versionone_sdk/update.rb

@@ -2,7 +2,6 @@ require 'nokogiri'
 
 module VersiononeSdk
   class Update
-
     def initialize(oClient=nil)
       @oClient        = oClient
       @dTagTypes      = {:simple_attribute=>1,:single_relationship=>1,:multi_relationship=>1}
@@ -27,13 +26,13 @@ module VersiononeSdk
       yTagType = yTagType.to_sym if yTagType.is_a?(String)
 
       unless yTagType.nil?
-        unless @dTagTypes.has_key?(yTagType)
+        unless @dTagTypes.key?(yTagType)
           raise ArgumentError, "E_BAD_TAG_TYPE: [#{yTagType.to_s}]"
         end
       else
         if sName.nil? || ! sName.kind_of?(String)
           raise ArgumentError, 'E_NO_ATTRIBUTE_NAME'
-        elsif @dRelationships.has_key?(sName)
+        elsif @dRelationships.key?(sName)
           aValues.each do |dValue|
             sAct = dValue[:act]
             if sAct    == 'set'
@@ -100,7 +99,7 @@ module VersiononeSdk
     end
 
     def getXmlBodyForSimpleAttributeUpdate(sName=nil,aValues=[])
-      sValue   = aValues.length>0 && aValues[0].has_key?(:value) \
+      sValue   = aValues.length>0 && aValues[0].key?(:value) \
         ? aValues[0][:value] : nil
       oBuilder = Nokogiri::XML::Builder.new do |xml|
         xml.Asset {
@@ -111,7 +110,7 @@ module VersiononeSdk
     end
 
     def getXmlBodyForSingleRelationship(sName=nil,aValues=[])
-      sValue   = aValues.length>0 && aValues[0].has_key?(:value) \
+      sValue   = aValues.length>0 && aValues[0].key?(:value) \
         ? aValues[0][:value] : nil
       oBuilder = sValue.nil? \
         ? Nokogiri::XML::Builder.new { |xml| xml.Asset { \
@@ -139,6 +138,5 @@ module VersiononeSdk
         } }
       return oBuilder.to_xml
     end
-
   end
-end
+end

data/lib/versionone_sdk/version.rb

@@ -1,4 +1,3 @@
 module VersiononeSdk
-  # The current version
-  VERSION = "0.1.1"
-end
+  VERSION = '0.1.2'
+end

data/test/test_setup.rb

@@ -1,9 +1,10 @@
 require 'test/unit'
 require 'versionone_sdk'
 
+require 'pp'
+
 class VersiononeSdkTest < Test::Unit::TestCase
   def testSetup
-
     oAsset  = VersiononeSdk::Asset.new
     oClient = VersiononeSdk::Client.new
     oParser = VersiononeSdk::ParserXmlAssets.new
@@ -11,6 +12,15 @@ class VersiononeSdkTest < Test::Unit::TestCase
     assert_equal 'VersiononeSdk::Asset', oAsset.class.name
     assert_equal 'VersiononeSdk::Client', oClient.class.name
     assert_equal 'VersiononeSdk::ParserXmlAssets', oParser.class.name
+  end
+
+  def testAsset
+    oAsset = VersiononeSdk::Asset.new({hello: 'world'},{},false,false)
+    assert_equal 'world', oAsset.getAttr(:hello)
+
+    oAsset.setProp(:AssetState, '128')
+    oAsset.inflateNames()
 
+    assert_equal 'Closed', oAsset.getProp(:'AssetState.Name')
   end
-end
+end

metadata

@@ -1,73 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: versionone_sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-14 00:00:00.000000000 Z
+date: 2016-02-05 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'
-    - - '>='
+        version: '0.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-    - - '>='
+        version: '0.1'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.4
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
 description: A Ruby SDK for the VersionOne REST API
@@ -77,10 +77,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- VERSION
 - lib/versionone_sdk.rb
 - lib/versionone_sdk/asset.rb
 - lib/versionone_sdk/client.rb
@@ -98,17 +98,17 @@ 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.1.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: VersionOne SDK - A Ruby SDK for the VersionOne REST API

data/VERSION

@@ -1 +0,0 @@
-0.1.1