zype 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a1a13362c63c35462242041f0487a1a79ec79b102f434386d575e8fe16c3473
-  data.tar.gz: 533def1a029421620f8da0f255c9db86a0d60ac60a6134fa1b1db2f2e9b7dc90
+  metadata.gz: b9a2ea73f4d8fbd2a269eac9d311b23d7d0d0a2a0c008e8f95931241c030cc4e
+  data.tar.gz: 7fa7fc82ca88b6aaf5a0396b68b613fec84dd764892b21e8aca866f67b8f1274
 SHA512:
-  metadata.gz: 4ca2a4cbcaa7ce41cc5a945c2830e46e9fa6142310282fa895fa09d8feb182f0820d40e76c4eda92562d872542f8f4428b896e190bd43f453fdfd3f8bb629218
-  data.tar.gz: d47ba8721610eeefcdc526fc4bd6759f584c3df93144a1701c6911d48cd24f86fbabe44710d44696eb6350d5e8e808457788f68528bf3c9fca73501e167b09db
+  metadata.gz: 561add775aca12eb095edd30a8d5b23b5d58b8603df5f2980922744cb87dad216325369ff72555cfc875ce84c985cdd04d04c7d76e4998ce48cca50739becf80
+  data.tar.gz: d1ca32fd59b69988dcbc3b3e7916c54986718959390bd63405400076df1a7aa4529fb2b839294b78e001d8bad8ea8493d19a1e981ed2d9121e11a80bc1228315

data/lib/zype.rb

@@ -1,7 +1,7 @@
 require 'httparty'
-require 'zype/configuration'
-require 'zype/client'
-require 'zype/base_model'
+require './lib/zype/configuration.rb'
+require './lib/zype/client.rb'
+require './lib/zype/base_model.rb'
 Dir[File.join(__dir__, '../lib/zype/models', '*.rb')].each { |file| require file }
 
 module Zype

data/lib/zype/base_model.rb

@@ -1,9 +1,58 @@
 module Zype
   class BaseModel
-    attr_reader :client
+    attr_reader :client, :path
 
     def initialize
-      @client ||= Client.new
+      @client = Client.new
+      @path = generate_path
+    end
+
+    # Returns all objects for given class
+    #
+    # @param params [Hash] the metadata to filter objects by
+    # @return [Array<Hash>] the objects returned from the API
+    def all(params: {})
+      client.execute(method: :get, path: "/#{path}", params: params)
+    end
+
+    # Returns object matching ID
+    #
+    # @param id [String] the ID of the object
+    # @return [Hash] the object returned from the API
+    def find(id:)
+      client.execute(method: :get, path: "/#{path}/#{id}")
+    end
+
+    # Creates a new object via the API
+    #
+    # @param params [Hash] the properties of the object
+    # @return [Hash] the newly created object
+    def create(params:)
+      client.execute(method: :post, path: "/#{path}", params: params)
+    end
+
+    # Updates an existing object via the API
+    #
+    # @param id [String] the ID of the object
+    # @param params [Hash] the properties to be updated
+    # @return [Hash] the updated object
+    def update(id:, params:)
+      client.execute(method: :put, path: "/#{path}/#{id}", params: params)
+    end
+
+    # Deletes an existing object via the API
+    #
+    # @param id [String] the ID of the object
+    # @return [Hash] the deleted object
+    def delete(id:)
+      client.execute(method: :delete, path: "/#{path}/#{id}")
+    end
+
+    private
+
+    def generate_path
+      split = self.class.name.split(/(?=[A-Z])/)
+      split[1..split.length].join('_').downcase
     end
   end
 end

data/lib/zype/client.rb

@@ -16,12 +16,13 @@ module Zype
       422 => UnprocessableEntity,
       500 => ServerError
     }.freeze
-    METHODS = %w(live_events encoders)
 
+    # Automatically converts all files in lib/zype/models to be used as methods
     class << self
-      METHODS.each do |method|
-        define_method method do
-          constant = method.split("_").map { |s| s.capitalize }.join("")
+      Dir["lib/zype/models/*"].each do |file|
+        model = file[/.*\/(.*?).rb$/, 1]
+        define_method model do
+          constant = model.split("_").map { |s| s.capitalize }.join("")
           Module.const_get("Zype::#{constant}").new
         end
       end
@@ -53,7 +54,7 @@ module Zype
 
       resp = self.send(method, path: path, params: params)
       if resp.success?
-        resp['response']
+        resp['response'].nil? ? resp.parsed_response : resp['response']
       else
         error!(code: resp.code, message: resp['message'])
       end

data/lib/zype/models/encoders.rb

@@ -1,20 +1,31 @@
 module Zype
   class Encoders < Zype::BaseModel
-
-    def all
-      client.execute(method: :get, path: '/live/encoders')
-    end
-
+    # Returns encoder matching the encoder_name
+    #
+    # @param encoder_name [String] the name of the encoder
+    # @return [Hash] properties of the encoder
     def find(encoder_name:)
       client.execute(method: :get, path: "/live/encoders/#{encoder_name}")
     end
 
+    # Starts encoder matching the encoder_name
+    #
+    # @param encoder_name [String] the name of the encoder
+    # @return [Hash] properties of the encoder
     def start(encoder_name:)
       client.execute(method: :post, path: "/live/encoders/#{encoder_name}/start")
     end
 
+    # Stops encoder matching the encoder_name
+    #
+    # @param encoder_name [String] the name of the encoder
+    # @return [Hash] properties of the encoder
     def stop(encoder_name:)
       client.execute(method: :post, path: "/live/encoders/#{encoder_name}/stop")
     end
+
+    def path
+      @path = "live/encoders"
+    end
   end
 end

data/lib/zype/models/live_events.rb

@@ -1,33 +1,25 @@
 module Zype
   class LiveEvents < Zype::BaseModel
-    def all(params: {})
-      client.execute(method: :get, path: '/live_events', params: params)
-    end
-
-    def find(id:)
-      client.execute(method: :get, path: "/live_events/#{id}")
-    end
-
-    def create(params:)
-      client.execute(method: :post, path: '/live_events', params: params)
-    end
-
-    def update(id:, params:)
-      client.execute(method: :put, path: "/live_events/#{id}", params: params)
-    end
-
-    def delete(id:)
-      client.execute(method: :delete, path: "/live_events/#{id}")
-    end
-
+    # Starts broadcasting a live event
+    #
+    # @param id [String] the ID of the live event
+    # @return [Hash] the live event
     def start(id:)
       client.execute(method: :put, path: "/live_events/#{id}/start")
     end
 
+    # Stops broadcasting a live event
+    #
+    # @param id [String] the ID of the live event
+    # @return [Hash] the live event
     def stop(id:)
       client.execute(method: :put, path: "/live_events/#{id}/stop")
     end
 
+    # Archives the live event
+    #
+    # @param id [String] the ID of the live event
+    # @return [Hash] the live event
     def archive(id:)
       client.execute(method: :put, path: "/live_events/#{id}/archive")
     end

data/lib/zype/models/playlists.rb

@@ -0,0 +1,36 @@
+module Zype
+  class Playlists < Zype::BaseModel
+    # Returns videos for a playlist
+    #
+    # @param id [String] the ID of the playlist
+    # @return [Array<Hash>] an array of video objects
+    def videos(id:)
+      client.execute(method: :get, path: "/playlists/#{id}/videos")
+    end
+
+    # Adds videos to a playlist
+    #
+    # @param id [String] the ID of the playlist
+    # @param video_ids [Array<String>] the video IDs to add to the playlist
+    # @return [Array<Hash>] an array of video objects
+    def add_videos(id:, video_ids:)
+      client.execute(method: :put, path: "/playlists/#{id}/add_videos", params: { video_id: video_ids })
+    end
+
+    # Removes videos from a playlist
+    #
+    # @param id [String] the ID of the playlist
+    # @param video_ids [Array<String>] the video IDs to remove to the playlist
+    # @return [Array<Hash>] an array of video objects
+    def remove_videos(id:, video_ids:)
+      client.execute(method: :put, path: "/playlists/#{id}/remove_videos", params: { video_id: video_ids })
+    end
+
+    # Returns all playlists from the API
+    #
+    # @return [Array<Hash>] all playlists in relational order
+    def relationships
+      client.execute(method: :get, path: '/playlists/relationships')
+    end
+  end
+end

data/lib/zype/models/videos.rb

@@ -0,0 +1,29 @@
+module Zype
+  class Videos < Zype::BaseModel
+    # Adds zobjects to video
+    #
+    # @param id [String] the ID of the video
+    # @param zobject_ids [Array<String>] an array of zobject IDs
+    # @return [Hash] the video object
+    def add_zobjects(id:, zobject_ids:)
+      client.execute(method: :put, path: "/videos/#{id}/add_zobjects", params: { zobject_id: zobject_ids })
+    end
+
+    # Removes zobjects from video
+    #
+    # @param id [String] the ID of the video
+    # @param zobject_ids [Array<String>] an array of zobject IDs
+    # @return [Hash] the video object
+    def remove_zobjects(id:, zobject_ids:)
+      client.execute(method: :put, path: "/videos/#{id}/remove_zobjects", params: { zobject_id: zobject_ids })
+    end
+
+    # Returns the original source file for the video
+    #
+    # @param id [String] the ID of the video
+    # @return [Hash] object containing a "url" key for the original source file
+    def download(id:)
+      client.execute(method: :get, path: "/videos/#{id}/download")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zype
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Zype
@@ -64,6 +64,8 @@ files:
 - lib/zype/configuration.rb
 - lib/zype/models/encoders.rb
 - lib/zype/models/live_events.rb
+- lib/zype/models/playlists.rb
+- lib/zype/models/videos.rb
 homepage: http://rubygems.org/gems/zype
 licenses:
 - MIT