RubyGems - helix - Versions diffs - 0.0.4.0.pre → 0.0.4.1.pre - Mend

helix 0.0.4.0.pre → 0.0.4.1.pre

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

data/lib/helix/durationed.rb CHANGED Viewed

@@ -2,6 +2,15 @@ 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/track.rb CHANGED Viewed

@@ -16,6 +16,31 @@ module Helix
     # @return [Symbol] Name of the class.
     def self.resource_label_sym; :track; end
+    # Used to download data for the given Track.
+    #
+    # @example
+    #   track      = Helix::Track.find("239c59483d346")
+    #   track_data = track.download #=> xDC\xF1?\xE9*?\xFF\xD9
+    #   File.open("my_track.mp3", "w") { |f| f.puts track_data }
+    #
+    # @param  [Hash] opts a hash of options for building URL
+    # @return [String] Raw track data, save it to a file
+    def download(opts={})
+      generic_download(opts.merge(action: :file))
+    end
+    # Used to play the given Track.
+    #
+    # @example
+    #   track      = Helix::Track.find("239c59483d346")
+    #   track_data = track.play #=> xDC\xF1?\xE9*?\xFF\xD9
+    #
+    # @param  [Hash] opts a hash of options for building URL
+    # @return [String] Raw track data
+    def play(opts={})
+      generic_download(opts.merge(action: :play))
+    end
   end
 end

data/lib/helix/video.rb CHANGED Viewed

@@ -106,14 +106,5 @@ module Helix
       url    << "#{width.to_s}#{height.to_s}.jpg"
     end
-    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/spec/statistics_spec.rb CHANGED Viewed

@@ -51,30 +51,20 @@ describe Helix::Statistics do
           when 'delivery'
             media_name = MEDIA_NAME_OF[resource_label] || resource_label
             context "when given opts containing a :#{media_name}_id" do
-              let(:opts) { {group: :daily, "#{media_name}_id".to_sym => "the_#{media_name}_id".to_sym} }
+              let(:opts) { {group: :daily, :"#{media_name}_id" => :"the_#{media_name}_id"} }
               it_behaves_like "clones the stats opts arg"
               it "should refer to the Helix::Config instance" do
                 Helix::Config.should_receive(:instance) { mock_config }
                 mod.send(meth, opts)
               end
-              it "should delete :content_type from opts" do
-                opts.stub(:delete)
-                opts.should_receive(:delete).with(:content_type) { "the_#{media_name}_id".to_sym }
-                mod.send(meth, opts)
-              end
-              it "should delete :#{media_name}_id from opts" do
-                opts.stub(:delete)
-                opts.should_receive(:delete).with("#{media_name}_id".to_sym) { "the_#{media_name}_id".to_sym }
-                mod.send(meth, opts)
-              end
               context "when opts contains a :content_type" do
                 before(:each) do opts.merge!(content_type: :the_format) end
                 it "should call config.build_url(guid: the_#{media_name}_id, resource_label: :#{media_name}s, action: :statistics, content_type: :the_format)" do
                   build_opts_url = {
-                    guid: "the_#{media_name}_id".to_sym,
-                    resource_label: "#{media_name}s".to_sym,
-                    action: :statistics,
-                    content_type: :the_format
+                    guid:           :"the_#{media_name}_id",
+                    resource_label: :"#{media_name}s",
+                    action:         :statistics,
+                    content_type:   :the_format
                   }
                   mock_config.should_receive(:build_url).with(build_opts_url) { :built_url }
                   mod.send(meth, opts)
@@ -82,7 +72,8 @@ describe Helix::Statistics do
               end
               context "when opts did NOT contain a :content_type" do
                 it "should call config.build_url(guid: the_#{media_name}_id, resource_label: :#{media_name}s, action: :statistics)" do
-                  mock_config.should_receive(:build_url).with({guid: "the_#{media_name}_id".to_sym, resource_label: "#{media_name}s".to_sym, action: :statistics}) { :built_url }
+                  build_url_opts = {guid: :"the_#{media_name}_id", resource_label: :"#{media_name}s", action: :statistics}
+                  mock_config.should_receive(:build_url).with(build_url_opts) { :built_url }
                   mod.send(meth, opts)
                 end
               end
@@ -99,27 +90,17 @@ describe Helix::Statistics do
                 Helix::Config.should_receive(:instance) { mock_config }
                 mod.send(meth, opts)
               end
-              it "should delete :content_type from opts" do
-                opts.stub(:delete)
-                opts.should_receive(:delete).with(:content_type) { nil }
-                mod.send(meth, opts)
-              end
-              it "should (fail to) delete :#{media_name}_id from opts" do
-                opts.stub(:delete)
-                opts.should_receive(:delete).with("#{media_name}_id".to_sym) { nil }
-                mod.send(meth, opts)
-              end
               context "when opts contains a :content_type" do
                 before(:each) do opts.merge!(content_type: :the_format) end
                 it "should call config.build_url(resource_label: :statistics, action: :#{media_name}_delivery, content_type: :the_format)" do
-                  build_url_opts = {resource_label: :statistics, action: "#{media_name}_delivery".to_sym, content_type: :the_format}
+                  build_url_opts = {resource_label: :statistics, action: :"#{media_name}_delivery", content_type: :the_format}
                   mock_config.should_receive(:build_url).with(build_url_opts) { :built_url }
                   mod.send(meth, opts)
                 end
               end
               context "when opts did NOT contain a :content_type" do
                 it "should call config.build_url(resource_label: :statistics, action: :#{media_name}_delivery)" do
-                  mock_config.should_receive(:build_url).with({resource_label: :statistics, action: "#{media_name}_delivery".to_sym}) { :built_url }
+                  mock_config.should_receive(:build_url).with({resource_label: :statistics, action: :"#{media_name}_delivery"}) { :built_url }
                   mod.send(meth, opts)
                 end
               end
@@ -141,7 +122,7 @@ describe Helix::Statistics do
                   mod.send(meth, opts)
                 end
                 it "should call config.build_url(resource_label: :statistics, action: :#{media_name}_#{publish_name}/brakdown)" do
-                  mock_config.should_receive(:build_url).with({resource_label: :statistics, action: "#{media_name}_#{publish_name}/breakdown".to_sym}) { :built_url }
+                  mock_config.should_receive(:build_url).with({resource_label: :statistics, action: :"#{media_name}_#{publish_name}/breakdown"}) { :built_url }
                   mod.send(meth, opts)
                 end
                 it "should assign config.get_response(built_url, opts.merge(sig_type: :view) => raw" do
@@ -159,7 +140,7 @@ describe Helix::Statistics do
                     mod.send(meth, opts)
                   end
                   it "should call config.build_url(resource_label: :statistics, action: :#{media_name}_#{publish_name}/#{act})" do
-                    mock_config.should_receive(:build_url).with({resource_label: :statistics, action: "#{media_name}_#{publish_name}/#{act}".to_sym}) { :built_url }
+                    mock_config.should_receive(:build_url).with({resource_label: :statistics, action: :"#{media_name}_#{publish_name}/#{act}"}) { :built_url }
                     mod.send(meth, opts)
                   end
                   it "should assign config.get_response(built_url, opts.merge(sig_type: :view) => raw" do
@@ -181,7 +162,7 @@ describe Helix::Statistics do
                 mod.send(meth, opts)
               end
               it "should call config.build_url(resource_label: :statistics, action: :#{media_name}_#{publish_name}/disk_usage)" do
-                mock_config.should_receive(:build_url).with({resource_label: :statistics, action: "#{media_name}_#{publish_name}/disk_usage".to_sym}) { :built_url }
+                mock_config.should_receive(:build_url).with({resource_label: :statistics, action: :"#{media_name}_#{publish_name}/disk_usage"}) { :built_url }
                 mod.send(meth, opts)
               end
               it "should assign config.get_response(built_url, opts.merge(sig_type: :view) => raw" do

data/spec/track_spec.rb CHANGED Viewed

@@ -25,6 +25,69 @@ describe Helix::Track do
     [:destroy, :update].each do |crud_call|
       it { should respond_to(crud_call) }
     end
+    describe "#download" do
+      let(:meth)        { :download }
+      let(:mock_config) { double(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_resource_label) { :resource_label }
+        RestClient.stub(:get) { '' }
+      end
+      { '' => '', mp3: :mp3, nil => '' }.each do |arg,actual|
+        build_url_h = {action: :file, content_type: actual, guid: :some_guid, resource_label: :resource_label}
+        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) { double(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_resource_label) { :resource_label }
+        RestClient.stub(:get) { '' }
+      end
+      { '' => '', mp3: :mp3, nil => '' }.each do |arg,actual|
+        build_url_h = {action: :play, content_type: actual, guid: :some_guid, resource_label: :resource_label}
+        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
   end
   ### CLASS METHODS

metadata CHANGED Viewed

@@ -1,136 +1,128 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: helix
-version: !ruby/object:Gem::Version
-  version: 0.0.4.0.pre
+version: !ruby/object:Gem::Version
   prerelease: 8
+  version: 0.0.4.1.pre
 platform: ruby
-authors:
+authors:
 - Twistage, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+date: 2013-09-04 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/base.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/uploadable.rb
-- lib/helix/statistics.rb
 - lib/helix/document.rb
-- lib/helix/durationed.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/video_playlist.rb
-- lib/helix/media.rb
+- lib/helix/config.rb
 - lib/helix/video.rb
-- lib/helix/album.rb
-- lib/helix/tag.rb
-- lib/helix/playlist.rb
 - lib/helix/track.rb
+- lib/helix/base.rb
+- lib/helix/image.rb
+- lib/helix/album.rb
 - lib/helix/exceptions.rb
-- lib/helix/config.rb
-- spec/durationed_spec.rb
-- spec/document_spec.rb
-- spec/audio_playlist_spec.rb
-- spec/library_spec.rb
+- lib/helix/hash_ext.rb
 - spec/spec_helper.rb
+- spec/audio_playlist_spec.rb
 - spec/config_spec.rb
-- spec/base_spec.rb
-- spec/playlist_spec.rb
-- spec/video_spec.rb
-- spec/tag_spec.rb
-- spec/user_spec.rb
-- spec/_integration_spec.rb
-- spec/album_spec.rb
 - spec/image_spec.rb
+- spec/media_spec.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/media_spec.rb
 - spec/track_spec.rb
+- spec/user_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.23
+rubygems_version: 1.8.11
 signing_key:
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []