brocade_vrouter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 19ef669a2955e9712f73dbdc3254490d9172677f
-  data.tar.gz: ca6ca13edafc6a482bb5c7a2bd85560dc4ca093a
+  metadata.gz: 76417369286937151d5ddd98715ef88e04f131e6
+  data.tar.gz: 6ff812dbe66810fdb2f3881efbdf8d8849a7064e
 SHA512:
-  metadata.gz: 8494cf2de277c54f330c55b450304a98ecabcb7a6a5c118c93503ff535bf58747c784f32b12becf92a0fe3b796f05e5e6e6df879c1f602b4ca794f14d11f68ac
-  data.tar.gz: cd3aecc85388fb3bf8fbdd6d9b246067d5ea03330bebb1c637e3d63347d8685bb1acafaae2e3516801f7c8ea035a572ad4e022aca45544f1d39f60b9671706a3
+  metadata.gz: 74a8c1d98504b427f5abf52589da092d90a2c3905c4d6838116d8a23fc97efbedef6558d176bbd48e6030a3153b21d73ef8226def7070273772f7c0f886c1e07
+  data.tar.gz: 3410cefe4c69f069c61552885678e4607d7a68f0eb68e32aeed53904058255aa72296710a66c1eab841efadd98f8631d1455bf83e45188814af68e6ae18d1536

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at key@kosmatov.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Konstantin Kosmatov
+
+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,93 @@
+# Brocade vRouter client
+
+[![Build Status](https://travis-ci.org/serverscom/brocade_vrouter.svg?branch=master)](https://travis-ci.org/serverscom/brocade_vrouter)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brocade_vrouter'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Configure
+
+```ruby
+BrocadeVRouter.configure do |conf|
+  conf.url 'https://examplerouter.com'
+  conf.basic_auth ['routeruser', 'routerpassword']
+  conf.ssl verify: false
+end
+
+router = BrocadeVRouter::Client.new
+```
+
+### Or pass config to client instance
+
+```ruby
+router = BrocadeVRouter::Client.new url: 'https://examplerouter.com', 
+  basic_auth: ['routeruser', 'routerpassword'], 
+  connection_options: {ssl: {verify: false}}
+```
+
+### Example router configuration
+
+```ruby
+router.configure do
+  set security do
+    vpn l2tp remote_access authentication local_users do
+      username testuser do
+        password 'testpass'
+        static_ip '10.0.2.1'
+      end
+    end
+
+    firewall name 'testfw', true do # pass `true` to perform command without block at first
+      default_action drop
+      rule 100 do
+        action accept
+        source address '10.0.2.1'
+        destination address '10.0.2.0/24'
+      end
+    end
+  end
+
+  commit
+end
+```
+
+CLI equivalent:
+
+```
+configure
+set security vpn l2tp remote-access authentication local-users username 'testuser' password 'testpass'
+set security vpn l2tp remote-access authentication local-users username 'testuser' static-ip '10.0.2.1'
+set security firewall name 'testfw'
+set security firewall name 'testfw' default-action drop
+set security firewall name 'testfw' rule 100 action accept
+set security firewall name 'testfw' rule 100 source address '10.0.2.1'
+set security firewall name 'testfw' rule 100 destination address '10.0.2.0/24'
+commit
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/serverscom/brocade_vrouter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "brocade_vrouter"
+require "pry"
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/brocade_vrouter.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'brocade_vrouter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'brocade_vrouter'
+  spec.version       = BrocadeVRouter::VERSION
+  spec.authors       = ['Konstantin Kosmatov']
+  spec.email         = ['key@kosmatov.ru']
+
+  spec.summary       = %q{Brocade 5600 vRouter client}
+  spec.description   = %q{Brocade 5600 vRouter REST API 2.0 client}
+  spec.homepage      = 'https://github.com/serverscom/brocade_vrouter'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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_dependency 'faraday', '~> 0'
+  spec.add_dependency 'multi_json', '~> 1'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0'
+  spec.add_development_dependency 'coveralls', '~> 0'
+  spec.add_development_dependency 'webmock', '~> 1'
+end

data/lib/brocade_vrouter/client.rb

@@ -0,0 +1,36 @@
+module BrocadeVRouter
+  class Client
+    attr_reader :connection
+
+    def initialize(url: nil, connection_options: nil, basic_auth: nil)
+      config = BrocadeVRouter.config
+      url ||= config.url
+      connection_options ||= config.connection_options
+      basic_auth ||= config.basic_auth
+
+      @connection = Faraday.new(url, connection_options) do |f|
+        f.adapter config.adapter
+        f.basic_auth(*basic_auth) if basic_auth
+      end
+    end
+
+    def configuration(&blk)
+      @current_conf ||= Configuration.new connection
+      block_given? ? @current_conf.perform(&blk) : @current_conf
+    end
+
+    alias_method :configure, :configuration
+
+    def close(commit: false, save: false)
+      close_configuration(commit: commit, save: save) if @current_conf
+    end
+
+    def close_configuration(commit:, save:)
+      @current_conf.commit if commit
+      @current_conf.save if save
+      @current_conf.close
+      @current_conf = nil
+    end
+
+  end
+end

data/lib/brocade_vrouter/config.rb

@@ -0,0 +1,60 @@
+module BrocadeVRouter
+  class Config
+    attr_reader :connection_opts, :request_opts
+
+    def self.define_opts_methods(opts)
+      opts.each do |name, _|
+        define_method name do |value = nil|
+          value ? (opts[name] = value) : opts[name]
+        end
+      end
+    end
+
+    def initialize
+      @connection_opts = {
+        ssl: {}
+      }
+
+      @request_opts = {
+        timeout: 5,
+        open_timeout: nil
+      }
+
+      self.class.define_opts_methods @connection_opts
+      self.class.define_opts_methods @request_opts
+
+      @raise_on_fail = true
+    end
+
+    def url(value = nil)
+      @url ||= value
+    end
+
+    def logger(logdev = nil)
+      @logger ||= logdev
+    end
+
+    def adapter(value = nil)
+      @adapter ||= value || Faraday.default_adapter
+    end
+
+    def raise_on_fail(value = nil)
+      @raise_on_fail = value unless value.nil?
+      @raise_on_fail
+    end
+
+    def basic_auth(value = nil)
+      @basic_auth ||= value
+    end
+
+    def connection_options
+      @connection_opts.map { |op, _| (value = send(op)) && [op, value] }.to_h
+        .merge request: request_options
+    end
+
+    def request_options
+      request_opts.map { |op, _| (value = send(op)) && [op, value] }
+    end
+
+  end
+end

data/lib/brocade_vrouter/configuration.rb

@@ -0,0 +1,98 @@
+module BrocadeVRouter
+  class Configuration
+    CONF_PATH = '/rest/conf'.freeze
+
+    attr_reader :connection, :last_response
+
+    def initialize(connection, base_path = nil)
+      @connection = connection
+      @base_path = base_path
+    end
+
+    def base_path
+      @base_path ||= handle_response(connection.post CONF_PATH).headers['location']
+    end
+
+    def perform(&blk)
+      @context = eval 'self', blk.binding
+      instance_eval(&blk) if block_given?
+    end
+
+    def set(paths = nil, &blk)
+      res = build_paths(paths, &blk).map do |p|
+        handle_response connection.put("#{base_path}/set/#{p}")
+      end
+
+      res.size > 1 ? res : res.first
+    end
+
+    def get(paths = nil, &blk)
+      all_res = build_paths(paths, &blk).map do |p|
+        res = handle_response connection.get "#{base_path}/#{p}"
+        res.success? ? MultiJson.load(res.body) : nil
+      end
+
+      all_res.size > 1 ? all_res : all_res.first
+    end
+
+    def delete(paths = nil, &blk)
+      res = build_paths(paths, &blk).map do |p|
+        handle_response connection.put "#{base_path}/delete/#{p}"
+      end
+
+      res.size > 1 ? res : res.first
+    end
+
+    def commit(path = nil)
+      handle_response connection.post "#{path || base_path}/commit"
+    end
+
+    def save(path = nil)
+      handle_response connection.post "#{path || base_path}/save"
+    end
+
+    def close(path = nil)
+      handle_response connection.delete(path || base_path)
+    end
+
+    def close_all_sessions!(commit: false, save: false)
+      sessions.each do |session|
+        path = "#{CONF_PATH}/#{session['id']}"
+        commit path if commit
+        save path if save
+        close path
+      end
+    end
+
+    def sessions
+      (MultiJson.load (handle_response connection.get CONF_PATH).body)
+        .fetch('session', [])
+    end
+
+    private
+
+    def handle_response(resp)
+      @last_response = resp
+      if BrocadeVRouter.config.logger
+        BrocadeVRouter.config.logger.info "#{resp.env.method} #{resp.env.url} #{resp.env.status}\n#{resp.body}"
+      end
+      if BrocadeVRouter.config.raise_on_fail && !resp.success?
+        raise RequestError.new "Request #{resp.env.method.upcase} #{resp.env.url} failed with code #{resp.status}: #{resp.body}"
+      end
+      resp
+    end
+
+    def method_missing(name, value = nil, exec = false, &blk)
+      PathBuilder.new(@context) { public_send name, value, exec, &blk }.to_a
+    end
+
+    def build_paths(paths, &blk)
+      paths = Array(paths)
+      if block_given?
+        paths.map { |p| PathBuilder.new(@context, p, &blk).to_a }.flatten
+      else
+        paths
+      end
+    end
+  end
+end

data/lib/brocade_vrouter/path_builder.rb

@@ -0,0 +1,61 @@
+module BrocadeVRouter
+  class PathBuilder
+    SEPARATOR = '/'.freeze
+    SNAKE_TRANSFORM = ['_', '-'].map(&:freeze).freeze
+
+    attr_reader :base_path
+
+    def initialize(context = nil, base_path = nil, &blk)
+      @base_path, @paths, @context = base_path, [], context
+
+      if block_given?
+        @context ||= eval 'self', blk.binding
+        instance_eval(&blk)
+      end
+    end
+
+    def to_a
+      return @paths.flatten if !base_path || base_path.empty?
+      @paths.flatten.map { |p| "#{base_path}/#{p}" }
+    end
+
+    private
+
+    def address(value)
+      generate_paths! :address, Array(value).map { |v| URI.escape v.to_s, SEPARATOR }
+    end
+
+    def method_missing(*args, &blk)
+      return @context.send(*args) if @context.respond_to?(args.first, true)
+      @paths << generate_paths!(*args, &blk)
+      @paths.last
+    end
+
+    def generate_paths!(name, value = nil, exec = nil, &blk)
+      path = URI.escape name.to_s.gsub(*SNAKE_TRANSFORM)
+
+      value_is_path = @paths.pop if @paths.last == value
+      @paths << "#{path}/#{value_is_path ? value : to_path(value)}" if exec
+
+      if value.is_a?(Array)
+        value.map { |v| "#{path}/#{v}" }
+      else
+        path = "#{path}/#{value_is_path ? value : to_path(value)}" if value
+        block_given? ? PathBuilder.new(@context, path, &blk).to_a : path
+      end
+    end
+
+    def to_path(value)
+      val = value.is_a?(Hash) ? hash_to_ary(value) : value
+      Array(val).flatten.map { |e| URI.escape e.to_s }.join SEPARATOR
+    end
+
+    def hash_to_ary(hash)
+      hash.reduce([]) do |m, (k, v)|
+        m << k.to_s.gsub(*SNAKE_TRANSFORM)
+        m << v
+      end
+    end
+
+  end
+end

data/lib/brocade_vrouter/version.rb

@@ -0,0 +1,3 @@
+module BrocadeVRouter
+  VERSION = '0.1.1'
+end

data/lib/brocade_vrouter.rb

@@ -0,0 +1,19 @@
+require 'faraday'
+require 'multi_json'
+
+module BrocadeVRouter
+  autoload 'Client', 'brocade_vrouter/client'
+  autoload 'Config', 'brocade_vrouter/config'
+  autoload 'Configuration', 'brocade_vrouter/configuration'
+  autoload 'PathBuilder', 'brocade_vrouter/path_builder'
+
+  RequestError = Class.new StandardError
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.configure
+    yield config
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brocade_vrouter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Konstantin Kosmatov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-17 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,21 +114,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 description: Brocade 5600 vRouter REST API 2.0 client
 email:
 - key@kosmatov.ru
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- brocade_vrouter.gemspec
+- lib/brocade_vrouter.rb
+- lib/brocade_vrouter/client.rb
+- lib/brocade_vrouter/config.rb
+- lib/brocade_vrouter/configuration.rb
+- lib/brocade_vrouter/path_builder.rb
+- lib/brocade_vrouter/version.rb
 homepage: https://github.com/serverscom/brocade_vrouter
 licenses:
 - MIT
@@ -149,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Brocade 5600 vRouter client