adobe_connect_api 0.0.1.alpha

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Christian Rohrer
+
+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,29 @@
+# AdobeConnectApi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'adobe_connect_api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install adobe_connect_api
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/adobe_connect_api.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/adobe_connect_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Christian Rohrer"]
+  gem.email         = ["christian.rohrer@switch.ch"]
+  gem.description   = %q{Wrapper to the Adobe Connect API}
+  gem.summary       = %q{Wrapper to the Adobe Connect API written in Ruby}
+  gem.homepage      = ""
+
+  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          = "adobe_connect_api"
+  gem.require_paths = ["lib"]
+  gem.version       = AdobeConnectApi::VERSION
+end

data/lib/adobe_connect_api/filter_definition.rb

@@ -0,0 +1,128 @@
+# A filter defeinition can be added to some actions to filter the results
+# server-side. Example:
+# filter = AdobeConnectAPI::FilterDefinition.new
+# filter["sco-id"].greater_than 25
+# filter["date-created"] <= Time.now
+
+class AdobeConnectApi::FilterDefinition
+  attr_accessor :rows
+  attr_accessor :start
+  attr_accessor :is_member
+
+  def initialize
+    @fields = Hash.new
+  end
+
+  def [](field_name)
+    field = @fields[field_name]
+    if field == nil
+      field = AdobeConnectApi::FilterDefinition::Field.new(field_name)
+      @fields[field_name] = field
+    end
+    return field
+  end
+
+  def query
+    string = ""
+
+    if @rows != nil
+      string += "&filter-rows=" + "#{@rows}"
+    end
+    if @start != nil
+      string += "&filter-start=" + "#{@start}"
+    end
+    if @is_member != nil
+      if @is_member
+        string += "&filter-is-member=true"
+      else
+        string += "&filter-is-member=false"
+      end
+    end
+
+    @fields.each_pair do |name, f|
+      string += f.query
+    end
+    return string
+  end
+
+  class Field
+    def matches (value)
+      @matches = value
+    end
+
+    def greater_than (value)
+      @greater_than = value
+    end
+
+    def lesser_than (value)
+      @lesser_than = value
+    end
+
+    def like (value)
+      @like = value
+    end
+
+    def greater_than_or_equals (value)
+      @greater_than_or_equals = value
+    end
+
+    def lesser_than_or_equals (value)
+      @lesser_than_or_equals = value
+    end
+
+    def excluding (value)
+      @excluding = value
+    end
+
+    def == (value)
+      @matches = value
+    end
+
+    def > (value)
+      @greater_than = value
+    end
+
+    def < (value)
+      @lesser_than = value
+    end
+
+    def >= (value)
+      @greater_than_or_equals = value
+    end
+
+    def <= (value)
+      @lesser_than_or_equals = value
+    end
+
+    def initialize (name)
+      @name = name
+    end
+
+    def query
+      query = ""
+      if @matches != nil
+        query += "&filter-" + @name + "=" + CGI.escape("#{@matches}")
+      end
+      if @greater_than != nil
+        query += "&filter-gt-" + @name + "=" + CGI.escape("#{@greater_than}")
+      end
+      if @lesser_than != nil
+        query += "&filter-lt-" + @name + "=" + CGI.escape("#{@lesser_than}")
+      end
+      if @like != nil
+        query += "&filter-like-" + @name + "=" + CGI.escape("#{@like}")
+      end
+      if @greater_than_or_equals != nil
+        query += "&filter-gte-" + @name + "=" + CGI.escape("#{@greater_than_or_equals}")
+      end
+      if @lesser_than_or_equals != nil
+        query += "&filter-lte-" + @name + "=" + CGI.escape("#{@lesser_than_or_equals}")
+      end
+      if @excluding != nil
+        query += "&filter-out-" + @name + "=" + CGI.escape("#{@excluding}")
+      end
+
+      return query
+    end
+  end
+end

data/lib/adobe_connect_api/result.rb

@@ -0,0 +1,29 @@
+#Result objects are returned by some of the convenience methods to make the
+#resulting values more accessible. The status attribute returns the status/@code field
+#and the rows attribute is an array of hashes with the values of the resulting
+#rows (or quotas etc.)
+
+class Result
+
+  attr_reader :status
+  attr_reader :rows
+
+  def initialize (status, rows)
+    @status = status
+    @rows = []
+    if rows != nil
+      rows.each do |row|
+        hash = {}
+        row.each_pair do |name, val|
+          if val.is_a?(Array)
+            hash[name] = val[0]
+          else
+            hash[name] = val
+          end
+        end
+        @rows.push hash
+      end
+    end
+  end
+
+end

data/lib/adobe_connect_api/sort_definition.rb

@@ -0,0 +1,36 @@
+#A SortDefinition can be used to sort the result server-side. It is not
+#possible to sort according to more than two fields
+#Example:
+#sort = AdobeConnectAPI::SortDefinition.new
+#sort.desc "date-created"
+#sort.asc "sco-id"
+
+class AdobeConnectApi::SortDefinition
+
+  def asc (field)
+    if @sort1 != nil
+      @sort1 = {"field" => field, "order" => "asc"}
+    elsif @sort2 != nil
+      @sort2 = {"field" => field, "order" => "asc"}
+    end
+  end
+
+  def desc (field)
+    if @sort1 != nil
+      @sort1 = {"field" => field, "order" => "desc"}
+    elsif @sort2 != nil
+      @sort2 = {"field" => field, "order" => "desc"}
+    end
+  end
+
+  def query
+    if (@sort1 != nil && @sort2 == nil)
+      return "&sort-#{@sort1[:field]}=#{@sort1[:direction]}"
+    elsif (@sort1 != nil && @sort2 != nil)
+      return "&sort1-#{@sort1[:field]}=#{@sort1[:direction]}&sort2-#{@sort2[:field]}=#{@sort2[:direction]}}"
+    else
+      return ""
+    end
+  end
+
+end

data/lib/adobe_connect_api/version.rb

@@ -0,0 +1,3 @@
+module AdobeConnectApi
+  VERSION = "0.0.1.alpha"
+end

data/lib/adobe_connect_api.rb

@@ -0,0 +1,252 @@
+
+# Copyright (c) 2010 SWITCH - Serving Swiss Universities
+# Author: Mischael Schill <me@mschill.ch>
+#         Martin Kos <martin@kos.li>
+#         Christian Rohrer <christian.rohrer@switch.ch>
+# $Id$
+
+require 'rubygems'
+# require "net/http"
+require "net/https"
+require "uri"
+require 'xmlsimple'
+require "cgi"
+#require 'logger'
+
+require "adobe_connect_api/version"
+require 'adobe_connect_api/filter_definition'
+require 'adobe_connect_api/sort_definition'
+require 'adobe_connect_api/result'
+
+
+# This class is a simple utility to acces the adobe connect api. Before
+# making any queries use the login-method
+# There are dedicated methods for some of the actions of the api and a generic
+# "query"-method for all the others.
+# All the actions are defined in the Adobe Connect Pro API documentation
+# some of the actions are accepting filter- and/or sorting-definitions.
+
+# module AdobeConnectApi
+class AdobeConnectAPI
+
+  attr :url
+  attr :pointconfig
+
+  #The URL is the base URL of the Connect-Server, without the trailing slash
+  def initialize (url = nil)
+    #TODO ChR: Get this from the application config/initializer/abobe_connect_api.rb
+    @pointconfig = YAML::load_file("#{Rails.root}/config/config.breeze.yml")[Rails.env]
+    if (url == nil)
+      @url = pointconfig["url"]
+    else
+      @url = url
+    end
+  end
+
+  #makes the login to the server
+  def login (login = nil, password = nil, account_id=nil, external_auth=nil, domain=nil)
+    if(login == nil)
+       login = pointconfig["username"]
+    end
+
+    if(password == nil)
+       password = pointconfig["password"]
+    end
+
+    res = query("login",
+      "login" => login,
+      "password" => password,
+      "account-id" => account_id,
+      "external-auth" => external_auth,
+      "domain" => domain)
+    cookies = res.response["set-cookie"]
+    cookies.split(";").each{|s|
+      array = s.split("=")
+      if array[0] == "BREEZESESSION"
+        @sessionid = array[1]
+      end
+    }
+    puts "ACS: Logged in"
+    return res.body
+  end
+
+  #makes a logout and removes the cookie
+  def logout
+    res = query("logout").body
+    @sessionid = nil
+    puts "ACS: Logged out"
+    return res
+  end
+
+  #Returns all defined quotas (untested)
+  def report_quotas
+    res = query("report-quota")
+    data = XmlSimple.xml_in(res.body)
+    rows = []
+    if data["report-quotas"]
+      data["report-quotas"].each do |trans|
+        rows = trans["quota"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], rows)
+  end
+
+  #returns all the session of a meeting as a result object
+  def report_meeting_sessions(meeting_id, filter = nil, sort = nil)
+    res = query("report-meeting-sessions", "sco-id" => meeting_id, "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    rows = []
+    if data["report-meeting-sessions"]
+      data["report-meeting-sessions"].each do |trans|
+        rows = trans["row"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], rows)
+  end
+
+  #returns all groups
+  def report_groups(filter = nil, sort = nil)
+    puts "ACS: Query: Groups"
+    res = query("principal-list", "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    groups = []
+    if data["principal-list"]
+      data["principal-list"].each do |trans|
+        groups = trans["principal"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], groups)
+
+  end
+
+  #returns all groups
+  def report_memberships(group_id, filter = nil, sort = nil)
+    puts "ACS: Query: Group Memberships"
+    res = query("principal-list", "group-id" => group_id, "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    members = []
+    if data["principal-list"]
+      data["principal-list"].each do |trans|
+        members = trans["principal"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], members)
+
+  end
+
+  #returns SCO contents of sco-id
+  def sco_contents(sco_id, filter = nil, sort = nil)
+    res = query("sco-contents", "sco-id" => sco_id, "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    scos = []
+#    puts YAML::dump(data)
+    if data["scos"]
+      data["scos"].each do |trans|
+#        puts YAML::dump(trans)
+#        puts "-------"
+        scos = trans["sco"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], scos)
+  end
+
+  #returns SCO information of sco-id
+  def sco_info(sco_id)
+    res = query("sco-info", "sco-id" => sco_id)
+    data = XmlSimple.xml_in(res.body)
+    if data["sco"][0]
+      return data["sco"][0]
+    end
+  end
+
+  #returns permission information of an sco-id
+  def permissions_info(sco_id, filter = nil)
+    res = query("permissions-info", "acl-id" => sco_id, "filter" => filter)
+    data = XmlSimple.xml_in(res.body)
+    puts YAML::dump(data)
+#    if data["sco"][0]
+#      return data["sco"][0]
+#    end
+  end
+
+
+  #returns all SCOs as a result object
+  def report_bulk_objects(filter = nil, sort = nil)
+    res = query("report-bulk-objects", "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    rows = []
+    if data["report-bulk-objects"]
+      data["report-bulk-objects"].each do |trans|
+        rows = trans["row"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], rows)
+  end
+
+  #returns all users as a result object
+  def report_bulk_users(custom_fields = false, filter = nil, sort = nil)
+    res = query("report-bulk-users", "custom-fields" => custom_fields, "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    rows = []
+    if data["report-bulk-users"]
+      data["report-bulk-users"].each do |trans|
+        rows = trans["row"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], rows)
+  end
+
+  #returns all transactions as a result object
+  def report_bulk_consolidated_transactions(filter = nil, sort = nil)
+    res = query("report-bulk-consolidated-transactions", "filter" => filter, "sort" => sort)
+    data = XmlSimple.xml_in(res.body)
+    rows = []
+    if data["report-bulk-consolidated-transactions"]
+      data["report-bulk-consolidated-transactions"].each do |trans|
+        rows = trans["row"]
+      end
+    end
+    return AdobeConnectAPI::Result.new(data["status"][0]["code"], rows)
+  end
+
+  #sends a query to the server and returns the http response. Parameters,
+  #filter- and sort-definitions can be added. The filter as "filter" => ... and
+  #the sort as "sort" => ...
+  def query(action, hash = {})
+    # uri = URI.parse("https://130.59.10.31")
+    # http = Net::HTTP.new(uri.host, uri.port)
+    # http.use_ssl = true
+    # http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    #
+    # request = Net::HTTP::Get.new(uri.request_uri)
+    #
+    # response = http.request(request)
+    # response.body
+    # response.status
+    # response["header-here"] # All headers are lowercase
+    uri = URI.parse(@url + "/api/xml?action=#{action}")
+    hash.each_pair do |key, val|
+      if val
+        if key == "filter" or key == "sort"
+          uri.query += val.query
+        else
+          uri.query += "&" + key + "=" + CGI::escape("#{val}")
+        end
+      end
+    end
+    http = Net::HTTP.new(uri.host, uri.port)
+    if uri.scheme == "https"
+       http.use_ssl=true
+       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+    request = Net::HTTP::Get.new(uri.request_uri)
+    # logger = Logger.new('log/development.log')
+    # logger.info(url.path + "?" + url.query)
+    if @sessionid
+      request.add_field("Cookie", "BREEZESESSION="+@sessionid)
+    end
+    response = http.request(request)
+    return response
+  end
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: adobe_connect_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+  prerelease: 6
+platform: ruby
+authors:
+- Christian Rohrer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-03 00:00:00.000000000 Z
+dependencies: []
+description: Wrapper to the Adobe Connect API
+email:
+- christian.rohrer@switch.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- adobe_connect_api.gemspec
+- lib/adobe_connect_api.rb
+- lib/adobe_connect_api/filter_definition.rb
+- lib/adobe_connect_api/result.rb
+- lib/adobe_connect_api/sort_definition.rb
+- lib/adobe_connect_api/version.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2391563684590532941
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Wrapper to the Adobe Connect API written in Ruby
+test_files: []