bluecat 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00b60276118b8d80fa86c5b65677f6b026b90ce7
-  data.tar.gz: 608aa91112d31ff22d227d9bba941292f34d2c80
+  metadata.gz: a901c48568977b23c1d782579260f8df25da8bcf
+  data.tar.gz: a039e858964fde468590531a01368e35e2e9b098
 SHA512:
-  metadata.gz: 177dafa86f82b3696dfcdeed8a97958405a2727ef5a498d144f935604b47a6ead0014eba76196a66d3760c22b35343c32f3ce3d81aeab5843eb3692f7c5a6380
-  data.tar.gz: 3c19956157e10e0bb778d9565e5227f8b5acce365de119e708c1955d2e7755d0e8b24dc1c2f06d4d7221599ed70c4dcadb8db1d5694eac57708a937af3f74c32
+  metadata.gz: 3b189d48d8206ac13caee05e69cd1c0f17336ef520db10d3b3753ead0a67fa9d9ffbc3defcdefd85740445c9c69ab58b4d4fcbea7d90e669cc7424b25dac1190
+  data.tar.gz: 6dfd3d4c6c973de14bf66e8d9d33448c6c58e6c5d3c532b7ef1d967413cee085c707cbe52c1fc683c0c6c09a722a32e0a190719ccaef5a74e9e391382c21a5f6

data/.gitignore

@@ -0,0 +1,17 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+/bin/
+
+# rspec failure tracking
+.rspec_status
+
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Dustin Wheeler
+
+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,75 @@
+# Bluecat
+
+This gem wraps certain operations with the Bluecat Address Management API via `savon`. I use this specifically to integrate with [Foreman](https://theforeman.org) so there is a lot that this gem cannot do, yet. That said, I am open to pull requests to add more features. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bluecat'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bluecat
+
+## Usage
+
+```ruby
+require 'bluecat'
+require 'pp'
+
+client = Bluecat::Client.new(wsdl: 'https://hostname/Services/API?wsdl')
+client.login('api-username', 'api-password')
+
+# This is the object ID of where to start
+# your search.
+container_id = 1
+
+pp client.ip4_networks(container_id).to_a
+
+client.logout
+```
+
+It is a "best practice" (according to Bluecat's documentation) to logout at the end of a session. When I use this in other projects, I might expose it like so:
+
+```ruby
+class SomeUseCase
+  # All access to API happens through this method
+  def bluecat
+    username = HammerCLI::Settings.get(:bluecat, :username)
+    password = HammerCLI::Settings.get(:bluecat, :password)
+
+    client = Bluecat::Client.new(wsdl: HammerCLI::Settings.get(:bluecat, :wsdl))
+    client.login(username, password)
+
+    yield client
+
+    client.logout
+  end
+  
+  def execute
+    bluecat do |client|
+      # Do things with the client
+      client.ip4_networks(@container_id).take(10)
+    end 
+  end
+end
+```
+
+In this way, the client will log in and out for every operation. This may not be best for your use-case.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mdwheele/bluecat.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bluecat.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bluecat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bluecat"
+  spec.version       = Bluecat::VERSION
+  spec.authors       = ["Dustin Wheeler"]
+  spec.email         = ["mdwheele@ncsu.edu"]
+
+  spec.summary       = %q{Bluecat Address Management Client}
+  spec.description   = %q{Use this gem to interact with the Bluecat Address Management SOAP API}
+  spec.homepage      = "https://github.com/mdwheele/bluecat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'thor', '~> 0.19'
+  spec.add_dependency 'savon', '~> 2.11'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/bluecat.rb

@@ -0,0 +1,6 @@
+require "bluecat/version"
+require "bluecat/client"
+
+module Bluecat
+
+end

data/lib/bluecat/client.rb

@@ -0,0 +1,46 @@
+require "savon"
+
+module Bluecat
+  class Client
+    def initialize(wsdl: '')
+      @client ||= Savon.client(wsdl: wsdl, ssl_verify_mode: :none)
+    end
+
+    def ops
+      @client.operations
+    end
+
+    def ip4_networks(container_id)
+      start = 0
+      count = 10
+
+      Enumerator.new do |yielder|
+        loop do
+          response = @client.call(:get_ip4_networks_by_hint, message: { container_id: container_id, start: start, count: count, options: '' }, cookies: @cookies)
+          retval = response.body[:get_ip4_networks_by_hint_response][:return]
+
+          raise StopIteration if retval == nil
+
+          # Last item will be hash if not more than one. Make it an array.
+          retval[:item] = [retval[:item]] unless retval[:item].is_a?(Array)
+
+          retval[:item].each do | item |
+            range = item[:properties].split('|')[0].split('=')[1]
+            yielder.yield({ id: item[:id], name: item[:name], ip_range: range })
+          end
+
+          start += count
+        end
+      end
+    end
+
+    def login(username, password)
+      response = @client.call(:login, message: { username: username, password: password })
+      @cookies = response.http.cookies
+    end
+
+    def logout
+      @client.call(:logout, cookies: @cookies)
+    end
+  end
+end

data/lib/bluecat/version.rb

@@ -0,0 +1,3 @@
+module Bluecat
+  VERSION = "0.1.1"
+end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: bluecat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dustin Wheeler
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2017-04-27 00:00:00.000000000 Z
 dependencies:
@@ -83,10 +83,25 @@ dependencies:
 description: Use this gem to interact with the Bluecat Address Management SOAP API
 email:
 - mdwheele@ncsu.edu
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bluecat.gemspec
+- lib/bluecat.rb
+- lib/bluecat/client.rb
+- lib/bluecat/version.rb
 homepage: https://github.com/mdwheele/bluecat
 licenses:
 - MIT