wisebedclientruby 0.0.49

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test/credentials.yml

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem "eventmachine"
+gem "em-http-request"
+gem "simpleblockingwebsocketclient"
+
+# Specify your gem's dependencies in wisebedclient-ruby.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marv Cool
+
+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,23 @@
+# Wisebedclient::Ruby
+
+Ruby gem to access the wisebed API via REST and websockets.
+
+## Installation
+
+Not on official gem repos yet, clone the code from github.
+
+## Usage
+
+For now, just do
+    
+    $ ruby test/testapp.rb
+
+or have a look at the code and enhance the testapp with whatever you like to do
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+desc "Runs the simply test app"
+task :test_app do
+  require File.expand_path('../test/testapp.rb', __FILE__)
+end
+
+desc "runs irb with this lib loaded"
+task :c do
+  sh "irb" " -r#{File.expand_path('../lib/wisebedclientruby.rb', __FILE__)}"
+end
+
+namespace :reservation do
+  
+  desc "lists current reservations on uzl"
+  task :list do
+    require File.expand_path('../lib/wisebedclientruby.rb', __FILE__)
+    res = Wisebed::Testbed.new("uzl").public_reservations(Time.now, Time.now+60*60*24)
+    res.each do |r|
+        puts "#{r["userData"]} : #{Time.at(r["from"]/1000)} -> #{Time.at(r["to"]/1000)}"
+    end
+  end
+
+  desc "deletes a reservation"
+  task :delete do
+    require File.expand_path('../lib/wisebedclientruby.rb', __FILE__)
+    tb = Wisebed::Testbed.new("uzl")
+    logindata = YAML.load_file(File.expand_path('../test/credentials.yml', __FILE__))
+    tb.login!(logindata)
+    puts tb.delete_reservation(JSON.parse(ENV['res']))
+  end
+      
+end
+

data/lib/wisebedclientruby/client.rb

@@ -0,0 +1,75 @@
+module Wisebed
+
+  BASEURL = "http://wisebed.itm.uni-luebeck.de"
+  WSBASEURL = "ws://wisebed.itm.uni-luebeck.de"
+  APIVERSION = "/rest/2.3/"
+
+  class Client
+    require 'httparty'
+    include HTTParty
+    base_uri Wisebed::BASEURL+Wisebed::APIVERSION
+
+    def testbeds
+      request_from_wisebed("testbeds")["testbedMap"]
+    end
+    
+    def experimentconfiguration(url)
+      request_from_wisebed("experimentconfiguration?url=#{url}")
+    end
+
+    def request_from_wisebed(url_extension)
+      url_extension = "/#{url_extension}" unless url_extension[0] == "/"
+      #puts "debug: requesting "+self.class.base_uri+url_extension
+      if @cookie
+        headers = {'Cookie' => @cookie}
+      else
+        headers = {}
+      end      
+      res = self.class.get(url_extension, :headers => headers)
+      begin        
+        JSON.parse(res.body)
+      rescue JSON::ParserError => e
+        res.body
+      end
+    
+    end
+
+    
+    def post_to_wisebed(url_extension, data)
+      url_extension = "/#{url_extension}" unless url_extension[0] == "/"
+      #puts "debug: posting "+self.class.base_uri+url_extension
+      #puts "debug: with data: #{data.to_json}"
+      if @cookie
+        headers = {'Cookie' => @cookie}
+      else
+        headers = {}
+      end
+      headers.merge!({'Content-Type' => "application/json; charset=utf-8"})
+      res = self.class.post(url_extension, :body => data.to_json, :headers => headers)
+      @cookie = res.headers['Set-Cookie'] if res.headers['Set-Cookie']
+      begin        
+        JSON.parse(res.body)
+      rescue JSON::ParserError => e
+        res.body
+      end
+    end
+    
+    def delete_from_wisebed(url_extension, data)
+      url_extension = "/#{url_extension}" unless url_extension[0] == "/"
+      #puts "debug: deleting "+self.class.base_uri+url_extension
+      if @cookie
+        headers = {'Cookie' => @cookie}
+      else
+        headers = {}
+      end
+      headers.merge!({'Content-Type' => "application/json; charset=utf-8"})
+      res = self.class.delete(url_extension, :body => data.to_json, :headers => headers)
+      begin        
+        JSON.parse(res.body)
+      rescue JSON::ParserError => e
+        res.body
+      end
+    end
+    
+  end
+end

data/lib/wisebedclientruby/testbed.rb

@@ -0,0 +1,78 @@
+module Wisebed
+  
+  class Testbed < Client
+    
+    attr_reader :cookie, :credentials
+  
+    def initialize(testbed_id)
+      @cookie = ""
+      @id = testbed_id
+    end
+
+    def wise_ml(experiment_id = nil, json_or_xml = "json")
+      # TODO: handle xml
+      request_from_wisebed(@id+ "/experiments/" + (experiment_id ? experiment_id+"/" : "") + "network")
+    end
+
+    def login!(credentials=nil)
+      @credentials = credentials if credentials
+      raise "Cannot login: No credentials given!" if not @credentials
+      res = post_to_wisebed @id+"/login", @credentials
+      raise SecurityError, "could not log into #{@id}: wrong username/password" if res.include? "Authentication failed"
+      @secret_authentication_keys = res
+    end
+
+    def logout!
+      request_from_wisebed @id + "/logout"
+      @cookie = ""
+    end
+
+    def is_logged_in?
+      res = request_from_wisebed @id+"/isLoggedIn"
+      not res.include? "not logged in"
+    end
+  
+    def personal_reservations(from=nil, to=nil)
+      login! if @cookie.empty?
+      public_reservations(from, to, true)["reservations"]
+    end
+
+    def public_reservations(from=nil, to=nil, useronly=false)
+      # Time.iso8601 includes the timezone (+01:00), however XMLGreagorianCalendar does not parse this
+      res = request_from_wisebed @id+"/reservations?userOnly="+useronly.to_s+"&"+
+        (from ? ("from=" + from.iso8601_no_tz + "&") : "") + (to ? ("to="+to.iso8601_no_tz + "&") : "")
+      res.nil? ? "not logged in for personal reservations" : res["reservations"]
+    end
+    
+    def make_reservation(from, to, user_data, node_URNs)
+      content = {
+        "from"     => from.iso8601_no_tz,
+        "nodeURNs" => node_URNs,
+        "to"       => to.iso8601_no_tz(),
+        "userData" => user_data # description or something
+      }
+      res = post_to_wisebed(@id+"/reservations/create", content)
+      raise "Another reservation is in conflict with yours" if res.include? "Another reservation is in conflict with yours"
+      res
+    end
+    
+    def delete_reservation(reservation_hash)
+      delete_from_wisebed(@id+"/reservations", reservation_hash)
+    end
+    
+    def experiments(reservation_data=nil)
+      unless reservation_data
+        reservation_data = personal_reservations(Time.now, Time.now+(24*60*60)).last["data"]
+        reservation_data[0].delete("username")
+        reservation_data = {"reservations" => reservation_data}
+      end            
+      res = post_to_wisebed(@id+"/experiments", reservation_data)
+      res.split("/").last
+    end
+    
+    def flash(secret_keservation_key, flash_this_json)
+      post_to_wisebed(@id+"/experiments/"+secret_keservation_key+"/flash", flash_this_json)
+    end
+    
+  end
+end

data/lib/wisebedclientruby/version.rb

@@ -0,0 +1,3 @@
+module Wisebedclient
+    VERSION = "0.0.49"
+end

data/lib/wisebedclientruby/websocketclient.rb

@@ -0,0 +1,21 @@
+module Wisebed
+
+  class WebsocketClient < Client
+    require 'simpleblockingwebsocketclient'
+
+    def initialize(secret_exp_id)
+      @secret_exp_id = secret_exp_id
+    end
+    
+    def attach(&message_handler)      
+      @ws = WebSocket.new(Wisebed::WSBASEURL+"/ws/experiments/"+@secret_exp_id) { |msg| message_handler.call(msg) }
+    end
+    
+    def detach
+      puts "WebSocket detaching..."
+      @ws.close
+    end
+    
+  end
+   
+end

data/lib/wisebedclientruby.rb

@@ -0,0 +1,19 @@
+require 'json'
+require 'time' # for easy iso8601 format
+
+class Time
+  # WARN: polluting global namespaces here...
+  def iso8601_no_tz
+    # example: 2012-10-19T13:00:31
+    utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+  end
+end
+
+module Wisebed
+  class Client
+    # empty class definition to relief require *.rb from dependencies
+  end
+end
+
+
+Dir[File.dirname(__FILE__) + '/wisebedclientruby/*.rb'].each { |file| require file }

data/test/credentials_example.yml

@@ -0,0 +1,7 @@
+# copy this file to "credentials.yml" and fill your user/pass
+---
+  authenticationData:
+    - urnPrefix: ! 'urn:wisebed:uzl1:'
+      username: user.name@host.example
+      password: p4zzw0rd
+      

data/test/testapp.rb

@@ -0,0 +1,51 @@
+require File.expand_path('../../lib/wisebedclientruby.rb', __FILE__)
+#require 'YAML'
+
+# prints out all testbeds
+#puts Wisebed::Client.new.testbeds
+
+#example:
+# logindata = {
+#  "authenticationData" => [
+#    {
+#      "urnPrefix" => "urn:wisebed:uzl1:",
+#      "username" => "user.name@host.example",
+#      "password"=> "p4zzw0rd"
+#    }
+#  ]
+# }
+logindata = YAML.load_file(File.expand_path('../credentials.yml', __FILE__))
+
+tb = Wisebed::Testbed.new("uzl")
+#puts tb.wise_ml
+
+# gets reservations for Uni Luebeck Testbed
+puts "logging in"
+begin
+  tb.login!(logindata)
+rescue SecurityError => e
+  puts e.message
+  exit
+end
+all_nodes_for_packet_tracking = ["urn:wisebed:uzl1:0x211c","urn:wisebed:uzl1:0x2114","urn:wisebed:uzl1:0x2104","urn:wisebed:uzl1:0x2118","urn:wisebed:uzl1:0x2120","urn:wisebed:uzl1:0x2144","urn:wisebed:uzl1:0x2140","urn:wisebed:uzl1:0x2108","urn:wisebed:uzl1:0x2100","urn:wisebed:uzl1:0x210c","urn:wisebed:uzl1:0x2124","urn:wisebed:uzl1:0x2134","urn:wisebed:uzl1:0x2130","urn:wisebed:uzl1:0x212c","urn:wisebed:uzl1:0x2128","urn:wisebed:uzl1:0x2138","urn:wisebed:uzl1:0x213c","urn:wisebed:uzl1:0x2110"]
+exp_reservation = tb.make_reservation(Time.now, Time.now+(60), "test reservation from ruby client", all_nodes_for_packet_tracking)
+puts "reservation: #{exp_reservation}"
+experiment_id = tb.experiments(exp_reservation)
+puts "secret experiment_id: #{experiment_id}"
+flash_this_json = Wisebed::Client.new.experimentconfiguration("https://raw.github.com/itm/wisebed-experiments/master/packet-tracking/config.json")
+tb.flash(experiment_id,flash_this_json)
+wsc = Wisebed::WebsocketClient.new(experiment_id)
+
+begin
+  attach_time = Time.now
+  messages = []
+  puts "opening websocket (might take some time before all nodes are flashed!)"
+  wsc.attach {|msg| print "."; messages << msg}
+  while true do end
+rescue Interrupt
+ensure
+  detach_time = Time.now
+  wsc.detach
+end
+
+puts "received #{messages.length} messages via websocket in #{detach_time-attach_time}"

data/wisebedclientruby.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/wisebedclientruby/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marvin Frick"]
+  gem.email         = ["frick@informatik.uni-luebeck.de"]
+  gem.description   = %q{Ruby gem to access the wisebed API via REST and websockets}
+  gem.summary       = %q{Ruby gem to access the wisebed API via REST and websockets}
+  gem.homepage      = "https://github.com/MrMarvin/wisebedclient-ruby"
+  
+  gem.add_dependency 'simpleblockingwebsocketclient'
+  gem.add_dependency 'httparty'
+  
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "wisebedclientruby"
+  gem.require_paths = ["lib"]
+  gem.version       = Wisebedclient::VERSION
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: wisebedclientruby
+version: !ruby/object:Gem::Version
+  version: 0.0.49
+  prerelease: 
+platform: ruby
+authors:
+- Marvin Frick
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simpleblockingwebsocketclient
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: httparty
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: Ruby gem to access the wisebed API via REST and websockets
+email:
+- frick@informatik.uni-luebeck.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/wisebedclientruby.rb
+- lib/wisebedclientruby/client.rb
+- lib/wisebedclientruby/testbed.rb
+- lib/wisebedclientruby/version.rb
+- lib/wisebedclientruby/websocketclient.rb
+- test/credentials_example.yml
+- test/testapp.rb
+- wisebedclientruby.gemspec
+homepage: https://github.com/MrMarvin/wisebedclient-ruby
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby gem to access the wisebed API via REST and websockets
+test_files:
+- test/credentials_example.yml
+- test/testapp.rb