fms-admin-api 0.1

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@fms-admin-api"
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficicent compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s ".rvm/hooks/after_use" ]]
+  then
+    . ".rvm/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create  "$environment_id"
+  then
+    echo "Failed to create RVM environment ''."
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]] ; then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+#
+# If you use bundler and would like to run bundle each time you enter the
+# directory, you can uncomment the following code.
+#
+# export PATH="./bin:$PATH"
+#
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    fms-admin-api (0.1)
+      activesupport
+      colorize
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    addressable (2.2.6)
+    colorize (0.5.8)
+    crack (0.3.1)
+    multi_json (1.0.4)
+    webmock (1.7.8)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fms-admin-api!
+  webmock

data/README.md

@@ -0,0 +1,40 @@
+Flash Media Server Administration API
+=====================================
+
+Command line interface to [Flash Media Server Administration API][fmsapi]:
+
+Usage
+-----
+
+    $ fmsapi <method_name> --host=<fms host> [other params]
+
+Just pick a method from the [documentation][fmsapi] and replace convention 
+from camelCase to underscore_case (same for the parameters)
+
+Example:
+
+    $ fmsapi reload_app --host=fms.example.com --auser=fms --apswd=secret --app_inst=live
+
+
+Ruby client usage
+-----------------
+
+You can use the ruby client directly on you code:
+
+    require 'fms'
+
+    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)
+
+just note that the methods name and parameters are used with ruby_default_notation 
+instead of camelCase as documented.
+
+Take a look in the tests/ folder for more detailed specification.
+
+[fmsapi]: http://help.adobe.com/en_US/flashmediaserver/adminapi/WSa4cb07693d12388431df580a12a34991ebc-8000.html

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  puts 'running tests'
+  t.libs << 'lib'
+  t.libs << 'tests'
+  t.test_files = FileList['tests/*_tests.rb', 'tests/*_test.rb']
+  t.verbose = true
+end

data/bin/fmsapi

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'fms'
+
+FMS::CmdLine.parse(ARGV)

data/fms-admin-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "fms"
+
+Gem::Specification.new do |s|
+  s.name        = "fms-admin-api"
+  s.version     = FMS::VERSION
+  s.authors     = ["Igor Sobreira"]
+  s.email       = ["igor@igorsobreira.com"]
+  s.homepage    = "http://github.com/igorsobreira/fms-admin-api"
+  s.summary     = %q{Ruby client and command line interface to Flash Media Server Administration API}
+  s.description = %q{Ruby client and command line interface to Flash Media Server Administration API}
+
+  s.rubyforge_project = "fms-admin-api"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "activesupport"
+  s.add_runtime_dependency "colorize"
+  s.add_development_dependency "webmock"
+end

data/lib/fms.rb

@@ -0,0 +1,7 @@
+require 'fms/client'
+require 'fms/cmdline'
+require 'fms/version'
+
+module FMS
+  Docs = "http://help.adobe.com/en_US/flashmediaserver/adminapi/WSa4cb07693d12388431df580a12a34991ebc-8000.html"
+end

data/lib/fms/client.rb

@@ -0,0 +1,53 @@
+require 'net/http'
+require 'active_support'
+
+module FMS
+  class Client
+
+    attr_reader :host, :port, :base_params
+
+    def initialize(options = {})
+      raise ArgumentError, ":host option is required" unless options.include? :host
+
+      defaults = {:auser => 'fms', :apswd => 'fms', :port => 1111}
+      defaults.update(options)
+
+      @host = defaults[:host]
+      @port = defaults[:port]
+      @base_params = {:auser => defaults[:auser], :apswd => defaults[:apswd]}
+    end
+
+    def method_missing(meth, *args)
+      meth = ActiveSupport::Inflector.camelize(meth.to_s, false)
+      if args.length == 1
+        params = args[0]
+      else
+        params = {}
+      end
+      do_get(meth, camelize_params(params))
+    end
+
+    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))
+      url
+    end
+
+    def camelize_params(params)
+      cam_params = {}
+      params.each_pair do |key, value|
+        cam_params[ActiveSupport::Inflector.camelize(key.to_s, false)] = value
+      end
+      cam_params
+    end
+
+  end
+end

data/lib/fms/cmdline.rb

@@ -0,0 +1,142 @@
+require 'colorize'
+
+module FMS
+
+  module CmdLine
+    class << self
+      
+      def parse(argv)
+        method = MethodParser.parse(argv)
+        params = ParamsParser.parse(argv)
+        call_if_possible method, params
+        Output.flush
+      end
+
+      def call_if_possible(method, params)
+        return Output.help_message if help_method? method
+
+        if method and params
+          call_method method, params
+        else
+          Output.invalid_command
+          Output.help_message
+        end
+      end
+
+      def call_method(method, params)
+        MethodCaller.call method, params
+      end
+
+      def help_method?(method)
+        method == "help"
+      end
+
+    end
+
+    module MethodParser
+      class << self
+ 
+        def parse(argv)
+          method = argv.shift
+          return nil unless method
+          return nil unless /^[a-z_]+$/.match(method)
+          method
+        end
+
+      end
+    end
+
+    module ParamsParser
+      class << self
+        
+        def parse(argv)
+          params = {}
+          argv.each do |rawparam|
+            param = parse_rawparam rawparam
+            params.update(param) if param
+          end
+          return nil if params.length != argv.length
+          params
+        end
+
+        def parse_rawparam(raw)
+          m = /--(.*)=(.*)/.match(raw)
+          {m[1].to_sym => m[2]} if m
+        end
+
+      end
+    end
+
+    module MethodCaller
+      class << self
+
+        def call(method, params)
+          init_params = filter_init_params params
+          begin
+            c = FMS::Client.new(init_params)
+            Output.stdout c.send(method.to_sym, params)
+          rescue ArgumentError => error
+            Output.stderr error.message.gsub(':','--')
+          rescue NoMethodError => error
+            Output.stderr error.message
+          end
+        end
+
+        def filter_init_params(params)
+          init_params = {}
+          params.each_pair do |key,value| 
+            if init_param? key
+              init_params[key] = value
+              params.delete key
+            end
+          end
+          init_params
+        end
+        
+        def init_param?(param)
+          [:host, :port, :auser, :apswd].include? param
+        end
+
+      end
+    end
+
+    module Output
+      class << self
+        
+        @@buffer_stdout = []
+        @@buffer_stderr = []
+
+        def invalid_command
+          stderr "Invalid command format."
+        end
+
+        def help_message
+          stdout "\nCommand line interface to Flash Media Server Administration API"
+          stdout "\nUsage:"
+          stdout "\n $ fmsapi <method_name> --host=<fms host> [other params]"
+          stdout "\nJust pick a method from the documentation and replace convention "
+          stdout "from camelCase to underscore_case (same for the parameters)"
+          stdout "\nExample:"
+          stdout "\n $ fmsapi reload_app --host=fms.example.com --auser=fms --apswd=secret --app_inst=live"
+          stdout "\nFMS Admin API documentation: #{FMS::Docs}"
+          stdout "This project documentation: http://github.com/igorsobreira/fms-admin-api"
+        end
+
+        def stdout(out)
+          @@buffer_stdout << out
+        end
+
+        def stderr(err)
+          @@buffer_stderr << err
+        end
+
+        def flush
+          puts @@buffer_stderr.join("\n").red
+          puts @@buffer_stdout.join("\n")
+        end
+
+      end
+    end
+
+  end
+end

data/lib/fms/version.rb

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

data/tests/client_tests.rb

@@ -0,0 +1,35 @@
+require 'tests_helper'
+
+class ClientTests < BaseTestCase
+
+  def test_should_require_host_parameter_and_provide_defaults_to_others
+    c = FMS::Client.new(:host => "fms.example.com")
+    assert_equal("fms.example.com", c.host)
+    assert_equal(1111, c.port)
+    assert_equal({:auser => "fms", :apswd => "fms"}, c.base_params)
+  end
+
+  def test_should_raise_error_if_host_not_provided
+    assert_raises(ArgumentError) { FMS::Client.new }
+  end
+
+  def test_should_build_url_based_on_method_name
+    c = FMS::Client.new(:host => "fms.example.com",
+                        :apswd => "secret")
+    c.get_apps
+    assert_requested(:get, "http://fms.example.com:1111/admin/getApps?apswd=secret&auser=fms")
+  end
+
+  def test_should_use_params_to_build_url
+    c = FMS::Client.new(:host => 'fms.example.com')
+    c.get_apps(:force => true, :verbose => false)
+    assert_requested(:get, "http://fms.example.com:1111/admin/getApps?apswd=fms&auser=fms&force=true&verbose=false")
+  end
+
+  def test_should_camelize_parameters_to_build_url
+    c = FMS::Client.new(:host => 'fms.example.com')
+    c.reload_app(:app_inst => 'live/cam1')
+    assert_requested(:get, "http://fms.example.com:1111/admin/reloadApp?appInst=live/cam1&apswd=fms&auser=fms")
+  end
+
+end

data/tests/cmdline_tests.rb

@@ -0,0 +1,97 @@
+require 'tests_helper'
+
+module FMS::CmdLine::Output
+  def self.flush
+    [@@buffer_stdout, @@buffer_stderr]
+  end
+
+  def self.clear
+    @@buffer_stderr = []
+    @@buffer_stdout = []
+  end
+end
+
+class CommandLineTests < BaseTestCase
+
+  # TODO: test mocked outputs
+
+  def teardown
+    super
+    FMS::CmdLine::Output.clear
+  end
+
+  def test_should_call_method_based_on_command
+    run_command ['get_apps', '--host=fms.example.com']
+    assert_requested(:get, "http://fms.example.com:1111/admin/getApps?apswd=fms&auser=fms")
+  end
+
+  def test_should_call_method_passing_command_parameters
+    run_command ['get_apps', '--host=fms.example.com', '--force=true']
+    assert_requested(:get, "http://fms.example.com:1111/admin/getApps?apswd=fms&auser=fms&force=true")
+  end
+
+  def test_should_require_host_parameter
+    run_command ['get_apps']
+    assert_not_requested(:get, /.*/)
+    assert_command_stderr_contains("--host option is required")
+  end
+
+  def test_should_show_help_if_invalid_command
+    stub_request_to_404 "http://fms.nonexistent.com:1111/admin/invalidCommand?apswd=fms&auser=fms"
+    run_command ["invalid_command", "--host=fms.nonexistent.com"]
+    assert_requested(:get, "http://fms.nonexistent.com:1111/admin/invalidCommand?apswd=fms&auser=fms")
+    assert_command_stderr_contains('"invalidCommand" is not a valid API method')
+  end
+
+  def test_show_error_msg_if_no_command_nor_options_provided
+    run_command []
+    assert_invalid_command
+  end
+
+  def test_show_error_msg_if_options_informed_before_command
+    run_command ["--options-first=foo", "get_apps"]
+    assert_invalid_command
+  end
+
+  def test_options_should_use_equal_sign_to_define_its_value
+    run_command ["get_apps", "--force", "true"]
+    assert_invalid_command
+  end
+
+  def test_help_command_should_show_usage_format
+    run_command ["help"]
+    assert_help_message
+  end
+
+  def run_command(argv)
+    FMS::CmdLine.parse(argv)
+  end
+
+  def stub_request_to_404(url)
+    WebMock.reset!
+    stub_request(:get, url).to_return(:status => 404)
+  end
+
+  def assert_command_stderr_contains(msg)
+    cmd_stdout, cmd_stderr = FMS::CmdLine::Output.flush
+    assert_includes(cmd_stderr, msg)
+  end
+
+  def assert_command_stdout_contains(msg)
+    cmd_stdout, cmd_stderr = FMS::CmdLine::Output.flush
+    assert_includes(cmd_stdout, msg)
+  end
+
+  def assert_invalid_command
+    assert_not_requested(:get, /.*/)
+    assert_command_stderr_contains("Invalid command format.")
+    assert_help_message
+  end
+
+  def assert_help_message
+    assert_not_requested(:get, /.*/)
+    assert_command_stdout_contains("\nUsage:")
+    assert_command_stdout_contains("\nExample:")
+  end
+
+end

data/tests/tests_helper.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'webmock'
+
+require 'fms'
+
+class BaseTestCase < MiniTest::Unit::TestCase
+  include WebMock::API
+
+  def setup
+    stub_request(:get, /.*/)
+  end
+
+  def teardown
+    WebMock.reset!
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: fms-admin-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Igor Sobreira
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-11 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: colorize
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Ruby client and command line interface to Flash Media Server Administration API
+email: 
+- igor@igorsobreira.com
+executables: 
+- fmsapi
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/fmsapi
+- fms-admin-api.gemspec
+- lib/fms.rb
+- lib/fms/client.rb
+- lib/fms/cmdline.rb
+- lib/fms/version.rb
+- tests/client_tests.rb
+- tests/cmdline_tests.rb
+- tests/tests_helper.rb
+has_rdoc: true
+homepage: http://github.com/igorsobreira/fms-admin-api
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+signing_key: 
+specification_version: 3
+summary: Ruby client and command line interface to Flash Media Server Administration API
+test_files: []
+