helix 0.0.1.4.pre → 0.0.1.5.pre

data/lib/helix/base.rb

@@ -1,7 +1,7 @@
 require 'rest-client'
 require 'json'
 require 'yaml'
-require 'active_support/core_ext'
+require 'nori'
 
 module Helix
   class Base
@@ -60,7 +60,8 @@ module Helix
     end
 
     def self.get_data_sets(opts)
-      url          = config.build_url(format: :json)
+      url          = config.build_url(format:     opts[:format] || :json, 
+                                      media_type: self.plural_media_type)
       # We allow opts[:sig_type] for internal negative testing only.
       raw_response = config.get_response(url, {sig_type: :view}.merge(opts))
       data_sets    = raw_response[plural_media_type]

data/lib/helix/config.rb

@@ -128,7 +128,10 @@ module Helix
       if url =~ /json/
         JSON.parse(response)
       elsif url =~ /xml/
-        Hash.from_xml(response)
+        #TODO: Cleanup Nori and response gsub.
+        Nori.parser = :nokogiri
+        xml = response.gsub(/<custom-fields type='array'>/, '<custom-fields type=\'hash\'>')
+        Nori.parse(xml)
       elsif url =~ /csv/
         response
       else

data/lib/helix/track.rb

@@ -11,7 +11,68 @@ module Helix
     #
     # @return [Symbol] Name of the class.
     def self.media_type_sym; :track; end
+    
+    # Used to import tracks from a URL into the Twistage system.
+    # Doc reference: /doc/api/track/import
+    #
+    # @example
+    #   track = Helix::Track.import(src:          "www.google.com/track.mp4",
+    #                               title:        "Some Title,
+    #                               description:  "A random track.")
+    #   new_track.track_id # => dd891b83ba39e
+    #
+    # @param [Hash] attrs The attributes for creating a track.
+    # @return [RestClient] The response object.
+    def self.import(attrs={})
+      #TODO: Pull shared logic (with video) into a shared lib file.
+      RestClient.post(self.get_url,
+                      self.get_xml(attrs),
+                      self.get_params(attrs))
+    end
+
+    private
+
+    # Method allows for :use_raw_xml to be passed into attributes.
+    # Normally attributes would be converted to xml, but use_raw_xml
+    # takes raw xml as an argument. Allowing for xml files to be
+    # used in place of attributes.
+    #
+    # @param [Hash] attrs The attributes for creating xml.
+    # @return [String] Returns xml either from a raw entry or generated from attributes.
+    def self.get_xml(attrs={})
+      return attrs[:use_raw_xml] if attrs[:use_raw_xml].present?
+      { list: { entry: attrs } }.to_xml(root: :add)
+    end
 
+    # Standard hash values used to generate the create_many
+    # url.
+    #
+    # @return [Hash]
+    def self.get_url_opts
+      { action:     :create_many,
+        media_type: plural_media_type,
+        format:     :xml }
+    end
+
+    # Gets the url used in the create_many import call.
+    #
+    # @return [String] Returns the valid url used for the API call.
+    def self.get_url
+      Helix::Config.instance.build_url(self.get_url_opts)
+    end
+
+    # 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.
+    def self.get_params(opts={})
+      opts        = { contributor: :helix, library_id: :development }.merge(opts)
+      sig         = Helix::Config.instance.signature(:ingest, opts)
+      #TODO: Find a better way to handle all the different params needed for a call, such as
+      #attributes vs signature params vs process params. :url params is a temp fix. 
+      url_params  = (opts[:url_params].nil? ? {} : opts[:url_params])
+      { params: (params  = { signature: sig }.merge(url_params)) }
+    end
   end
 
 end

data/lib/helix/video.rb

@@ -29,7 +29,7 @@ module Helix
     def self.import(attrs={})
       RestClient.post(self.get_url,
                       self.get_xml(attrs),
-                      self.get_params(self.extract_params(attrs)))
+                      self.get_params(attrs))
     end
 
     private
@@ -49,7 +49,6 @@ module Helix
     # Standard hash values used to generate the create_many
     # url.
     #
-    #
     # @return [Hash]
     def self.get_url_opts
       { action:     :create_many,
@@ -64,21 +63,17 @@ module Helix
       Helix::Config.instance.build_url(self.get_url_opts)
     end
 
-    def self.extract_params(attrs)
-      [:contributor, :library_id].each_with_object({}) do |param, hash|
-        hash[param] = attrs[param] unless attrs[param].nil?
-      end
-    end
-
     # 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.
     def self.get_params(opts={})
-      opts  = { contributor: :helix, library_id: :development }.merge(opts)
-      sig   = Helix::Config.instance.signature(:ingest, opts)
-      { params: { signature: sig } }
+      opts        = { contributor: :helix, library_id: :development }.merge(opts)
+      sig         = Helix::Config.instance.signature(:ingest, opts)
+      #TODO: Find a better way to handle all the different params needed for a call, such as
+      #attributes vs signature params vs process params. :url params is a temp fix. 
+      url_params  = (opts[:url_params].nil? ? {} : opts[:url_params])
+      { params: (params  = { signature: sig }.merge(url_params)) }
     end
-
   end
 end

data/spec/base_spec.rb

@@ -108,7 +108,8 @@ describe Helix::Base do
       let(:plural_media_type) { :videos }
       before(:each) do klass.stub(:plural_media_type) { plural_media_type } end
       it "should build a JSON URL -> the_url" do
-        mock_config.should_receive(:build_url).with(format: :json)
+        mock_config.should_receive(:build_url).with(format:     :json, 
+                                                    media_type: plural_media_type)
         klass.send(meth, opts)
       end
       it "should get_response(the_url, {sig_type: :view}.merge(opts) -> raw_response" do

data/spec/track_spec.rb

@@ -2,20 +2,99 @@ require File.expand_path('../spec_helper', __FILE__)
 require 'helix'
 
 describe Helix::Track do
+
+  def import_xml(values={})
+    { list: { entry: values } }.to_xml(root: :add)
+  end
+
   let(:klass) { Helix::Track }
 
-  subject { klass }
-  its(:ancestors) { should include(Helix::Base) }
-  its(:guid_name) { should eq('track_id') }
+  subject                 { klass }
+  its(:ancestors)         { should include(Helix::Base) }
+  its(:guid_name)         { should eq('track_id') }
   its(:media_type_sym)    { should be(:track)   }
   its(:plural_media_type) { should eq('tracks') }
 
   describe "Constants"
 
+  let(:sig_opts)  { { contributor:  :helix, 
+                      library_id:   :development } }
+  let(:url_opts)  { { action:       :create_many, 
+                      media_type:   "tracks", 
+                      format:       :xml } }
+
   describe "an instance" do
-    let(:obj) { klass.new({'track_id' => 'some_track_guid'}) }
-    subject { obj }
+    let(:obj)            { klass.new({'track_id' => 'some_track_guid'}) }
+    subject              { obj }
     its(:media_type_sym) { should be(:track) }
   end
 
+  describe ".import" do
+    let(:meth)        { :import }
+    let(:mock_config) { mock(Helix::Config) }
+    subject           { klass.method(meth) }
+    its(:arity)       { should eq(-1) }
+    let(:params)      { { params: { signature: :some_sig } } }  
+    before            { Helix::Config.stub(:instance) { mock_config } } 
+
+    it "should get an ingest signature" do
+      mock_config.should_receive(:build_url).with(url_opts)
+      mock_config.should_receive(:signature).with(:ingest, sig_opts) { :some_sig }
+      RestClient.should_receive(:post).with(nil, import_xml, params)
+      klass.send(meth)
+    end
+  end
+
+  describe ".get_xml" do 
+    let(:meth)  { :get_xml }
+    subject     { klass.method(meth) }
+    its(:arity) { should eq(-1) }
+    context "when :use_raw_xml is present in attrs" do
+      let(:use_raw_xml) { { use_raw_xml: :xml } }
+      it "should return the value of attrs[:use_raw_xml]" do
+        expect(klass.send(meth, use_raw_xml)).to eq(:xml)
+      end
+    end
+    context "when hash is passed without :use_raw_xml" do
+      let(:attrs) { { attribute: :value } }
+      it "should convert attrs into xml" do
+        expect(klass.send(meth, attrs)).to eq(import_xml(attrs))
+      end
+    end
+    context "when nothing in passed in" do
+      it "should return valid xml" do
+        expect(klass.send(meth)).to eq(import_xml)
+      end
+    end
+  end
+
+  describe ".get_url_opts" do
+    let(:meth)  { :get_url_opts }
+    subject     { klass.method(meth) }
+    its(:arity) { should eq(0) }
+    it "should return a valid hash url options for Helix::Config#build_url" do
+       expect(klass.send(meth)).to eq(url_opts)
+    end
+  end
+
+  describe ".get_url" do
+    let(:meth)  { :get_url }
+    subject     { klass.method(meth) }
+    its(:arity) { should eq(0) }
+    it "should call Helix::Config#build_url with url opts" do
+      Helix::Config.instance.should_receive(:build_url).with(klass.send(:get_url_opts))
+      klass.send(meth)
+    end
+  end
+
+  describe ".get_params" do
+    let(:meth)  { :get_params }
+    subject     { klass.method(meth) }
+    its(:arity) { should eq(-1) }
+    it "should call Helix::Config#signature and return a hash of params" do
+      Helix::Config.instance.should_receive(:signature).with(:ingest, sig_opts) { :sig }
+      expect(klass.send(meth)).to eq({ params: { signature: :sig } })
+    end
+  end
+
 end

data/spec/video_spec.rb

@@ -96,18 +96,4 @@ describe Helix::Video do
       expect(klass.send(meth)).to eq({ params: { signature: :sig } })
     end
   end
-
-  describe ".extract_params" do
-    let(:meth)          { :extract_params }
-    subject             { klass.method(meth) }
-    its(:arity)         { should eq(1) }
-    let(:expected_hash) { { contributor: :con, library_id: :id } }
-    let(:attrs)         { { extra_key_one: :one, 
-                            extra_key_two: :two }.merge(expected_hash) }
-    it "should return the correct key values from attributes" do
-      expect(klass.send(meth, attrs)).to eq(expected_hash)
-    end
-  end
-
-
 end

metadata

@@ -1,104 +1,112 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: helix
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.0.1.5.pre
   prerelease: 8
-  version: 0.0.1.4.pre
 platform: ruby
-authors: 
+authors:
 - Twistage, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-12-03 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.5.4
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rest-client
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !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: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    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: 3.0.9
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
   type: :runtime
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 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/base.rb
-- lib/helix/statistics.rb
-- lib/helix/video.rb
-- lib/helix/config.rb
 - lib/helix/image.rb
-- spec/base_spec.rb
+- lib/helix/config.rb
+- lib/helix/video.rb
+- lib/helix/track.rb
+- lib/helix/statistics.rb
+- spec/video_spec.rb
+- spec/spec_helper.rb
 - spec/statistics_spec.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
+- spec/track_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.24
 signing_key: 
 specification_version: 3
 summary: Wrapper library for the video API
 test_files: []
-
 has_rdoc: true