helix 0.0.2.6.pre → 0.0.2.7.pre

data/lib/helix/base.rb

@@ -22,7 +22,8 @@ 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={})
+    def self.find_all(original_opts={})
+      opts           = original_opts.clone
       RestClient.log = 'helix.log' if opts.delete(:log)
       data_sets = get_data_sets(opts)
       return [] if data_sets.nil?

data/lib/helix/config.rb

@@ -95,7 +95,8 @@ module Helix
     # @param [String] url the base part of the URL to be used
     # @param [Hash] opts a hash of options for building URL additions
     # @return [String] The full RESTful URL string object
-    def get_response(url, opts={})
+    def get_response(url, original_opts={})
+      opts        = original_opts.clone
       sig_type    = opts.delete(:sig_type)
       params      = opts.merge(signature: signature(sig_type, opts))
       response    = RestClient.get(url, params: params)

data/lib/helix/media.rb

@@ -55,7 +55,8 @@ module Helix
     #
     # @param [Hash] opts a hash of attributes to update the instance with.
     # @return [Base] Returns an instance of the class after update.
-    def update(opts={})
+    def update(original_opts={})
+      opts           = original_opts.clone
       RestClient.log = 'helix.log' if opts.delete(:log)
       memo_cfg = config
       url      = memo_cfg.build_url(content_type:   :xml,

data/lib/helix/statistics.rb

@@ -124,7 +124,8 @@ module Helix
 
     private
 
-    def self.delivery(resource_label, opts)
+    def self.delivery(resource_label, original_opts)
+      opts          = original_opts.clone
       memo_cfg      = Helix::Config.instance
       content_type  = opts.delete(:content_type)
       guid          = opts.delete("#{resource_label}_id".to_sym)
@@ -137,13 +138,15 @@ module Helix
       memo_cfg.get_response(url, {sig_type: :view}.merge(opts))
     end
 
-    def self.ingest(resource_label, opts)
+    def self.ingest(resource_label, original_opts)
+      opts            = original_opts.clone
       opts[:action] ||= :breakdown
       action_prefix   = ingest_action_prefix_for(resource_label)
       storage(resource_label, opts.merge(action: :"#{action_prefix}/#{opts[:action]}"))
     end
 
-    def self.storage(resource_label, opts)
+    def self.storage(resource_label, original_opts)
+      opts          = original_opts.clone
       memo_cfg      = Helix::Config.instance
       content_type  = opts.delete(:content_type)
       action        = opts.delete(:action) || storage_action_for(resource_label)

data/lib/helix/video.rb

@@ -32,16 +32,34 @@ module Helix
     # @param [String] guid is the string containing the guid for the video.
     # @param [Hash] opts a hash of options for building URL
     # @return [String] Stillframe jpg data, save it to a file with extension .jpg.
-    def self.get_stillframe(guid, opts={})
+    def self.get_stillframe(guid, original_opts={})
+      opts = original_opts.clone
       RestClient.log = 'helix.log' if opts.delete(:log)
       url = get_stillframe_url(guid, opts)
       RestClient.get(url)
     end
 
+    # Used to download data for the given Video.
+    #
+    # @example
+    #   video      = Helix::Video.find("239c59483d346")
+    #   video_data = video.download #=> xDC\xF1?\xE9*?\xFF\xD9
+    #   File.open("my_video.mp4", "w") { |f| f.puts video_data }
+    #
+    # @param [Hash] opts a hash of options for building URL
+    # @return [String] Raw video data, save it to a file
     def download(opts={})
       generic_download(opts.merge(action: :file))
     end
 
+    # Used to play the given Video.
+    #
+    # @example
+    #   video      = Helix::Video.find("239c59483d346")
+    #   video_data = video.play #=> xDC\xF1?\xE9*?\xFF\xD9
+    #
+    # @param [Hash] opts a hash of options for building URL
+    # @return [String] Raw video data
     def play(opts={})
       generic_download(opts.merge(action: :play))
     end

data/spec/base_spec.rb

@@ -43,6 +43,10 @@ describe Helix::Base do
       let(:opts) { {opts_key1: :opts_val1} }
       let(:plural_resource_label) { :videos }
       before(:each) do klass.stub(:plural_resource_label) { plural_resource_label } end
+      it "should clone the opts arg" do
+        opts.should_receive(:clone) { opts }
+        klass.send(meth, opts)
+      end
       it "should build a XML URL -> the_url" do
         mock_config.should_receive(:build_url).with(content_type:   :xml,
                                                     resource_label: plural_resource_label)
@@ -137,8 +141,8 @@ describe Helix::Base do
     its(:arity) { should eq(1) }
     let(:attrs) { Hash.new }
     it "should call massage_custom_field_attrs and massage_time_attrs" do
-      klass.should_receive(:massage_time_attrs).and_return attrs
-      klass.should_receive(:massage_custom_field_attrs).and_return attrs
+      klass.should_receive(:massage_time_attrs) { attrs }
+      klass.should_receive(:massage_custom_field_attrs) { attrs }
       klass.send(meth, attrs)
     end
   end

data/spec/config_spec.rb

@@ -307,25 +307,35 @@ describe Helix::Config do
     subject     { obj.method(meth) }
     its(:arity) { should eq(-2) }
     context "when given a url and options" do
-      let(:opts)          { {sig_type: :the_sig_type} }
-      let(:params)        { { params: { signature: 'mock_sig' } } }
+      let(:opts)          { {sig_type: :the_sig_type, some_key: :some_value} }
+      let(:params)        { { params: { signature: 'mock_sig', some_key: :some_value } } }
       let(:returned_csv)  { 'x,y,z' }
       let(:returned_json) { '{"key": "val"}' }
       let(:returned_xml)  { '<root><inner>inner value</inner></root>' }
       let(:json_parsed)   { { "key" => "val" } }
       let(:xml_parsed)    { { "root" => { "inner" => "inner value" } } }
       before(:each) do
-        obj.stub(:signature).with(:the_sig_type, opts) { 'mock_sig' }
+        obj.stub(:signature).with(:the_sig_type, opts.reject { |k,v| k == :sig_type }) { 'mock_sig' }
       end
       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 "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
       end
-      context "and the URL matches /json/" do
+      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 "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)
@@ -333,6 +343,11 @@ describe Helix::Config do
       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 "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)

data/spec/media_spec.rb

@@ -143,6 +143,11 @@ describe Helix::Media do
       context "when given an opts argument of {key1: :value1}" do
         let(:opts)  { {key1: :value1} }
         it_behaves_like "builds URL for update"
+        it "clones the opts arg" do
+          RestClient.stub(:put).with(:expected_url, {signature: 'some_sig', video: opts})
+          opts.should_receive(:clone) { opts }
+          obj.send(meth, opts)
+        end
         it "should call RestClient.put(output_of_build_url, {signature: the_sig, video: opts}) and return instance of klass" do
           RestClient.should_receive(:put).with(:expected_url, {signature: 'some_sig', video: opts})
           expect(obj.send(meth, opts)).to be_an_instance_of(klass)

data/spec/statistics_spec.rb

@@ -17,6 +17,13 @@ describe Helix::Statistics do
 
   describe "Constants"
 
+  shared_examples_for "clones the stats opts arg" do
+    it "should clone the opts arg" do
+      opts.should_receive(:clone) { opts }
+      mod.send(meth, opts)
+    end
+  end
+
   STATS_TYPES.each do |stats_type|
     STATS_MEDIA_TYPES.each do |resource_label|
 
@@ -35,6 +42,7 @@ describe Helix::Statistics do
             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} }
+              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)
@@ -75,6 +83,7 @@ describe Helix::Statistics do
             end
             context "when given opts NOT containing a :#{media_name}_id" do
               let(:opts) { {group: :daily} }
+              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)
@@ -114,6 +123,7 @@ describe Helix::Statistics do
             context "when given opts" do
               context "and opts has no :action key" do
                 let(:opts) { {group: :daily} }
+                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)
@@ -130,6 +140,7 @@ describe Helix::Statistics do
               [ :encode, :source, :breakdown ].each do |act|
                 context "and opts has an :action value of :#{act}" do
                   let(:opts) { {action: act, group: :daily} }
+                  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)
@@ -150,6 +161,7 @@ describe Helix::Statistics do
             publish_name = INGEST_NAME_OF[resource_label] || 'ingest'
             context "when given opts" do
               let(:opts) { {group: :daily} }
+              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)

data/spec/video_spec.rb

@@ -93,7 +93,7 @@ describe Helix::Video do
       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) { :some_guid }
         klass.should_receive(:get_stillframe)
         obj.send(meth)
       end
@@ -143,7 +143,7 @@ describe Helix::Video do
     context "when no height or width is passed in " do
       let(:full_url) { "#{base_url}original.jpg" }
       it "should build the correct url and return data" do
-        RestClient.should_receive(:get).with(full_url).and_return image_data
+        RestClient.should_receive(:get).with(full_url) { image_data }
         expect(klass.send(meth, guid)).to eq(image_data)
       end
     end
@@ -153,8 +153,13 @@ describe Helix::Video do
         let(:dim_val)   { 100 }
         let(:full_url)  { "#{base_url}#{dim_val}#{url_tag}.jpg" }
         let(:opts)      { { dimension => dim_val } }
+        it "should clone the opts arg" do
+          RestClient.stub(:get).with(full_url) { image_data }
+          opts.should_receive(:clone) { opts }
+          klass.send(meth, guid, opts)
+        end
         it "should build the correct url and return data" do
-          RestClient.should_receive(:get).with(full_url).and_return image_data
+          RestClient.should_receive(:get).with(full_url) { image_data }
           expect(klass.send(meth, guid, opts)).to eq(image_data)
         end
       end
@@ -163,8 +168,13 @@ describe Helix::Video do
       let(:dim_val)   { 100 }
       let(:full_url)  { "#{base_url}#{dim_val}w#{dim_val}h.jpg" }
       let(:opts)      { { height: dim_val, width: dim_val } }
+      it "should clone the opts arg" do
+        RestClient.stub(:get).with(full_url) { image_data }
+        opts.should_receive(:clone) { opts }
+        klass.send(meth, guid, opts)
+      end
       it "should build the correct url and return data" do
-        RestClient.should_receive(:get).with(full_url).and_return image_data
+        RestClient.should_receive(:get).with(full_url) { image_data }
         expect(klass.send(meth, guid, opts)).to eq(image_data)
       end
     end

metadata

@@ -2,7 +2,7 @@
 name: helix
 version: !ruby/object:Gem::Version 
   prerelease: 8
-  version: 0.0.2.6.pre
+  version: 0.0.2.7.pre
 platform: ruby
 authors: 
 - Twistage, Inc
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-02-14 00:00:00 Z
+date: 2013-02-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: json
@@ -55,36 +55,36 @@ extra_rdoc_files: []
 
 files: 
 - lib/helix.rb
-- lib/helix/tag.rb
+- lib/helix/album.rb
+- lib/helix/track.rb
+- lib/helix/base.rb
+- lib/helix/library.rb
 - lib/helix/media.rb
+- lib/helix/durationed_media.rb
+- lib/helix/tag.rb
 - lib/helix/statistics.rb
-- lib/helix/library.rb
+- lib/helix/video_playlist.rb
 - lib/helix/audio_playlist.rb
-- lib/helix/durationed_media.rb
+- lib/helix/video.rb
 - lib/helix/playlist.rb
-- lib/helix/video_playlist.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
-- spec/spec_helper.rb
-- spec/audio_playlist_spec.rb
-- spec/config_spec.rb
-- spec/image_spec.rb
-- spec/media_spec.rb
+- lib/helix/image.rb
 - spec/durationed_media_spec.rb
-- spec/album_spec.rb
+- spec/base_spec.rb
 - spec/statistics_spec.rb
-- spec/tag_spec.rb
-- spec/video_playlist_spec.rb
+- spec/config_spec.rb
 - spec/track_spec.rb
-- spec/video_spec.rb
 - spec/playlist_spec.rb
+- spec/image_spec.rb
 - spec/library_spec.rb
-- spec/base_spec.rb
+- spec/spec_helper.rb
+- spec/audio_playlist_spec.rb
+- spec/video_spec.rb
+- spec/tag_spec.rb
+- spec/album_spec.rb
+- spec/video_playlist_spec.rb
+- spec/media_spec.rb
 - LICENSE
 - README.md
 homepage: https://github.com/Twistage/helix/
@@ -110,9 +110,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []
 
+has_rdoc: yard