helix 0.0.4.8.pre → 0.0.4.9.pre

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDdlNDE3OWNiMmYwNmU5Y2NmOGI0NWU2M2YzYmNjNWRjYzA1NzAyMA==
+    OWY5OTNjMjY3NTE4ZWVhMTk0MWRjYTRmNTY2NGQwYzRiNjk2MWJjYQ==
   data.tar.gz: !binary |-
-    OTQ2MTRkMzQyZDYwYWQ2NGVkYjVmZjczZmViZTUzMThkZmJlNjI1ZA==
+    NmZkNGU3NDhlY2IxNjI2ODc1ZmU3YTJkODNmODdhYWFjMmM3Y2IyZA==
 SHA512:
   metadata.gz: !binary |-
-    ZGJjYTk3M2RlMGM1NTA4YzhiOTI3MWU0MGJkODhjOTcwOTliMzkxNDJmZDMy
-    YWVhMmU4ODc1MzgyNDM0NGQ1YWM2ZTFiM2NlMGM4NzlmZTdmYmNjZGExZTgw
-    MDQ4MDFiY2U3MDVmYjczYmIyNTBhZWYyMjU2MDY1MDk3ZTE0ZjY=
+    NzU4M2RmYzY2MDc5ZTk2NWY4OTFkMGRhNmM4MDA2ZDE3ZTRmNTVlNDE5YTBm
+    MzE3OWNjMzljNWVhYTg3NjU0NTlmMWE5YjhiYTRjOTMyMjM2NGUzNzdhYzA3
+    ZDNmYWJkMDYwYmY4MWE3ZTA0ODYyMWIxMzU5OGU5M2EwNGFlOGY=
   data.tar.gz: !binary |-
-    NDhhNWI4NWU0YWYxYWVkOGFlZjhiYjVlZTY0ZTlhYTYwYTc4OTdkZmU0M2Mz
-    MmFiOWNhMjcxYjliOTA4NTVlZGYzM2Q1MWIxYzNmYjVkZDQ0ZmRmM2Q2NzI3
-    OTllNjcyMDkzOGMxNjk2YjgwMTA0MDM1YWU0YTJhZjkzNDdlNDI=
+    NzI2NTFkMzk0NjBhYjA4NzE5NTBlOGJjYTI0OWE1ZmNjZDljYjZjNzU0NzQ1
+    OTU2YjE4NGU0MTA2ZjVjZmJhOThiMTZjYzQ3NmJhMGExYjRiYmY3NTNlZmI4
+    NzliOWUzYzY5M2VkN2ExMWM1N2FlYjk4MmIzMTVlNTcxNzczNjM=

data/lib/helix.rb

@@ -1,5 +1,6 @@
 require 'helix/restful'
 require 'helix/uploadable'
+require 'helix/downloadable'
 require 'helix/durationed'
 require 'helix/video'
 require 'helix/track'

data/lib/helix/document.rb

@@ -14,6 +14,34 @@ module Helix
     # @return [Symbol] Name of the class.
     def self.resource_label_sym; :document; end
 
+    # Used to download data for the given Document.
+    #
+    # @example
+    #   document      = Helix::Document.find("239c59483d346")
+    #   document_data = document.download #=> xDC\xF1?\xE9*?\xFF\xD9
+    #   File.open("my_document.mp4", "w") { |f| f.puts document_data }
+    #
+    # @param  [Hash] opts a hash of options for building URL
+    # @return [String] Raw document data, save it to a file
+    def download(opts={})
+      generic_download(opts.merge(action: :file))
+    end
+
+    # Used to play the given Document.
+    #
+    # The definition of what "play" means for Documents
+    # may vary by specific type.
+    #
+    # @example
+    #   document      = Helix::Document.find("239c59483d346")
+    #   document_data = document.play #=> xDC\xF1?\xE9*?\xFF\xD9
+    #
+    # @param  [Hash] opts a hash of options for building URL
+    # @return [String] Raw document data
+    def play(opts={})
+      generic_download(opts.merge(action: :play))
+    end
+
   end
 
 end

data/lib/helix/downloadable.rb

@@ -0,0 +1,18 @@
+module Helix
+
+  module Downloadable
+
+    private
+
+    def generic_download(opts)
+      content_type  = opts[:content_type] || ''
+      url           = config.build_url( action:         opts[:action],
+                                        content_type:   content_type,
+                                        guid:           guid,
+                                        resource_label: plural_resource_label )
+      RestClient.get(url, params: {signature: config.signature(:view)})
+    end
+
+  end
+
+end

data/lib/helix/durationed.rb

@@ -2,15 +2,6 @@ module Helix
 
   module Durationed
 
-    def generic_download(opts)
-      content_type  = opts[:content_type] || ''
-      url           = config.build_url( action:         opts[:action],
-                                        content_type:   content_type,
-                                        guid:           guid,
-                                        resource_label: plural_resource_label )
-      RestClient.get(url, params: {signature: config.signature(:view)})
-    end
-
     module ClassMethods
 
       # Used to import tracks from a URL into the Twistage system.

data/lib/helix/has_signatures.rb

@@ -1,5 +1,6 @@
 module Helix
 
+  require 'set'
   module HasSignatures
 
     unless defined?(self::VALID_SIG_TYPES)

data/lib/helix/media.rb

@@ -4,7 +4,7 @@ module Helix
 
   class Media < Base
 
-    include RESTful, Uploadable
+    include RESTful, Uploadable, Downloadable
 
   end
 

data/spec/document_spec.rb

@@ -2,14 +2,14 @@ require File.expand_path('../spec_helper', __FILE__)
 require 'helix'
 
 describe Helix::Document do
-  let(:klass) { Helix::Document }
 
+  klass = Helix::Document
   subject { klass }
   mods = [ Helix::Base, Helix::Media ]
   mods.each { |mod| its(:ancestors) { should include(mod) } }
-  its(:guid_name) { should eq('document_id') }
-  its(:resource_label_sym)    { should be(:document)   }
-  its(:plural_resource_label) { should eq('documents') }
+  its(:guid_name)             { should eq('document_id') }
+  its(:resource_label_sym)    { should be(:document)     }
+  its(:plural_resource_label) { should eq('documents')   }
   [:find, :create, :all, :find_all, :where].each do |crud_call|
     it { should respond_to(crud_call) }
   end
@@ -19,12 +19,14 @@ describe Helix::Document do
   ### INSTANCE METHODS
 
   describe "an instance" do
-    let(:obj) { klass.new({'document_id' => 'some_document_guid'}) }
+    obj = klass.new({'document_id' => 'some_document_guid'})
     subject { obj }
     its(:resource_label_sym) { should be(:document) }
     [:destroy, :update].each do |crud_call|
       it { should respond_to(crud_call) }
     end
+    it_behaves_like "downloads", obj
+    it_behaves_like "plays",     obj
   end
 
   ### CLASS METHODS

data/spec/media_spec.rb

@@ -31,7 +31,7 @@ describe Helix::Media do
       Helix::Video    => :video,
     }
 
-    mods = [ Helix::RESTful, Helix::Uploadable ]
+    mods = [ Helix::RESTful, Helix::Uploadable, Helix::Downloadable ]
     mods.each { |mod| its(:ancestors) { should include(mod) } }
 
     describe ".create" do

data/spec/paginates_spec.rb

@@ -43,7 +43,7 @@ describe Helix::Paginates do
           non_final_response = double(String, headers: {is_last_page: 'false'})
           RestClient.should_receive(:get).once { non_final_response }
           @klass.stub(:parse_response_by_url_format).with(non_final_response, :a_url) { {label => [:non_final]} }
-          @klass.send(meth, :a_url, label, opts)  
+          @klass.send(meth, :a_url, label, opts)
         end
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helix
 version: !ruby/object:Gem::Version
-  version: 0.0.4.8.pre
+  version: 0.0.4.9.pre
 platform: ruby
 authors:
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-14 00:00:00.000000000 Z
+date: 2014-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -59,50 +59,49 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/helix.rb
-- lib/helix/album.rb
-- lib/helix/audio_playlist.rb
 - lib/helix/base.rb
-- lib/helix/builds_urls.rb
-- lib/helix/config.rb
-- lib/helix/document.rb
-- lib/helix/durationed.rb
-- lib/helix/exceptions.rb
-- lib/helix/has_signatures.rb
-- lib/helix/hash_ext.rb
-- lib/helix/image.rb
-- lib/helix/library.rb
-- lib/helix/media.rb
-- lib/helix/object_ext.rb
 - lib/helix/paginates.rb
-- lib/helix/playlist.rb
+- lib/helix/audio_playlist.rb
+- lib/helix/image.rb
 - lib/helix/restful.rb
+- lib/helix/hash_ext.rb
+- lib/helix/library.rb
+- lib/helix/user.rb
+- lib/helix/has_signatures.rb
+- lib/helix/uploadable.rb
+- lib/helix/downloadable.rb
 - lib/helix/statistics.rb
+- lib/helix/document.rb
+- lib/helix/durationed.rb
+- lib/helix/object_ext.rb
+- lib/helix/video_playlist.rb
+- lib/helix/media.rb
+- lib/helix/video.rb
+- lib/helix/album.rb
+- lib/helix/builds_urls.rb
 - lib/helix/tag.rb
+- lib/helix/playlist.rb
 - lib/helix/track.rb
-- lib/helix/uploadable.rb
-- lib/helix/user.rb
-- lib/helix/video.rb
-- lib/helix/video_playlist.rb
-- spec/_integration_spec.rb
-- spec/album_spec.rb
-- spec/audio_playlist_spec.rb
-- spec/base_spec.rb
-- spec/config_spec.rb
-- spec/document_spec.rb
+- lib/helix/exceptions.rb
+- lib/helix/config.rb
 - spec/durationed_spec.rb
-- spec/helix_spec.rb
-- spec/image_spec.rb
+- spec/document_spec.rb
 - spec/library_spec.rb
-- spec/media_spec.rb
-- spec/paginates_spec.rb
-- spec/playlist_spec.rb
 - spec/spec_helper.rb
-- spec/statistics_spec.rb
+- spec/config_spec.rb
+- spec/base_spec.rb
+- spec/playlist_spec.rb
+- spec/video_spec.rb
 - spec/tag_spec.rb
-- spec/track_spec.rb
 - spec/user_spec.rb
-- spec/video_playlist_spec.rb
-- spec/video_spec.rb
+- spec/_integration_spec.rb
+- spec/album_spec.rb
+- spec/image_spec.rb
+- spec/helix_spec.rb
+- spec/statistics_spec.rb
+- spec/paginates_spec.rb
+- spec/media_spec.rb
+- spec/track_spec.rb
 - LICENSE
 - README.md
 homepage: https://github.com/Twistage/helix/
@@ -125,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Wrapper library for the video API