helix 0.0.2.4.pre → 0.0.2.5.pre

data/lib/helix.rb

@@ -6,6 +6,7 @@ require 'helix/album'
 require 'helix/image'
 require 'helix/config'
 require 'helix/statistics'
+require 'helix/library'
 
 module Helix
 end

data/lib/helix/album.rb

@@ -22,6 +22,10 @@ module Helix
       raise "Albums Update is not currently supported."
     end
 
+    def self.known_attributes
+      [:title, :description]
+    end 
+
   end
 
 end

data/lib/helix/audio_playlist.rb

@@ -0,0 +1,8 @@
+require 'helix/media'
+
+module Helix
+
+  class AudioPlaylist
+  end
+
+end

data/lib/helix/base.rb

@@ -23,6 +23,7 @@ module Helix
     # @param [Hash] opts a hash of options for parameters passed into the HTTP GET
     # @return [Array] The array of instance objects for a class.
     def self.find_all(opts={})
+      RestClient.log = 'helix.log' if opts.delete(:log)
       data_sets = get_data_sets(opts)
       return [] if data_sets.nil?
       data_sets.map { |attrs| self.new( attributes: massage_attrs(attrs),
@@ -126,7 +127,7 @@ module Helix
       begin
         @attributes[method_sym.to_s]
       rescue
-        raise NoMethodError, "#{method_sym} is not recognized within #{self.class.to_s}'s @attributes"
+        raise NoMethodError, "#{method_sym} is not recognized within #{self.class.to_s}'s methods or @attributes"
       end
     end
 
@@ -161,6 +162,7 @@ module Helix
       attrs["custom_fields"].delete_if { |key, val| key.to_s =~ /^@/ }
       cfs = []
       attrs["custom_fields"].each do |key, val|
+        val = [val] unless val.is_a?(Array)
         val.each do |val_val|
           cfs << { "name" => key, "value" => val_val.to_s }
         end

data/lib/helix/config.rb

@@ -52,6 +52,7 @@ module Helix
       url  += "/#{guid}"            if guid
       url  += "/formats/#{format}"  if format
       url  += "/#{action}"          if action
+      return url if opts[:content_type].blank?
       "#{url}.#{opts[:content_type]}"
     end
 

data/lib/helix/library.rb

@@ -0,0 +1,33 @@
+require 'helix/media'
+
+module Helix
+
+  class Library < Media
+
+    # The class name, to be used by supporting classes. Such as Config which uses
+    # this method as a way to build URLs.
+    #
+    #
+    # @example
+    #   Helix::Library.media_type_sym #=> :library
+    #
+    # @return [Symbol] Name of the class.
+    def self.media_type_sym; :library; end
+
+    # Creates a string associated with a class name pluralized
+    #
+    # @example
+    #   Helix::Library.plural_media_type #=> "libraries"
+    #
+    # @return [String] The class name pluralized
+    def self.plural_media_type
+      "#{self.media_type_sym.to_s.gsub(/y/, '')}ies"
+    end
+
+    def self.known_attributes
+      [:player_profile, :ingest_profile, :secure_stream_callback_url, :hooks_attributes]
+    end
+
+  end
+
+end

data/lib/helix/media.rb

@@ -30,6 +30,7 @@ module Helix
     # @param [String] guid an id in guid form.
     # @return [Base] An instance of Helix::Base
     def self.find(guid)
+      raise ArgumentError.new("find requires a non-nil guid argument - received a nil argument.") if guid.nil?
       item   = self.new(attributes: { guid_name => guid }, config: config)
       item.load
     end
@@ -65,4 +66,4 @@ module Helix
       self
     end
   end
-end
+end

data/lib/helix/playlist.rb

@@ -0,0 +1,8 @@
+require 'helix/media'
+
+module Helix
+
+  class Playlist
+  end
+
+end

data/lib/helix/video.rb

@@ -34,17 +34,43 @@ module Helix
     # @return [String] Stillframe jpg data, save it to a file with extension .jpg.
     def self.get_stillframe(guid, opts={})
       RestClient.log = 'helix.log' if opts.delete(:log)
-      server  = opts[:server] || config.credentials[:server] || "service-staging"
+      url = get_stillframe_url(guid, opts)
+      RestClient.get(url)
+    end
+
+    def download(opts={})
+      generic_download(opts.merge(action: :file))
+    end
+
+    def play(opts={})
+      generic_download(opts.merge(action: :play))
+    end
+
+    def stillframe(opts={})
+      self.class.get_stillframe(self.guid, opts)
+    end
+
+    private
+
+    def self.get_stillframe_dimensions(opts)
       width   = opts[:width].to_s  + "w" unless opts[:width].nil?
       height  = opts[:height].to_s + "h" unless opts[:height].nil?
       width   = "original" if opts[:width].nil? && opts[:height].nil?
+      [width, height]
+    end
+
+    def self.get_stillframe_url(guid, opts)
+      server  = opts[:server] || config.credentials[:server] || "service-staging"
+      width, height = get_stillframe_dimensions(opts)
       url     = "#{server}.twistage.com/videos/#{guid}/screenshots/"
       url    << "#{width.to_s}#{height.to_s}.jpg"
-      RestClient.get(url)
     end
 
-    def stillframe(opts={})
-      self.class.get_stillframe(self.guid, opts)
+    def generic_download(opts)
+      content_type = opts[:content_type] || ''
+      url = config.build_url(action: opts[:action], content_type: content_type, guid: guid, media_type: plural_media_type)
+      RestClient.get(url, params: {signature: config.signature(:view)})
     end
+
   end
 end

data/lib/helix/video_playlist.rb

@@ -0,0 +1,8 @@
+require 'helix/media'
+
+module Helix
+
+  class VideoPlaylist < Playlist
+  end
+
+end

data/spec/album_spec.rb

@@ -13,6 +13,14 @@ describe Helix::Album do
     it { should respond_to(crud_call) }
   end
 
+  describe ".known_attributes" do
+    let(:meth)            { :known_attributes }
+    let(:expected_attrs)  { [:title, :description] }
+    it "should equal expected_attrs" do
+      expect(klass.send(meth)).to eq(expected_attrs)
+    end
+  end
+
   describe "Constants"
 
   describe "an instance" do

data/spec/base_spec.rb

@@ -167,6 +167,11 @@ describe Helix::Base do
     it "should return the custom_hash in its form" do
       expect(klass.send(meth, expected)).to eq(expected)
     end
+    let(:custom_hash_with_false)  { { "custom_fields" => {"boole"=>false, "@type"=>"hash"} } }
+    let(:expected_with_false)     { { "custom_fields" => [{"name"=>"boole", "value"=>"false"}] } }
+    it "should turn custom_hash into expected" do
+      expect(klass.send(meth, custom_hash_with_false)).to eq(expected_with_false)
+    end
   end
 
   describe "an instance" do
@@ -296,7 +301,7 @@ describe Helix::Base do
         context "and @attributes[method_sym.to_s] raises an exception" do
           before(:each) do mock_attributes.should_receive(:[]).with(method_sym.to_s).and_raise("some exception") end
           it "should raise a NoMethodError" do
-            msg = "#{method_sym} is not recognized within #{klass}'s @attributes"
+            msg = "#{method_sym} is not recognized within #{klass}'s methods or @attributes"
             expect(lambda { obj.send(meth, method_sym) }).to raise_error(msg)
           end
         end

data/spec/config_spec.rb

@@ -241,6 +241,16 @@ describe Helix::Config do
         end
       end
     end
+    dl_opts = {action: :file, content_type: '', guid: :the_guid, media_type: :videos}
+    context "when given opts of #{dl_opts}" do
+      subject { obj.send(meth, dl_opts) }
+      it { should eq("http://example.com/videos/the_guid/file") }
+    end
+    dp_opts = {action: :play, content_type: '', guid: :the_guid, media_type: :videos}
+    context "when given opts of #{dp_opts}" do
+      subject { obj.send(meth, dp_opts) }
+      it { should eq("http://example.com/videos/the_guid/play") }
+    end
   end
 
   describe "#clear_signatures!" do

data/spec/library_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'helix'
+
+describe Helix::Library do
+
+  let(:klass)             { Helix::Library }
+  subject                 { klass }
+  its(:guid_name)         { should eq('library_id') }
+  its(:media_type_sym)    { should be(:library)   }
+  its(:plural_media_type) { should eq('libraries') }
+  [:find, :create, :all, :find_all, :where].each do |crud_call|
+    it { should respond_to(crud_call) }
+  end
+
+  describe ".known_attributes" do
+    let(:meth)            { :known_attributes }
+    let(:expected_attrs)  { [ :player_profile, 
+                              :ingest_profile, 
+                              :secure_stream_callback_url, 
+                              :hooks_attributes] }
+    it "should equal expected_attrs" do
+      expect(klass.send(meth)).to eq(expected_attrs)
+    end
+  end
+
+  describe "Constants"
+
+  describe "an instance" do
+    let(:obj)            { klass.new({'library_id' => 'some_library_id'}) }
+    subject              { obj }
+    its(:media_type_sym) { should be(:library) }
+    [:destroy, :update].each do |crud_call|
+      it { should respond_to(crud_call) }
+    end
+  end
+end

data/spec/media_spec.rb

@@ -51,7 +51,6 @@ describe Helix::Media do
     its(:arity) { should eq(1) }
     before(:each) do Helix::Config.stub(:instance) { mock_config } end
     context "when given a Helix::Config instance and a guid" do
-      let(:guid)       { :a_guid }
       let(:guid_name)  { :the_guid_name }
       let(:mock_attrs) { mock(Object, :[]= => :output_of_setting_val) }
       before(:each) do
@@ -59,13 +58,22 @@ describe Helix::Media do
         klass.stub(:guid_name)  { guid_name  }
         klass.stub(:new)        { mock_obj }
       end
-      it "should instantiate with {attributes: guid_name => the_guid, config: config}" do
-        klass.should_receive(:new).with({attributes: {guid_name => guid}, config: mock_config})
-        klass.send(meth, guid)
+      context "and the guid is nil" do
+        it "should raise an ArgumentError complaining about a nil guid" do
+          msg = 'find requires a non-nil guid argument - received a nil argument.'
+          lambda { klass.send(meth, nil) }.should raise_error(ArgumentError, msg)
+        end
       end
-      it "should load" do
-        mock_obj.should_receive(:load)
-        klass.send(meth, guid)
+      context "and the guid is non-nil" do
+        let(:guid) { :a_guid }
+        it "should instantiate with {attributes: guid_name => the_guid, config: config}" do
+          klass.should_receive(:new).with({attributes: {guid_name => guid}, config: mock_config})
+          klass.send(meth, guid)
+        end
+        it "should load" do
+          mock_obj.should_receive(:load)
+          klass.send(meth, guid)
+        end
       end
     end
   end
@@ -142,4 +150,4 @@ describe Helix::Media do
       end
     end
   end
-end
+end

data/spec/video_spec.rb

@@ -24,20 +24,85 @@ describe Helix::Video do
     let(:obj)            { klass.new({video_id: 'some_video_guid'}) }
     subject              { obj }
     its(:media_type_sym) { should be(:video) }
+
+    describe "#download" do
+      let(:meth)        { :download }
+      let(:mock_config) { mock(Helix::Config, build_url: :the_built_url, signature: :some_sig) }
+      subject      { obj.method(meth) }
+      let(:params) { { params: {signature: :some_sig } } }
+      before do
+        obj.stub(:config)            { mock_config }
+        obj.stub(:guid)              { :some_guid  }
+        obj.stub(:plural_media_type) { :media_type }
+        RestClient.stub(:get) { '' }
+      end
+      { '' => '', mp3: :mp3, nil => '' }.each do |arg,actual|
+        build_url_h = {action: :file, content_type: actual, guid: :some_guid, media_type: :media_type}
+        context "when given {content_type: #{arg}" do
+          it "should build_url(#{build_url_h})" do
+            mock_config.should_receive(:build_url).with(build_url_h)
+            obj.send(meth, content_type: arg)
+          end
+          it "should get a view signature" do
+            mock_config.should_receive(:signature).with(:view) { :some_sig }
+            obj.send(meth, content_type: arg)
+          end
+          it "should return an HTTP get to the built URL with the view sig" do
+            mock_config.stub(:build_url).with(build_url_h) { :the_url }
+            RestClient.should_receive(:get).with(:the_url, params) { :expected }
+            expect(obj.send(meth, content_type: arg)).to be(:expected)
+          end
+        end
+      end
+    end
+
+    describe "#play" do
+      let(:meth)        { :play }
+      let(:mock_config) { mock(Helix::Config, build_url: :the_built_url, signature: :some_sig) }
+      subject      { obj.method(meth) }
+      let(:params) { { params: {signature: :some_sig } } }
+      before do
+        obj.stub(:config)            { mock_config }
+        obj.stub(:guid)              { :some_guid  }
+        obj.stub(:plural_media_type) { :media_type }
+        RestClient.stub(:get) { '' }
+      end
+      { '' => '', mp3: :mp3, nil => '' }.each do |arg,actual|
+        build_url_h = {action: :play, content_type: actual, guid: :some_guid, media_type: :media_type}
+        context "when given {content_type: #{arg}" do
+          it "should build_url(#{build_url_h})" do
+            mock_config.should_receive(:build_url).with(build_url_h)
+            obj.send(meth, content_type: arg)
+          end
+          it "should get a view signature" do
+            mock_config.should_receive(:signature).with(:view) { :some_sig }
+            obj.send(meth, content_type: arg)
+          end
+          it "should return an HTTP get to the built URL with the view sig" do
+            mock_config.stub(:build_url).with(build_url_h) { :the_url }
+            RestClient.should_receive(:get).with(:the_url, params) { :expected }
+            expect(obj.send(meth, content_type: arg)).to be(:expected)
+          end
+        end
+      end
+    end
+
     describe "#stillframe" do
       let(:meth)        { :stillframe }
       let(:mock_config) { mock(Helix::Config) }
       subject           { obj.method(meth) }
       its(:arity)       { should eq(-1) }
       it "should call self.class.get_stillframe" do
-        obj.stub!(:guid).and_return :some_guid
+        obj.stub(:guid).and_return :some_guid
         klass.should_receive(:get_stillframe)
         obj.send(meth)
       end
     end
+
     [:destroy, :update].each do |crud_call|
       it { should respond_to(crud_call) }
     end
+
   end
 
   ### CLASS METHODS

metadata

@@ -1,119 +1,118 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: helix
-version: !ruby/object:Gem::Version
-  version: 0.0.2.4.pre
+version: !ruby/object:Gem::Version 
   prerelease: 8
+  version: 0.0.2.5.pre
 platform: ruby
-authors:
+authors: 
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-02-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.5.4
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
         version: 1.5.4
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.6.7
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
         version: 1.6.7
-- !ruby/object:Gem::Dependency
-  name: nori
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.3
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: nori
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
         version: 1.1.3
+  type: :runtime
+  version_requirements: *id003
 description: Provides helper libraries for Ruby access to the Twistage API
 email: kbaird@twistage.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/helix.rb
-- lib/helix/album.rb
-- lib/helix/base.rb
-- lib/helix/image.rb
+- lib/helix/tag.rb
 - lib/helix/media.rb
+- lib/helix/statistics.rb
+- lib/helix/library.rb
+- lib/helix/audio_playlist.rb
 - lib/helix/durationed_media.rb
-- lib/helix/exceptions.rb
+- lib/helix/playlist.rb
+- lib/helix/video_playlist.rb
 - lib/helix/config.rb
-- lib/helix/tag.rb
 - lib/helix/video.rb
 - lib/helix/track.rb
-- lib/helix/statistics.rb
-- spec/video_spec.rb
+- lib/helix/base.rb
+- lib/helix/image.rb
+- lib/helix/album.rb
+- lib/helix/exceptions.rb
 - spec/spec_helper.rb
-- spec/statistics_spec.rb
+- spec/audio_playlist_spec.rb
 - spec/config_spec.rb
-- spec/media_spec.rb
 - spec/image_spec.rb
+- spec/media_spec.rb
+- spec/durationed_media_spec.rb
 - spec/album_spec.rb
+- spec/statistics_spec.rb
+- spec/tag_spec.rb
+- spec/video_playlist_spec.rb
 - spec/track_spec.rb
+- spec/video_spec.rb
+- spec/playlist_spec.rb
+- spec/library_spec.rb
 - spec/base_spec.rb
-- spec/durationed_media_spec.rb
-- spec/tag_spec.rb
 - LICENSE
 - README.md
 homepage: https://github.com/Twistage/helix/
-licenses:
+licenses: 
 - 3-Clause BSD
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>'
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
       version: 1.3.1
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []
-has_rdoc: yard
+