wowza_cloud 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2db8acbb5827fdcb882cab2c42262c46b3ebaeb0
-  data.tar.gz: 0750eb7cc1c9a655578d852e2ff18478902f72db
+  metadata.gz: f93e795103b33a9131e0e72cc030d9c46243545e
+  data.tar.gz: c0de4989ea379eb0439d61297e51a44366268d61
 SHA512:
-  metadata.gz: 6879358fb5ef38d0ac404b2dff544f3c2e4337f417cb23c04a3757186c1d10f2fb92697f3a1f713f5bd14a5c8ca22e6e6c7ab7db331d00bffac8003b4f3fc8e5
-  data.tar.gz: ef30e3bb176a409a0c40ef16f3d6a73a43ec7e7a3733d0001e6955473cd0807cfcae6410ef25ea3baac56e1f8755a78b2948516b5850ca84e93cc65b69de7b94
+  metadata.gz: 0177b46405a10f260ce78f16088957e5a96367d6774e51ab8f74eea5dc630c4a2ae7c051e7db7b1092febe1ae774dec8f301063b82388d9126d57cd0991c2fc8
+  data.tar.gz: cd5e277d96478db8c75149813fb412e77ebe33ac010d5fd65f8b77c5e2ef9388e05ea80347cba4d928170b66c533784d64375c987af4a844ceffe6497a9b3436

data/README.md

@@ -5,10 +5,12 @@ 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.
+As it stands right now, I've only implemented the endpoints that I have an
+active need for. That means that the feature of the API that _you're_ looking
+for may not be here. If that's the case, you've got two options. First, you
+could try shooting me a message and asking me to build the feature in. If I've
+got time, I'll take care of it for you. Alternatively, I'm all for accepting
+pull requests, so feel free to add the feature for yourself.
 
 ## Installation
 
@@ -49,6 +51,7 @@ 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
@@ -78,6 +81,19 @@ manipulate that particular stream.
 The gem gives you a number of basic actions you can take for a particular
 stream.
 
+### Accessing basic attributes
+
+All of the return values for a call to `/live_streams/{id}` are made available as
+attributes on the `WowzaCloud::Stream` object. So, for instance, if you want to
+get the broadcast location for a given stream, you can call:
+
+```ruby
+stream.broadcast_location # => "us_west_california"
+```
+
+This will get you back the string value that corresponds to that attribute from
+the API. This works for all of the keys in the return JSON from the API call.
+
 #### Checking Stream Status
 
 You can get the status, (also called state), of a stream by calling the
@@ -115,10 +131,96 @@ stream = WowzaCloud::Stream.get_stream('vxy4nprl')
 stream.start # => 'starting'
 # Reset a stream
 stream.reset # => 'resetting'
-# Stop a stream
-stream.stop # => 'stopping'
+# Stop a stream 
+stream.stop # => 'stopping' 
+```
+
+### Working With Schedules
+
+Once again, I'd encourage you to refer to the official Wowza API documentation
+for details about the schedule API. As of this writing, this gem only supports
+retrieving schedule details and enabling or disabling schedules. Editing,
+adding and removing are all unsupported at the moment, so you'll still have to
+do that through the Wowza Cloud interface.
+
+In any case, you can retrieve and work with schedules in  much the same way
+that you work with streams:
+
+#### Getting a list of schedules
+
+You can get a complete list of all your configured schedules like this:
+
+```ruby
+schedules = WowzaCloud::Schedule.all
+```
+
+This will return an array of `WowzaCloud::Schedule` instances. 
+
+### Accessing basic attributes
+
+All of the return values for a call to `/schedules/{id}` are made available as
+attributes on the `WowzaCloud::Schedule` object. So, for instance, if you want
+to get the list of days the schedule runs for, you can call:
+
+```ruby
+schedule.recurrence_data # => "sunday,monday,tuesday,wednesday,thursday,friday,saturday"
 ```
 
+This will get you back the string value that corresponds to that attribute from
+the API. This works for all of the keys in the return JSON from the API call.
+
+### Fetching a single schedule
+
+Once you have the ID of the schedule you'd like to retrieve, you can fetch it's
+data with the following:
+
+```ruby
+schedule = WowzaCloud::Schedule.get_schedule('myscheduleid')
+```
+
+This will return an instance of `WowzaCloud::Schedule` that you can then work
+with as detailed below.
+
+### Enabling a schedule
+
+You can enable a particular schedule by calling the `enable` method:
+
+```ruby
+schedule.enable # => 'enabled'
+```
+
+The return value of the enable call is the current status of the stream,
+(should be "enabled").
+
+### Disabling a schedule
+
+Conversely, if you want to disable a schedule:
+
+```ruby
+schedule.disable # => 'disabled'
+```
+
+The return value is the same as for enabling -- the current status of the
+schedule.
+
+### Getting schedule status
+
+If you want to know whether a schedule is enabled or disabled, you can find out
+by calling the `status` instance method:
+
+```ruby
+schedule.status # => 'enabled'
+```
+
+### Fetching corresponding streams and schedules
+
+Instances of `WowzaCloud::Stream` have a convenience method `schedule` that
+will return `nil` if the Stream does not have an associated schedule, but an
+appropriate instance of `WowzaCloud::Schedule` if a schedule does exist.
+
+Similarly, instances of `WowzaCloud::Schedule` have a convenience method
+`stream`, which will always return the appropriate instance of
+a `WowzaCloud::Stream`.
 
 ## Development
 

data/lib/wowza_cloud/stream.rb

@@ -76,9 +76,13 @@ module WowzaCloud
       return raw_response['live_stream']['state']
     end
 
-    # Returns the schedule attached to this stream, if one exists
+    # Returns the first active schedule attached to this stream, if one exists
     def schedule
-      Schedule.all.select{|s| s.transcoder_id == @id }.first
+      Schedule.all.select{|s| s.transcoder_id == @id s.state == 'enabled' }.first
+    end
+
+    def schedules
+      Schedule.all.select{|s| s.transcoder_id == @id } 
     end
   
   end

data/lib/wowza_cloud/version.rb

@@ -1,3 +1,3 @@
 module WowzaCloud
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wowza_cloud
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Steve Lewis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-22 00:00:00.000000000 Z
+date: 2017-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty