helix 0.0.1.2.pre → 0.0.1.3.pre

data/lib/helix/base.rb

@@ -10,7 +10,8 @@ module Helix
       METHODS_DELEGATED_TO_CLASS = [ :guid_name, :media_type_sym, :plural_media_type ]
     end
 
-    attr_accessor :attributes, :config
+    attr_accessor :attributes
+    attr_writer   :config
 
     # Creates a new record via API and then returns an instance of that record.
     #
@@ -23,7 +24,6 @@ module Helix
     # @param [Hash] attributes a hash containing the attributes used in the create
     # @return [Base] An instance of Helix::Base
     def self.create(attributes={})
-      config    = Helix::Config.instance
       url       = config.build_url(media_type:  plural_media_type,
                                    format:      :xml)
       response  = RestClient.post(url, attributes.merge(signature: config.signature(:update)))
@@ -41,7 +41,6 @@ module Helix
     # @param [String] guid an id in guid form.
     # @return [Base] An instance of Helix::Base
     def self.find(guid)
-      config = Helix::Config.instance
       item   = self.new(attributes: { guid_name => guid }, config: config)
       item.load
     end
@@ -57,11 +56,10 @@ module Helix
     def self.find_all(opts)
       data_sets = get_data_sets(opts)
       return [] if data_sets.nil?
-      data_sets.map { |attrs| self.new(attributes: attrs) }
+      data_sets.map { |attrs| self.new(attributes: attrs, config: config) }
     end
 
     def self.get_data_sets(opts)
-      config       = Helix::Config.instance
       url          = config.build_url(format: :json)
       # We allow opts[:sig_type] for internal negative testing only.
       raw_response = config.get_response(url, {sig_type: :view}.merge(opts))
@@ -97,6 +95,14 @@ module Helix
       @config     = opts[:config]
     end
 
+    def self.config
+      Helix::Config.instance
+    end
+
+    def config
+      @config ||= Helix::Config.instance
+    end
+
     # Deletes the record of the Helix::Base instance.
     #
     # @example
@@ -105,7 +111,6 @@ module Helix
     #
     # @return [String] The response from the HTTP DELETE call.
     def destroy
-      config   = Helix::Config.instance
       url      = config.build_url(format: :xml, guid: guid, media_type: plural_media_type)
       RestClient.delete(url, params: {signature: config.signature(:update)})
     end

data/lib/helix/config.rb

@@ -88,7 +88,7 @@ module Helix
       sig_type    = opts.delete(:sig_type)
       params      = opts.merge(signature: signature(sig_type, opts))
       response    = RestClient.get(url, params: params)
-      JSON.parse(response)
+      parse_response_by_url_format(response, url)
     end
 
     # Fetches the signature for a specific license key.
@@ -123,6 +123,19 @@ module Helix
       @credentials['license_key']
     end
 
+    def parse_response_by_url_format(response, url)
+      ### FIXME: This is ugly. Clean it up.
+      if url =~ /json/
+        JSON.parse(response)
+      elsif url =~ /xml/
+        Hash.from_xml(response)
+      elsif url =~ /csv/
+        response
+      else
+        raise "Could not parse #{url}"
+      end
+    end
+
     def prepare_signature_memoization
       lk = license_key
       @signature_for                ||= {}

data/lib/helix/statistics.rb

@@ -119,10 +119,12 @@ module Helix
 
     def self.delivery(media_type, opts)
       memo_cfg = Helix::Config.instance
+      format   = opts.delete(:format)
       guid     = opts.delete("#{media_type}_id".to_sym)
       url_opts = guid ?
         {guid: guid, media_type: "#{media_type}s".to_sym, action: :statistics} :
         {media_type: :statistics, action: "#{media_type}_delivery".to_sym}
+      url_opts.merge!(format: format) if format
       url = memo_cfg.build_url(url_opts)
       # We allow opts[:sig_type] for internal negative testing only.
       memo_cfg.get_response(url, {sig_type: :view}.merge(opts))
@@ -130,7 +132,9 @@ module Helix
 
     def self.storage(media_type, opts)
       memo_cfg = Helix::Config.instance
+      format   = opts.delete(:format)
       url_opts = {media_type: :statistics, action: storage_action_for(media_type)}
+      url_opts.merge!(format: format) if format
       url = memo_cfg.build_url(url_opts)
       # We allow opts[:sig_type] for internal negative testing only.
       memo_cfg.get_response(url, {sig_type: :view}.merge(opts))

data/lib/helix/video.rb

@@ -19,16 +19,16 @@ module Helix
     # Doc reference: /doc/api/video/import
     #
     # @example
-    #   video = Helix::Video.import(src:          "www.google.com/video.mp4", 
-    #                               title:        "Some Title, 
+    #   video = Helix::Video.import(src:          "www.google.com/video.mp4",
+    #                               title:        "Some Title,
     #                               description:  "A random video.")
     #   new_video.video_id # => dd891b83ba39e
     #
     # @param [Hash] attrs The attributes for creating a video.
     # @return [RestClient] The response object.
     def self.import(attrs={})
-      RestClient.post(self.get_url, 
-                      self.get_xml(attrs), 
+      RestClient.post(self.get_url,
+                      self.get_xml(attrs),
                       self.get_params(self.extract_params(attrs)))
     end
 
@@ -50,9 +50,9 @@ module Helix
     # url.
     #
     #
-    # @return [Hash] 
+    # @return [Hash]
     def self.get_url_opts
-      { action:     :create_many, 
+      { action:     :create_many,
         media_type: plural_media_type,
         format:     :xml }
     end
@@ -73,11 +73,11 @@ module Helix
     # Gets the hash used in adding the signature to the API
     # call.
     #
-    # @return [Hash] Returns a formatted hash for passing in the signature to the API call. 
+    # @return [Hash] Returns a formatted hash for passing in the signature to the API call.
     def self.get_params(opts={})
       opts  = { contributor: :helix, library_id: :development }.merge(opts)
       sig   = Helix::Config.instance.signature(:ingest, opts)
-      { params: { signature: sig } } 
+      { params: { signature: sig } }
     end
 
   end

data/spec/base_spec.rb

@@ -24,6 +24,16 @@ describe Helix::Base do
 
   ### CLASS METHODS
 
+  describe ".config" do
+    let(:meth)  { :config }
+    subject     { klass.method(meth) }
+    its(:arity) { should eq(0) }
+    describe "when called" do
+      subject     { klass.send(meth) }
+      it { should eq(Helix::Config.instance) }
+    end
+  end
+
   describe ".create" do
     let(:meth)        { :create }
     let(:mock_config) { mock(Helix::Config) }
@@ -118,9 +128,9 @@ describe Helix::Base do
         let(:data_set) { (0..2).to_a }
         before(:each) do mock_config.stub(:get_response) { {plural_media_type => data_set } } end
         it "should map instantiation with attributes: each data set element" do
-          klass.should_receive(:new).with(attributes: data_set[0]) { :a }
-          klass.should_receive(:new).with(attributes: data_set[1]) { :b }
-          klass.should_receive(:new).with(attributes: data_set[2]) { :c }
+          klass.should_receive(:new).with(attributes: data_set[0], config: mock_config) { :a }
+          klass.should_receive(:new).with(attributes: data_set[1], config: mock_config) { :b }
+          klass.should_receive(:new).with(attributes: data_set[2], config: mock_config) { :c }
           expect(klass.send(meth, opts)).to eq([:a, :b, :c])
         end
       end
@@ -132,6 +142,23 @@ describe Helix::Base do
 
     ### INSTANCE METHODS
 
+    describe ".config" do
+      let(:meth)  { :config }
+      subject     { obj.method(meth) }
+      its(:arity) { should eq(0) }
+      describe "when called" do
+        subject     { obj.send(meth) }
+        context "and @config is already set" do
+          before(:each) do obj.instance_variable_set(:@config, :cached_val) end
+          it { should be(:cached_val) }
+        end
+        context "and @config is NOT already set" do
+          before(:each) do obj.instance_variable_set(:@config, nil) end
+          it { should eq(Helix::Config.instance) }
+        end
+      end
+    end
+
     describe "#destroy" do
       let(:meth)   { :destroy }
       let(:mock_config) { mock(Helix::Config, build_url: :the_built_url, signature: :some_sig) }

data/spec/config_spec.rb

@@ -273,15 +273,43 @@ describe Helix::Config do
     subject     { obj.method(meth) }
     its(:arity) { should eq(-2) }
     context "when given a url and options" do
-      let(:string)        { String.new }
       let(:opts)          { {sig_type: :the_sig_type} }
-      let(:params)        { { params: { signature: string } } }
+      let(:params)        { { params: { signature: 'mock_sig' } } }
+      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" } }
-      it "should call RestClient.get and return a hash from parsed JSON" do
-        obj.stub(:signature).with(:the_sig_type, opts) { string }
-        RestClient.should_receive(:get).with(string, params) { returned_json }
-        expect(obj.send(meth, string, opts)).to eq(json_parsed)
+      let(:xml_parsed)    { { "root" => { "inner" => "inner value" } } }
+      before(:each) do
+        obj.stub(:signature).with(:the_sig_type, opts) { 'mock_sig' }
+      end
+      context "and the URL matches /json/" do
+        let(:url) { 'blah.json' }
+        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
+        let(:url) { 'blah.xml' }
+        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
+      end
+      context "and the URL matches /csv/" do
+        let(:url) { 'blah.csv' }
+        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
+      end
+      context "and the URL matches none of /json/, /xml/, or /csv/" do
+        let(:url) { 'blah.yml' }
+        it "should raise an exception" do
+          RestClient.should_receive(:get).with(url, params) { returned_csv }
+          expect(lambda { obj.send(meth, url, opts) }).to raise_error
+        end
       end
     end
   end

data/spec/statistics_spec.rb

@@ -38,13 +38,34 @@ describe Helix::Statistics do
               Helix::Config.should_receive(:instance) { mock_config }
               mod.send(meth, opts)
             end
+            it "should delete :format from opts" do
+              opts.stub(:delete)
+              opts.should_receive(:delete).with(:format) { "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
-            it "should call config.build_url(guid: the_#{media_name}_id, media_type: :#{media_name}s, action: :statistics)" do
-              mock_config.should_receive(:build_url).with({guid: "the_#{media_name}_id".to_sym, media_type: "#{media_name}s".to_sym, action: :statistics}) { :built_url }
-              mod.send(meth, opts)
+            context "when opts contains a :format" do
+              before(:each) do opts.merge!(format: :the_format) end
+              it "should call config.build_url(guid: the_#{media_name}_id, media_type: :#{media_name}s, action: :statistics, format: :the_format)" do
+                build_opts_url = {
+                  guid: "the_#{media_name}_id".to_sym,
+                  media_type: "#{media_name}s".to_sym,
+                  action: :statistics,
+                  format: :the_format
+                }
+                mock_config.should_receive(:build_url).with(build_opts_url) { :built_url }
+                mod.send(meth, opts)
+              end
+            end
+            context "when opts did NOT contain a :format" do
+              it "should call config.build_url(guid: the_#{media_name}_id, media_type: :#{media_name}s, action: :statistics)" do
+                mock_config.should_receive(:build_url).with({guid: "the_#{media_name}_id".to_sym, media_type: "#{media_name}s".to_sym, action: :statistics}) { :built_url }
+                mod.send(meth, opts)
+              end
             end
             it "should return config.get_response(built_url, opts.merge(sig_type: :view)" do
               mock_config.should_receive(:get_response).with(:built_url, {group: :daily, sig_type: :view}) { :response }
@@ -57,13 +78,29 @@ describe Helix::Statistics do
               Helix::Config.should_receive(:instance) { mock_config }
               mod.send(meth, opts)
             end
+            it "should delete :format from opts" do
+              opts.stub(:delete)
+              opts.should_receive(:delete).with(:format) { 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
-            it "should call config.build_url(media_type: :statistics, action: :#{media_name}_delivery)" do
-              mock_config.should_receive(:build_url).with({media_type: :statistics, action: "#{media_name}_delivery".to_sym}) { :built_url }
-              mod.send(meth, opts)
+            context "when opts contains a :format" do
+              before(:each) do opts.merge!(format: :the_format) end
+              it "should call config.build_url(media_type: :statistics, action: :#{media_name}_delivery, format: :the_format)" do
+                build_url_opts = {media_type: :statistics, action: "#{media_name}_delivery".to_sym, format: :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 :format" do
+              it "should call config.build_url(media_type: :statistics, action: :#{media_name}_delivery)" do
+                mock_config.should_receive(:build_url).with({media_type: :statistics, action: "#{media_name}_delivery".to_sym}) { :built_url }
+                mod.send(meth, opts)
+              end
             end
             it "should return config.get_response(built_url, opts.merge(sig_type: :view)" do
               mock_config.should_receive(:get_response).with(:built_url, {group: :daily, sig_type: :view}) { :response }

metadata

@@ -1,112 +1,104 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: helix
-version: !ruby/object:Gem::Version
-  version: 0.0.1.2.pre
+version: !ruby/object:Gem::Version 
   prerelease: 8
+  version: 0.0.1.3.pre
 platform: ruby
-authors:
+authors: 
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-28 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-11-29 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: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.9
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: activesupport
   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: 3.0.9
+  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/track.rb
-- lib/helix/video.rb
+- lib/helix/base.rb
 - lib/helix/statistics.rb
-- lib/helix/image.rb
-- lib/helix/album.rb
+- lib/helix/video.rb
 - lib/helix/config.rb
-- lib/helix/base.rb
-- spec/video_spec.rb
-- spec/album_spec.rb
-- spec/config_spec.rb
+- lib/helix/image.rb
 - spec/base_spec.rb
 - spec/statistics_spec.rb
-- spec/spec_helper.rb
+- spec/config_spec.rb
 - spec/track_spec.rb
 - spec/image_spec.rb
+- spec/spec_helper.rb
+- spec/video_spec.rb
+- spec/album_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
 signing_key: 
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []
+
 has_rdoc: true