netdot-restclient 1.0

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*~
+cookie.dat
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright (c) 2014 Carlos Vicente
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,59 @@
+# Netdot::RestClient
+
+RESTful API Ruby client for the Network Documentation Tool
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'netdot-restclient'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install netdot-restclient
+
+## Usage
+
+	require 'netdot-restclient'
+	require 'pp'
+
+	netdot = Netdot::RestClient.new(
+        :server   => 'http://localhost.localdomain/netdot',
+        :username => 'admin',
+        :password => 'xxxxx',
+    )
+
+    # Get all devices
+    devs = netdot.get('/Device');
+
+    pp devs
+
+    # Get Device id 1
+    dev = netdot.get('/Device/1');
+
+    # Get Device id 1 and foreign objects one level away
+    dev = netdot.get('/Device/1?depth=1');
+
+    # Update Device 1
+    dev = netdot.post('/Device/1', {community=>'public'});
+
+    # Delete Device 1
+    netdot.delete('/Device/1');
+
+## See Also
+
+The Netdot user manual at:
+
+    http://netdot.uoregon.edu
+
+## Contributing
+
+1. Fork it ( https://github.com/cvicente/netdot-restclient/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/netdot/restclient.rb

@@ -0,0 +1,149 @@
+require 'netdot/restclient/version'
+
+require 'httpclient'
+
+module Netdot
+  class RestClient    
+    attr_accessor :format, :base_url, :ua, :xs
+
+    # Constructor and login method
+    #
+    # Arguments (hash):
+    #
+    # server   - Netdot server URL
+    # username - Netdot Username
+    # password - Netdot password
+    # retries  - Number of attempts
+    # timeout  - Timeout in seconds
+    # format   - Content format <xml>
+    #
+    # Returns:
+    #   Netdot::RestClient object
+    # Example:
+    #   Netdot::Restclient.new(args)
+    #
+    def initialize(argv = {})
+      
+      [:server, :username, :password].each do |k|
+        raise ArgumentError, "Missing required argument '#{k}'" unless argv[k]
+      end
+      
+      argv.each { |k,v| instance_variable_set("@#{k}", v) }
+      
+      @timeout ||= 10
+      @retries ||= 3
+      @format  ||= 'xml'
+      
+      if ( @format == 'xml' ) 
+        begin
+          require 'xmlsimple'
+        rescue LoadError => e
+          raise LoadError, "Cannot load XML library. Try running 'gem install xml-simple'"
+        end
+        xs = XmlSimple.new({ 'ForceArray' => true, 'KeyAttr' => 'id'})
+        @xs = xs
+      else
+        raise ArgumentError, "Only XML formatting supported at this time"
+      end
+
+      ua = HTTPClient.new(:agent_name => "Netdot::RestClient/#{self.version}")
+      ua.set_cookie_store("cookie.dat")
+
+      login_url = @server + '/NetdotLogin'
+      
+      resp = nil
+
+      @retries.times do
+        resp = ua.post login_url, {
+          'destination'       => 'index.html',
+          'credential_0'      => @username,
+          'credential_1'      => @password,
+          'permanent_session' => 1,
+        }
+        if resp 
+          ua.save_cookie_store
+          @ua = ua
+          @base_url = @server + '/rest'
+          break
+        else
+          $stderr.puts "Connection attempt to #{@server} failed"
+        end
+      end
+      
+      raise "Could not log into #{@server}" unless resp
+
+    end
+    
+
+    # Build the Extra headers
+    #
+    def extheader
+      { 'Accept' => 'text/' + self.format + '; version=1.0' }
+    end
+
+    # Build URL given a resource
+    #
+    def build_url(resource)
+      self.base_url + '/' + resource
+    end
+
+    # Get a resource
+    #
+    # Arguments:
+    #   resource - A URI
+    # Returns:
+    #   hash when successful
+    #   exception when not
+    def get(resource)
+      url = self.build_url(resource)
+      resp = self.ua.get(url, nil, self.extheader)
+      if ( resp.status == 200 )
+        self.xs.xml_in(resp.content)
+      else
+        raise "Could not get #{url}: #{resp.status}" 
+      end
+    end
+
+
+    # Update or create a resource
+    # 
+    # Arguments:
+    #   resource - A URI
+    #   data     - Hash with key/values
+    # Returns:
+    #   new or modified record hash when successful
+    #   exception when not
+    def post(resource, data)
+      url = self.build_url(resource)
+      raise ArgumentError, "Data must be hash" unless data.is_a?(Hash)
+      resp = self.ua.post(url, data, self.extheader)
+      if ( resp.status == 200 )
+        self.xs.xml_in(resp.content)
+      else
+        raise "Could not post to #{url}: #{resp.status}"
+      end
+    end
+
+
+    # Delete a resource
+    # 
+    # Arguments:
+    #   resource - A URI
+    #   
+    # Returns:
+    #   true when successful
+    #   exception when not
+    #
+    def delete(resource)
+      url = self.build_url(resource)
+      resp = self.ua.delete(url, nil, self.extheader)
+      if ( resp.status == 200 )
+        return true
+      else
+        raise "Could not delete #{url}: #{resp.status}"
+      end
+
+    end
+
+  end
+end

data/lib/netdot/restclient/version.rb

@@ -0,0 +1,10 @@
+module Netdot
+  class RestClient
+    VERSION = "1.0"
+
+    def version
+      VERSION
+    end
+
+  end
+end

data/netdot-restclient.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'netdot/restclient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "netdot-restclient"
+  spec.version       = Netdot::RestClient::VERSION
+  spec.authors       = ["Carlos Vicente"]
+  spec.email         = ["cvicente@gmail.com"]
+  spec.summary       = %q{RESTful API client for Netdot}
+  spec.description   = %q{Talk to Netdot via REST with Ruby}
+  spec.homepage      = ""
+  spec.license       = "Apache-2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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_dependency "httpclient"
+  spec.add_dependency "xml-simple"
+
+end

data/sample/host.rb

@@ -0,0 +1,36 @@
+#
+# Example: Use the special-purpose 'host' resource 
+# to allocate a new IP and assign DNS records
+#
+#
+require 'netdot/restclient'
+
+require 'pp'
+
+netdot = Netdot::RestClient.new(
+                                :server   => 'http://localhost/netdot',
+                                :username => 'admin',
+                                :password => 'admin',
+                                )
+# Add 
+# This allocates the first available IP in the given subnet
+# and creates A and PTR records, assuming that the subnet
+# is associated with the appropriate forward and reverse zones
+netdot.post('host', { 'name' => 'testhost1', 'subnet' => '192.168.1.0/24'})
+
+# Find
+resp = netdot.get('host?name=testhost1.defaultdomain')
+
+pp resp
+
+ipid = resp['Ipblock'].keys[0]
+
+# Delete DNS records associated with new IP
+netdot.delete("host?ipid=#{ipid}")
+
+# Notice that the above does not delete the Ipblock object, but
+# marks it as "available"
+# If user has admin privileges and really wants to delete the 
+# Ipblock, then they can do:
+
+netdot.delete("Ipblock/#{ipid}")

data/spec/restclient_spec.rb

@@ -0,0 +1,94 @@
+require 'netdot/restclient'
+
+describe Netdot::RestClient do
+  before :all do
+    args = {
+      username:  'admin',
+      server:    'http://localhost/netdot'
+    }
+    expect {
+      Netdot::RestClient.new(args)
+    }.to raise_error(ArgumentError)
+    
+    args[:password] = 'admin'
+    @netdot = Netdot::RestClient.new(args)
+    expect(@netdot).to be_an_instance_of(Netdot::RestClient)
+    
+  end
+
+  context 'when getting' do
+
+    it 'invalid resource raises exception' do
+      expect { 
+        resp = @netdot.get('foobar')
+      }.to raise_error
+    end
+
+    it 'valid resource as hash' do
+      resp = @netdot.get('Entity/1')
+      resp.should be_an_instance_of(Hash)
+    end
+    
+    it 'record by id' do
+      resp = @netdot.get('Entity/1')
+      expect(resp['name']).to eq('Unknown')
+    end
+
+    it 'records filtered by name' do
+      resp = @netdot.get('Entity?name=Unknown')
+      expect(resp['Entity']['1']['name']).to eq('Unknown')
+    end
+
+    
+  end
+
+   context 'when posting' do
+
+     it 'fails to update invalid record' do
+      expect {
+        resp = @netdot.post('Foobar/1', {'key' => 'value'} )
+      }.to raise_error
+     end
+
+     it 'creates new record' do
+      resp = @netdot.post('Person', 
+                          { 'firstname' => 'Joe', 
+                            'lastname' => 'Plumber',
+                            'username' => 'joetubes'
+                          })
+      expect(resp['firstname']).to eq ('Joe')
+      expect(resp['lastname']).to eq ('Plumber')
+
+     end
+
+     it 'fails to create duplicate record' do
+      expect {
+        resp = @netdot.post('Person', 
+                            { 'firstname' => 'Joe', 
+                              'lastname' => 'Plumber',
+                              'username' => 'joetubes'
+                            })
+      }.to raise_error
+     end
+
+  end
+
+  context 'when deleting' do
+    
+    it 'fails to delete invalid record' do
+      expect {
+        resp = @netdot.delete('FooBar/1234')
+      }.to raise_error
+    end
+
+    it 'deletes exiting record' do
+      resp = @netdot.get('Person?lastname=Plumber')
+      person_id =  resp['Person'].keys[0]
+      resp = @netdot.delete("Person/#{person_id}")
+      expect(resp).to be_true
+    end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: netdot-restclient
+version: !ruby/object:Gem::Version
+  version: '1.0'
+  prerelease: 
+platform: ruby
+authors:
+- Carlos Vicente
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &83415360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: *83415360
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &83414820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *83414820
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &83414210 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *83414210
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &83413860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83413860
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: &83413340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *83413340
+description: Talk to Netdot via REST with Ruby
+email:
+- cvicente@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/netdot/restclient.rb
+- lib/netdot/restclient/version.rb
+- netdot-restclient.gemspec
+- sample/host.rb
+- spec/restclient_spec.rb
+homepage: ''
+licenses:
+- Apache-2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: RESTful API client for Netdot
+test_files:
+- spec/restclient_spec.rb