netdot-restclient 2.0.0 → 2.0.1

data/Gemfile

@@ -1,4 +1,2 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in netdot-restclient.gemspec
 gemspec

data/Makefile

@@ -0,0 +1,5 @@
+#!/usr/bin/env make -f
+
+default:
+	@echo 'You should use rake...'
+	@rake -T -A

data/README.md

@@ -18,6 +18,10 @@ Or install it yourself as:
 
 ## Usage
 
+See file `sample/sample.rb` for example usage of the `Netdot::Host` and `Netdot::Ipblock` classes.
+
+The following example shows how you can use the low level `Netdot::RestClient` class.
+
 	require 'netdot/restclient'
 	require 'pp'
 
@@ -50,8 +54,6 @@ The Netdot user manual at:
 
     http://netdot.uoregon.edu
 
-See the sample/sample.rb for sample usage of the Host and Ipblock classes.
-
 ## Contributing
 
 1. Fork it ( https://github.com/cvicente/netdot-restclient/fork )
@@ -59,3 +61,54 @@ See the sample/sample.rb for sample usage of the Host and Ipblock classes.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+### Setting up a development environment on Ubuntu 14.04
+* Resynchronize the package index files from their sources.
+```
+sudo apt-get update
+```
+* Install rbenv, then reconfigure PATH.
+```
+git clone https://github.com/sstephenson/rbenv.git ~/.rbenv
+cat >>~/.bashrc <<EOF
+export PATH=~/.rbenv/bin:\$PATH
+eval "\$(rbenv init -)"
+EOF
+```
+* Logout and back in!
+```
+logout
+```
+* Install and verify the desired Ruby version.
+```
+git clone https://github.com/sstephenson/ruby-build.git ~/.rbenv/plugins/ruby-build
+rbenv install 1.9.3-p547
+cat >~/.rbenv/version <<EOF
+1.9.3-p547
+EOF
+rbenv rehash
+ruby --version
+```
+* Install the bundler gem
+```
+rbenv exec gem install bundler
+rbenv rehash
+bundle version
+```
+* Install the netdot-restclient code
+```
+git clone https://github.com/cvicente/netdot-restclient.git
+cd netdot-restclient
+```
+* Run the bundler, to ensure we have all the gems we need
+```
+bundle install
+```
+* Optional: set environment variables for rspec tests
+```
+export SERVER=http://ipam0-01-unicorn-usnbn1.ci-aws.dev.ec2.dynback.net/netdot
+```
+* Run the default rake tasks
+```
+rake
+```

data/Rakefile

@@ -1,8 +1,59 @@
+#
+# Rakefile
+#
+
+require 'rake'
+require 'rake/clean'
+
+CLEAN.include('.yardoc',
+              'cookie.dat'
+             )
+CLOBBER.include('doc',
+                'pkg'
+               )
+
+#---------------------------------------------------------------------------
+# Packaging (bundler) -- build, install, and release
+
 require 'bundler/gem_tasks'
+
+#---------------------------------------------------------------------------
+# Documentation (yard)
+
 require 'yard'
+YARD::Rake::YardocTask.new
+
+desc 'Use yard for doc'
+task doc: :yard
+
+#---------------------------------------------------------------------------
+# Test
 
-YARD::Rake::YardocTask.new do |_t|
-  # t.files   = ['lib/**/*.rb', OTHER_PATHS]   # optional
-  # t.options = ['--any', '--extra', '--opts'] # optional
-  # t.stats_options = ['--list-undoc']         # optional
+require 'rspec/core/rake_task'
+
+# These are for running 'rspec' with our Netdot test server
+ENV['SERVER'] ||= 'http://localhost/netdot'
+ENV['USERNAME'] ||= 'admin'
+ENV['PASSWORD'] ||= 'admin'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**{,/*/**}/*_spec.rb'
+  t.rspec_opts = '--format documentation'
 end
+
+desc 'Use rspec for test'
+task test: :spec
+
+#---------------------------------------------------------------------------
+# Style (rubocop)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+desc 'Use rubocop for style'
+task style: :rubocop
+
+#---------------------------------------------------------------------------
+
+desc 'Build the Gem if style, test, and doc are successful'
+task default: [:rubocop, :spec, :yard, :build]

data/lib/netdot/host.rb

@@ -5,7 +5,7 @@ module Netdot
     attr_accessor :connection
 
     # Constructor
-    # @param :connection [Hash] a Netdot::RestClient object
+    # @option argv [Hash] :connection (REQUIRED) a Netdot::RestClient object
     def initialize(argv = {})
       [:connection].each do |k|
         fail ArgumentError, "Missing required argument '#{k}'" unless argv[k]

data/lib/netdot/ipblock.rb

@@ -5,7 +5,7 @@ module Netdot
     attr_accessor :connection
 
     # Constructor
-    # @param :connection [Hash] a Netdot::RestClient object
+    # @option argv [Hash] :connection (REQUIRED) a Netdot::RestClient object
     def initialize(argv = {})
       [:connection].each do |k|
         fail ArgumentError, "Missing required argument '#{k}'" unless argv[k]

data/lib/netdot/restclient.rb

@@ -9,18 +9,18 @@ module Netdot
     attr_accessor :format, :base_url, :ua, :xs
 
     # Constructor and login method
-    # @param :server [String] Netdot server URL
-    # @param :username [String] Netdot Username
-    # @param :password [String] Netdot password
-    # @param :retries [String] (optional) Number of attempts
-    # @param :timeout [String] (optional) Timeout in seconds
-    # @param :format [String] (optional) Content format <xml>
-    # @param :ssl_version [String] (optional) Specify version of SSL;
+    # @option argv [String] :server (REQUIRED) Netdot server URL
+    # @option argv [String] :username (REQUIRED) Netdot Username
+    # @option argv [String] :password (REQUIRED) Netdot password
+    # @option argv [Fixnum] :retries (3) number of attempts
+    # @option argv [Fixnum] :timeout (10) timeout in seconds
+    # @option argv [String] :format (xml) content format <xml>
+    # @option argv [String] :ssl_version ('') specify version of SSL;
     #   see HTTPClient
-    # @param :ssl_verify [String] (optional) Verify server cert (default: yes)
-    # @param :ssl_ca_file [String] (optional) Path to SSL CA cert file
-    # @param :ssl_ca_dir [String] (optional) Path to SSL CA cert directory
-    # @param :cookie_file [String] (optional) Cookie filename
+    # @option argv [String] :ssl_verify (true) verify server cert (default: yes)
+    # @option argv [String] :ssl_ca_file ('') path to SSL CA cert file
+    # @option argv [String] :ssl_ca_dir ('') path to SSL CA cert directory
+    # @option argv [String] :cookie_file ('./cookie.dat') cookie filename
     def initialize(argv = {})
       [:server, :username, :password].each do |k|
         fail ArgumentError, "Missing required argument '#{k}'" unless argv[k]

data/lib/netdot/restclient/version.rb

@@ -2,7 +2,7 @@
 module Netdot
   # RestClient
   class RestClient
-    VERSION = '2.0.0'
+    VERSION = '2.0.1'
 
     def version
       VERSION

data/netdot-restclient.gemspec

@@ -18,10 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 2.6'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'logger', '~>1.2'
+  spec.add_development_dependency 'netaddr', '~>1.5'
+  spec.add_development_dependency 'rake', '~>10.4'
+  spec.add_development_dependency 'redcarpet', '~>3.2'
+  spec.add_development_dependency 'rspec', '~> 2.99'
+  spec.add_development_dependency 'rubocop', '~>0.31'
+  spec.add_development_dependency 'yard', '~>0.8'
 
-  spec.add_dependency 'httpclient'
-  spec.add_dependency 'xml-simple'
+  spec.add_runtime_dependency 'httpclient', '~>2.6'
+  spec.add_runtime_dependency 'xml-simple', '~>1.1'
 end

data/spec/restclient_spec.rb

@@ -35,9 +35,14 @@ describe Netdot::RestClient do
         username:  ENV['USERNAME'] || 'admin',
         password:  ENV['PASSWORD'] || 'admin'
       }
-      expect do
-        Netdot::RestClient.new(args)
-      end.to raise_error
+      if ENV['SERVER'] =~ /^https:/
+        expect do
+          Netdot::RestClient.new(args)
+        end.to raise_error
+      else
+        STDERR.puts 'Warning: Skipping the following test' \
+          ", as URL scheme is not 'https:'"
+      end
     end
 
     it 'does not raise an exception if SSL verification is disabled' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netdot-restclient
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,63 +9,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &79226940 !ruby/object:Gem::Requirement
+  requirement: &81443330 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.9'
   type: :development
   prerelease: false
-  version_requirements: *79226940
+  version_requirements: *81443330
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: &81443080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: *81443080
+- !ruby/object:Gem::Dependency
+  name: netaddr
+  requirement: &81442850 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: *81442850
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &79224860 !ruby/object:Gem::Requirement
+  requirement: &81442620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: *81442620
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: &81442390 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.2'
   type: :development
   prerelease: false
-  version_requirements: *79224860
+  version_requirements: *81442390
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &79027910 !ruby/object:Gem::Requirement
+  requirement: &81442160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: *81442160
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: &81441930 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.31'
   type: :development
   prerelease: false
-  version_requirements: *79027910
+  version_requirements: *81441930
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &81441700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: *81441700
 - !ruby/object:Gem::Dependency
   name: httpclient
-  requirement: &79027320 !ruby/object:Gem::Requirement
+  requirement: &81441470 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.6'
   type: :runtime
   prerelease: false
-  version_requirements: *79027320
+  version_requirements: *81441470
 - !ruby/object:Gem::Dependency
   name: xml-simple
-  requirement: &79026340 !ruby/object:Gem::Requirement
+  requirement: &81441240 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *79026340
+  version_requirements: *81441240
 description: Talk to Netdot via REST with Ruby
 email:
 - cvicente@gmail.com
@@ -80,6 +135,7 @@ files:
 - .rubocop.yml
 - Gemfile
 - LICENSE.txt
+- Makefile
 - README.md
 - Rakefile
 - lib/netdot.rb