wowza_cloud 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75252e7830b78751e1f56b7683d9528d702ce785
+  data.tar.gz: c213409ce42330930f764f179399f921142f198d
+SHA512:
+  metadata.gz: ec276e2cf729a4487672052d79c3a754342f33afd56cddb2a31fa37c343702b121e14fa79db089bffcf3f5f29af514e5cc2d1c1244797deee3424cd9a38a514b
+  data.tar.gz: 1bbbcfcef0d4f728c87dfe40fb26f0f0a123d23f1a4a66ab77cfef2b362a9351dfddca2013bcb70a4340bee154371825789e98775bdf226db79555957661164e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+credentials.yml
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Steve Lewis
+
+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,138 @@
+# WowzaCloud 
+
+This gem is a dead-simple wrapper around the [Wowza Streaming Cloud
+API]('https://sandbox.cloud.wowza.com/apidocs/v1/'). The quickest way to get
+started with this library would be to glance over the Wowza documentation, then
+come back here and take a look at some of the examples below.
+
+Thus far, this only covers the live streams portion of the API, and is missing
+delete, create and update from that section. I'm planning on adding more
+functionality as I need it, but feel free to add a pull request if there's
+something missing here that you'd like to see.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wowza_cloud'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wowza_cloud
+
+## Usage
+
+### Configuration 
+
+Before you can use the Wowza Streaming Cloud API, you'll need to get an API key
+and an Access key from Wowza. You can do so through your account settings. Once
+you have them, you'll need to provide them to the gem, via a configuration
+block. For Rails users, your best bet is to create a `wowza-cloud.rb` file in
+your `config/initializers/` directory, then place something like the below in
+it:
+
+```ruby
+WowzaCloud.configure do |config|
+  yaml_path         = `path/to_file/containing/credentials.yml`
+  hsh               = YAML.load(File.read(yaml_path))
+  config.api_key    = hsh['api_key']
+  config.access_key = hsh['access_key']
+end
+```
+
+For non-Rails users, some variation of the above called somewhere before you
+start using the gem should do.
+
+### Getting a list of streams
+
+One of the more basic things you'll want to do is to get a list of all of your
+streams. Doing so is as simple as:
+
+```ruby
+streams = WowzaCloud::Stream.all
+```
+
+The above will return an array of `Wowza::Stream` objects, which you can use to
+manipulate individual streams.
+
+### Fetching a single stream
+
+If you have a specific stream you need to work with, you can pull it by itself,
+using it's ID:
+
+```ruby
+stream = WowzaCloud::Stream.get_stream('vxy4nprl')
+```
+
+The above will return a single instance of `Wowza::Stream` that you can use to
+manipulate that particular stream.
+
+### Working with a Stream
+
+The gem gives you a number of basic actions you can take for a particular
+stream.
+
+#### Checking Stream Status
+
+You can get the status, (also called state), of a stream by calling the
+`status` method on a WowzaCloud::Stream instance:
+
+```ruby
+stream = WowzaCloud::Stream.get_stream('vxy4nprl')
+stream.status # => 'started'
+```
+
+The method above will return a string representing the status of the stream,
+Possible return states are: starting, stopping, started, stopped, and
+resetting.
+
+#### Getting stream statistics 
+
+You can get a hash of stream-related statistics. This is important for
+monitoring and reporting purposes:
+
+```ruby
+stream = WowzaCloud::Stream.get_stream('vxy4nprl')
+stream.stats # => {...}
+```
+
+#### Starting, Stopping, and Resetting a Stream
+
+You can manipulate the state of a stream with a few simple commands. Each of
+the commands below return a string representing the state of the stream after
+your call was made. For instance, if you were to stop a running stream, the
+return value of the call would be "stopping":
+
+```ruby
+stream = WowzaCloud::Stream.get_stream('vxy4nprl')
+# Start a stream
+stream.start # => 'starting'
+# Reset a stream
+stream.reset # => 'resetting'
+# Stop a stream
+stream.stop # => 'stopping'
+```
+
+
+## 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/stlewis/wowza_cloud.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wowza_cloud"
+
+# 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
+#
+WowzaCloud.configure do |config|
+  yaml_path         = File.dirname(__FILE__) + '/../credentials.yml'
+  hsh               = YAML.load(File.read(yaml_path))
+  config.api_key    = hsh['api_key']
+  config.access_key = hsh['access_key']
+end
+
+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_cloud/client.rb

@@ -0,0 +1,14 @@
+require 'httparty'
+
+module WowzaCloud
+  class Client
+    include HTTParty
+
+    base_uri 'https://api-sandbox.cloud.wowza.com/api/v1' 
+    attr_reader :headers
+
+    def initialize(params = {})
+      @headers = {'wsc-api-key' => WowzaCloud.configuration.api_key, 'wsc-access-key' => WowzaCloud.configuration.access_key }
+    end
+  end
+end

data/lib/wowza_cloud/stream.rb

@@ -0,0 +1,80 @@
+module WowzaCloud
+  class Stream < WowzaCloud::Client
+		attr_accessor :aspect_ratio_height, :aspect_ratio_width, :billing_mode, :broadcast_location, :closed_caption_type, :delivery_method, :delivery_protocols, :delivery_protocol,
+									:delivery_type, :disable_authentication, :encoder, :hosted_page, :hosted_page_description, :hosted_page_logo_image, :hosted_page_sharing_icons,
+								  :hosted_page_title, :name, :password, :player_countdown, :player_countdown_at, :player_logo_image, :player_resposive, :player_type, 
+									:player_video_poster_image, :player_width, :recording, :remove_hosted_page_logo_image, :remove_player_video_poster_image, :source_url, 
+                  :transcoder_type, :use_stream_source, :username, :video_fallback, :api_key, :access_key, :id, :low_latency, :target_delivery_protocol, :source_connection_information,
+                  :streaming_server, :stream_name, :player_id, :player_embed_code
+
+
+    def self.all()
+      result = []
+      headers = {'wsc-api-key' => WowzaCloud.configuration.api_key, 'wsc-access-key' => WowzaCloud.configuration.access_key}
+      raw_result = get('/live_streams', headers: headers)
+      raw_result['live_streams'].each do |data|
+        result << WowzaCloud::Stream.new(data)
+      end
+      return result
+    end
+
+    def self.get_stream(stream_id)
+      headers    = {'wsc-api-key' => WowzaCloud.configuration.api_key, 'wsc-access-key' => WowzaCloud.configuration.access_key}
+      raw_result = get("/live_streams/#{stream_id}", headers: headers)
+      return WowzaCloud::Stream.new(raw_result[1].first)
+    end
+
+
+    def initialize(params = {})
+      super
+      params.each do |k, v|
+        instance_variable_set(:"@#{k}", v) if self.respond_to?("#{k}=")
+      end
+      if(conn_params = params['source_connection_information'])
+        self.streaming_server = conn_params['primary_server']
+        self.stream_name      = conn_params['stream_name']
+        self.disable_authentication = conn_params['disable_authentication']
+        self.username = conn_params['username']
+        self.password = conn_params['password']
+      end
+    end
+
+    #def destroy
+      #raw_response = self.class.delete("/live_streams/#{self.id}", headers: @headers) 
+      #return raw_response.code == 204
+    #end
+    
+    def status
+      raw_response = self.class.get("/live_streams/#{self.id}/state/", headers: @headers) 
+      return raw_response['live_stream']['state']
+    end
+
+    alias state status
+
+    def stats
+      raw_response = self.class.get("/live_streams/#{self.id}/stats", headers: @headers) 
+      return raw_response['live_stream']
+    end
+
+    def thumbnail
+      raw_response = self.class.get("/live_streams/#{self.id}/thumbnail_url", headers: @headers) 
+      return raw_response['live_stream']['thumbnail_url']
+    end
+
+    def start
+      raw_response = self.class.put("/live_streams/#{self.id}/start", headers: @headers) 
+      return raw_response['live_stream']['state']
+    end
+
+    def reset
+      raw_response = self.class.put("/live_streams/#{self.id}/reset", headers: @headers) 
+      return raw_response['live_stream']['state']
+    end
+
+    def stop
+      raw_response = self.class.put("/live_streams/#{self.id}/stop", headers: @headers) 
+      return raw_response['live_stream']['state']
+    end
+  
+  end
+end

data/lib/wowza_cloud/version.rb

@@ -0,0 +1,3 @@
+module WowzaCloud
+  VERSION = "0.2.0"
+end

data/lib/wowza_cloud.rb

@@ -0,0 +1,18 @@
+require "wowza_cloud/version"
+require "wowza_cloud/client"
+require "wowza_cloud/stream"
+
+module WowzaCloud
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new 
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :api_key, :access_key
+  end
+end

data/wowza_cloud.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wowza_cloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wowza_cloud"
+  spec.version       = WowzaCloud::VERSION
+  spec.authors       = ["Steve Lewis"]
+  spec.email         = ["steve@decodingsteve.com"]
+
+  spec.summary       = %q{Thin wrapper around the Wowza Cloud API}
+  spec.homepage      = "https://www.github.com/stlewis/wowza_cloud"
+  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'] = "https://rubygems.org"
+  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_dependency 'httparty'
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: wowza_cloud
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Steve Lewis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-10 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: 
+email:
+- steve@decodingsteve.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wowza_cloud.rb
+- lib/wowza_cloud/client.rb
+- lib/wowza_cloud/stream.rb
+- lib/wowza_cloud/version.rb
+- wowza_cloud.gemspec
+homepage: https://www.github.com/stlewis/wowza_cloud
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Thin wrapper around the Wowza Cloud API
+test_files: []