wowza_rest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2ec144a5f9422b5be4d8b7d81bbaae75edd6ee06
+  data.tar.gz: 9d3f98a07919d7a6a90d9d589a3543d78b31b285
+SHA512:
+  metadata.gz: c9701aed6a548562fde18d45e1342b26eef6b419cef04d106cf566247644ed5ca5e92bf3bf7af38ef6914d3c778e802712b231ab6a8593b711264e763125c256
+  data.tar.gz: 20db8c2a418dfb1f1b109dcff7e754e3bc4ce4ed24f4528671904b7e61e3def0d6fa9326df9fcf9bdd4c3d30b10f70b8917f063eae39358e631bb3c708e6e13f

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# dotenv env files
+.env
+
+# rubocop files
+rubocop.html

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require: rubocop-rspec
+AllCops:
+  Exclude:
+    - 'wowza_rest.gemspec'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+Metrics/BlockLength:
+  Exclude:
+    - 'wowza_rest.gemspec'
+    - 'spec/**/*'
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 2.3.2
+  - 2.3.3
+before_install:
+  - gem install bundler
+  - gem update --system
+  - gem --version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at thatskan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hazem Taha
+
+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,44 @@
+# WowzaRest
+
+[![Build Status](https://travis-ci.org/hazemtaha/wowza-rest.svg?branch=master)](https://travis-ci.org/hazemtaha/wowza-rest)
+[![Code Climate](https://codeclimate.com/github/hazemtaha/wowza_rest/badges/gpa.svg)](https://codeclimate.com/github/hazemtaha/wowza_rest)
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/wowza_rest`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wowza_rest'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wowza_rest
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wowza_rest. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task test: :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dotenv/load'
+require 'wowza_rest'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wowza_rest.rb

@@ -0,0 +1,6 @@
+require 'wowza_rest/version'
+require 'wowza_rest/client'
+require 'json'
+
+module WowzaRest
+end

data/lib/wowza_rest/api.rb

@@ -0,0 +1,12 @@
+require 'wowza_rest/applications'
+require 'wowza_rest/instances'
+require 'wowza_rest/publishers'
+
+module WowzaRest
+  module API
+    # include all api modules here
+    include WowzaRest::Applications
+    include WowzaRest::Instances
+    include WowzaRest::Publishers
+  end
+end

data/lib/wowza_rest/applications.rb

@@ -0,0 +1,85 @@
+module WowzaRest
+  module Applications
+    def applications
+      connection.request(:get, '/applications').parsed_response
+    end
+
+    def get_application(app_name)
+      response = connection.request(:get, "/applications/#{app_name}")
+      response.response.code == '200' ? response.parsed_response : nil
+    end
+
+    def create_application(app_body, use_default_config = true)
+      unless app_body.include?(:name) && app_body.include?(:appType)
+        raise WowzaRest::Errors::MissingRequiredKeys,
+              '{ name } and/or { appType } Keys on application hash is required'
+      end
+      if use_default_config
+        app_body = default_application_config.merge(app_body)
+      end
+      connection.request(:post, '/applications', body: app_body.to_json)
+    end
+
+    def update_application(app_name, config)
+      apply_update_application_checks(app_name, config)
+      connection.request(:put, "/applications/#{app_name}",
+                         body: config.to_json)['success']
+    end
+
+    def delete_application(app_name)
+      unless app_name.is_a?(String)
+        raise WowzaRest::Errors::InvalidArgumentType,
+              "First argument expected to be String got #{app_name.class}"
+      end
+      connection.request(:delete, "/applications/#{app_name}")['success']
+    end
+
+    private
+
+    # rubocop:disable Metrics/LineLength
+    def apply_update_application_checks(app_name, config)
+      if !app_name.is_a?(String)
+        raise WowzaRest::Errors::InvalidArgumentType,
+              "First argument expected to be String got #{app_name.class} instead"
+      elsif !config.is_a?(Hash)
+        raise WowzaRest::Errors::InvalidArgumentType,
+              "Second argument expected to be String got #{config.class} instead"
+      elsif config.empty?
+        raise WowzaRest::Errors::InvalidArgument,
+              'Configuration hash must have at least one attribute'
+      end
+    end
+    # rubocop:enable Metrics/LineLength
+
+    # rubocop:disable Metrics/MethodLength
+    # rubocop:disable Metrics/LineLength
+    def default_application_config
+      {
+        clientStreamWriteAccess: '*',
+        httpCORSHeadersEnabled: true,
+        securityConfig: {
+          clientStreamWriteAccess: '*',
+          publishRequirePassword: true,
+          publishAuthenticationMethod: 'digest'
+        },
+        streamConfig: {
+          streamType: 'live',
+          liveStreamPacketizer: %w[cupertinostreamingpacketizer mpegdashstreamingpacketizer sanjosestreamingpacketizer smoothstreamingpacketizer]
+        },
+        modules: {
+          moduleList: [
+            {
+              'order' => 0,
+              'name' => 'ModuleCoreSecurity',
+              'description' => 'Core Security Module for Applications',
+              'class' => 'com.wowza.wms.security.ModuleCoreSecurity'
+            }
+          ]
+        }
+
+      }
+    end
+    # rubocop:enable Metrics/MethodLength
+    # rubocop:enable Metrics/LineLength
+  end
+end

data/lib/wowza_rest/client.rb

@@ -0,0 +1,52 @@
+require 'wowza_rest/api'
+require 'wowza_rest/connection'
+require 'wowza_rest/errors'
+
+module WowzaRest
+  class Client
+    include WowzaRest::API
+    include WowzaRest::Errors
+
+    attr_accessor :host, :port, :username, :password, :server_name,
+                  :api_version, :vhost
+    attr_reader :connection
+
+    def initialize(options = {})
+      check_required_attrs(options)
+      options.each do |key, value|
+        instance_variable_set("@#{key}", value)
+      end
+      @connection = WowzaRest::Connection.new(base_uri, @username, @password)
+    end
+
+    def server_name
+      @server_name || '_defaultServer_'
+    end
+
+    def api_version
+      @api_version || 'v2'
+    end
+
+    def vhost
+      @vhost || '_defaultVHost_'
+    end
+
+    def base_uri
+      "#{host}:#{port}/#{api_version}/servers/#{server_name}/vhosts/#{vhost}"
+    end
+
+    private
+
+    def check_required_attrs(options)
+      required_attrs = %i[host port username password]
+      missing_attrs = []
+      required_attrs.each do |attr|
+        missing_attrs << attr unless options.include? attr
+      end
+
+      return if missing_attrs.empty?
+      raise WowzaRest::Errors::MissingRequiredKeys,
+            "{ #{missing_attrs.join(' | ')} } missing"
+    end
+  end
+end

data/lib/wowza_rest/connection.rb

@@ -0,0 +1,18 @@
+require 'httparty'
+
+module WowzaRest
+  class Connection
+    include HTTParty
+
+    def initialize(uri, username, password)
+      self.class.base_uri(uri)
+      self.class.digest_auth(username, password)
+      self.class.headers('Accept' => 'application/json',
+                         'Content-Type' => 'application/json')
+    end
+
+    def request(method, path, options = {}, &block)
+      self.class.public_send(method, path, options, &block)
+    end
+  end
+end

data/lib/wowza_rest/errors.rb

@@ -0,0 +1,7 @@
+module WowzaRest
+  module Errors
+    class MissingRequiredKeys < StandardError; end
+    class InvalidArgumentType < StandardError; end
+    class InvalidArgument < StandardError; end
+  end
+end

data/lib/wowza_rest/instances.rb

@@ -0,0 +1,25 @@
+module WowzaRest
+  module Instances
+    def instances(app_name)
+      connection.request(
+        :get, "/applications/#{app_name}/instances"
+      )['instanceList']
+    end
+
+    def get_instance(app_name, instance_name = '_definst_')
+      response = connection.request(
+        :get, "/applications/#{app_name}/instances/#{instance_name}"
+      )
+      response.code == 200 ? response.parsed_response : nil
+    end
+
+    # rubocop:disable Metrics/LineLength
+    def get_incoming_stream_stats(app_name, stream_name, instance_name = '_definst_')
+      response = connection.request(
+        :get, "/applications/#{app_name}/instances/#{instance_name}/incomingstreams/#{stream_name}/monitoring/current"
+      )
+      response.code == 200 ? response.parsed_response : nil
+    end
+    # rubocop:enable Metrics/LineLength
+  end
+end

data/lib/wowza_rest/publishers.rb

@@ -0,0 +1,15 @@
+module WowzaRest
+  module Publishers
+    def create_publisher(name, password)
+      connection.request(
+        :post, "/publishers/#{name}", body: { password: password }.to_json
+      )['success']
+    end
+
+    def delete_publisher(name)
+      connection.request(
+        :delete, "/publishers/#{name}"
+      )['success']
+    end
+  end
+end

data/lib/wowza_rest/version.rb

@@ -0,0 +1,3 @@
+module WowzaRest
+  VERSION = '0.1.0'.freeze
+end

data/wowza_rest.gemspec

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wowza_rest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wowza_rest'
+  spec.version       = WowzaRest::VERSION
+  spec.authors       = ['Hazem Taha']
+  spec.email         = ['hazemt.93@gmail.com']
+
+  spec.summary       = 'Wowza REST API Wrapper Gem.'
+  spec.description   = 'Wowza REST API Wrapper Gem.'
+  spec.homepage      = 'https://github.com/hazemtaha/wowza-rest'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against ' \
+  #     'public gem pushes.'
+  # end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+
+  spec.add_dependency 'httparty'
+end

metadata

@@ -0,0 +1,205 @@
+--- !ruby/object:Gem::Specification
+name: wowza_rest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hazem Taha
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wowza REST API Wrapper Gem.
+email:
+- hazemt.93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wowza_rest.rb
+- lib/wowza_rest/api.rb
+- lib/wowza_rest/applications.rb
+- lib/wowza_rest/client.rb
+- lib/wowza_rest/connection.rb
+- lib/wowza_rest/errors.rb
+- lib/wowza_rest/instances.rb
+- lib/wowza_rest/publishers.rb
+- lib/wowza_rest/version.rb
+- wowza_rest.gemspec
+homepage: https://github.com/hazemtaha/wowza-rest
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Wowza REST API Wrapper Gem.
+test_files: []