opendaylight 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8c9fbb5d75673daa8e54f4d7e58a5ad289d4581d
+  data.tar.gz: 0ca89291a52bb5b6cef888e3055c125b3bcf92c6
+SHA512:
+  metadata.gz: 10e67c6c981ff1440b3eff97383c407bb0568450308c28ceb7f7eed5f0dca1d83dc4eb31c4615486c50192bac7e13b4b6fce2f468a8127b5cb6fb2dc3a3002f5
+  data.tar.gz: 728b40b229396c5a655068d9fe2646fe110ae494eab542cdcacc2384d35836153a6b0c103019d98bd84cd3a616d5f0590d16c3ed33445a1c445a9159868ec7a2

data/.gitignore

@@ -0,0 +1,22 @@
+*.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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 rickpr
+
+MIT License
+
+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,147 @@
+# Opendaylight
+
+This gem is made as a ruby wrapper for OpenDaylight's FlowProgrammer api
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'opendaylight'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opendaylight
+
+## Usage
+
+Configure with an initializer in config/initializers as follows:
+
+    Opendaylight.configure do |config|
+      config.username = "your_username"
+      config.password = "your_password"
+      config.url = "http://yourserver.com:port/"
+    end
+
+Then make a call to Opendaylight's OpenDaylight.makeflow:
+
+For example:
+
+    Opendaylight::OpenDaylight.makeflow(id: "00:00:00:00:00:00:00:02", name: "flow1", actions: "DROP")
+
+Here are the possible arguments for makeflow. All the arguments default to nil unless otherwise specified:
+
+    #Server information
+    url			#Your controller's web url, usually "http://yourserver.com:8080/" (defaults to config url in initializer)
+    username		#OpenDaylight login username (defaults to config username in initializer)
+    password		#OpenDaylight login password (defaults to config password in initializer)
+
+    #Flow Parameters
+    id			#Node ID (usually MAC address) *REQUIRED*
+    name		#Flow Name *REQUIRED*
+    actions		#OpenDaylight OpenFlow Action *REQUIRED*
+    ingressPort		#Layer 1 (physical) Source Port
+    dlSrc		#Layer 2 (MAC address) source
+    dlDst		#Layer 2 (MAC address) Destination
+    nwSrc		#Layer 3 (IP address) source
+    nwDst		#Layer 3 (IP address) destination
+    tpSrc		#Layer 4 (Network Socket Port) Source
+    tpDst		#Layer 4 (Network Socket Port) destination
+    installInHW		#Make the flow installed and active (default "true")
+    type		#Node Type (default "OF")
+    protocol		#IP Protocol Number (default "6")
+    etherType		#Ethertype field (default "0x800")
+    vlanId		#Virtual LAN ID
+    vlanPriority	#Virtual LAN QoS Priotity
+    idleTimeout		#Flow Idle Timeout
+    priority		#Flow Priority
+    tosBits		#Type of Service Bits
+    hardTimeout		#Flow Hard Timeout
+    cookie		#Cookie enhancements
+
+
+## OpenDaylight Actions for the actions field
+CONTROLLER
+DROP
+ENQUEUE
+FLOOD
+FLOOD_ALL
+HW_PATH
+INTERFACE
+LOOPBACK
+OUTPUT
+POP_VLAN
+PUSH_VLAN
+SET_DL_DST
+SET_DL_SRC
+SET_DL_TYPE
+SET_NEXT_HOP
+SET_NW_DST
+SET_NW_SRC
+SET_NW_TOS
+SET_TP_DST
+SET_TP_SRC
+SET_VLAN_CFI
+SET_VLAN_ID
+SET_VLAN_PCP
+SW_PATH
+
+##Topology
+
+To get your topology, use Opendaylight.topology:
+
+    Opendaylight::OpenDaylight.topology
+
+This returns a hash of all the edges (links). The hash is organized as follows (I have capitalized things that will come back as variables):
+
+    "edgeProperties"=>[{
+            "properties"=>{
+                "timeStamp"=>{
+                    "value"=>TIMESTAMP, "name"=>"NAME"
+                }
+                , "name"=>{
+                    "value"=>"SWITCHNAME-PORTNAME"
+                }
+                , "state"=>{
+                    "value"=>LINKSTATE
+                }
+                , "config"=>{
+                    "value"=>CONFIGSTATE
+                }
+                , "bandwidth"=>{
+                    "value"=>BANDWIDTH
+                }
+
+            }
+            , "edge"=>{
+                "tailNodeConnector"=>{
+                    "node"=>{
+                        "id"=>"SWITCHID", "type"=>"SWITCHTYPE" #Usually the switch ID is a MAC address and the type is OF for OpenFlow
+                    }
+                    , "id"=>"PORTID", "type"=>"LINKTYPE" #I believe the PORTID is the interface of the connected device, type is usually OF for OpenFlow
+                }
+                , "headNodeConnector"=>{
+                    "node"=>{
+                        "id"=>"SWITCHID", "type"=>"SWITCHTYPE"
+                    }
+                    , "id"=>"PORTID", "type"=>"LINKTYPE"
+                }
+
+            }
+
+        }
+            "properties" => {#This would be the next link
+            ....
+        }
+    }]
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/opendaylight/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/opendaylight.rb

@@ -0,0 +1,73 @@
+require "opendaylight/version"
+
+module Opendaylight
+    class Configuration
+    attr_accessor :username, :password, :url
+    def initialize
+      username = nil
+      password = nil
+      url = nil
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration) if block_given?
+  end
+
+  class OpenDaylight
+    def self.makeflow(tpSrc: nil, protocol: "6", vlanId: nil, id: nil, type: "OF", vlanPriority: nil, idleTimeout: nil, priority: nil, ingressPort: nil, tosBits: nil, name: nil, hardTimeout: nil, dlDst: nil, installInHW: "true", etherType: "0x800", actions: nil, cookie: nil, dlSrc: nil, nwSrc: nil, nwDst: nil, tpDst: nil, username: OpenDaylight.configuration.username, password: Opendaylight.configuration.password, url: Opendaylight.configuration.url, containerName: "default")
+      auth = {username: username, password: password}
+      options = {
+        headers: {"Content-Type" => "application/json"},
+        body: {
+          "tpSrc" => tpSrc,
+          "protocol" => protocol,
+          "vlanId" => vlanId,
+          "node" => {
+            "id" => id,
+            "type" => type
+          },
+          "vlanPriority" => vlanPriority,
+          "idleTimeout" => idleTimeout,
+          "priority" => priority,
+          "ingressPort" => ingressPort,
+          "tosBits" => tosBits,
+          "name" => name,
+          "hardTimeout" => hardTimeout,
+          "dlDst" => dlDst,
+          "installInHW" => installInHW,
+          "etherType" => etherType,
+          "actions" => [actions],
+          "cookie" => cookie,
+          "dlSrc" => dlSrc,
+          "nwSrc" => nwSrc,
+          "nwDst" => nwDst,
+          "tpDst" => tpDst
+          }.to_json,
+        basic_auth: auth
+      }
+      HTTParty.put("#{url}controller/nb/v2/flowprogrammer/#{containerName}/node/#{type}/#{id}/staticFlow/#{name}",options)
+    end
+    def self.topology(username: Opendaylight.configuration.username, password: Opendaylight.configuration.password, url: Opendaylight.configuration.url, containerName: "default")
+        auth = {username: username, password: password}
+        HTTParty.get("#{url}controller/nb/v2/topology/#{containerName}", :basic_auth => auth)
+    end
+    def username
+      Opendaylight.configuration.username
+    end
+
+    def password
+      Opendaylight.configuration.password
+    end
+
+    def url
+      Opendaylight.configuration.url
+    end
+  end
+  Opendaylight.configure
+end

data/lib/opendaylight/version.rb

@@ -0,0 +1,3 @@
+module Opendaylight
+  VERSION = "0.0.1"
+end

data/opendaylight.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opendaylight/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "opendaylight"
+  spec.version       = Opendaylight::VERSION
+  spec.authors       = ["rickpr"]
+  spec.email         = ["fdisk@fdisk.co"]
+  spec.summary       = "Ruby Wrapper for OpenDaylight"
+  spec.description   = "Makes writing Ruby apps for OpenDaylight easy"
+  spec.homepage      = "http://fdisk.co"
+  spec.license       = "MIT"
+
+  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"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: opendaylight
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- rickpr
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Makes writing Ruby apps for OpenDaylight easy
+email:
+- fdisk@fdisk.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/opendaylight.rb
+- lib/opendaylight/version.rb
+- opendaylight.gemspec
+homepage: http://fdisk.co
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Ruby Wrapper for OpenDaylight
+test_files: []
+has_rdoc: