helix 0.0.3.7.pre → 0.0.3.9.pre

data/lib/helix.rb

@@ -1,6 +1,6 @@
 require 'helix/restful'
 require 'helix/uploadable'
-require 'helix/durationed_media'
+require 'helix/durationed'
 require 'helix/video'
 require 'helix/track'
 require 'helix/tag'
@@ -11,6 +11,7 @@ require 'helix/config'
 require 'helix/statistics'
 require 'helix/library'
 require 'helix/user'
+require 'helix/playlist'
 
 # Pulled from active_support
 # This solves the active_support collision discussed in issue 19 on GitHub.

data/lib/helix/base.rb

@@ -133,8 +133,9 @@ module Helix
     # @param [Hash] opts a hash of attributes to update the instance with.
     # @return [Base] Returns an instance of the class.
     def load(opts={})
-      memo_cfg    = config
-      url         = memo_cfg.build_url(content_type: :json, guid: self.guid, resource_label: plural_resource_label)
+      memo_cfg      = config
+      base_url_opts = {content_type: (opts[:content_type] || :json)}
+      url           = memo_cfg.build_url(base_url_opts.merge(guid: self.guid, resource_label: plural_resource_label))
       # We allow opts[:sig_type] for internal negative testing only.
       raw_attrs   = memo_cfg.get_response(url, {sig_type: :view}.merge(opts))
       @attributes = massage_raw_attrs(raw_attrs)

data/lib/helix/config.rb

@@ -117,10 +117,14 @@ module Helix
     # @param [Hash] original_opts a hash of options for building URL additions
     # @return [String] The full RESTful URL string object
     def get_response(url, original_opts={})
-      opts        = original_opts.clone
+      opts        = massage_custom_fields_in(original_opts)
       sig_type    = opts.delete(:sig_type)
       params      = opts.merge(signature: signature(sig_type, opts))
-      @response   = RestClient.get(url, params: params)
+      begin
+        @response = RestClient.get(url, params: params)
+      rescue RestClient::InternalServerError => e
+        raise NetworkError, "Unable to access url #{url} with params #{params}"
+      end
       parse_response_by_url_format(@response, url)
     end
 
@@ -182,6 +186,15 @@ module Helix
       @credentials[:license_key]
     end
 
+    def massage_custom_fields_in(opts)
+      return opts.clone unless opts.has_key?(:custom_fields)
+      cf_opts = opts.delete(:custom_fields)
+      cf_opts.inject(opts.clone) do |memo,pair|
+        k,v = pair
+        memo.merge("custom_fields[#{k}]" => v)
+      end
+    end
+
     def parse_response_by_url_format(response, url)
       ### FIXME: This is ugly. Clean it up.
       if url =~ /json/

data/lib/helix/{durationed_media.rb → durationed.rb}

@@ -1,6 +1,6 @@
 module Helix
 
-  module DurationedMedia
+  module Durationed
 
     module ClassMethods
 

data/lib/helix/exceptions.rb

@@ -1,4 +1,5 @@
 require 'helix/base'
 module Helix
   class NoConfigurationLoaded < StandardError ; end
+  class NetworkError          < StandardError ; end
 end

data/lib/helix/playlist.rb

@@ -2,7 +2,20 @@ require 'helix/media'
 
 module Helix
 
-  class Playlist
+  class Playlist < Base
+
+    include RESTful
+
+    # The class name, to be used by supporting classes. Such as Config which uses
+    # this method as a way to build URLs.
+    #
+    #
+    # @example
+    #   Helix::Playlist.resource_label_sym #=> :playlist
+    #
+    # @return [Symbol] Name of the class.
+    def self.resource_label_sym; :playlist; end
+
   end
 
-end
+end

data/lib/helix/restful.rb

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

data/lib/helix/track.rb

@@ -4,7 +4,7 @@ module Helix
 
   class Track < Media
 
-    include DurationedMedia
+    include Durationed
 
     # The class name, to be used by supporting classes. Such as Config which uses
     # this method as a way to build URLs.

data/lib/helix/video.rb

@@ -4,7 +4,7 @@ module Helix
 
   class Video < Media
 
-    include DurationedMedia
+    include Durationed
 
     # The class name, to be used by supporting classes. Such as Config which uses
     # this method as a way to build URLs.

data/spec/_integration_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'helix'
+
+config_filename = File.expand_path('../../config/staging.yml', __FILE__)
+config = File.exists?(config_filename) ? Helix::Config.load(config_filename) : nil
+
+if config.nil?
+  puts "No config, skipping integration specs"
+elsif %w(1 t true).include?(ENV['SKIP_INTEGRATION'])
+  puts "Skipping integration specs due to user request"
+else
+
+  media_by_id = {
+    album_id:    Helix::Album,
+    document_id: Helix::Document,
+    image_id:    Helix::Image,
+    playlist_id: Helix::Playlist,
+    track_id:    Helix::Track,
+    video_id:    Helix::Video
+  }
+
+  media_by_id.each do |guid_key,klass|
+
+    describe "Integration Specs for #{klass.to_s}" do
+
+      describe ".all" do
+        subject { klass.all }
+        it { should_not be_empty }
+      end
+
+      describe ".where(query: 'rest-client')" do
+        it "should not raise an exception" do
+          lambda { klass.where(query: 'rest-client') }.should_not raise_error
+        end
+      end
+
+      unless guid_key == :album_id
+        describe ".where({custom_fields: {boole: 'true'}})" do
+          it "should not raise an exception" do
+            lambda { klass.where({custom_fields: {boole: 'true'}}) }.should_not raise_error
+          end
+        end
+      end
+
+      media_id = config.credentials[guid_key]
+      next if media_id.nil?
+
+      describe ".where(query: #{media_id}" do
+        subject { klass.where(query: media_id) }
+        it { should_not be_empty }
+      end
+
+      shared_examples_for "found #{klass}" do
+        it { should_not be_empty }
+        if klass == Helix::Playlist
+          # Playlist Metadata is just a wrapper for an Array of media items: no guid
+          its(guid_key) { should eq(nil) }
+        else
+          its(guid_key) { should eq(media_id) }
+        end
+        if guid_key == :video_id
+          describe "screenshots" do
+            expected_ss = {
+              "frame"        => 141.4,
+              "content_type" => "image/jpeg",
+              "width"        => 1280,
+              "height"       => 720,
+              "size"         => 260548,
+              "url"          => "http://edited-yet-again-staging.twistage.com:80/videos/ece0d3fd03bf0/screenshots/original.jpg"
+            }
+            subject { item.screenshots.first }
+            it { should eq(expected_ss) }
+          end
+        end
+      end
+
+      describe ".find(media_id)" do
+        let(:item) { klass.find(media_id) }
+        subject { item }
+        it_behaves_like "found #{klass}"
+      end
+      [ :json, :xml ].each do |content_type|
+        describe ".find(media_id, content_type: #{content_type})" do
+          let(:item) { klass.find(media_id, content_type: content_type) }
+          subject { item }
+          it_behaves_like "found #{klass}"
+        end
+      end
+
+      unless guid_key == :document_id # no Document stats yet
+        describe "Stats" do
+          media_type  = guid_key.to_s.split(/_/).first
+          helix_stats = Helix::Statistics
+          %w(delivery ingest storage).each do |stats_type|
+            next if [:album_id, :image_id].include?(guid_key) and stats_type == 'ingest'
+            next if [:image_id].include?(guid_key) and stats_type == 'delivery'
+            it "should call stats" do
+              stats = helix_stats.send("#{media_type}_#{stats_type}")
+              puts "#{klass.to_s} #{stats_type} stats = #{stats.inspect}"
+              item_stats = helix_stats.send("#{media_type}_#{stats_type}", guid_key => media_id)
+              puts "#{klass.to_s} #{media_id} #{stats_type} stats = #{item_stats.inspect}"
+            end
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/base_spec.rb

@@ -167,7 +167,7 @@ describe Helix::Base do
     end
   end
 
-  klasses = [ Helix::Album, Helix::Image, Helix::Track, Helix::Video ]
+  klasses = [ Helix::Album, Helix::Image, Helix::Playlist, Helix::Track, Helix::Video ]
   klasses.each do |klass|
 
     describe "an instance of class #{klass.to_s}" do

data/spec/config_spec.rb

@@ -351,6 +351,26 @@ describe Helix::Config do
     let(:meth)  { :get_response }
     subject     { obj.method(meth) }
     its(:arity) { should eq(-2) }
+    shared_examples_for "raises NetworkError" do
+      context "and RestClient.get raises a RestClient::InternalServerError exception" do
+        it "should raise a NetworkError" do
+          RestClient.should_receive(:get).and_raise(RestClient::InternalServerError)
+          expect(
+            lambda { obj.send(meth, url, opts) }
+          ).to raise_error(Helix::NetworkError, %r[Unable to access url #{url} with params {])
+        end
+      end
+    end
+    shared_examples_for "clones and massages opts" do
+      it "should clone the options arg" do
+        opts.should_receive(:clone) { opts }
+        obj.send(meth, url, opts)
+      end
+      it "should massage_custom_fields_in(opts)" do
+        obj.should_receive(:massage_custom_fields_in).with(opts) { opts }
+        obj.send(meth, url, opts)
+      end
+    end
     context "when given a url and options" do
       let(:opts)          { {sig_type: :the_sig_type, some_key: :some_value} }
       let(:params)        { { params: { signature: 'mock_sig', some_key: :some_value } } }
@@ -365,38 +385,32 @@ describe Helix::Config do
       context "and the URL matches /json/" do
         let(:url) { 'blah.json' }
         before(:each) do RestClient.stub(:get).with(url, params) { returned_json } end
-        it "should clone the options arg" do
-          opts.should_receive(:clone) { opts }
-          obj.send(meth, url, opts)
-        end
+        it_behaves_like "clones and massages opts"
         it "should call RestClient.get and return a hash from parsed JSON" do
           RestClient.should_receive(:get).with(url, params) { returned_json }
           expect(obj.send(meth, url, opts)).to eq(json_parsed)
         end
+        it_behaves_like "raises NetworkError"
       end
       context "and the URL matches /xml/" do
         let(:url) { 'blah.xml' }
         before(:each) do RestClient.stub(:get).with(url, params) { returned_xml } end
-        it "should clone the options arg" do
-          opts.should_receive(:clone) { opts }
-          obj.send(meth, url, opts)
-        end
+        it_behaves_like "clones and massages opts"
         it "should call RestClient.get and return a hash from parsed XML" do
           RestClient.should_receive(:get).with(url, params) { returned_xml }
           expect(obj.send(meth, url, opts)).to eq(xml_parsed)
         end
+        it_behaves_like "raises NetworkError"
       end
       context "and the URL matches /csv/" do
         let(:url) { 'blah.csv' }
         before(:each) do RestClient.stub(:get).with(url, params) { returned_csv } end
-        it "should clone the options arg" do
-          opts.should_receive(:clone) { opts }
-          obj.send(meth, url, opts)
-        end
+        it_behaves_like "clones and massages opts"
         it "should call RestClient.get and return the raw CSV response" do
           RestClient.should_receive(:get).with(url, params) { returned_csv }
           expect(obj.send(meth, url, opts)).to eq(returned_csv)
         end
+        it_behaves_like "raises NetworkError"
       end
       context "and the URL matches none of /json/, /xml/, or /csv/" do
         let(:url) { 'blah.yml' }
@@ -455,6 +469,17 @@ describe Helix::Config do
     end
   end
 
+  describe "#massage_custom_fields_in" do
+    let(:meth)  { :massage_custom_fields_in }
+    subject     { obj.method(meth) }
+    its(:arity) { should eq(1) }
+    opts = { k1: :v1, k2: :v2, custom_fields: {cfk1: :cfv1, cfk2: :cfv2} }
+    context "when given #{opts}" do
+      subject { obj.send(meth, opts) }
+      it { should eq({k1: :v1, k2: :v2, "custom_fields[cfk1]" => :cfv1, "custom_fields[cfk2]" => :cfv2}) }
+    end
+  end
+
   describe "#prepare_signature_memoization" do
     let(:meth)  { :prepare_signature_memoization }
     subject     { obj.method(meth) }

data/spec/{durationed_media_spec.rb → durationed_spec.rb}

@@ -1,7 +1,7 @@
 require File.expand_path('../spec_helper', __FILE__)
 require 'helix'
 
-describe Helix::DurationedMedia do
+describe Helix::Durationed do
 
   def import_xml(values={})
     { list: { entry: values[:url_params] || {} } }.to_xml(root: :add)
@@ -10,7 +10,7 @@ describe Helix::DurationedMedia do
   klasses = [ Helix::Video, Helix::Track ]
   klasses.each do |klass|
     subject         { klass }
-    mods = [ Helix::Base, Helix::DurationedMedia, Helix::Media ]
+    mods = [ Helix::Base, Helix::Durationed, Helix::Media ]
     mods.each { |mod| its(:ancestors) { should include(mod) } }
 
     describe "Constants"

data/spec/media_spec.rb

@@ -111,7 +111,7 @@ describe Helix::Media do
       let(:mock_config) { mock(Helix::Config) }
       let(:mock_obj)    { mock(klass, :load => :output_of_load) }
       subject     { klass.method(meth) }
-      its(:arity) { should eq(1) }
+      its(:arity) { should eq(-2) }
       context "when a Helix:Config instance is absent" do
         before(:each) do Helix::Config.stub(:instance) { nil } end
         context "and given a guid" do
@@ -120,7 +120,7 @@ describe Helix::Media do
           before(:each) do
             klass.stub(:attributes) { mock_attrs }
             klass.stub(:guid_name)  { guid_name  }
-            klass.stub(:new)        { mock_obj }
+            klass.stub(:new)        { mock_obj   }
           end
           context "and the guid is nil" do
             it "should raise an ArgumentError complaining about a nil guid" do
@@ -162,6 +162,18 @@ describe Helix::Media do
               mock_obj.should_receive(:load)
               klass.send(meth, guid)
             end
+            [ :json, :xml ].each do |content_type|
+              context "and also given an optional content_type of :#{content_type}" do
+                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, content_type: content_type)
+                end
+                it "should load(content_type: #{content_type}" do
+                  mock_obj.should_receive(:load).with(content_type: content_type)
+                  klass.send(meth, guid, content_type: content_type)
+                end
+              end
+            end
           end
         end
       end

data/spec/playlist_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path('../spec_helper', __FILE__)
+require 'helix'
+
+describe Helix::Playlist do
+
+  let(:klass) { Helix::Playlist }
+  subject     { klass }
+  mods = [ Helix::Base, Helix::RESTful ]
+  mods.each { |mod| its(:ancestors) { should include(mod) } }
+  its(:guid_name)             { should eq('playlist_id') }
+  its(:resource_label_sym)    { should be(:playlist)     }
+  its(:plural_resource_label) { should eq('playlists')   }
+  [:find, :create, :all, :find_all, :where].each do |crud_call|
+    it { should respond_to(crud_call) }
+  end
+
+  describe "Constants"
+
+  ### INSTANCE METHODS
+
+  describe "an instance" do
+    let(:obj) { klass.new({playlist_id: 'some_playlist_guid'}) }
+    subject   { obj }
+    its(:resource_label_sym) { should be(:playlist) }
+
+    [:destroy, :update].each do |crud_call|
+      it { should respond_to(crud_call) }
+    end
+
+  end
+
+  ### CLASS METHODS
+
+end

data/spec/track_spec.rb

@@ -5,7 +5,7 @@ describe Helix::Track do
 
   let(:klass) { Helix::Track }
   subject     { klass }
-  mods = [ Helix::Base, Helix::DurationedMedia, Helix::Media ]
+  mods = [ Helix::Base, Helix::Durationed, Helix::Media ]
   mods.each { |mod| its(:ancestors) { should include(mod) } }
   its(:guid_name)             { should eq('track_id') }
   its(:resource_label_sym)    { should be(:track)     }

data/spec/video_spec.rb

@@ -9,7 +9,7 @@ describe Helix::Video do
 
   let(:klass) { Helix::Video }
   subject     { klass }
-  mods = [ Helix::Base, Helix::DurationedMedia, Helix::Media ]
+  mods = [ Helix::Base, Helix::Durationed, Helix::Media ]
   mods.each { |mod| its(:ancestors) { should include(mod) } }
   its(:guid_name)             { should eq('video_id') }
   its(:resource_label_sym)    { should be(:video)     }

metadata

@@ -1,135 +1,128 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: helix
-version: !ruby/object:Gem::Version
-  version: 0.0.3.7.pre
+version: !ruby/object:Gem::Version 
   prerelease: 8
+  version: 0.0.3.9.pre
 platform: ruby
-authors:
+authors: 
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-07-03 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: kevin.baird@perceptivesoftware.com, michael.wood@perceptivesoftware.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - lib/helix.rb
-- lib/helix/album.rb
-- lib/helix/audio_playlist.rb
-- lib/helix/base.rb
-- lib/helix/config.rb
+- lib/helix/user.rb
 - lib/helix/document.rb
-- lib/helix/durationed_media.rb
-- lib/helix/exceptions.rb
-- lib/helix/hash_ext.rb
-- lib/helix/image.rb
-- lib/helix/library.rb
+- lib/helix/tag.rb
 - lib/helix/media.rb
+- lib/helix/statistics.rb
 - lib/helix/object_ext.rb
+- lib/helix/library.rb
+- lib/helix/audio_playlist.rb
+- lib/helix/uploadable.rb
+- lib/helix/durationed.rb
 - lib/helix/playlist.rb
 - lib/helix/restful.rb
-- lib/helix/statistics.rb
-- lib/helix/tag.rb
-- lib/helix/track.rb
-- lib/helix/uploadable.rb
-- lib/helix/user.rb
-- lib/helix/video.rb
 - lib/helix/video_playlist.rb
-- spec/album_spec.rb
+- lib/helix/config.rb
+- lib/helix/video.rb
+- lib/helix/track.rb
+- lib/helix/base.rb
+- lib/helix/image.rb
+- lib/helix/album.rb
+- lib/helix/exceptions.rb
+- lib/helix/hash_ext.rb
+- spec/spec_helper.rb
 - spec/audio_playlist_spec.rb
-- spec/base_spec.rb
 - spec/config_spec.rb
-- spec/document_spec.rb
-- spec/durationed_media_spec.rb
-- spec/helix_spec.rb
 - spec/image_spec.rb
-- spec/library_spec.rb
 - spec/media_spec.rb
-- spec/playlist_spec.rb
-- spec/spec_helper.rb
+- spec/durationed_spec.rb
+- spec/helix_spec.rb
+- spec/document_spec.rb
+- spec/album_spec.rb
 - spec/statistics_spec.rb
+- spec/_integration_spec.rb
 - spec/tag_spec.rb
+- spec/video_playlist_spec.rb
 - spec/track_spec.rb
 - spec/user_spec.rb
-- spec/video_playlist_spec.rb
 - spec/video_spec.rb
+- spec/playlist_spec.rb
+- spec/library_spec.rb
+- spec/base_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.25
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []
+