fms-admin-api 0.1 → 0.2

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode

data/Gemfile.lock

@@ -8,12 +8,15 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (3.1.3)
+    activesupport (3.2.3)
+      i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.2.6)
     colorize (0.5.8)
     crack (0.3.1)
-    multi_json (1.0.4)
+    i18n (0.6.0)
+    multi_json (1.3.5)
+    rake (0.9.2.2)
     webmock (1.7.8)
       addressable (~> 2.2, > 2.2.5)
       crack (>= 0.1.7)
@@ -23,4 +26,5 @@ PLATFORMS
 
 DEPENDENCIES
   fms-admin-api!
+  rake
   webmock

data/README.md

@@ -1,8 +1,13 @@
-Flash Media Server Administration API
+Flash Media Server Administration API ![Build status](https://secure.travis-ci.org/igorsobreira/fms-admin-api.png?branch=master)
 =====================================
 
 Command line interface to [Flash Media Server Administration API][fmsapi]:
 
+Instalation
+-----------
+
+    $ gem install fms-admin-api
+
 Usage
 -----
 
@@ -21,20 +26,37 @@ Ruby client usage
 
 You can use the ruby client directly on you code:
 
-    require 'fms'
+```ruby
+require 'fms'
 
-    client = FMS::Client.new(:host => 'fms.example.com',
-                             :auser => 'fms',
-                             :apswd => 'secret')  # you can use :port here, 1111 is default
+client = FMS::Client.new(:host => 'fms.example.com',
+                         :auser => 'fms',
+                         :apswd => 'secret')  # you can use :port here, 1111 is default
+```
 
 now just call any method defined in the [FMS Admin API][fmsapi]:
 
-    client.reload_app(:app_inst => 'live/cam1')
-    client.get_apps(:force => true, :verbose => true)
+```ruby
+client.reload_app(:app_inst => 'live/cam1')
+client.get_apps(:force => true, :verbose => true)
+```
 
 just note that the methods name and parameters are used with ruby_default_notation 
 instead of camelCase as documented.
 
+The return value from all api method calls is a `FMS::Response`, on which you may want to call `.to_xml` 
+to get a `REXML::Document` instance:
+
+```ruby
+require 'rexml/xpath'
+
+xml_resp = client.get_live_stream_stats(:app_inst => 'live', :stream => 'cam1').to_xml
+puts REXML::XPath.first(xml_resp, '/result/data/publisher/name').text
+
+```
+
+there is also a `to_s` method on `FMS::Response`.
+
 Take a look in the tests/ folder for more detailed specification.
 
 [fmsapi]: http://help.adobe.com/en_US/flashmediaserver/adminapi/WSa4cb07693d12388431df580a12a34991ebc-8000.html

data/fms-admin-api.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
-require "fms"
+require "fms/version"
 
 Gem::Specification.new do |s|
   s.name        = "fms-admin-api"
@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "activesupport"
   s.add_runtime_dependency "colorize"
   s.add_development_dependency "webmock"
+  s.add_development_dependency "rake"
 end

data/lib/fms/client.rb

@@ -1,4 +1,5 @@
 require 'net/http'
+require 'rexml/document'
 require 'active_support'
 
 module FMS
@@ -24,17 +25,17 @@ module FMS
       else
         params = {}
       end
-      do_get(meth, camelize_params(params))
+      Response.new do_get(meth, camelize_params(params)).strip
     end
 
-    private 
+    private
 
     def do_get(action, params = {})
       resp = Net::HTTP.get_response(build_url(action, params))
       raise NoMethodError, "#{action.inspect} is not a valid API method" unless resp.code == "200"
       resp.body
     end
-    
+
     def build_url(method, extra_params = {})
       url = URI("http://#{@host}:#{@port}/admin/#{method}")
       url.query = URI.encode_www_form(@base_params.merge(extra_params))
@@ -50,4 +51,21 @@ module FMS
     end
 
   end
+
+  class Response
+
+    def initialize(content)
+      @content = content
+    end
+
+    def to_xml
+      REXML::Document.new @content
+    end
+
+    def to_s
+      @content
+    end
+
+  end
+
 end

data/lib/fms/cmdline.rb

@@ -74,7 +74,7 @@ module FMS
           init_params = filter_init_params params
           begin
             c = FMS::Client.new(init_params)
-            Output.stdout c.send(method.to_sym, params)
+            Output.stdout c.send(method.to_sym, params).to_s
           rescue ArgumentError => error
             Output.stderr error.message.gsub(':','--')
           rescue NoMethodError => error

data/lib/fms/version.rb

@@ -1,3 +1,3 @@
 module FMS
-  VERSION = "0.1"
-end
+  VERSION = "0.2"
+end

data/tests/client_tests.rb

@@ -1,3 +1,4 @@
+require 'rexml/xpath'
 require 'tests_helper'
 
 class ClientTests < BaseTestCase
@@ -32,4 +33,52 @@ class ClientTests < BaseTestCase
     assert_requested(:get, "http://fms.example.com:1111/admin/reloadApp?appInst=live/cam1&apswd=fms&auser=fms")
   end
 
+  def test_should_return_response_as_xml
+    url = "http://fms.example.com:1111/admin/getLiveStreamStats?appInst=live&apswd=fms&auser=fms&stream=cam1"
+    stub_request(:get, url).to_return(:body => GET_LIVE_STREAM_STATS)
+
+    c = FMS::Client.new(:host => 'fms.example.com')
+    xml_resp = c.get_live_stream_stats(:app_inst => 'live', :stream => 'cam1').to_xml
+
+    assert_requested(:get, url)
+    assert_equal "cam1", REXML::XPath.first(xml_resp, '/result/data/publisher/name').text
+  end
+
+  def test_should_return_response_as_raw_string
+    url = "http://fms.example.com:1111/admin/getLiveStreamStats?appInst=live&apswd=fms&auser=fms&stream=cam1"
+    stub_request(:get, url).to_return(:body => GET_LIVE_STREAM_STATS)
+
+    c = FMS::Client.new(:host => 'fms.example.com')
+    str_resp = c.get_live_stream_stats(:app_inst => 'live', :stream => 'cam1').to_s
+
+    assert_requested(:get, url)
+    assert str_resp.include?('<name>cam1</name>')
+  end
+
 end
+
+# Stub responses
+
+GET_LIVE_STREAM_STATS = %Q{
+<?xml version="1.0" encoding="utf-8"?>
+<result>
+  <level>status</level>
+  <code>NetConnection.Call.Success</code>
+  <timestamp>Mon May 14 22:44:35 2012</timestamp>
+  <data>
+    <name>_defaultRoot_:_defaultVHost_:::_0</name>
+    <publisher>
+      <name>cam1</name>
+      <time>Mon May 14 22:43:39 2012</time>
+      <type>publishing</type>
+      <client>oAACAAAA</client>
+      <stream_id>ACACAAAA</stream_id>
+      <client_type>normal</client_type>
+      <diffserv_bits>0x0</diffserv_bits>
+      <publish_time>Mon May 14 22:43:39 2012</publish_time>
+    </publisher>
+    <subscribers>
+    </subscribers>
+  </data>
+</result>
+}

data/tests/cmdline_tests.rb

@@ -63,6 +63,16 @@ class CommandLineTests < BaseTestCase
     assert_help_message
   end
 
+  def test_should_return_response_as_string
+    url = "http://fms.example.com:1111/admin/getLiveStreams?appInst=live&apswd=fms&auser=fms"
+    stub_request(:get, url).to_return(:body => GET_LIVE_STREAMS)
+
+    run_command ["get_live_streams", "--host=fms.example.com", "--app_inst=live"]
+    assert_requested(:get, url)
+    assert_command_stdout_contains GET_LIVE_STREAMS.strip
+  end
+
+
   def run_command(argv)
     FMS::CmdLine.parse(argv)
   end
@@ -95,3 +105,17 @@ class CommandLineTests < BaseTestCase
   end
 
 end
+
+GET_LIVE_STREAMS = %Q{
+<?xml version="1.0" encoding="utf-8"?>
+<result>
+  <level>status</level>
+  <code>NetConnection.Call.Success</code>
+  <timestamp>Mon May 14 22:47:45 2012</timestamp>
+  <name>_defaultRoot_:_defaultVHost_:::_0</name>
+  <data>
+    <_0>stream1</_0>
+    <_1>stream1</_2>
+  </data>
+</result>
+}

metadata

@@ -1,11 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: fms-admin-api
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  version: "0.1"
+  prerelease: 
+  version: "0.2"
 platform: ruby
 authors: 
 - Igor Sobreira
@@ -13,8 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-11 00:00:00 -02:00
-default_executable: 
+date: 2012-05-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -24,8 +20,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id001
@@ -37,8 +31,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :runtime
   version_requirements: *id002
@@ -50,11 +42,20 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Ruby client and command line interface to Flash Media Server Administration API
 email: 
 - igor@igorsobreira.com
@@ -66,12 +67,14 @@ extra_rdoc_files: []
 
 files: 
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/fmsapi
 - fms-admin-api.gemspec
+- gems/fms-admin-api-0.1.gem
 - lib/fms.rb
 - lib/fms/client.rb
 - lib/fms/cmdline.rb
@@ -79,7 +82,6 @@ files:
 - tests/client_tests.rb
 - tests/cmdline_tests.rb
 - tests/tests_helper.rb
-has_rdoc: true
 homepage: http://github.com/igorsobreira/fms-admin-api
 licenses: []
 
@@ -93,21 +95,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: fms-admin-api
-rubygems_version: 1.3.7
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Ruby client and command line interface to Flash Media Server Administration API